@logto/nuxt 1.2.5 → 1.2.7

package/dist/module.d.ts

@@ -0,0 +1,10 @@
+import { type NuxtModule } from 'nuxt/schema';
+import { type LogtoRuntimeConfigInput } from './runtime/utils/types';
+export * from '@logto/node';
+export { default as LogtoNodeClient } from '@logto/node';
+export * from './runtime/utils/types';
+export * from './runtime/utils/constants';
+export * from './runtime/utils/handler';
+declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
+export default logtoModule;
+//# sourceMappingURL=module.d.ts.map

package/dist/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,OAAO,EAA2B,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAG9F,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,aAAa,CAAC;AACzD,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AAExC,QAAA,MAAM,WAAW,EAAE,UAAU,CAAC,uBAAuB,CA0CnD,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@logto/nuxt",
   "configKey": "logto",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "builder": {
     "@nuxt/module-builder": "1.0.1",
     "unbuild": "unknown"

package/dist/runtime/composables/use-logto-client.d.ts

@@ -0,0 +1,21 @@
+import type LogtoClient from '@logto/node';
+/**
+ * Get the Logto client instance in the current context. Returns `undefined` if the client is not
+ * available.
+ *
+ * Note: This composable only works in the server side and relies on the SSR context which is
+ * filled by the Logto event handler.
+ *
+ * @returns The Logto client instance if available, otherwise `undefined`.
+ *
+ * @example
+ * ```ts
+ * const client = useLogtoClient();
+ *
+ * if (client) {
+ *   const token = await client.getAccessToken();
+ * }
+ * ```
+ */
+export default function useLogtoClient(): LogtoClient | undefined;
+//# sourceMappingURL=use-logto-client.d.ts.map

package/dist/runtime/composables/use-logto-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-logto-client.d.ts","sourceRoot":"","sources":["../../../src/runtime/composables/use-logto-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAE3C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,IAAI,WAAW,GAAG,SAAS,CAKhE"}

package/dist/runtime/composables/use-logto-user.d.ts

@@ -0,0 +1,21 @@
+import type { UserInfoResponse } from '@logto/node';
+/**
+ * Get the Logto user information. If the user is not signed in, this composable will return
+ * `undefined`.
+ *
+ * Note: This composable relies on the SSR context which is filled by the Logto event handler. Once
+ * the user is signed in, the user information will be available in both the server and client side.
+ *
+ * @returns The user information if the user is signed in, otherwise `undefined`.
+ *
+ * @example
+ * ```ts
+ * const user = useLogtoUser();
+ *
+ * if (user) {
+ *   console.log('User is signed in:', user); // { sub: '123', ... }
+ * }
+ * ```
+ */
+export default function useLogtoUser(): UserInfoResponse | undefined;
+//# sourceMappingURL=use-logto-user.d.ts.map

package/dist/runtime/composables/use-logto-user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-logto-user.d.ts","sourceRoot":"","sources":["../../../src/runtime/composables/use-logto-user.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAKpD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,iCAMnC"}

package/dist/runtime/server/event-handler.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
+export default _default;
+//# sourceMappingURL=event-handler.d.ts.map

package/dist/runtime/server/event-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-handler.d.ts","sourceRoot":"","sources":["../../../src/runtime/server/event-handler.ts"],"names":[],"mappings":";AAMA,wBAGG"}

package/dist/runtime/utils/constants.d.ts

@@ -0,0 +1,13 @@
+/** The keys used to store the Logto state in `useState()`. */
+export declare enum LogtoStateKey {
+    /** The key used to store the Logto user information. */
+    User = "logto.user"
+}
+/** The default Logto runtime configuration values that should be replaced with your own values. */
+export declare const defaults: Readonly<{
+    readonly endpoint: "<replace-with-logto-endpoint>";
+    readonly appId: "<replace-with-logto-app-id>";
+    readonly appSecret: "<replace-with-logto-app-secret>";
+    readonly cookieEncryptionKey: "<replace-with-random-string>";
+}>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/runtime/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/runtime/utils/constants.ts"],"names":[],"mappings":"AAEA,8DAA8D;AAC9D,oBAAY,aAAa;IACvB,wDAAwD;IACxD,IAAI,eAAe;CACpB;AAED,mGAAmG;AACnG,eAAO,MAAM,QAAQ;;;;;EAKwB,CAAC"}

package/dist/runtime/utils/handler.d.ts

@@ -0,0 +1,4 @@
+import { type H3Event } from 'h3';
+import type { RuntimeConfig } from 'nuxt/schema';
+export declare const logtoEventHandler: (event: H3Event, config: RuntimeConfig) => Promise<void>;
+//# sourceMappingURL=handler.d.ts.map

package/dist/runtime/utils/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../../src/runtime/utils/handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAqD,MAAM,IAAI,CAAC;AACrF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAKjD,eAAO,MAAM,iBAAiB,UAAiB,OAAO,UAAU,aAAa,kBAwF5E,CAAC"}

package/dist/runtime/utils/types.d.ts

@@ -0,0 +1,106 @@
+import type LogtoClient from '@logto/node';
+import type { LogtoConfig, SignInOptions, IdTokenClaims, UserInfoResponse } from '@logto/node';
+declare module 'h3' {
+    interface H3EventContext {
+        logtoUser: UserInfoResponse | IdTokenClaims | undefined;
+        logtoClient: LogtoClient;
+    }
+}
+type DeepPartial<T> = T extends Record<string, unknown> ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+type LogtoModuleOptions = {
+    /**
+     * The name to use when storing the Logto cookie.
+     *
+     * @see {@link CookieConfig.cookieKey} for the default value.
+     */
+    cookieName?: string;
+    /**
+     * Whether the Logto cookie should be secure.
+     *
+     * Set this to `true` if you are using https.
+     *
+     * @see {@link CookieConfig.isSecure}
+     */
+    cookieSecure?: boolean;
+    /**
+     * If Logto should fetch from the [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
+     * in the server side for the `event.context.logtoUser` property (used by `useLogtoUser` composable).
+     *
+     * This is useful when you need to fetch additional claims like `custom_data`.
+     */
+    fetchUserInfo: boolean;
+    /**
+     * The URI to redirect to after a successful sign-in callback.
+     *
+     * This is NOT the redirect URI used in Logto's configuration. This is the URI that the user will be
+     * redirected to after the sign-in callback is handled by the server.
+     *
+     * @default '/'
+     */
+    postCallbackRedirectUri: string;
+    /**
+     * The URI to redirect to after a successful sign-out.
+     *
+     * This is the post sign-out redirect URI used in Logto's configuration.
+     *
+     * @default '/'
+     */
+    postLogoutRedirectUri: string;
+    /**
+     * Pathnames for the sign-in, sign-out, and callback URIs. They will be handled by the Logto
+     * event handler.
+     */
+    pathnames: {
+        /**
+         * The URI for initiating the sign-in process.
+         *
+         * @default '/sign-in'
+         */
+        signIn: string;
+        /**
+         * The URI for initiating the sign-out process.
+         *
+         * @default '/sign-out'
+         */
+        signOut: string;
+        /**
+         * The URI for handling the sign-in callback.
+         *
+         * @default '/callback'
+         */
+        callback: string;
+    };
+    /**
+     * The options for the sign-in process.
+     *
+     * @see https://docs.logto.io/docs/references/openid-connect/authentication-parameters
+     */
+    signInOptions?: Omit<SignInOptions, 'redirectUri' | 'postRedirectUri'>;
+};
+/** The full runtime configuration for the Logto module. */
+export type LogtoRuntimeConfig = LogtoModuleOptions & {
+    /**
+     * The secret used to encrypt the Logto cookie. It should be a random string.
+     */
+    cookieEncryptionKey: string;
+    /**
+     * Custom base URL for redirects
+     *
+     * This URL is used as the base for generating redirect and callback URLs.
+     * It's particularly useful in environments where the application is behind
+     * a proxy or where URLs are rewritten.
+     *
+     * If set, this value will be used instead of the automatically detected URL.
+     * If not set, the system will use the URL obtained from `getRequestURL`.
+     *
+     * Example: 'https://your-public-facing-domain.com'
+     *
+     * Note: Provide only the base URL without paths or query parameters.
+     */
+    customRedirectBaseUrl: string;
+} & Omit<LogtoConfig, 'appSecret'> & Required<Pick<LogtoConfig, 'appSecret'>>;
+export type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/runtime/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/runtime/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/F,OAAO,QAAQ,IAAI,CAAC;IAElB,UAAU,cAAc;QACtB,SAAS,EAAE,gBAAgB,GAAG,aAAa,GAAG,SAAS,CAAC;QACxD,WAAW,EAAE,WAAW,CAAC;KAC1B;CACF;AAED,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnD;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,GACD,CAAC,CAAC;AAEN,KAAK,kBAAkB,GAAG;IACxB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;;;;OAMG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,SAAS,EAAE;QACT;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;;WAIG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,iBAAiB,CAAC,CAAC;CACxE,CAAC;AAEF,2DAA2D;AAC3D,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,GAAG;IACpD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GAChC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AAE3C,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC"}

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@logto/nuxt",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/module.d.mts",
       "import": "./dist/module.mjs"
     }
   },
+  "types": "./dist/module.d.mts",
   "files": [
     "dist"
   ],
@@ -24,7 +26,7 @@
     "@vue/test-utils": "^2.4.4",
     "eslint": "^8.57.0",
     "h3": "^1.13.0",
-    "happy-dom": "^16.0.0",
+    "happy-dom": "^20.0.8",
     "lint-staged": "^15.0.0",
     "nuxt": "^3.17.2",
     "prettier": "^3.0.0",
@@ -43,13 +45,13 @@
     "@nuxt/kit": "^3.17.2",
     "@silverhand/essentials": "^2.9.2",
     "defu": "^6.1.4",
-    "@logto/node": "^3.1.5"
+    "@logto/node": "^3.1.7"
   },
   "scripts": {
     "precommit": "lint-staged",
     "dev": "nuxi dev playground",
     "dev:prepare": "nuxt-module-build prepare && nuxi prepare playground",
-    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "build": "nuxt-module-build prepare && nuxt-module-build build && tsc -p tsconfig.build.json",
     "test": "vitest",
     "test:coverage": "vitest --coverage",
     "check": "tsc --noEmit",