# @gjermundgaraba/clankerauth-admin-api 中文文档

规范地址：https://npmcn.com/package/%40gjermundgaraba/clankerauth-admin-api/

版本：0\.35\.1
npm 元数据更新时间：2026-11-11T02:07:58.441Z
中文译文更新时间：2026-11-16T15:28:33.247Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gjermundgaraba/clankerauth-admin-api
原文对照：https://npmcn.com/package/%40gjermundgaraba/clankerauth-admin-api/?lang=original
源码仓库：https://github.com/gjermundgaraba/clankerauth

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

- 包体积（解压后）：76.8 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26\.13\.0
- 运行依赖：0 个
- peer 依赖：effect ~4\.1\.1，@gjermundgaraba/effect-actions ^0\.31\.0
- 首次发布：2026-10-16T20:29:28.608Z
- 最新版本发布：2026-11-11T02:07:58.124Z
- 近 30 天下载量：3444（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

Crankerauth管理合同:其效果行动、计划、错误和HTTP绑定,用于管理一个程序的发行人.

## 安装

```sh
npm install @gjermundgaraba/clankerauth-admin-api
```

也可以使用：`pnpm add @gjermundgaraba/clankerauth-admin-api`、`yarn add @gjermundgaraba/clankerauth-admin-api`、`bun add @gjermundgaraba/clankerauth-admin-api`

## README

# @gjermundgaraba/clankerauth-admin-api (英语)

A/ 管理合同 [科克劳斯](https://github.com/gjermundgaraba/clankerauth) 发行者:每个拥有者行为 [效果动作](https://www.npmjs.com/package/@gjermundgaraba/effect-actions) 动作,加上其输入和输出计划,其标记出错,以及HTTP绑定发行人为它们服务。 发行商、仪表板、MCP端点和 `clankerauth` CLI都来源于它,所以一个叫它的程序得到相同的动作,被打入,中间没有CLI.

其版本跟随发行商:使用与您拨打的发行商相匹配的版本.

## 安装

```sh
vp add @gjermundgaraba/clankerauth-admin-api effect @gjermundgaraba/effect-actions@^0.31.0
```

Effect 4.1, from 4.1.1, 效果行动是同行,与程序共享. 效应-动作0.31本身需要效应4.1.3或后4.1补丁.

## 从程序调用管理器

`OwnerHttp` 所送达的装订 `/api/owner/<action>`,由管理资源的所有者访问符、发行者的发端根或管理键认证: API 密钥 `clankerauth:read` 或者说 `clankerauth:write` 在资源。 店主的签名 `clankerauth login <issuer>` 保持给定符号 : `authorizing` 联 合 国 [`@gjermundgaraba/clankerauth-sdk/credentials`](https://npmcn.com/package/%40gjermundgaraba/sdk/README.md) 随每个请求一起发送, 到期后刷新, 方法失败 `SignInRequired` 当没有。 鉴于 `token`, (中文(简体) ), `authorizing` 发送环境所持有的,所以下面的程序运行时没有管理键 `CLANKERAUTH_TOKEN`变量 `clankerauth` 命令也读取,当未设定时则由所有者签名.

```ts
import { OwnerHttp } from "@gjermundgaraba/clankerauth-admin-api";
import * as Credentials from "@gjermundgaraba/clankerauth-sdk/credentials";
import * as ActionHttp from "@gjermundgaraba/effect-actions/ActionHttp";
import { Config, Effect } from "effect";
import { FetchHttpClient } from "effect/http";

const issuer = "https://clankerauth.home.example";

const program = Effect.gen(function* () {
  const admin = yield* ActionHttp.client(OwnerHttp, {
    baseUrl: issuer,
    transformClient: Credentials.authorizing({
      url: issuer,
      token: Config.Redacted("CLANKERAUTH_TOKEN"),
    }),
  });

  const { created } = yield* admin.putResource({
    identifier: "https://notes.home.example/",
    name: "Notes",
    scopes: ["notes:read", "notes:write"],
  });

  return created;
}).pipe(Effect.provide(FetchHttpClient.layer));
```

拒绝失败时出现标记错误, 如 `ResourceNotFound` 从 `getResource` 或者说 `deleteResource`每一个动作都宣布它们能产生什么. `getResource` 读取一个资源, `putResource` 创建或更新一个到给出的确切名称和范围,所以一个部署工具会说明它想要的东西,而不在创建和更新之间作出选择,以及 `deleteResource` 移除一个.

拥有者用 `clankerauth create-api-key --name deployer --permissions '{"https://clankerauth.home.example/":["clankerauth:read","clankerauth:write"]}' --expires-at null`,或者在仪表板。 它可以做什么,当它的改变适用 [发行人的读取器](https://npmcn.com/package/README.md#administer-unattended-with-an-api-key)。 。 。 .

麻省理工学院有执照.

## 常见问题

### @gjermundgaraba/clankerauth-admin-api 是什么？

Crankerauth管理合同:其效果行动、计划、错误和HTTP绑定,用于管理一个程序的发行人\.

### 如何安装 @gjermundgaraba/clankerauth-admin-api？

在项目目录运行 npm install @gjermundgaraba/clankerauth-admin-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（~4\.1\.1）、@gjermundgaraba/effect-actions（^0\.31\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gjermundgaraba/clankerauth-admin-api 支持 TypeScript 吗？

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

### @gjermundgaraba/clankerauth-admin-api 支持 ESM 还是 CommonJS？

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

### @gjermundgaraba/clankerauth-admin-api 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=26\.13\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gjermundgaraba/clankerauth-admin-api 可以商用吗？

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

### @gjermundgaraba/clankerauth-admin-api 的下载量有多少？

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

### @gjermundgaraba/clankerauth-admin-api 还在维护吗？

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

