@executor-js/plugin-graphql

中文文档
1.6.11发布于 2026/10/23MITTypeScriptES Module构建来源已验证近 30 天下载 39.2万

Introspect a GraphQL endpoint and expose its queries and mutations as invokable tools on an executor.

原始使用文档
文档目录6 节
  1. Install
  2. Usage
  3. Secret-backed auth
  4. Using with Effect
  5. Status
  6. License

@executor-js/plugin-graphql

Introspect a GraphQL endpoint and expose its queries and mutations as invokable tools on an executor.

Install

bun add @executor-js/sdk @executor-js/plugin-graphql
# or
npm install @executor-js/sdk @executor-js/plugin-graphql

Usage

import { createExecutor } from "@executor-js/sdk";
import { graphqlPlugin } from "@executor-js/plugin-graphql";

const executor = await createExecutor({
  onElicitation: "accept-all",
  plugins: [graphqlPlugin()] as const,
});

// Public endpoint — no auth
await executor.graphql.addIntegration({
  scope: executor.scopes[0]!.id,
  endpoint: "https://graphql.anilist.co",
  namespace: "anilist",
});

const tools = await executor.tools.list();
const result = await executor.tools.invoke("anilist.Media", {
  search: "Frieren",
});

Secret-backed auth

import { createExecutor } from "@executor-js/sdk";
import { graphqlPlugin } from "@executor-js/plugin-graphql";
import { fileSecretsPlugin } from "@executor-js/plugin-file-secrets";

const executor = await createExecutor({
  onElicitation: "accept-all",
  plugins: [fileSecretsPlugin(), graphqlPlugin()] as const,
});

const scope = executor.scopes[0]!.id;

await executor.secrets.set({
  id: "github-token",
  name: "GitHub Token",
  value: "ghp_...",
  scope,
});

await executor.graphql.addIntegration({
  scope,
  endpoint: "https://api.github.com/graphql",
  namespace: "github",
  headers: {
    Authorization: { secretId: "github-token", prefix: "Bearer " },
  },
});

Using with Effect

If you're building on @executor-js/sdk/core (the raw Effect entry), import this plugin from its /core subpath instead — it returns the Effect-shaped plugin with Effect.Effect<...>-returning methods rather than promisified wrappers:

import { graphqlPlugin } from "@executor-js/plugin-graphql/core";

Status

Pre-1.0. APIs may still change between beta releases. Part of the executor monorepo.

License

MIT

版本与发布记录

@executor-js/plugin-graphql 共发布 80 个版本,首次发布于 2026/04/10;过去 12 个月发布了 80 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.6.11latest2026/10/2322 天前
1.6.102026/09/191 个月前
1.6.92026/09/181 个月前
1.6.82026/09/062 个月前
1.6.72026/08/302 个月前
1.6.62026/08/302 个月前

其他发布通道:beta → 0.0.1-beta.6。

关于 @executor-js/plugin-graphql 的常见问题

@executor-js/plugin-graphql 是什么?

Introspect a GraphQL endpoint and expose its queries and mutations as invokable tools on an executor.

如何安装 @executor-js/plugin-graphql?

在项目目录运行 npm install @executor-js/plugin-graphql,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:effect(4.0.0-beta.59)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@executor-js/plugin-graphql 支持 TypeScript 吗?

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

@executor-js/plugin-graphql 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@executor-js/plugin-graphql 可以商用吗?

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

@executor-js/plugin-graphql 的下载量有多少?

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

@executor-js/plugin-graphql 还在维护吗?

最新版本 1.6.11 发布于 2026/10/23(22 天前);至今共发布 80 个版本,其中过去 12 个月发布了 80 个;首次发布于 2026/04/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。