@getlarge/keto-client-wrapper

中文文档
0.7.0发布于 2025/05/05MITTypeScriptESM + CJS近 30 天下载 8232

NestJS Module wrapper for the Ory Keto API

原始使用文档
文档目录5 节
  1. Install
  2. Usage
  3. Development
  4. Building
  5. Running unit tests

keto-client-wrapper

npm

This library is a wrapper around the Ory Keto client - @ory/client. It provides :

  • OryRelationshipsModule: a module to interact with the Ory Keto Relationships API
  • OryPermissionsModule: a module to interact with the Ory Keto Permissions API
  • OryAuthorizationGuard: a guard to protect your routes based on the Ory Keto permissions

Install

npm install @getlarge/keto-client-wrapper

Usage

Import the module in your app:

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',
      }),
    }),
  ],
})

Inject the service in your provider:

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

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

Use the Guard to protect your routes:

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';
  }
}

Development

Building

Run nx build keto-client-wrapper to build the library.

Running unit tests

Run nx test keto-client-wrapper to execute the unit tests via Jest.

版本与发布记录

@getlarge/keto-client-wrapper 共发布 20 个版本,首次发布于 2024/01/14;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.7.0latest2025/05/051.5 年前
0.6.32025/03/251.6 年前
0.6.12025/02/021.8 年前
0.6.02025/02/011.8 年前
0.5.02024/11/122 年前
0.4.02024/11/072 年前

关于 @getlarge/keto-client-wrapper 的常见问题

@getlarge/keto-client-wrapper 是什么?

NestJS Module wrapper for the 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 和提交记录判断。