@logto/react-router 1.0.0

package/lib/useCases/handleSignOut/HandleSignOutController.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/useCases/handleSignOut/HandleSignOutController.spec.js

@@ -0,0 +1,16 @@
+import { createLogtoAdapter, sessionStorage } from '../../framework/mocks.js';
+import { HandleSignOutController } from './HandleSignOutController.js';
+import { makeHandleSignOutUseCase } from './HandleSignOutUseCase.js';
+describe('useCases:handleSignOut:HandleSignOutController', () => {
+    it('can be created', () => {
+        const useCase = makeHandleSignOutUseCase({
+            createLogtoAdapter,
+            sessionStorage,
+        });
+        const controller = HandleSignOutController.fromDto({
+            useCase,
+            redirectUri: '/',
+        });
+        expect(controller.constructor.name).toBe('HandleSignOutController');
+    });
+});

package/lib/useCases/handleSignOut/HandleSignOutError.d.ts

@@ -0,0 +1,8 @@
+export declare class HandleSignOutError extends Error {
+    private readonly properties;
+    static readonly becauseNoCookieHeaderPresent: () => HandleSignOutError;
+    readonly code: number;
+    readonly cause: Error | undefined;
+    readonly plainMessage: string;
+    private constructor();
+}

package/lib/useCases/handleSignOut/HandleSignOutError.js

@@ -0,0 +1,15 @@
+class HandleSignOutError extends Error {
+    static { this.becauseNoCookieHeaderPresent = () => new HandleSignOutError({
+        code: 1_665_388_713,
+        message: `The authentication sign-out route can't be accessed without a valid cookie.`,
+    }); }
+    constructor(properties) {
+        super(`#[${properties.code}] ${properties.message}`);
+        this.properties = properties;
+        this.code = this.properties.code;
+        this.cause = this.properties.cause;
+        this.plainMessage = this.properties.message;
+    }
+}
+
+export { HandleSignOutError };

package/lib/useCases/handleSignOut/HandleSignOutUseCase.d.ts

@@ -0,0 +1,16 @@
+import type { SessionStorage } from 'react-router';
+import type { CreateLogtoAdapter } from '../../infrastructure/logto/index.js';
+type SignOutRequest = {
+    readonly cookieHeader: string | undefined;
+    redirectUri: string;
+};
+type SignOutResponse = {
+    cookieHeader: string;
+    readonly navigateToUrl: string;
+};
+export declare const makeHandleSignOutUseCase: (deps: {
+    createLogtoAdapter: CreateLogtoAdapter;
+    sessionStorage: SessionStorage;
+}) => (request: SignOutRequest) => Promise<SignOutResponse>;
+export type HandleSignOutUseCase = ReturnType<typeof makeHandleSignOutUseCase>;
+export {};

package/lib/useCases/handleSignOut/HandleSignOutUseCase.js

@@ -0,0 +1,15 @@
+const makeHandleSignOutUseCase = (deps) => async (request) => {
+    const { sessionStorage, createLogtoAdapter } = deps;
+    const session = await sessionStorage.getSession(request.cookieHeader);
+    const logto = createLogtoAdapter(session);
+    const response = await logto.handleSignOut({
+        redirectUri: request.redirectUri,
+    });
+    const cookieHeader = await sessionStorage.destroySession(session);
+    return {
+        cookieHeader,
+        navigateToUrl: response.navigateToUrl,
+    };
+};
+
+export { makeHandleSignOutUseCase };

package/lib/useCases/handleSignOut/HandleSignOutUseCase.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/useCases/handleSignOut/HandleSignOutUseCase.spec.js

@@ -0,0 +1,18 @@
+import { createLogtoAdapter, sessionStorage, handleSignOut } from '../../framework/mocks.js';
+import { makeHandleSignOutUseCase } from './HandleSignOutUseCase.js';
+describe('useCases:handleSignOut:makeHandleSignOutUseCase', () => {
+    afterEach(() => {
+        vi.resetAllMocks();
+    });
+    it('can make a use case executer', async () => {
+        const execute = makeHandleSignOutUseCase({
+            createLogtoAdapter,
+            sessionStorage,
+        });
+        await execute({
+            cookieHeader: 'abcd',
+            redirectUri: '/',
+        });
+        expect(handleSignOut).toBeCalledTimes(1);
+    });
+});

package/lib/useCases/handleSignOut/index.d.ts

@@ -0,0 +1,11 @@
+import type { SessionStorage } from 'react-router';
+import type { CreateLogtoAdapter } from '../../infrastructure/logto/index.js';
+type HandleSignOutDto = {
+    readonly redirectBackTo: string;
+};
+type HandleSignOutDeps = {
+    readonly createLogtoAdapter: CreateLogtoAdapter;
+    readonly sessionStorage: SessionStorage;
+};
+export declare const makeHandleSignOut: (dto: HandleSignOutDto, deps: HandleSignOutDeps) => (request: Request) => Promise<Response>;
+export {};

package/lib/useCases/handleSignOut/index.js

@@ -0,0 +1,17 @@
+import { HandleSignOutController } from './HandleSignOutController.js';
+import { makeHandleSignOutUseCase } from './HandleSignOutUseCase.js';
+
+const makeHandleSignOut = (dto, deps) => async (request) => {
+    const { createLogtoAdapter, sessionStorage } = deps;
+    const useCase = makeHandleSignOutUseCase({
+        createLogtoAdapter,
+        sessionStorage,
+    });
+    const controller = HandleSignOutController.fromDto({
+        useCase,
+        redirectUri: dto.redirectBackTo,
+    });
+    return controller.execute(request);
+};
+
+export { makeHandleSignOut };

package/lib/useCases/handleSignUp/HandleSignUpController.d.ts

@@ -0,0 +1,14 @@
+import type { HandleSignUpUseCase } from './HandleSignUpUseCase.js';
+type HandleSignUpControllerDto = {
+    readonly redirectUri: string;
+    readonly useCase: HandleSignUpUseCase;
+};
+export declare class HandleSignUpController {
+    private readonly properties;
+    static readonly fromDto: (dto: HandleSignUpControllerDto) => HandleSignUpController;
+    private readonly useCase;
+    private readonly redirectUri;
+    private constructor();
+    readonly execute: (request: Request) => Promise<Response>;
+}
+export {};

package/lib/useCases/handleSignUp/HandleSignUpController.js

@@ -0,0 +1,29 @@
+import { redirect } from 'react-router';
+import { getCookieHeaderFromRequest } from '../../framework/get-cookie-header-from-request.js';
+
+class HandleSignUpController {
+    static { this.fromDto = (dto) => new HandleSignUpController({
+        useCase: dto.useCase,
+        redirectUri: dto.redirectUri,
+    }); }
+    constructor(properties) {
+        this.properties = properties;
+        this.useCase = this.properties.useCase;
+        this.redirectUri = this.properties.redirectUri;
+        this.execute = async (request) => {
+            const cookieHeader = getCookieHeaderFromRequest(request);
+            const { redirectUri } = this;
+            const result = await this.useCase({
+                cookieHeader: cookieHeader ?? undefined,
+                redirectUri,
+            });
+            return redirect(result.navigateToUrl, {
+                headers: {
+                    'Set-Cookie': result.cookieHeader,
+                },
+            });
+        };
+    }
+}
+
+export { HandleSignUpController };

package/lib/useCases/handleSignUp/HandleSignUpController.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/useCases/handleSignUp/HandleSignUpController.spec.js

@@ -0,0 +1,16 @@
+import { createLogtoAdapter, sessionStorage } from '../../framework/mocks.js';
+import { HandleSignUpController } from './HandleSignUpController.js';
+import { makeHandleSignUpUseCase } from './HandleSignUpUseCase.js';
+describe('useCases:handleSignUp:HandleSignUpController', () => {
+    it('can be created', () => {
+        const useCase = makeHandleSignUpUseCase({
+            createLogtoAdapter,
+            sessionStorage,
+        });
+        const controller = HandleSignUpController.fromDto({
+            useCase,
+            redirectUri: '/',
+        });
+        expect(controller.constructor.name).toBe('HandleSignUpController');
+    });
+});

package/lib/useCases/handleSignUp/HandleSignUpUseCase.d.ts

@@ -0,0 +1,16 @@
+import type { SessionStorage } from 'react-router';
+import type { CreateLogtoAdapter } from '../../infrastructure/logto/index.js';
+type SignUpRequest = {
+    readonly cookieHeader: string | undefined;
+    readonly redirectUri: string;
+};
+type SignUpResponse = {
+    readonly cookieHeader: string;
+    readonly navigateToUrl: string;
+};
+export declare const makeHandleSignUpUseCase: (deps: {
+    createLogtoAdapter: CreateLogtoAdapter;
+    sessionStorage: SessionStorage;
+}) => (request: SignUpRequest) => Promise<SignUpResponse>;
+export type HandleSignUpUseCase = ReturnType<typeof makeHandleSignUpUseCase>;
+export {};

package/lib/useCases/handleSignUp/HandleSignUpUseCase.js

@@ -0,0 +1,15 @@
+const makeHandleSignUpUseCase = (deps) => async (request) => {
+    const { sessionStorage, createLogtoAdapter } = deps;
+    const session = await sessionStorage.getSession(request.cookieHeader);
+    const logto = createLogtoAdapter(session);
+    const response = await logto.handleSignUp({
+        redirectUri: request.redirectUri,
+    });
+    const cookieHeader = await sessionStorage.commitSession(response.session);
+    return {
+        cookieHeader,
+        navigateToUrl: response.navigateToUrl,
+    };
+};
+
+export { makeHandleSignUpUseCase };

package/lib/useCases/handleSignUp/HandleSignUpUseCase.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/useCases/handleSignUp/HandleSignUpUseCase.spec.js

@@ -0,0 +1,18 @@
+import { createLogtoAdapter, sessionStorage, handleSignUp } from '../../framework/mocks.js';
+import { makeHandleSignUpUseCase } from './HandleSignUpUseCase.js';
+describe('useCases:handleSignUp:HandleSignUpUseCase', () => {
+    afterEach(() => {
+        vi.resetAllMocks();
+    });
+    it('can make a use case executer', async () => {
+        const execute = makeHandleSignUpUseCase({
+            createLogtoAdapter,
+            sessionStorage,
+        });
+        await execute({
+            cookieHeader: 'abcd',
+            redirectUri: '/',
+        });
+        expect(handleSignUp).toBeCalledTimes(1);
+    });
+});

package/lib/useCases/handleSignUp/index.d.ts

@@ -0,0 +1,11 @@
+import type { SessionStorage } from 'react-router';
+import type { CreateLogtoAdapter } from '../../infrastructure/logto/index.js';
+type HandleSignUpDto = {
+    readonly redirectBackTo: string;
+};
+type HandleSignUpDeps = {
+    readonly createLogtoAdapter: CreateLogtoAdapter;
+    readonly sessionStorage: SessionStorage;
+};
+export declare const makeHandleSignUp: (dto: HandleSignUpDto, deps: HandleSignUpDeps) => (request: Request) => Promise<Response>;
+export {};

package/lib/useCases/handleSignUp/index.js

@@ -0,0 +1,17 @@
+import { HandleSignUpController } from './HandleSignUpController.js';
+import { makeHandleSignUpUseCase } from './HandleSignUpUseCase.js';
+
+const makeHandleSignUp = (dto, deps) => async (request) => {
+    const { createLogtoAdapter, sessionStorage } = deps;
+    const useCase = makeHandleSignUpUseCase({
+        createLogtoAdapter,
+        sessionStorage,
+    });
+    const controller = HandleSignUpController.fromDto({
+        useCase,
+        redirectUri: dto.redirectBackTo,
+    });
+    return controller.execute(request);
+};
+
+export { makeHandleSignUp };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@logto/react-router",
+  "version": "1.0.0",
+  "type": "module",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    "types": "./lib/index.d.ts",
+    "import": "./lib/index.js",
+    "default": "./lib/index.js"
+  },
+  "files": [
+    "lib"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/logto-io/js.git",
+    "directory": "packages/react-router"
+  },
+  "dependencies": {
+    "@logto/node": "^3.1.6"
+  },
+  "devDependencies": {
+    "react-router": "^7.5.3",
+    "@silverhand/eslint-config": "^6.0.1",
+    "@silverhand/ts-config": "^6.0.0",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^2.1.9",
+    "eslint": "^8.57.0",
+    "lint-staged": "^15.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.3.3",
+    "vitest": "^2.1.9"
+  },
+  "peerDependencies": {
+    "react-router": ">=7"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand"
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "targets": {
+    "main": {
+      "context": "node",
+      "engines": {
+        "node": ">=18.12.0"
+      }
+    }
+  },
+  "scripts": {
+    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "precommit": "lint-staged",
+    "check": "tsc --noEmit",
+    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --declaration && rollup -c",
+    "lint": "eslint --ext .ts src",
+    "test": "vitest",
+    "test:coverage": "vitest --silent --coverage"
+  }
+}