keto-client-wrapper

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

1npm install @getlarge/keto-client-wrapper

Usage

Import the module in your app:

1import {
2  OryRelationshipsModule,
3  OryPermissionsModule,
4} from '@getlarge/keto-client-wrapper';
5import { Module } from '@nestjs/common';
6
7@Module({
8   imports: [
9    OryRelationshipsModule.forRoot({
10      basePath: 'http://localhost:4467',
11      accessToken: 'my-access-token',
12    }),
13    OryPermissionsModule.forRootAsync({
14      useFactory: () => ({
15        baseUrl: 'http://localhost:4466',
16      }),
17    }),
18  ],
19})
20

Inject the service in your provider:

1import { OryRelationshipsService } from '@getlarge/keto-client-wrapper';
2import { Injectable } from '@nestjs/common';
3
4@Injectable()
5export class YourService {
6  constructor(
7    private readonly oryRelationshipsService: OryRelationshipsService
8  ) {}
9}

Use the Guard to protect your routes:

1import {
2  OryAuthorizationGuard,
3  OryPermissionChecks,
4} from '@getlarge/keto-client-wrapper';
5import { RelationTupleBuilder } from '@getlarge/keto-relations-parser';
6import { Controller, Get, Logger, UseGuards } from '@nestjs/common';
7
8@Controller()
9export class YourController {
10  @OryPermissionChecks((ctx) => {
11    const req = ctx.switchToHttp().getRequest();
12    const currentUserId = req.headers['x-current-user-id'] as string;
13    const resourceId = req.params.id;
14    return new RelationTupleBuilder()
15      .subject('User', currentUserId)
16      .isIn('owners')
17      .of('Toy', resourceId)
18      .toString();
19  })
20  @UseGuards(
21    OryAuthorizationGuard({
22      postCheck(relationTuple, isPermitted) {
23        Logger.log('relationTuple', relationTuple);
24        Logger.log('isPermitted', isPermitted);
25      },
26    })
27  )
28  @Get()
29  getArticles() {
30    return 'Articles';
31  }
32}

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.