@logto/sveltekit 0.2.10 → 0.3.1

package/lib/index.d.ts

@@ -1,7 +1,7 @@
-import LogtoClient, { type LogtoConfig, type CookieConfig } from '@logto/node';
+import LogtoClient, { type CookieConfig, type LogtoConfig, type PersistKey, type Storage } from '@logto/node';
 import { type Handle, type RequestEvent } from '@sveltejs/kit';
-export type { AccessTokenClaims, IdTokenClaims, LogtoErrorCode, LogtoConfig, LogtoClientErrorCode, Storage, StorageKey, InteractionMode, ClientAdapter, JwtVerifier, UserInfoResponse, CookieConfig, } from '@logto/node';
-export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, CookieStorage, StandardLogtoClient, default as LogtoClient, } from '@logto/node';
+export type { AccessTokenClaims, ClientAdapter, CookieConfig, IdTokenClaims, InteractionMode, JwtVerifier, LogtoClientErrorCode, LogtoConfig, LogtoErrorCode, Storage, StorageKey, UserInfoResponse, } from '@logto/node';
+export { CookieStorage, default as LogtoClient, LogtoClientError, LogtoError, LogtoRequestError, OidcError, PersistKey, Prompt, ReservedResource, ReservedScope, StandardLogtoClient, UserScope, buildOrganizationUrn, getOrganizationIdFromUrn, organizationUrnPrefix, } from '@logto/node';
 export type HookConfig = {
     /**
      * The error response factory when an error occurs during the callback. If not provided, a 400
@@ -10,6 +10,13 @@ export type HookConfig = {
      * @param error The error that occurred.
      */
     onCallbackError?: (error: unknown) => Response;
+    /**
+     * The error response factory when an error occurs during fetching user info or parsing the IdToken.
+     * If not provided, a 500 response will be returned.
+     *
+     * @param error
+     */
+    onGetUserInfoError?: (error: unknown) => Response;
     /**
      * The path to the callback handler. Default to `/callback`.
      */
@@ -23,6 +30,11 @@ export type HookConfig = {
      * created.
      */
     buildLogtoClient?: (event: RequestEvent) => LogtoClient;
+    /**
+     * The custom persistent storage instance parsed to the `LogtoClient`. It will be used to store the session and tokens.
+     * If not provided, a default `CookieStorage` instance will be created.
+     */
+    customStorage?: Storage<PersistKey>;
 };
 /**
  * The factory to create a SvelteKit hook to handle Logto authentication. The hook will
@@ -63,8 +75,8 @@ export type HookConfig = {
  * ```
  *
  * @param config The Logto configuration.
- * @param cookieConfig The configuration object for the cookie storage.
+ * @param cookieConfig The configuration object for the cookie storage. Required if no custom storage is provided.
  * @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;
+export declare const handleLogto: (config: LogtoConfig, cookieConfig?: Pick<CookieConfig, 'cookieKey' | 'encryptionKey'>, hookConfig?: HookConfig) => Handle;

package/lib/index.js

@@ -1,6 +1,6 @@
-import LogtoClient, { CookieStorage } from '@logto/node';
-import { redirect, isRedirect } from '@sveltejs/kit';
-export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, CookieStorage, StandardLogtoClient, default as LogtoClient, } from '@logto/node';
+import LogtoClient, { CookieStorage, } from '@logto/node';
+import { isRedirect, redirect } from '@sveltejs/kit';
+export { CookieStorage, default as LogtoClient, LogtoClientError, LogtoError, LogtoRequestError, OidcError, PersistKey, Prompt, ReservedResource, ReservedScope, StandardLogtoClient, UserScope, buildOrganizationUrn, getOrganizationIdFromUrn, organizationUrnPrefix, } 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
@@ -40,26 +40,20 @@ export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, Res
  * ```
  *
  * @param config The Logto configuration.
- * @param cookieConfig The configuration object for the cookie storage.
+ * @param cookieConfig The configuration object for the cookie storage. Required if no custom storage is provided.
  * @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 ?? {};
+    const { signInCallback = '/callback', onCallbackError, onGetUserInfoError, fetchUserInfo = false, buildLogtoClient, } = hookConfig ?? {};
+    // eslint-disable-next-line complexity
     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 storage = hookConfig?.customStorage ?? (await buildCookieStorageFromEvent(event, cookieConfig));
         const logtoClient = buildLogtoClient?.(event) ??
             new LogtoClient(config, {
                 navigate: (url) => {
@@ -78,19 +72,40 @@ export const handleLogto = (config, cookieConfig, hookConfig) => {
                     // eslint-disable-next-line @typescript-eslint/no-throw-literal -- SvelteKit's convention
                     throw error;
                 }
-                return (onCallbackError?.(error) ??
-                    new Response(`Error: ${error instanceof Error ? error.message : JSON.stringify(error, undefined, 2)}`, {
-                        status: 400,
-                    }));
+                return onCallbackError?.(error) ?? defaultErrorHandler(error, 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());
+            try {
+                // eslint-disable-next-line @silverhand/fp/no-mutation
+                event.locals.user = await (fetchUserInfo
+                    ? logtoClient.fetchUserInfo()
+                    : logtoClient.getIdTokenClaims());
+            }
+            catch (error) {
+                return onGetUserInfoError?.(error) ?? defaultErrorHandler(error);
+            }
         }
         return resolve(event);
     };
 };
+const defaultErrorHandler = (error, status = 500) => {
+    return new Response(`Error: ${error instanceof Error ? error.message : JSON.stringify(error, undefined, 2)}`, {
+        status,
+    });
+};
+const buildCookieStorageFromEvent = async (event, cookieConfig) => {
+    if (!cookieConfig) {
+        throw new Error('Missing cookie configuration for the CookieStorage.');
+    }
+    const storage = new CookieStorage({
+        setCookie: (...args) => {
+            event.cookies.set(...args);
+        },
+        getCookie: (...args) => event.cookies.get(...args),
+        ...cookieConfig,
+    }, event.request);
+    await storage.init();
+    return storage;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/sveltekit",
-  "version": "0.2.10",
+  "version": "0.3.1",
   "type": "module",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -46,7 +46,7 @@
     "@sveltejs/kit": "^2.0.0"
   },
   "dependencies": {
-    "@logto/node": "^2.5.1"
+    "@logto/node": "^2.5.2"
   },
   "scripts": {
     "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",