@logto/nuxt 0.0.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,44 @@
+# Logto Nuxt 3 SDK
+
+[![Version](https://img.shields.io/npm/v/@logto/nuxt)](https://www.npmjs.com/package/@logto/nuxt)
+[![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 Nuxt 3 SDK written in TypeScript.
+
+Check out our [docs](https://docs.logto.io/sdk/nuxt/) for more information.
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @logto/nuxt
+```
+
+### Using yarn
+
+```bash
+yarn add @logto/nuxt
+```
+
+### Using pnpm
+
+```bash
+pnpm add @logto/nuxt
+```
+
+## Get sample
+
+A sample project can be found at [playground](./playground/).
+
+Check out the full JS repo and try it with pnpm.
+
+```bash
+pnpm i && pnpm dev
+```
+
+## 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/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,38 @@
+import { NuxtModule } from 'nuxt/schema';
+import { LogtoConfig } from '@logto/node';
+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;
+    /**
+     * 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`.
+     */
+    fetchUserInfo: boolean;
+    postCallbackRedirectUri: string;
+    postLogoutRedirectUri: string;
+    pathnames: {
+        signIn: string;
+        signOut: string;
+        callback: string;
+    };
+};
+type LogtoRuntimeConfig = LogtoModuleOptions & {
+    cookieEncryptionKey: string;
+} & Omit<LogtoConfig, 'appSecret'> & {
+    appSecret: NonNullable<LogtoConfig['appSecret']>;
+};
+type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
+
+declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
+
+export { logtoModule as default };

package/dist/module.d.ts

@@ -0,0 +1,38 @@
+import { NuxtModule } from 'nuxt/schema';
+import { LogtoConfig } from '@logto/node';
+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;
+    /**
+     * 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`.
+     */
+    fetchUserInfo: boolean;
+    postCallbackRedirectUri: string;
+    postLogoutRedirectUri: string;
+    pathnames: {
+        signIn: string;
+        signOut: string;
+        callback: string;
+    };
+};
+type LogtoRuntimeConfig = LogtoModuleOptions & {
+    cookieEncryptionKey: string;
+} & Omit<LogtoConfig, 'appSecret'> & {
+    appSecret: NonNullable<LogtoConfig['appSecret']>;
+};
+type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
+
+declare const logtoModule: NuxtModule<LogtoRuntimeConfigInput>;
+
+export { logtoModule as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -0,0 +1,43 @@
+import { defineNuxtModule, createResolver, addServerHandler, addImportsDir } from '@nuxt/kit';
+import { defu } from 'defu';
+export * from '@logto/node';
+export { default as LogtoNodeClient } from '@logto/node';
+
+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>"
+});
+
+const logtoModule = defineNuxtModule({
+  meta: {
+    name: "@logto/nuxt",
+    configKey: "logto"
+  },
+  defaults,
+  setup(options, nuxt) {
+    const runtimeConfig = defu(
+      nuxt.options.runtimeConfig.logto,
+      options,
+      {
+        fetchUserInfo: false,
+        postCallbackRedirectUri: "/",
+        postLogoutRedirectUri: "/",
+        pathnames: {
+          signIn: "/sign-in",
+          signOut: "/sign-out",
+          callback: "/callback"
+        }
+      }
+    );
+    nuxt.options.runtimeConfig.logto = runtimeConfig;
+    const { resolve } = createResolver(import.meta.url);
+    addServerHandler({
+      handler: resolve("./runtime/server/event-handler")
+    });
+    addImportsDir(resolve("./runtime/composables"));
+  }
+});
+
+export { logtoModule as default };

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

@@ -0,0 +1,2 @@
+import LogtoClient from '@logto/node';
+export default function useLogtoClient(): LogtoClient | undefined;

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

@@ -0,0 +1,7 @@
+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;
+}

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

@@ -0,0 +1 @@
+export default function useLogtoUser(): any;

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

@@ -0,0 +1,10 @@
+import { LogtoStateKey } from "../utils/constants.mjs";
+import { shallowRef as shallowReference, useNuxtApp, useState } from "#imports";
+export default function useLogtoUser() {
+  const nuxtApp = useNuxtApp();
+  const user = useState(
+    LogtoStateKey.User,
+    () => shallowReference(nuxtApp.ssrContext?.event.context.logtoUser)
+  );
+  return user.value;
+}

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

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

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

@@ -0,0 +1,57 @@
+import LogtoClient, { CookieStorage } from "@logto/node";
+import { defaults } from "../utils/constants.mjs";
+export default defineEventHandler(async (event) => {
+  const config = useRuntimeConfig(event);
+  const logtoConfig = config.logto;
+  const {
+    cookieName,
+    cookieEncryptionKey,
+    fetchUserInfo,
+    pathnames,
+    postCallbackRedirectUri,
+    postLogoutRedirectUri,
+    ...clientConfig
+  } = logtoConfig;
+  const defaultValueKeys = Object.entries(defaults).filter(([key, value]) => logtoConfig[key] === value).map(([key]) => key);
+  if (defaultValueKeys.length > 0) {
+    throw new TypeError(
+      `The following Logto configuration keys have default values: ${defaultValueKeys.join(
+        ", "
+      )}. Please replace them with your own values.`
+    );
+  }
+  const url = getRequestURL(event);
+  const storage = new CookieStorage(
+    {
+      cookieKey: cookieName,
+      encryptionKey: cookieEncryptionKey,
+      getCookie: (name) => getCookie(event, name),
+      setCookie: (name, value, options) => {
+        setCookie(event, name, value, options);
+      }
+    },
+    { headers: event.headers, url: url.href }
+  );
+  await storage.init();
+  const logto = new LogtoClient(clientConfig, {
+    navigate: async (url2) => {
+      await sendRedirect(event, url2, 302);
+    },
+    storage
+  });
+  if (url.pathname === pathnames.signIn) {
+    await logto.signIn(new URL(pathnames.callback, url).href);
+    return;
+  }
+  if (url.pathname === pathnames.signOut) {
+    await logto.signOut(new URL(postLogoutRedirectUri, url).href);
+    return;
+  }
+  if (url.pathname === pathnames.callback) {
+    await logto.handleSignInCallback(url.href);
+    await sendRedirect(event, postCallbackRedirectUri, 302);
+    return;
+  }
+  event.context.logtoClient = logto;
+  event.context.logtoUser = await logto.isAuthenticated() ? await (fetchUserInfo ? logto.fetchUserInfo() : logto.getIdTokenClaims()) : void 0;
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server",
+}

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

@@ -0,0 +1,9 @@
+export declare enum LogtoStateKey {
+    User = "logto.user"
+}
+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>";
+}>;

package/dist/runtime/utils/constants.mjs

@@ -0,0 +1,10 @@
+export var LogtoStateKey = /* @__PURE__ */ ((LogtoStateKey2) => {
+  LogtoStateKey2["User"] = "logto.user";
+  return LogtoStateKey2;
+})(LogtoStateKey || {});
+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>"
+});

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

@@ -0,0 +1,31 @@
+import type { LogtoConfig } from '@logto/node';
+export 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;
+    /**
+     * 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`.
+     */
+    fetchUserInfo: boolean;
+    postCallbackRedirectUri: string;
+    postLogoutRedirectUri: string;
+    pathnames: {
+        signIn: string;
+        signOut: string;
+        callback: string;
+    };
+};
+export type LogtoRuntimeConfig = LogtoModuleOptions & {
+    cookieEncryptionKey: string;
+} & Omit<LogtoConfig, 'appSecret'> & {
+    appSecret: NonNullable<LogtoConfig['appSecret']>;
+};
+export type LogtoRuntimeConfigInput = DeepPartial<LogtoRuntimeConfig>;
+export {};

package/dist/types.d.mts

@@ -0,0 +1,25 @@
+
+import type { ModuleOptions, ModuleHooks, RuntimeModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.js'
+
+declare module '#app' {
+  interface RuntimeNuxtHooks extends RuntimeModuleHooks, ModuleRuntimeHooks {}
+}
+
+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'

package/dist/types.d.ts

@@ -0,0 +1,25 @@
+
+import type { ModuleOptions, ModuleHooks, RuntimeModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module'
+
+declare module '#app' {
+  interface RuntimeNuxtHooks extends RuntimeModuleHooks, ModuleRuntimeHooks {}
+}
+
+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'

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@logto/nuxt",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/module.mjs",
+      "types": "./dist/module.d.ts",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/module.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/logto-io/js.git",
+    "directory": "packages/nuxt"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "^0.5.5",
+    "@silverhand/eslint-config": "^5.0.0",
+    "eslint": "^8.56.0",
+    "h3": "^1.10.2",
+    "lint-staged": "^15.0.0",
+    "nuxt": "^3.10.2",
+    "prettier": "^3.0.0",
+    "typescript": "^5.3.3",
+    "vue": "^3.4.19"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand"
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.10.2",
+    "defu": "^6.1.4",
+    "@logto/node": "^2.4.0"
+  },
+  "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",
+    "check": "tsc --noEmit",
+    "lint": "eslint --ext .ts src"
+  }
+}