# @gapi/ac 中文文档

规范地址：https://npmcn.com/package/%40gapi/ac/

版本：1\.8\.263
npm 元数据更新时间：2026-11-15T16:23:27.283Z
中文译文更新时间：2026-11-15T23:07:50.702Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gapi/ac
原文对照：https://npmcn.com/package/%40gapi/ac/?lang=original
项目主页：https://github.com/Stradivario/gapi#readme
源码仓库：https://github.com/Stradivario/gapi

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：126 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2020-04-22T10:27:46.314Z
- 最新版本发布：2026-11-15T16:23:27.134Z
- 近 30 天下载量：3914（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：216（近 12 个月 116 个）

## 中文简介

@gapi/ ac 库是一个用于GraphQL应用程序的访问控制工具。 它帮助开发者管理不同用户角色的权限,例如GULT,USER,和ADMIN,跨越各种GraphQL动作,如查询,突变,下标等

## 安装

```sh
npm install @gapi/ac
```

也可以使用：`pnpm add @gapi/ac`、`yarn add @gapi/ac`、`bun add @gapi/ac`

## README

@gapi/ ac 库是一个用于GraphQL应用程序的访问控制工具。 它帮助开发者管理不同用户角色的权限,例如GULT,USER,和ADMIN,跨越各种GraphQL动作,例如查询,突变,订阅和事件. 它允许开发者定义并强制执行规则,其中的角色可以访问或操纵系统中的特定资源.

关键特征包括:

基于角色权限:您可以根据用户角色定义访问控制(如GULT,USER,ADMIN),并控制他们可以执行的行动. GraphQL 聚焦:在 GraphQL 中为处理许可而专门构建,使其自然适合应用此API标准. 过滤数据 : 库允许根据用户角色过滤数据,因此不同角色只看到他们被授权访问的数据. 例如,管理员可以访问查询某个数据字段(状态),而普通用户可以部分访问,根据许可定义过滤出一些响应属性.

```ts
import { AccessControl, Union } from '@gapi/ac';

enum GraphqlActions {
  query,
  mutation,
  subscription,
  event,
}

enum Roles {
  GUEST,
  USER,
  ADMIN,
}

interface IQuery {
  status: {
    status: number;
  };
}

const Permissions: Union<typeof Roles, IQuery, typeof GraphqlActions> = {
  GUEST: {
    status: {
      query: {
        enabled: false,
      },
    },
  },
  USER: {
    status: {
      query: {
        enabled: true,
        attributes: {
          status: false,
        },
      },
    },
  },
  ADMIN: {
    status: {
      query: {
        enabled: true,
      },
    },
  },
};

const ac = new AccessControl<
  typeof Roles,
  IQuery & ISubscription & IMutation,
  typeof GraphqlActions
>(Permissions);

const canAdminQueryStatus = ac.can('ADMIN', 'query', 'status');
const canAdminQueryStatus = ac.can('USER', 'query', 'status');

if (!canAdminQueryStatus) {
  throw new Error('You are not authorized');
}

const data = { status: 200 };
const filteredData = await ac.filter('USER', 'query', 'status')(data);
filteredData; // { status: null }
```

## 常见问题

### @gapi/ac 是什么？

@gapi/ ac 库是一个用于GraphQL应用程序的访问控制工具。 它帮助开发者管理不同用户角色的权限,例如GULT,USER,和ADMIN,跨越各种GraphQL动作,如查询,突变,下标等

### 如何安装 @gapi/ac？

在项目目录运行 npm install @gapi/ac，或使用 pnpm add / yarn add / bun add。

### @gapi/ac 支持 TypeScript 吗？

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

### @gapi/ac 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gapi/ac 可以商用吗？

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

### @gapi/ac 的下载量有多少？

根据 npm 官方下载统计，@gapi/ac 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,914 次，日均约 130 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gapi/ac 还在维护吗？

最新版本 1\.8\.263 发布于 2026/11/16（今天）；至今共发布 216 个版本，其中过去 12 个月发布了 116 个；首次发布于 2020/04/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

