@logto/sveltekit 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Silverhand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# Logto SvelteKit SDK
+
+[![Version](https://img.shields.io/npm/v/@logto/sveltekit)](https://www.npmjs.com/package/@logto/sveltekit)
+[![Build Status](https://github.com/logto-io/js/actions/workflows/main.yml/badge.svg)](https://github.com/logto-io/js/actions/workflows/main.yml)
+
+The Logto SvelteKit SDK written in TypeScript. Requires SvelteKit ^2.0.0.
+
+Check out our [docs](https://docs.logto.io/sdk/sveltekit/) for more information.
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @logto/sveltekit
+```
+
+### Using yarn
+
+```bash
+yarn add @logto/sveltekit
+```
+
+### Using pnpm
+
+```bash
+pnpm add @logto/sveltekit
+```
+
+## Get sample
+
+A sample project can be found at [SvelteKit sample](https://github.com/logto-io/js/tree/master/packages/sveltekit-sample)
+
+Check out the full JS repo and try it with pnpm.
+
+```bash
+pnpm i && pnpm build
+cd packages/sveltekit-sample && pnpm start
+```
+
+## Resources
+
+[![Website](https://img.shields.io/badge/website-logto.io-8262F8.svg)](https://logto.io/)
+[![Docs](https://img.shields.io/badge/docs-logto.io-green.svg)](https://docs.logto.io/)
+[![Discord](https://img.shields.io/discord/965845662535147551?logo=discord&logoColor=ffffff&color=7389D8&cacheSeconds=600)](https://discord.gg/UEPaF3j5e6)

package/lib/__mocks__/@sveltejs/kit.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="jest" />
+export declare const redirect: jest.Mock<any, any, any>;

package/lib/__mocks__/@sveltejs/kit.js

@@ -0,0 +1 @@
+export const redirect = jest.fn();

package/lib/index.d.ts

@@ -0,0 +1,70 @@
+import LogtoClient, { type LogtoConfig, type CookieConfig } from '@logto/node';
+import { type Handle, type RequestEvent } from '@sveltejs/kit';
+export type { IdTokenClaims, LogtoErrorCode, LogtoConfig, LogtoClientErrorCode, Storage, StorageKey, InteractionMode, ClientAdapter, JwtVerifier, UserInfoResponse, } from '@logto/node';
+export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, StandardLogtoClient, default as LogtoClient, } from '@logto/node';
+export type HookConfig = {
+    /**
+     * The error response factory when an error occurs during the callback. If not provided, a 400
+     * response will be returned.
+     *
+     * @param error The error that occurred.
+     */
+    onCallbackError?: (error: unknown) => Response;
+    /**
+     * The path to the callback handler. Default to `/callback`.
+     */
+    signInCallback?: string;
+    /**
+     * Whether to fetch user info via OIDC userinfo endpoint. Default to `false`.
+     */
+    fetchUserInfo?: boolean;
+    /**
+     * The factory to build the `LogtoClient` instance. If not provided, a default instance will be
+     * created.
+     */
+    buildLogtoClient?: (event: RequestEvent) => LogtoClient;
+};
+/**
+ * The factory to create a SvelteKit hook to handle Logto authentication. The hook will
+ * initialize the `LogtoClient` instance and add it to the `locals` of the request event. It will
+ * also handle the callback from the OIDC provider and fetch user info if necessary.
+ *
+ * @example
+ * Here is a minimal example of how to use this hook:
+ * ```ts
+ * // src/hooks.server.ts
+ * import { handleLogto } from '@logto/sveltekit';
+ * import { env } from '$env/dynamic/private';
+ *
+ * export const handle = handleLogto(
+ *   {
+ *     endpoint: env.LOGTO_ENDPOINT,
+ *     appId: env.LOGTO_APP_ID,
+ *     appSecret: env.LOGTO_APP_SECRET,
+ *   },
+ *   {
+ *     encryptionKey: env.LOGTO_COOKIE_ENCRYPTION_KEY,
+ *   }
+ * );
+ * // Then you can use the `logtoClient` and `user` in `locals` of the request event.
+ *
+ * // For TypeScript, you can extend the `Locals` interface to add the `logtoClient` and `user` properties:
+ * // app.d.ts
+ * import type { UserInfoResponse, LogtoClient } from '@logto/sveltekit';
+ *
+ * declare global {
+ *   namespace App {
+ *     interface Locals {
+ *       logtoClient: LogtoClient;
+ *       user?: UserInfoResponse;
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param config The Logto configuration.
+ * @param cookieConfig The configuration object for the cookie storage.
+ * @param hookConfig The configuration object for the hook itself.
+ * @returns The SvelteKit hook.
+ */
+export declare const handleLogto: (config: LogtoConfig, cookieConfig: Pick<CookieConfig, 'cookieKey' | 'encryptionKey'>, hookConfig?: HookConfig) => Handle;

package/lib/index.js

@@ -0,0 +1,92 @@
+import LogtoClient, { CookieStorage } from '@logto/node';
+import { redirect } from '@sveltejs/kit';
+export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, StandardLogtoClient, default as LogtoClient, } from '@logto/node';
+/**
+ * The factory to create a SvelteKit hook to handle Logto authentication. The hook will
+ * initialize the `LogtoClient` instance and add it to the `locals` of the request event. It will
+ * also handle the callback from the OIDC provider and fetch user info if necessary.
+ *
+ * @example
+ * Here is a minimal example of how to use this hook:
+ * ```ts
+ * // src/hooks.server.ts
+ * import { handleLogto } from '@logto/sveltekit';
+ * import { env } from '$env/dynamic/private';
+ *
+ * export const handle = handleLogto(
+ *   {
+ *     endpoint: env.LOGTO_ENDPOINT,
+ *     appId: env.LOGTO_APP_ID,
+ *     appSecret: env.LOGTO_APP_SECRET,
+ *   },
+ *   {
+ *     encryptionKey: env.LOGTO_COOKIE_ENCRYPTION_KEY,
+ *   }
+ * );
+ * // Then you can use the `logtoClient` and `user` in `locals` of the request event.
+ *
+ * // For TypeScript, you can extend the `Locals` interface to add the `logtoClient` and `user` properties:
+ * // app.d.ts
+ * import type { UserInfoResponse, LogtoClient } from '@logto/sveltekit';
+ *
+ * declare global {
+ *   namespace App {
+ *     interface Locals {
+ *       logtoClient: LogtoClient;
+ *       user?: UserInfoResponse;
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param config The Logto configuration.
+ * @param cookieConfig The configuration object for the cookie storage.
+ * @param hookConfig The configuration object for the hook itself.
+ * @returns The SvelteKit hook.
+ */
+export const handleLogto = (config, cookieConfig, hookConfig) => {
+    const { signInCallback = '/callback', onCallbackError, fetchUserInfo = false, buildLogtoClient, } = hookConfig ?? {};
+    return async ({ resolve, event }) => {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- sanity check
+        if (event.locals.logtoClient) {
+            console.warn('`logtoClient` already exists in `locals`, you probably have added the `handleLogto` hook more than once. Skipping.');
+            return resolve(event);
+        }
+        const storage = new CookieStorage({
+            setCookie: (...args) => {
+                event.cookies.set(...args);
+            },
+            getCookie: (...args) => event.cookies.get(...args),
+            ...cookieConfig,
+        }, event.request);
+        await storage.init();
+        const logtoClient = buildLogtoClient?.(event) ??
+            new LogtoClient(config, {
+                navigate: (url) => {
+                    redirect(302, url);
+                },
+                storage,
+            });
+        // eslint-disable-next-line @silverhand/fp/no-mutation -- for init
+        event.locals.logtoClient = logtoClient;
+        if (event.url.pathname === signInCallback) {
+            try {
+                await logtoClient.handleSignInCallback(event.url.href);
+            }
+            catch (error) {
+                return (onCallbackError?.(error) ??
+                    new Response(`Error: ${error instanceof Error ? error.message : String(error)}`, {
+                        status: 400,
+                    }));
+            }
+            return redirect(302, '/');
+        }
+        if (await logtoClient.isAuthenticated()) {
+            // eslint-disable-next-line @silverhand/fp/no-mutation
+            event.locals.user = await (fetchUserInfo
+                ? logtoClient.fetchUserInfo()
+                : logtoClient.getIdTokenClaims());
+        }
+        return resolve(event);
+    };
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@logto/sveltekit",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    "types": "./lib/index.d.ts",
+    "import": "./lib/index.js",
+    "require": "./lib/index.js",
+    "default": "./lib/index.js"
+  },
+  "files": [
+    "lib"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/logto-io/js.git",
+    "directory": "packages/sveltekit"
+  },
+  "devDependencies": {
+    "@silverhand/eslint-config": "^5.0.0",
+    "@silverhand/ts-config": "^5.0.0",
+    "@sveltejs/kit": "^2.0.0",
+    "@swc/core": "^1.4.2",
+    "@swc/jest": "^0.2.24",
+    "@types/cookie": "^0.6.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
+    "eslint": "^8.44.0",
+    "jest": "^29.5.0",
+    "lint-staged": "^15.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.3.3"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand"
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@sveltejs/kit": "^2.0.0"
+  },
+  "dependencies": {
+    "@logto/node": "^2.4.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",
+    "lint": "eslint --ext .ts src",
+    "test": "jest"
+  }
+}