# @graphql-schema-filter/core 中文文档

规范地址：https://npmcn.com/package/%40graphql-schema-filter/core/

版本：0\.3\.0
npm 元数据更新时间：2025-11-29T13:59:41.311Z
中文译文更新时间：2026-11-16T23:10:18.511Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40graphql-schema-filter/core
原文对照：https://npmcn.com/package/%40graphql-schema-filter/core/?lang=original

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

- 包体积（解压后）：162 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：graphql ^16\.0\.0
- 首次发布：2025-11-29T05:15:23.348Z
- 最新版本发布：2025-11-29T13:59:41.073Z
- 近 30 天下载量：89945（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

图QL 筛选库中包含 @ expose 指令支持的目标访问控制

## 安装

```sh
npm install @graphql-schema-filter/core
```

也可以使用：`pnpm add @graphql-schema-filter/core`、`yarn add @graphql-schema-filter/core`、`bun add @graphql-schema-filter/core`

## README

# @ graphql-schema- filter/ 核心

GraphQL 筛选库 `@expose` 指令支持基于目标的访问控制.

## 特征

-   **基于目标的过滤**: 基于 `@expose` 以标签为基础的访问控制指令
-   **智能默认**: 自动曝光输出类型字段,允许输入类型处理,明确查询/混合字段控制
-   **类型安全**: 包含全面类型定义的完整类型脚本支持
-   **零配置**: 有合理默认的简单 API
-   **生产准备**: 有源地图和声明文件的双格式(ESM + CJS)

## 安装

```bash
npm install @graphql-schema-filter/core graphql
```

## 快速启动

```typescript
import { buildSchema } from "graphql";
import { filterSchema } from "@graphql-schema-filter/core";

const schema = buildSchema(`
  directive @expose(tags: [String!]!) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION

  type Query {
    users: [User!]! @expose(tags: ["readonly", "admin"])
    adminUsers: [User!]! @expose(tags: ["admin"])
  }

  type User {
    id: ID!
    name: String!
    email: String!
    salary: Float @expose(tags: ["admin"])
  }
`);

// Filter for readonly users
const readonlySchema = filterSchema(schema, {
  target: "readonly",
});

// Filter for admin users
const adminSchema = filterSchema(schema, {
  target: "admin",
});
```

## API 密码

### `filterSchema(schema, options)`

过滤 GraphQL 计划的主要切入点 .

**参数:**

-   `schema: GraphQLSchema` - 过滤的 GraphQL 方案
-   `options: FilterSchemaOptions`
    -   `target: string` - 过滤的目标标记(例如“admin”、“只读”)
    -   `logLevel?: LogLevel` - 日志级别(例如“调试”、“信息”、“警告”、“无”)(默认:“无”)
    -   `formatOptions?: FormatSchemaOptions` - Schema格式化选项(默认:字母排序)

**回返情况:** `GraphQLSchema` - 过滤计划

### 导出类型

```typescript
import type {
  FilterSchemaOptions,
  FormatSchemaOptions,
  DefinitionsSortOptions,
  SortFieldsOptions,
} from "@graphql-schema-filter/core";
```

### `FormatSchemaOptions`

控制被过滤的 schema 输出的格式.

```typescript
interface FormatSchemaOptions {
  definitionsSort: DefinitionsSortOptions;
  fieldsSort: SortFieldsOptions;
}

type DefinitionsSortOptions =
  | { type: "alphabetical" }  // Sort by group then alphabetically
  | { type: "none" };         // Preserve original order

type SortFieldsOptions =
  | { type: "alphabetical" }  // Sort fields alphabetically
  | { type: "none" };         // Preserve original order
```

**定义组(按顺序排列):**

1.  根类型( 查询、 变异、 订阅)
2.  斯卡尔
3.  指令
4.  命名类型( 对象、 界面、 输入、 联盟、 Enum - 按字母排序)

### 指令定义

包包括一个 `directives.graphql` 文件位于 `dist/directives.graphql`。您可以将该文件链接到您的工程,或者根据需要将定义复制到您的计划:

```bash
ln -s node_modules/@graphql-schema-filter/core/dist/directives.graphql src/graphql/directives.graphql
```

## 指令

### `@expose(tags: [String!]!)`

标记字段为暴露于特定目标.

```graphql
directive @expose(
  tags: [String!]!
) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
```

### `@disableAutoExpose`

禁用某种类型的自动字段曝光( 如查询/ 混合等处理) .

```graphql
directive @disableAutoExpose on OBJECT | INTERFACE
```

## 文档

关于详细文件、实例和先进用途,请访问 [GitHub 仓库](https://github.com/whatasoda/graphql-schema-filter)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @graphql-schema-filter/core 是什么？

图QL 筛选库中包含 @ expose 指令支持的目标访问控制

### 如何安装 @graphql-schema-filter/core？

在项目目录运行 npm install @graphql-schema-filter/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（^16\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @graphql-schema-filter/core 支持 TypeScript 吗？

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

### @graphql-schema-filter/core 支持 ESM 还是 CommonJS？

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

### @graphql-schema-filter/core 可以商用吗？

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

### @graphql-schema-filter/core 的下载量有多少？

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

### @graphql-schema-filter/core 还在维护吗？

最新版本 0\.3\.0 发布于 2025/11/29（11 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2025/11/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

