# @getlarge/keto-client-wrapper 中文文档

规范地址：https://npmcn.com/package/%40getlarge/keto-client-wrapper/

版本：0\.7\.0
npm 元数据更新时间：2025-05-05T14:52:03.792Z
中文译文更新时间：2026-11-16T06:18:11.450Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40getlarge/keto-client-wrapper
原文对照：https://npmcn.com/package/%40getlarge/keto-client-wrapper/?lang=original
项目主页：https://github.com/getlarge/nestjs-ory-integration/tree/main/packages/keto-client-wrapper

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

- 包体积（解压后）：94.1 kB，70 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：@nestjs/axios ^3 \|\| ^4，@nestjs/common ^10 \|\| ^11，@nestjs/core ^10 \|\| ^11，axios ^1\.6 \|\| ^1\.7，@ory/client ^1
- 首次发布：2024-01-13T19:27:05.619Z
- 最新版本发布：2025-05-05T14:52:03.599Z
- 近 30 天下载量：8232（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 0 个）

## 中文简介

网点JS Ory Keto API 模块包装器

## 安装

```sh
npm install @getlarge/keto-client-wrapper
```

也可以使用：`pnpm add @getlarge/keto-client-wrapper`、`yarn add @getlarge/keto-client-wrapper`、`bun add @getlarge/keto-client-wrapper`

## README

# keto- 客户端包装器

[![npm](https://img.shields.io/npm/v/@getlarge/keto-client-wrapper.svg?style=flat)](https://npmjs.org/package/@getlarge/keto-client-wrapper)

这个图书馆是一个包装 周围的 [奥里·克托](https://www.ory.sh/keto/docs/) 客户端 - [@ ory/ 客户](https://github.com/ory/client-js)它规定:

-   `OryRelationshipsModule`: 与 Ory Keto 关系 API 互动的模块
-   `OryPermissionsModule`: 与 Ory Keto 权限 API 交互的模块
-   `OryAuthorizationGuard`: 一个根据Ory Keto权限保护您路线的警卫

## 安装

```sh
npm install @getlarge/keto-client-wrapper
```

## 使用量

导入应用程序中的模块 :

```ts
import {
  OryRelationshipsModule,
  OryPermissionsModule,
} from '@getlarge/keto-client-wrapper';
import { Module } from '@nestjs/common';

@Module({
   imports: [
    OryRelationshipsModule.forRoot({
      basePath: 'http://localhost:4467',
      accessToken: 'my-access-token',
    }),
    OryPermissionsModule.forRootAsync({
      useFactory: () => ({
        baseUrl: 'http://localhost:4466',
      }),
    }),
  ],
})

```

在您的提供者中注入服务 :

```ts
import { OryRelationshipsService } from '@getlarge/keto-client-wrapper';
import { Injectable } from '@nestjs/common';

@Injectable()
export class YourService {
  constructor(
    private readonly oryRelationshipsService: OryRelationshipsService
  ) {}
}
```

利用警卫保护你的路线:

```ts
import {
  OryAuthorizationGuard,
  OryPermissionChecks,
} from '@getlarge/keto-client-wrapper';
import { RelationTupleBuilder } from '@getlarge/keto-relations-parser';
import { Controller, Get, Logger, UseGuards } from '@nestjs/common';

@Controller()
export class YourController {
  @OryPermissionChecks((ctx) => {
    const req = ctx.switchToHttp().getRequest();
    const currentUserId = req.headers['x-current-user-id'] as string;
    const resourceId = req.params.id;
    return new RelationTupleBuilder()
      .subject('User', currentUserId)
      .isIn('owners')
      .of('Toy', resourceId)
      .toString();
  })
  @UseGuards(
    OryAuthorizationGuard({
      postCheck(relationTuple, isPermitted) {
        Logger.log('relationTuple', relationTuple);
        Logger.log('isPermitted', isPermitted);
      },
    })
  )
  @Get()
  getArticles() {
    return 'Articles';
  }
}
```

## 发展

### 大楼

运行 `nx build keto-client-wrapper` 来建造图书馆.

### 运行单元测试

运行 `nx test keto-client-wrapper` 通过 [欢乐](https://jestjs.io/)。 。 。 .

## 常见问题

### @getlarge/keto-client-wrapper 是什么？

网点JS Ory Keto API 模块包装器

### 如何安装 @getlarge/keto-client-wrapper？

在项目目录运行 npm install @getlarge/keto-client-wrapper，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/axios（^3 \|\| ^4）、@nestjs/common（^10 \|\| ^11）、@nestjs/core（^10 \|\| ^11）、axios（^1\.6 \|\| ^1\.7）、@ory/client（^1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getlarge/keto-client-wrapper 支持 TypeScript 吗？

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

### @getlarge/keto-client-wrapper 支持 ESM 还是 CommonJS？

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

### @getlarge/keto-client-wrapper 可以商用吗？

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

### @getlarge/keto-client-wrapper 的下载量有多少？

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

### @getlarge/keto-client-wrapper 还在维护吗？

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

