@graphql-authz/envelop-plugin

中文文档
1.0.7发布于 2024/08/13MITTypeScriptCommonJS零依赖近 30 天下载 5.8万

图克l-authz 的内嵌插件

中文使用文档
文档目录3 节
  1. 覆盖配置
  2. 用于指令的使用
  3. 用于 AuthSchema 用途

@graphql-authz/envelop-plugin (英语)

覆盖配置

确保配置上下文解析器以进行认证,并在上下文中添加用户信息

  const getEnveloped = envelop({
    plugins: [
      ...
      useExtendContext(req => ({
        user: someHowAuthenticateUser(req.get("authorization"))),
      })),
      ...
    ]
  });

或者说

  getEnveloped({
    user: someHowAuthenticateUser(req.get("authorization"))),
  });

添加插件以嵌入

  import { authZEnvelopPlugin } from "@graphql-authz/envelop-plugin";
  
  const getEnveloped = envelop({
    plugins: [
      ...
      authZEnvelopPlugin({ rules })
      ...
    ]
  });

用于指令的使用

将指令变压器应用到计划

import { authZDirective } from '@graphql-authz/directive';
import { authZEnvelopPlugin } from "@graphql-authz/envelop-plugin";

const { authZDirectiveTransformer } = authZDirective();

const transformedSchema = authZDirectiveTransformer(schema);

const getEnveloped = envelop({
  plugins: [
    useSchema(transformedSchema),
    authZEnvelopPlugin({ rules })
    ...
  ]
});

用于 AuthSchema 用途

通过额外的参数 authSchema 改为 authZEnvelopPlugin

import { authZEnvelopPlugin } from "@graphql-authz/envelop-plugin";
  
const getEnveloped = envelop({
  plugins: [
    ...
    authZEnvelopPlugin({ rules, authSchema })
    ...
  ]
});

版本与发布记录

@graphql-authz/envelop-plugin 共发布 7 个版本,首次发布于 2021/09/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.7latest2024/08/132 年前
1.0.52023/11/302 年前
1.0.42022/09/124 年前
1.0.32021/12/224 年前
1.0.22021/12/034 年前
1.0.12021/11/115 年前

关于 @graphql-authz/envelop-plugin 的常见问题

@graphql-authz/envelop-plugin 是什么?

图克l-authz 的内嵌插件

如何安装 @graphql-authz/envelop-plugin?

在项目目录运行 npm install @graphql-authz/envelop-plugin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@envelop/core(^5.0.1)、@graphql-authz/core(^1.3.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphql-authz/envelop-plugin 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphql-authz/envelop-plugin 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@graphql-authz/envelop-plugin 可以商用吗?

@graphql-authz/envelop-plugin 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@graphql-authz/envelop-plugin 的下载量有多少?

根据 npm 官方下载统计,@graphql-authz/envelop-plugin 在 2026/10/17 – 2026/11/15 这 30 天内被下载 57,751 次,日均约 1,925 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphql-authz/envelop-plugin 还在维护吗?

最新版本 1.0.7 发布于 2024/08/13(2 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/09/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。