@logto/node 2.5.8 → 3.0.3

package/package.json

@@ -1,23 +1,19 @@
 {
   "name": "@logto/node",
-  "version": "2.5.8",
+  "version": "3.0.3",
   "type": "module",
-  "main": "./lib/src/index.cjs",
   "module": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
   "exports": {
     ".": {
-      "require": "./lib/src/index.cjs",
       "import": "./lib/src/index.js",
       "types": "./lib/src/index.d.ts"
     },
     "./edge": {
-      "require": "./lib/edge/index.cjs",
       "import": "./lib/edge/index.js",
       "types": "./lib/edge/index.d.ts"
     },
     "./exports": {
-      "require": "./lib/exports/index.cjs",
       "import": "./lib/exports/index.js",
       "types": "./lib/exports/index.d.ts"
     }
@@ -32,15 +28,15 @@
     "directory": "packages/node"
   },
   "dependencies": {
-    "@silverhand/essentials": "^2.8.7",
+    "@silverhand/essentials": "^2.9.2",
     "js-base64": "^3.7.4",
-    "@logto/client": "^2.8.1"
+    "@logto/client": "^3.0.3"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",
     "@silverhand/ts-config": "^6.0.0",
     "@types/cookie": "^0.6.0",
-    "@types/node": "^20.11.19",
+    "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^1.6.0",
     "eslint": "^8.57.0",
     "lint-staged": "^15.0.0",
@@ -62,6 +58,6 @@
     "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
     "lint": "eslint --ext .ts src",
     "test": "vitest",
-    "test:coverage": "node test.cjs && vitest --silent --coverage"
+    "test:coverage": "vitest --silent --coverage"
   }
 }

package/lib/edge/generators.cjs

@@ -1,44 +0,0 @@
-'use strict';
-
-var BaseClient = require('@logto/client');
-var jsBase64 = require('js-base64');
-
-/** @link [Proof Key for Code Exchange by OAuth Public Clients](https://datatracker.ietf.org/doc/html/rfc7636) */
-/**
- * @param length The length of the raw random data.
- */
-const generateRandomString = (length = 64) => jsBase64.fromUint8Array(crypto.getRandomValues(new Uint8Array(length)), true);
-/**
- * Generates random string for state and encodes them in url safe base64
- */
-const generateState = () => generateRandomString();
-/**
- * Generates code verifier
- *
- * @link [Client Creates a Code Verifier](https://datatracker.ietf.org/doc/html/rfc7636#section-4.1)
- */
-const generateCodeVerifier = () => generateRandomString();
-/**
- * Calculates the S256 PKCE code challenge for an arbitrary code verifier and encodes it in url safe base64
- *
- * @param {String} codeVerifier Code verifier to calculate the S256 code challenge for
- * @link [Client Creates the Code Challenge](https://datatracker.ietf.org/doc/html/rfc7636#section-4.2)
- */
-const generateCodeChallenge = async (codeVerifier) => {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (crypto.subtle === undefined) {
-        /**
-         * `crypto.subtle` is available only in secure contexts (HTTPS) in some or all supporting browsers,
-         * https://developer.mozilla.org/en-US/docs/Web/API/Crypto/subtle
-         * https://www.chromium.org/blink/webcrypto/#accessing-it
-         */
-        throw new BaseClient.LogtoError('crypto_subtle_unavailable');
-    }
-    const encodedCodeVerifier = new TextEncoder().encode(codeVerifier);
-    const codeChallenge = new Uint8Array(await crypto.subtle.digest('SHA-256', encodedCodeVerifier));
-    return jsBase64.fromUint8Array(codeChallenge, true);
-};
-
-exports.generateCodeChallenge = generateCodeChallenge;
-exports.generateCodeVerifier = generateCodeVerifier;
-exports.generateState = generateState;

package/lib/edge/index.cjs

@@ -1,39 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var BaseClient = require('@logto/client');
-var client = require('../src/client.cjs');
-var generators = require('./generators.cjs');
-
-// Used for edge runtime, currently only NextJS.
-class LogtoClient extends client.default {
-    constructor(config, adapter) {
-        super(config, {
-            ...adapter,
-            requester: BaseClient.createRequester(config.appSecret
-                ? async (...args) => {
-                    const [input, init] = args;
-                    // Encode to base64 using btoa
-                    const base64Credentials = btoa(`${config.appId}:${config.appSecret ?? ''}`);
-                    return fetch(input, {
-                        ...init,
-                        headers: {
-                            Authorization: `Basic ${base64Credentials}`,
-                            ...init?.headers,
-                        },
-                    });
-                }
-                : fetch),
-            generateCodeChallenge: generators.generateCodeChallenge,
-            generateCodeVerifier: generators.generateCodeVerifier,
-            generateState: generators.generateState,
-        });
-    }
-}
-
-Object.defineProperty(exports, "PersistKey", {
-    enumerable: true,
-    get: function () { return BaseClient.PersistKey; }
-});
-exports.default = LogtoClient;

package/lib/src/client.cjs

@@ -1,80 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var BaseClient = require('@logto/client');
-var essentials = require('@silverhand/essentials');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var BaseClient__default = /*#__PURE__*/_interopDefault(BaseClient);
-
-class LogtoNodeBaseClient extends BaseClient__default.default {
-    constructor() {
-        super(...arguments);
-        this.getContext = async ({ getAccessToken, resource, fetchUserInfo, getOrganizationToken, organizationId, } = {}) => {
-            const isAuthenticated = await this.isAuthenticated();
-            if (!isAuthenticated) {
-                return {
-                    isAuthenticated,
-                };
-            }
-            const claims = await this.getIdTokenClaims();
-            const { accessToken, accessTokenClaims } = getAccessToken
-                ? {
-                    accessToken: await essentials.trySafe(async () => this.getAccessToken(resource, organizationId)),
-                    accessTokenClaims: await essentials.trySafe(async () => this.getAccessTokenClaims(resource)),
-                }
-                : { accessToken: undefined, accessTokenClaims: undefined };
-            if (getAccessToken && !accessToken) {
-                // Failed to get access token, the user is not authenticated
-                return {
-                    isAuthenticated: false,
-                };
-            }
-            const organizationTokens = essentials.conditional(getOrganizationToken &&
-                claims.organizations &&
-                Object.fromEntries(await Promise.all(claims.organizations.map(async (organizationId) => [
-                    organizationId,
-                    await this.getOrganizationToken(organizationId),
-                ]))));
-            return {
-                isAuthenticated,
-                claims,
-                userInfo: essentials.conditional(fetchUserInfo && (await this.fetchUserInfo())),
-                ...essentials.conditional(getAccessToken && { accessToken, scopes: accessTokenClaims?.scope?.split(' ') }),
-                organizationTokens,
-            };
-        };
-    }
-}
-
-Object.defineProperty(exports, "LogtoClientError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoClientError; }
-});
-Object.defineProperty(exports, "LogtoError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoError; }
-});
-Object.defineProperty(exports, "LogtoRequestError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoRequestError; }
-});
-Object.defineProperty(exports, "OidcError", {
-    enumerable: true,
-    get: function () { return BaseClient.OidcError; }
-});
-Object.defineProperty(exports, "Prompt", {
-    enumerable: true,
-    get: function () { return BaseClient.Prompt; }
-});
-Object.defineProperty(exports, "ReservedScope", {
-    enumerable: true,
-    get: function () { return BaseClient.ReservedScope; }
-});
-Object.defineProperty(exports, "UserScope", {
-    enumerable: true,
-    get: function () { return BaseClient.UserScope; }
-});
-exports.default = LogtoNodeBaseClient;

package/lib/src/index.cjs

@@ -1,89 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var BaseClient = require('@logto/client');
-var generators = require('../edge/generators.cjs');
-var client = require('./client.cjs');
-var session = require('./utils/session.cjs');
-var cookieStorage = require('./utils/cookie-storage.cjs');
-
-class LogtoClient extends client.default {
-    constructor(config, adapter, buildJwtVerifier) {
-        super(config, {
-            requester: BaseClient.createRequester(config.appSecret
-                ? async (...args) => {
-                    const [input, init] = args;
-                    return fetch(input, {
-                        ...init,
-                        headers: {
-                            Authorization: `Basic ${Buffer.from(`${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
-                            ...init?.headers,
-                        },
-                    });
-                }
-                : fetch),
-            generateCodeChallenge: generators.generateCodeChallenge,
-            generateCodeVerifier: generators.generateCodeVerifier,
-            generateState: generators.generateState,
-            ...adapter,
-        }, buildJwtVerifier);
-    }
-}
-
-Object.defineProperty(exports, "LogtoClientError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoClientError; }
-});
-Object.defineProperty(exports, "LogtoError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoError; }
-});
-Object.defineProperty(exports, "LogtoRequestError", {
-    enumerable: true,
-    get: function () { return BaseClient.LogtoRequestError; }
-});
-Object.defineProperty(exports, "OidcError", {
-    enumerable: true,
-    get: function () { return BaseClient.OidcError; }
-});
-Object.defineProperty(exports, "PersistKey", {
-    enumerable: true,
-    get: function () { return BaseClient.PersistKey; }
-});
-Object.defineProperty(exports, "Prompt", {
-    enumerable: true,
-    get: function () { return BaseClient.Prompt; }
-});
-Object.defineProperty(exports, "ReservedResource", {
-    enumerable: true,
-    get: function () { return BaseClient.ReservedResource; }
-});
-Object.defineProperty(exports, "ReservedScope", {
-    enumerable: true,
-    get: function () { return BaseClient.ReservedScope; }
-});
-Object.defineProperty(exports, "StandardLogtoClient", {
-    enumerable: true,
-    get: function () { return BaseClient.StandardLogtoClient; }
-});
-Object.defineProperty(exports, "UserScope", {
-    enumerable: true,
-    get: function () { return BaseClient.UserScope; }
-});
-Object.defineProperty(exports, "buildOrganizationUrn", {
-    enumerable: true,
-    get: function () { return BaseClient.buildOrganizationUrn; }
-});
-Object.defineProperty(exports, "getOrganizationIdFromUrn", {
-    enumerable: true,
-    get: function () { return BaseClient.getOrganizationIdFromUrn; }
-});
-Object.defineProperty(exports, "organizationUrnPrefix", {
-    enumerable: true,
-    get: function () { return BaseClient.organizationUrnPrefix; }
-});
-exports.unwrapSession = session.unwrapSession;
-exports.wrapSession = session.wrapSession;
-exports.CookieStorage = cookieStorage.CookieStorage;
-exports.default = LogtoClient;

package/lib/src/utils/cookie-storage.cjs

@@ -1,63 +0,0 @@
-'use strict';
-
-var promiseQueue = require('./promise-queue.cjs');
-var session = require('./session.cjs');
-
-/**
- * A storage that persists data in cookies with encryption.
- */
-class CookieStorage {
-    get cookieOptions() {
-        return Object.freeze({
-            httpOnly: true,
-            path: '/',
-            sameSite: 'lax',
-            secure: this.config.isSecure ?? false,
-            maxAge: 14 * 24 * 3600, // 14 days
-        });
-    }
-    get cookieKey() {
-        return this.config.cookieKey ?? 'logtoCookies';
-    }
-    get data() {
-        return this.sessionData;
-    }
-    constructor(config) {
-        this.config = config;
-        this.sessionData = {};
-        this.saveQueue = new promiseQueue.PromiseQueue();
-        if (!config.encryptionKey) {
-            throw new TypeError('The `encryptionKey` string is required for `CookieStorage`');
-        }
-    }
-    async init() {
-        const { encryptionKey } = this.config;
-        this.sessionData = await session.unwrapSession(this.config.getCookie(this.cookieKey) ?? '', encryptionKey);
-    }
-    async getItem(key) {
-        return this.sessionData[key] ?? null;
-    }
-    async setItem(key, value) {
-        this.sessionData[key] = value;
-        await this.save();
-    }
-    async removeItem(key) {
-        // eslint-disable-next-line @silverhand/fp/no-delete, @typescript-eslint/no-dynamic-delete
-        delete this.sessionData[key];
-        await this.save();
-    }
-    async destroy() {
-        this.sessionData = {};
-        await this.save();
-    }
-    async save() {
-        return this.saveQueue.enqueue(async () => this.write());
-    }
-    async write(data = this.sessionData) {
-        const { encryptionKey } = this.config;
-        const value = await session.wrapSession(data, encryptionKey);
-        this.config.setCookie(this.cookieKey, value, this.cookieOptions);
-    }
-}
-
-exports.CookieStorage = CookieStorage;

package/lib/src/utils/promise-queue.cjs

@@ -1,46 +0,0 @@
-'use strict';
-
-/**
- * A simple promise queue that processes tasks sequentially in the order they are enqueued.
- */
-class PromiseQueue {
-    constructor() {
-        this.queue = [];
-        this.processing = false;
-    }
-    async enqueue(task) {
-        return new Promise((resolve, reject) => {
-            // Wrap the task along with its resolve and reject callbacks
-            const wrappedTask = async () => {
-                try {
-                    resolve(await task());
-                }
-                catch (error) {
-                    reject(error instanceof Error ? error : new Error(String(error)));
-                }
-            };
-            // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-            this.queue.push(wrappedTask);
-            if (!this.processing) {
-                void this.processQueue();
-            }
-        });
-    }
-    async processQueue() {
-        if (this.processing) {
-            return;
-        }
-        this.processing = true;
-        while (this.queue.length > 0) {
-            // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-            const task = this.queue.shift();
-            if (task) {
-                // eslint-disable-next-line no-await-in-loop
-                await task();
-            }
-        }
-        this.processing = false;
-    }
-}
-
-exports.PromiseQueue = PromiseQueue;

package/lib/src/utils/session.cjs

@@ -1,60 +0,0 @@
-'use strict';
-
-async function getKeyFromPassword(password, crypto) {
-    const encoder = new TextEncoder();
-    const data = encoder.encode(password);
-    const hash = await crypto.subtle.digest('SHA-256', data);
-    // Convert the hash to a hex string
-    return Array.from(new Uint8Array(hash))
-        .map((byte) => byte.toString(16).padStart(2, '0'))
-        .join('');
-}
-async function encrypt(text, password, crypto) {
-    const iv = crypto.getRandomValues(new Uint8Array(12));
-    const encodedPlaintext = new TextEncoder().encode(text);
-    const secretKey = await crypto.subtle.importKey('raw', Buffer.from(await getKeyFromPassword(password, crypto), 'hex'), {
-        name: 'AES-GCM',
-        length: 256,
-    }, true, ['encrypt', 'decrypt']);
-    const ciphertext = await crypto.subtle.encrypt({
-        name: 'AES-GCM',
-        iv,
-    }, secretKey, encodedPlaintext);
-    return {
-        ciphertext: Buffer.from(ciphertext).toString('base64'),
-        iv: Buffer.from(iv).toString('base64'),
-    };
-}
-async function decrypt(ciphertext, iv, password, crypto) {
-    const secretKey = await crypto.subtle.importKey('raw', Buffer.from(await getKeyFromPassword(password, crypto), 'hex'), {
-        name: 'AES-GCM',
-        length: 256,
-    }, true, ['encrypt', 'decrypt']);
-    const cleartext = await crypto.subtle.decrypt({
-        name: 'AES-GCM',
-        iv: Buffer.from(iv, 'base64'),
-    }, secretKey, Buffer.from(ciphertext, 'base64'));
-    return new TextDecoder().decode(cleartext);
-}
-const unwrapSession = async (cookie, secret) => {
-    try {
-        const [ciphertext, iv] = cookie.split('.');
-        if (!ciphertext || !iv) {
-            return {};
-        }
-        const decrypted = await decrypt(ciphertext, iv, secret, crypto);
-        // eslint-disable-next-line no-restricted-syntax
-        return JSON.parse(decrypted);
-    }
-    catch {
-        // Ignore invalid session
-    }
-    return {};
-};
-const wrapSession = async (session, secret) => {
-    const { ciphertext, iv } = await encrypt(JSON.stringify(session), secret, crypto);
-    return `${ciphertext}.${iv}`;
-};
-
-exports.unwrapSession = unwrapSession;
-exports.wrapSession = wrapSession;