@logto/nuxt 1.0.0 → 1.1.4

package/dist/module.d.mts

@@ -1,113 +1,10 @@
 import { NuxtModule } from 'nuxt/schema';
-import { LogtoConfig } from '@logto/node';
+import { LogtoRuntimeConfigInput } from '../dist/runtime/utils/types.js';
+export * from '../dist/runtime/utils/types.js';
 export * from '@logto/node';
 export { default as LogtoNodeClient } from '@logto/node';
-
-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 full runtime configuration for the Logto module. */
-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'>>;
-type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
-
-/** The keys used to store the Logto state in `useState()`. */
-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. */
-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>";
-    readonly customRedirectBaseUrl: "<replace-with-custom-redirect-base-url>";
-}>;
+export * from '../dist/runtime/utils/constants.js';
 
 declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
 
-export { type LogtoRuntimeConfig, type LogtoRuntimeConfigInput, LogtoStateKey, logtoModule as default, defaults };
+export { logtoModule as default };

package/dist/module.d.ts

@@ -1,113 +1,10 @@
 import { NuxtModule } from 'nuxt/schema';
-import { LogtoConfig } from '@logto/node';
+import { LogtoRuntimeConfigInput } from '../dist/runtime/utils/types.js';
+export * from '../dist/runtime/utils/types.js';
 export * from '@logto/node';
 export { default as LogtoNodeClient } from '@logto/node';
-
-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 full runtime configuration for the Logto module. */
-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'>>;
-type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
-
-/** The keys used to store the Logto state in `useState()`. */
-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. */
-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>";
-    readonly customRedirectBaseUrl: "<replace-with-custom-redirect-base-url>";
-}>;
+export * from '../dist/runtime/utils/constants.js';
 
 declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
 
-export { type LogtoRuntimeConfig, type LogtoRuntimeConfigInput, LogtoStateKey, logtoModule as default, defaults };
+export { logtoModule as default };

package/dist/module.json

@@ -1,5 +1,9 @@
 {
   "name": "@logto/nuxt",
   "configKey": "logto",
-  "version": "1.0.0"
+  "version": "1.1.4",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "unknown"
+  }
 }

package/dist/module.mjs

@@ -1,19 +1,10 @@
 import { defineNuxtModule, createResolver, addServerHandler, addImportsDir } from '@nuxt/kit';
 import { defu } from 'defu';
+import { defaults } from '../dist/runtime/utils/constants.js';
+export * from '../dist/runtime/utils/constants.js';
 export * from '@logto/node';
 export { default as LogtoNodeClient } from '@logto/node';
-
-var LogtoStateKey = /* @__PURE__ */ ((LogtoStateKey2) => {
-  LogtoStateKey2["User"] = "logto.user";
-  return LogtoStateKey2;
-})(LogtoStateKey || {});
-const defaults = Object.freeze({
-  endpoint: "<replace-with-logto-endpoint>",
-  appId: "<replace-with-logto-app-id>",
-  appSecret: "<replace-with-logto-app-secret>",
-  cookieEncryptionKey: "<replace-with-random-string>",
-  customRedirectBaseUrl: "<replace-with-custom-redirect-base-url>"
-});
+export * from '../dist/runtime/utils/types.js';
 
 const logtoModule = defineNuxtModule({
   meta: {
@@ -45,4 +36,4 @@ const logtoModule = defineNuxtModule({
   }
 });
 
-export { LogtoStateKey, logtoModule as default, defaults };
+export { logtoModule as default };

package/dist/runtime/composables/{use-logto-user.mjs → use-logto-user.js}

@@ -1,4 +1,4 @@
-import { LogtoStateKey } from "../utils/constants.mjs";
+import { LogtoStateKey } from "../utils/constants.js";
 import { shallowRef as shallowReference, useNuxtApp, useState } from "#imports";
 export default function useLogtoUser() {
   const nuxtApp = useNuxtApp();

package/dist/runtime/server/{event-handler.mjs → event-handler.js}

@@ -1,7 +1,7 @@
 import LogtoClient, { CookieStorage } from "@logto/node";
 import { trySafe } from "@silverhand/essentials";
 import { defineEventHandler, getRequestURL, getCookie, setCookie, sendRedirect } from "h3";
-import { defaults } from "../utils/constants.mjs";
+import { defaults } from "../utils/constants.js";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
   const config = useRuntimeConfig(event);
@@ -15,6 +15,7 @@ export default defineEventHandler(async (event) => {
     postCallbackRedirectUri,
     postLogoutRedirectUri,
     customRedirectBaseUrl,
+    signInOptions,
     ...clientConfig
   } = logtoConfig;
   const defaultValueKeys = Object.entries(defaults).filter(([key, value]) => logtoConfig[key] === value).map(([key]) => key);
@@ -44,7 +45,10 @@ export default defineEventHandler(async (event) => {
     storage
   });
   if (url.pathname === pathnames.signIn) {
-    await logto.signIn(new URL(pathnames.callback, url).href);
+    await logto.signIn({
+      ...signInOptions,
+      redirectUri: new URL(pathnames.callback, url).href
+    });
     return;
   }
   if (url.pathname === pathnames.signOut) {

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

@@ -9,5 +9,4 @@ export declare const defaults: Readonly<{
     readonly appId: "<replace-with-logto-app-id>";
     readonly appSecret: "<replace-with-logto-app-secret>";
     readonly cookieEncryptionKey: "<replace-with-random-string>";
-    readonly customRedirectBaseUrl: "<replace-with-custom-redirect-base-url>";
 }>;

package/dist/runtime/utils/{constants.mjs → constants.js}

@@ -6,6 +6,5 @@ export const defaults = Object.freeze({
   endpoint: "<replace-with-logto-endpoint>",
   appId: "<replace-with-logto-app-id>",
   appSecret: "<replace-with-logto-app-secret>",
-  cookieEncryptionKey: "<replace-with-random-string>",
-  customRedirectBaseUrl: "<replace-with-custom-redirect-base-url>"
+  cookieEncryptionKey: "<replace-with-random-string>"
 });

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

@@ -1,4 +1,4 @@
-import type { LogtoConfig } from '@logto/node';
+import type { LogtoConfig, SignInOptions } from '@logto/node';
 type DeepPartial<T> = T extends Record<string, unknown> ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
@@ -65,6 +65,12 @@ type LogtoModuleOptions = {
          */
         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 & {

package/dist/types.d.mts

@@ -1,25 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
 
-import type { ModuleOptions, ModuleHooks, RuntimeModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.js'
+import type { default as Module } from './module.js'
 
-declare module '#app' {
-  interface RuntimeNuxtHooks extends RuntimeModuleHooks, ModuleRuntimeHooks {}
-}
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['logto']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['logto']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['logto']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['logto']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-
-export type { LogtoNodeClient } from './module.js'
+export { type LogtoNodeClient } from './module.js'

package/dist/types.d.ts

@@ -1,25 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
 
-import type { ModuleOptions, ModuleHooks, RuntimeModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module'
+import type { default as Module } from './module'
 
-declare module '#app' {
-  interface RuntimeNuxtHooks extends RuntimeModuleHooks, ModuleRuntimeHooks {}
-}
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['logto']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['logto']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['logto']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['logto']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-
-export type { LogtoNodeClient } from './module'
+export { type LogtoNodeClient } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/nuxt",
-  "version": "1.0.0",
+  "version": "1.1.4",
   "type": "module",
   "exports": {
     ".": {
@@ -19,16 +19,16 @@
     "directory": "packages/nuxt"
   },
   "devDependencies": {
-    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/module-builder": "^0.8.0",
     "@nuxt/test-utils": "^3.12.1",
     "@silverhand/eslint-config": "^6.0.1",
     "@vitest/coverage-v8": "^1.6.0",
     "@vue/test-utils": "^2.4.4",
     "eslint": "^8.57.0",
     "h3": "^1.11.1",
-    "happy-dom": "^14.0.0",
+    "happy-dom": "^15.10.2",
     "lint-staged": "^15.0.0",
-    "nuxt": "^3.11.2",
+    "nuxt": "^3.12.4",
     "prettier": "^3.0.0",
     "typescript": "^5.3.3",
     "vitest": "^1.6.0",
@@ -43,9 +43,9 @@
   },
   "dependencies": {
     "@nuxt/kit": "^3.10.2",
-    "@silverhand/essentials": "^2.8.7",
+    "@silverhand/essentials": "^2.9.2",
     "defu": "^6.1.4",
-    "@logto/node": "^2.5.7"
+    "@logto/node": "^3.0.3"
   },
   "scripts": {
     "precommit": "lint-staged",