@logto/nuxt 0.0.0 → 0.1.1

package/README.md

@@ -37,6 +37,15 @@ Check out the full JS repo and try it with pnpm.
 pnpm i && pnpm dev
 ```
 
+The minimal configuration to run the playground is (use `.env` file for example):
+
+```env
+NUXT_LOGTO_ENDPOINT=<your-logto-endpoint>
+NUXT_LOGTO_APP_ID=<your-logto-app-id>
+NUXT_LOGTO_APP_SECRET=<your-logto-app-secret>
+NUXT_LOGTO_COOKIE_ENCRYPTION_KEY=<random-string>
+```
+
 ## Resources
 
 [![Website](https://img.shields.io/badge/website-logto.io-8262F8.svg)](https://logto.io/)

package/dist/module.d.mts

@@ -15,24 +15,75 @@ type LogtoModuleOptions = {
     cookieName?: string;
     /**
      * If Logto should fetch from the [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
-     * when the user is signed in. This is useful when you need to fetch additional claims like `custom_data`.
+     * 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;
-} & Omit<LogtoConfig, 'appSecret'> & {
-    appSecret: NonNullable<LogtoConfig['appSecret']>;
-};
+} & 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>";
+}>;
+
 declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
 
-export { logtoModule as default };
+export { type LogtoRuntimeConfig, type LogtoRuntimeConfigInput, LogtoStateKey, logtoModule as default, defaults };

package/dist/module.d.ts

@@ -15,24 +15,75 @@ type LogtoModuleOptions = {
     cookieName?: string;
     /**
      * If Logto should fetch from the [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
-     * when the user is signed in. This is useful when you need to fetch additional claims like `custom_data`.
+     * 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;
-} & Omit<LogtoConfig, 'appSecret'> & {
-    appSecret: NonNullable<LogtoConfig['appSecret']>;
-};
+} & 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>";
+}>;
+
 declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
 
-export { logtoModule as default };
+export { type LogtoRuntimeConfig, type LogtoRuntimeConfigInput, LogtoStateKey, logtoModule as default, defaults };

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "@logto/nuxt",
   "configKey": "logto",
-  "version": "0.0.0"
+  "version": "0.1.1"
 }

package/dist/module.mjs

@@ -3,6 +3,10 @@ import { defu } from 'defu';
 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>",
@@ -40,4 +44,4 @@ const logtoModule = defineNuxtModule({
   }
 });
 
-export { logtoModule as default };
+export { LogtoStateKey, logtoModule as default, defaults };

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

@@ -1,2 +1,20 @@
-import LogtoClient from '@logto/node';
+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;

package/dist/runtime/composables/use-logto-client.mjs

@@ -1,7 +1,6 @@
-import LogtoClient from "@logto/node";
 import { useNuxtApp } from "#app";
 export default function useLogtoClient() {
   const nuxtApp = useNuxtApp();
   const client = nuxtApp.ssrContext?.event.context.logtoClient;
-  return client instanceof LogtoClient ? client : void 0;
+  return client;
 }

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

@@ -1 +1,19 @@
+/**
+ * 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(): any;

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

@@ -1,2 +1,2 @@
-declare const _default: any;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 export default _default;

package/dist/runtime/server/event-handler.mjs

@@ -1,4 +1,5 @@
 import LogtoClient, { CookieStorage } from "@logto/node";
+import { defineEventHandler } from "h3";
 import { defaults } from "../utils/constants.mjs";
 export default defineEventHandler(async (event) => {
   const config = useRuntimeConfig(event);

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

@@ -1,6 +1,9 @@
+/** 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>";

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

@@ -1,5 +1,5 @@
 import type { LogtoConfig } from '@logto/node';
-export type DeepPartial<T> = T extends Record<string, unknown> ? {
+type DeepPartial<T> = T extends Record<string, unknown> ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 type LogtoModuleOptions = {
@@ -11,21 +11,59 @@ type LogtoModuleOptions = {
     cookieName?: string;
     /**
      * If Logto should fetch from the [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
-     * when the user is signed in. This is useful when you need to fetch additional claims like `custom_data`.
+     * 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. */
 export type LogtoRuntimeConfig = LogtoModuleOptions & {
+    /**
+     * The secret used to encrypt the Logto cookie. It should be a random string.
+     */
     cookieEncryptionKey: string;
-} & Omit<LogtoConfig, 'appSecret'> & {
-    appSecret: NonNullable<LogtoConfig['appSecret']>;
-};
+} & Omit<LogtoConfig, 'appSecret'> & Required<Pick<LogtoConfig, 'appSecret'>>;
 export type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/nuxt",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "type": "module",
   "exports": {
     ".": {
@@ -22,13 +22,17 @@
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/test-utils": "^3.11.0",
     "@silverhand/eslint-config": "^5.0.0",
+    "@vue/test-utils": "^2.4.4",
     "eslint": "^8.56.0",
     "h3": "^1.10.2",
+    "happy-dom": "^13.4.1",
     "lint-staged": "^15.0.0",
     "nuxt": "^3.10.2",
     "prettier": "^3.0.0",
     "typescript": "^5.3.3",
+    "vitest": "^1.3.1",
     "vue": "^3.4.19"
   },
   "eslintConfig": {
@@ -48,6 +52,7 @@
     "dev": "nuxi dev playground",
     "dev:prepare": "nuxt-module-build prepare && nuxi prepare playground",
     "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "test": "vitest",
     "check": "tsc --noEmit",
     "lint": "eslint --ext .ts src"
   }