kratos-client-wrapper

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

• OryIdentitiesModule: a module to interact with the Ory Kratos Identities API
• OryFrontendModule: a module to interact with the Ory Kratos Frontend API
• OryAuthenticationGuard: a guard to protect your routes based on the Ory Kratos session

Install

1npm install @getlarge/kratos-client-wrapper

Usage

Import the module in your app:

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

Inject the service in your provider:

1import { OryIdentitiesService } from '@getlarge/kratos-client-wrapper';
2import { Injectable } from '@nestjs/common';
3
4@Injectable()
5export class YourService {
6  constructor(private readonly oryIdentitiesService: OryIdentitiesService) {}
7}

Use the Guard to protect your routes:

1import { OryAuthenticationGuard } from '@getlarge/kratos-client-wrapper';
2import { Controller, Get, Logger, UseGuards } from '@nestjs/common';
3
4@Controller()
5export class YourController {
6  @UseGuards(
7    OryAuthenticationGuard({
8      postValidationHook: (ctx, session) => {
9        const req = ctx.switchToHttp().getRequest();
10        req.session = session;
11        req.user = session.identity;
12      },
13      isValidSession(session): boolean {
14        return !!session.active;
15      },
16      sessionTokenResolver: (ctx) =>
17        ctx
18          .switchToHttp()
19          .getRequest()
20          ?.headers?.authorization?.replace('Bearer ', ''),
21    })
22  )
23  @Get()
24  async get() {
25    return 'Hello World';
26  }
27}

Development

Building

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

Running unit tests

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