@logto/node 1.1.2 → 2.1.0

package/lib/edge/generators.cjs

@@ -0,0 +1,44 @@
+'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/generators.d.ts

@@ -0,0 +1,18 @@
+/** @link [Proof Key for Code Exchange by OAuth Public Clients](https://datatracker.ietf.org/doc/html/rfc7636) */
+/**
+ * Generates random string for state and encodes them in url safe base64
+ */
+export declare const generateState: () => string;
+/**
+ * Generates code verifier
+ *
+ * @link [Client Creates a Code Verifier](https://datatracker.ietf.org/doc/html/rfc7636#section-4.1)
+ */
+export declare const generateCodeVerifier: () => string;
+/**
+ * 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)
+ */
+export declare const generateCodeChallenge: (codeVerifier: string) => Promise<string>;

package/lib/edge/generators.js

@@ -0,0 +1,40 @@
+import { LogtoError } from '@logto/client';
+import { fromUint8Array } from '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) => 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 LogtoError('crypto_subtle_unavailable');
+    }
+    const encodedCodeVerifier = new TextEncoder().encode(codeVerifier);
+    const codeChallenge = new Uint8Array(await crypto.subtle.digest('SHA-256', encodedCodeVerifier));
+    return fromUint8Array(codeChallenge, true);
+};
+
+export { generateCodeChallenge, generateCodeVerifier, generateState };

package/lib/edge/index.cjs

@@ -0,0 +1,35 @@
+'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;
+                    return fetch(input, {
+                        ...init,
+                        headers: {
+                            Authorization: `Basic ${Buffer.from(
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
+                            ...init?.headers,
+                        },
+                    });
+                }
+                : fetch),
+            generateCodeChallenge: generators.generateCodeChallenge,
+            generateCodeVerifier: generators.generateCodeVerifier,
+            generateState: generators.generateState,
+        });
+    }
+}
+
+exports.default = LogtoClient;

package/lib/edge/index.d.ts

@@ -0,0 +1,5 @@
+import type { LogtoConfig, ClientAdapter } from '@logto/client';
+import BaseClient from '../src/client.js';
+export default class LogtoClient extends BaseClient {
+    constructor(config: LogtoConfig, adapter: Pick<ClientAdapter, 'navigate' | 'storage'>);
+}

package/lib/edge/index.js

@@ -0,0 +1,31 @@
+import { createRequester } from '@logto/client';
+import LogtoNodeBaseClient from '../src/client.js';
+import { generateCodeChallenge, generateCodeVerifier, generateState } from './generators.js';
+
+// Used for edge runtime, currently only NextJS.
+class LogtoClient extends LogtoNodeBaseClient {
+    constructor(config, adapter) {
+        super(config, {
+            ...adapter,
+            requester: createRequester(config.appSecret
+                ? async (...args) => {
+                    const [input, init] = args;
+                    return fetch(input, {
+                        ...init,
+                        headers: {
+                            Authorization: `Basic ${Buffer.from(
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
+                            ...init?.headers,
+                        },
+                    });
+                }
+                : fetch),
+            generateCodeChallenge,
+            generateCodeVerifier,
+            generateState,
+        });
+    }
+}
+
+export { LogtoClient as default };

package/lib/{index.js → src/client.cjs}

@@ -4,36 +4,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var BaseClient = require('@logto/client');
 var essentials = require('@silverhand/essentials');
-var fetch = require('node-fetch');
-var generators = require('./utils/generators.js');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var BaseClient__default = /*#__PURE__*/_interopDefault(BaseClient);
-var fetch__default = /*#__PURE__*/_interopDefault(fetch);
 
-class LogtoClient extends BaseClient__default.default {
-    constructor(config, adapter) {
-        super(config, {
-            ...adapter,
-            requester: BaseClient.createRequester(config.appSecret
-                ? async (...args) => {
-                    const [input, init] = args;
-                    return fetch__default.default(input, {
-                        ...init,
-                        headers: {
-                            Authorization: `basic ${Buffer.from(
-                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
-                            ...init?.headers,
-                        },
-                    });
-                }
-                : fetch__default.default),
-            generateCodeChallenge: generators.generateCodeChallenge,
-            generateCodeVerifier: generators.generateCodeVerifier,
-            generateState: generators.generateState,
-        });
+class LogtoNodeBaseClient extends BaseClient__default.default {
+    constructor() {
+        super(...arguments);
         this.getContext = async ({ getAccessToken, resource, fetchUserInfo, } = {}) => {
             const isAuthenticated = await this.isAuthenticated();
             if (!isAuthenticated) {
@@ -51,11 +29,13 @@ class LogtoClient extends BaseClient__default.default {
             }
             try {
                 const accessToken = await this.getAccessToken(resource);
+                const accessTokenClaims = await this.getAccessTokenClaims(resource);
                 return {
                     isAuthenticated,
                     claims: await this.getIdTokenClaims(),
                     userInfo: essentials.conditional(fetchUserInfo && (await this.fetchUserInfo())),
                     accessToken,
+                    scopes: accessTokenClaims.scope?.split(' '),
                 };
             }
             catch {
@@ -95,4 +75,4 @@ Object.defineProperty(exports, 'UserScope', {
     enumerable: true,
     get: function () { return BaseClient.UserScope; }
 });
-exports.default = LogtoClient;
+exports.default = LogtoNodeBaseClient;

package/lib/{index.d.ts → src/client.d.ts}

@@ -1,10 +1,8 @@
-import type { LogtoConfig, ClientAdapter } from '@logto/client';
 import BaseClient from '@logto/client';
-import type { GetContextParameters, LogtoContext } from './types';
-export type { LogtoContext, GetContextParameters } from './types';
+import type { GetContextParameters, LogtoContext } from './types.js';
+export type { LogtoContext, GetContextParameters } from './types.js';
 export type { IdTokenClaims, LogtoErrorCode, LogtoConfig, LogtoClientErrorCode, Storage, StorageKey, InteractionMode, } from '@logto/client';
 export { LogtoError, OidcError, Prompt, LogtoRequestError, LogtoClientError, ReservedScope, UserScope, } from '@logto/client';
-export default class LogtoClient extends BaseClient {
-    constructor(config: LogtoConfig, adapter: Pick<ClientAdapter, 'navigate' | 'storage'>);
+export default class LogtoNodeBaseClient extends BaseClient {
     getContext: ({ getAccessToken, resource, fetchUserInfo, }?: GetContextParameters) => Promise<LogtoContext>;
 }

package/lib/{index.mjs → src/client.js}

@@ -1,31 +1,10 @@
-import BaseClient, { createRequester } from '@logto/client';
+import BaseClient from '@logto/client';
 export { LogtoClientError, LogtoError, LogtoRequestError, OidcError, Prompt, ReservedScope, UserScope } from '@logto/client';
 import { conditional } from '@silverhand/essentials';
-import fetch from 'node-fetch';
-import { generateCodeChallenge, generateCodeVerifier, generateState } from './utils/generators.mjs';
 
-class LogtoClient extends BaseClient {
-    constructor(config, adapter) {
-        super(config, {
-            ...adapter,
-            requester: createRequester(config.appSecret
-                ? async (...args) => {
-                    const [input, init] = args;
-                    return fetch(input, {
-                        ...init,
-                        headers: {
-                            Authorization: `basic ${Buffer.from(
-                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
-                            ...init?.headers,
-                        },
-                    });
-                }
-                : fetch),
-            generateCodeChallenge,
-            generateCodeVerifier,
-            generateState,
-        });
+class LogtoNodeBaseClient extends BaseClient {
+    constructor() {
+        super(...arguments);
         this.getContext = async ({ getAccessToken, resource, fetchUserInfo, } = {}) => {
             const isAuthenticated = await this.isAuthenticated();
             if (!isAuthenticated) {
@@ -43,11 +22,13 @@ class LogtoClient extends BaseClient {
             }
             try {
                 const accessToken = await this.getAccessToken(resource);
+                const accessTokenClaims = await this.getAccessTokenClaims(resource);
                 return {
                     isAuthenticated,
                     claims: await this.getIdTokenClaims(),
                     userInfo: conditional(fetchUserInfo && (await this.fetchUserInfo())),
                     accessToken,
+                    scopes: accessTokenClaims.scope?.split(' '),
                 };
             }
             catch {
@@ -59,4 +40,4 @@ class LogtoClient extends BaseClient {
     }
 }
 
-export { LogtoClient as default };
+export { LogtoNodeBaseClient as default };

package/lib/src/index.cjs

@@ -0,0 +1,67 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var BaseClient = require('@logto/client');
+var fetch = require('node-fetch');
+var client = require('./client.cjs');
+var generators = require('./utils/generators.cjs');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var fetch__default = /*#__PURE__*/_interopDefault(fetch);
+
+class LogtoClient extends client.default {
+    constructor(config, adapter) {
+        super(config, {
+            ...adapter,
+            requester: BaseClient.createRequester(config.appSecret
+                ? async (...args) => {
+                    const [input, init] = args;
+                    return fetch__default.default(input, {
+                        ...init,
+                        headers: {
+                            Authorization: `Basic ${Buffer.from(
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
+                            ...init?.headers,
+                        },
+                    });
+                }
+                : fetch__default.default),
+            generateCodeChallenge: generators.generateCodeChallenge,
+            generateCodeVerifier: generators.generateCodeVerifier,
+            generateState: generators.generateState,
+        });
+    }
+}
+
+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 = LogtoClient;

package/lib/src/index.d.ts

@@ -0,0 +1,8 @@
+import type { LogtoConfig, ClientAdapter } from '@logto/client';
+import BaseClient from './client.js';
+export type { LogtoContext, GetContextParameters } from './types.js';
+export type { IdTokenClaims, LogtoErrorCode, LogtoConfig, LogtoClientErrorCode, Storage, StorageKey, InteractionMode, } from '@logto/client';
+export { LogtoError, OidcError, Prompt, LogtoRequestError, LogtoClientError, ReservedScope, UserScope, } from '@logto/client';
+export default class LogtoClient extends BaseClient {
+    constructor(config: LogtoConfig, adapter: Pick<ClientAdapter, 'navigate' | 'storage'>);
+}

package/lib/src/index.js

@@ -0,0 +1,32 @@
+import { createRequester } from '@logto/client';
+export { LogtoClientError, LogtoError, LogtoRequestError, OidcError, Prompt, ReservedScope, UserScope } from '@logto/client';
+import fetch from 'node-fetch';
+import LogtoNodeBaseClient from './client.js';
+import { generateCodeChallenge, generateCodeVerifier, generateState } from './utils/generators.js';
+
+class LogtoClient extends LogtoNodeBaseClient {
+    constructor(config, adapter) {
+        super(config, {
+            ...adapter,
+            requester: createRequester(config.appSecret
+                ? async (...args) => {
+                    const [input, init] = args;
+                    return fetch(input, {
+                        ...init,
+                        headers: {
+                            Authorization: `Basic ${Buffer.from(
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                            `${config.appId}:${config.appSecret}`, 'utf8').toString('base64')}`,
+                            ...init?.headers,
+                        },
+                    });
+                }
+                : fetch),
+            generateCodeChallenge,
+            generateCodeVerifier,
+            generateState,
+        });
+    }
+}
+
+export { LogtoClient as default };

package/lib/{types.d.ts → src/types.d.ts}

@@ -9,6 +9,7 @@ export type LogtoContext = {
     claims?: IdTokenClaims;
     accessToken?: string;
     userInfo?: UserInfoResponse;
+    scopes?: string[];
 };
 export type GetContextParameters = {
     fetchUserInfo?: boolean;

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "@logto/node",
-  "version": "1.1.2",
-  "source": "./src/index.ts",
-  "main": "./lib/index.js",
+  "version": "2.1.0",
+  "type": "module",
+  "main": "./lib/src/index.cjs",
+  "module": "./lib/src/index.js",
+  "types": "./lib/src/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "import": "./lib/index.mjs"
+    ".": {
+      "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"
+    }
   },
-  "module": "./lib/index.mjs",
-  "types": "./lib/index.d.ts",
   "files": [
     "lib"
   ],
@@ -18,26 +26,15 @@
     "url": "https://github.com/logto-io/js.git",
     "directory": "packages/node"
   },
-  "scripts": {
-    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
-    "precommit": "lint-staged",
-    "check": "tsc --noEmit",
-    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
-    "lint": "eslint --ext .ts src",
-    "test": "jest",
-    "test:coverage": "jest --silent --coverage",
-    "prepack": "pnpm test"
-  },
   "dependencies": {
-    "@logto/client": "^1.1.2",
-    "@silverhand/essentials": "^2.6.1",
+    "@logto/client": "^2.1.0",
+    "@silverhand/essentials": "^2.6.2",
     "js-base64": "^3.7.4",
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "@jest/types": "^29.5.0",
-    "@silverhand/eslint-config": "^2.0.0",
-    "@silverhand/ts-config": "^1.0.0",
+    "@silverhand/eslint-config": "^3.0.1",
+    "@silverhand/ts-config": "^3.0.0",
     "@swc/core": "^1.3.7",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.5.0",
@@ -51,11 +48,22 @@
     "typescript": "^5.0.0"
   },
   "eslintConfig": {
-    "extends": "@silverhand"
+    "extends": "@silverhand",
+    "rules": {
+      "unicorn/prefer-node-protocol": "off"
+    }
   },
   "prettier": "@silverhand/eslint-config/.prettierrc",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9e9a8b0887ef67baa7c3c564590bb06e7801d03e"
-}
+  "scripts": {
+    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "precommit": "lint-staged",
+    "check": "tsc --noEmit",
+    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
+    "lint": "eslint --ext .ts src",
+    "test": "jest",
+    "test:coverage": "node test.cjs && jest --silent --coverage"
+  }
+}