@logto/browser 1.1.2 → 2.1.0

package/lib/cache.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+const keyPrefix = `logto_cache`;
+class CacheStorage {
+    constructor(appId) {
+        this.appId = appId;
+    }
+    getKey(item) {
+        if (item === undefined) {
+            return `${keyPrefix}:${this.appId}`;
+        }
+        return `${keyPrefix}:${this.appId}:${item}`;
+    }
+    async getItem(key) {
+        return sessionStorage.getItem(this.getKey(key));
+    }
+    async setItem(key, value) {
+        sessionStorage.setItem(this.getKey(key), value);
+    }
+    async removeItem(key) {
+        sessionStorage.removeItem(`${this.getKey(key)}`);
+    }
+}
+
+exports.CacheStorage = CacheStorage;

package/lib/cache.d.ts

@@ -0,0 +1,10 @@
+import type { Storage, CacheKey } from '@logto/client';
+import type { Nullable } from '@silverhand/essentials';
+export declare class CacheStorage implements Storage<CacheKey> {
+    readonly appId: string;
+    constructor(appId: string);
+    getKey(item?: string): string;
+    getItem(key: CacheKey): Promise<Nullable<string>>;
+    setItem(key: CacheKey, value: string): Promise<void>;
+    removeItem(key: CacheKey): Promise<void>;
+}

package/lib/cache.js

@@ -0,0 +1,23 @@
+const keyPrefix = `logto_cache`;
+class CacheStorage {
+    constructor(appId) {
+        this.appId = appId;
+    }
+    getKey(item) {
+        if (item === undefined) {
+            return `${keyPrefix}:${this.appId}`;
+        }
+        return `${keyPrefix}:${this.appId}:${item}`;
+    }
+    async getItem(key) {
+        return sessionStorage.getItem(this.getKey(key));
+    }
+    async setItem(key, value) {
+        sessionStorage.setItem(this.getKey(key), value);
+    }
+    async removeItem(key) {
+        sessionStorage.removeItem(`${this.getKey(key)}`);
+    }
+}
+
+export { CacheStorage };

package/lib/cache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var BaseClient = require('@logto/client');
+var essentials = require('@silverhand/essentials');
+var cache = require('./cache.cjs');
+var storage = require('./storage.cjs');
+var generators = require('./utils/generators.cjs');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var BaseClient__default = /*#__PURE__*/_interopDefault(BaseClient);
+
+const navigate = (url) => {
+    window.location.assign(url);
+};
+class LogtoClient extends BaseClient__default.default {
+    /**
+     * @param config The configuration object for the client.
+     * @param [unstable_enableCache=false] Whether to enable cache for well-known data.
+     * Use sessionStorage by default.
+     */
+    constructor(config, unstable_enableCache = false) {
+        const requester = BaseClient.createRequester(fetch);
+        super(config, {
+            requester,
+            navigate,
+            storage: new storage.BrowserStorage(config.appId),
+            unstable_cache: essentials.conditional(unstable_enableCache && new cache.CacheStorage(config.appId)),
+            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/index.d.ts

@@ -3,5 +3,10 @@ import BaseClient from '@logto/client';
 export type { IdTokenClaims, LogtoErrorCode, LogtoConfig, LogtoClientErrorCode, UserInfoResponse, InteractionMode, } from '@logto/client';
 export { LogtoError, OidcError, Prompt, LogtoRequestError, LogtoClientError, ReservedScope, UserScope, } from '@logto/client';
 export default class LogtoClient extends BaseClient {
-    constructor(config: LogtoConfig);
+    /**
+     * @param config The configuration object for the client.
+     * @param [unstable_enableCache=false] Whether to enable cache for well-known data.
+     * Use sessionStorage by default.
+     */
+    constructor(config: LogtoConfig, unstable_enableCache?: boolean);
 }

package/lib/index.js

@@ -1,58 +1,31 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var BaseClient = require('@logto/client');
-var storage = require('./storage.js');
-var generators = require('./utils/generators.js');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var BaseClient__default = /*#__PURE__*/_interopDefault(BaseClient);
+import BaseClient, { createRequester } from '@logto/client';
+export { LogtoClientError, LogtoError, LogtoRequestError, OidcError, Prompt, ReservedScope, UserScope } from '@logto/client';
+import { conditional } from '@silverhand/essentials';
+import { CacheStorage } from './cache.js';
+import { BrowserStorage } from './storage.js';
+import { generateCodeChallenge, generateCodeVerifier, generateState } from './utils/generators.js';
 
 const navigate = (url) => {
     window.location.assign(url);
 };
-class LogtoClient extends BaseClient__default.default {
-    constructor(config) {
-        const requester = BaseClient.createRequester(fetch);
+class LogtoClient extends BaseClient {
+    /**
+     * @param config The configuration object for the client.
+     * @param [unstable_enableCache=false] Whether to enable cache for well-known data.
+     * Use sessionStorage by default.
+     */
+    constructor(config, unstable_enableCache = false) {
+        const requester = createRequester(fetch);
         super(config, {
             requester,
             navigate,
-            storage: new storage.BrowserStorage(config.appId),
-            generateCodeChallenge: generators.generateCodeChallenge,
-            generateCodeVerifier: generators.generateCodeVerifier,
-            generateState: generators.generateState,
+            storage: new BrowserStorage(config.appId),
+            unstable_cache: conditional(unstable_enableCache && new CacheStorage(config.appId)),
+            generateCodeChallenge,
+            generateCodeVerifier,
+            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;
+export { LogtoClient as default };

package/lib/storage.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+const keyPrefix = `logto`;
+class BrowserStorage {
+    constructor(appId) {
+        this.appId = appId;
+    }
+    getKey(item) {
+        if (item === undefined) {
+            return `${keyPrefix}:${this.appId}`;
+        }
+        return `${keyPrefix}:${this.appId}:${item}`;
+    }
+    async getItem(key) {
+        if (key === 'signInSession') {
+            // The latter `getItem()` is for backward compatibility. Can be removed when major bump.
+            return sessionStorage.getItem(this.getKey(key)) ?? sessionStorage.getItem(this.getKey());
+        }
+        return localStorage.getItem(this.getKey(key));
+    }
+    async setItem(key, value) {
+        if (key === 'signInSession') {
+            sessionStorage.setItem(this.getKey(key), value);
+            return;
+        }
+        localStorage.setItem(this.getKey(key), value);
+    }
+    async removeItem(key) {
+        if (key === 'signInSession') {
+            sessionStorage.removeItem(this.getKey(key));
+            return;
+        }
+        localStorage.removeItem(this.getKey(key));
+    }
+}
+
+exports.BrowserStorage = BrowserStorage;

package/lib/storage.d.ts

@@ -1,9 +1,9 @@
 import type { Storage, StorageKey } from '@logto/client';
 import type { Nullable } from '@silverhand/essentials';
-export declare const logtoStorageItemKeyPrefix = "logto";
-export declare class BrowserStorage implements Storage {
-    private readonly storageKey;
+export declare class BrowserStorage implements Storage<StorageKey> {
+    readonly appId: string;
     constructor(appId: string);
+    getKey(item?: string): string;
     getItem(key: StorageKey): Promise<Nullable<string>>;
     setItem(key: StorageKey, value: string): Promise<void>;
     removeItem(key: StorageKey): Promise<void>;

package/lib/storage.js

@@ -1,31 +1,35 @@
-'use strict';
-
-const logtoStorageItemKeyPrefix = `logto`;
+const keyPrefix = `logto`;
 class BrowserStorage {
     constructor(appId) {
-        this.storageKey = `${logtoStorageItemKeyPrefix}:${appId}`;
+        this.appId = appId;
+    }
+    getKey(item) {
+        if (item === undefined) {
+            return `${keyPrefix}:${this.appId}`;
+        }
+        return `${keyPrefix}:${this.appId}:${item}`;
     }
     async getItem(key) {
         if (key === 'signInSession') {
-            return sessionStorage.getItem(this.storageKey);
+            // The latter `getItem()` is for backward compatibility. Can be removed when major bump.
+            return sessionStorage.getItem(this.getKey(key)) ?? sessionStorage.getItem(this.getKey());
         }
-        return localStorage.getItem(`${this.storageKey}:${key}`);
+        return localStorage.getItem(this.getKey(key));
     }
     async setItem(key, value) {
         if (key === 'signInSession') {
-            sessionStorage.setItem(this.storageKey, value);
+            sessionStorage.setItem(this.getKey(key), value);
             return;
         }
-        localStorage.setItem(`${this.storageKey}:${key}`, value);
+        localStorage.setItem(this.getKey(key), value);
     }
     async removeItem(key) {
         if (key === 'signInSession') {
-            sessionStorage.removeItem(this.storageKey);
+            sessionStorage.removeItem(this.getKey(key));
             return;
         }
-        localStorage.removeItem(`${this.storageKey}:${key}`);
+        localStorage.removeItem(this.getKey(key));
     }
 }
 
-exports.BrowserStorage = BrowserStorage;
-exports.logtoStorageItemKeyPrefix = logtoStorageItemKeyPrefix;
+export { BrowserStorage };

package/lib/utils/{generators.mjs → generators.cjs}

@@ -1,11 +1,13 @@
-import { LogtoError } from '@logto/client';
-import { fromUint8Array } from 'js-base64';
+'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) => fromUint8Array(crypto.getRandomValues(new Uint8Array(length)), true);
+const generateRandomString = (length = 64) => jsBase64.fromUint8Array(crypto.getRandomValues(new Uint8Array(length)), true);
 /**
  * Generates random string for state and encodes them in url safe base64
  */
@@ -30,11 +32,13 @@ const generateCodeChallenge = async (codeVerifier) => {
          * 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');
+        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 fromUint8Array(codeChallenge, true);
+    return jsBase64.fromUint8Array(codeChallenge, true);
 };
 
-export { generateCodeChallenge, generateCodeVerifier, generateState };
+exports.generateCodeChallenge = generateCodeChallenge;
+exports.generateCodeVerifier = generateCodeVerifier;
+exports.generateState = generateState;

package/lib/utils/generators.js

@@ -1,13 +1,11 @@
-'use strict';
-
-var BaseClient = require('@logto/client');
-var jsBase64 = require('js-base64');
+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) => jsBase64.fromUint8Array(crypto.getRandomValues(new Uint8Array(length)), true);
+const generateRandomString = (length = 64) => fromUint8Array(crypto.getRandomValues(new Uint8Array(length)), true);
 /**
  * Generates random string for state and encodes them in url safe base64
  */
@@ -32,13 +30,11 @@ const generateCodeChallenge = async (codeVerifier) => {
          * 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');
+        throw new 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);
+    return fromUint8Array(codeChallenge, true);
 };
 
-exports.generateCodeChallenge = generateCodeChallenge;
-exports.generateCodeVerifier = generateCodeVerifier;
-exports.generateState = generateState;
+export { generateCodeChallenge, generateCodeVerifier, generateState };

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@logto/browser",
-  "version": "1.1.2",
-  "source": "./src/index.ts",
-  "main": "./lib/index.js",
+  "version": "2.1.0",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "import": "./lib/index.mjs"
+    "types": "./lib/index.d.ts",
+    "require": "./lib/index.cjs",
+    "import": "./lib/index.js",
+    "default": "./lib/index.js"
   },
-  "module": "./lib/index.mjs",
-  "types": "./lib/index.d.ts",
   "files": [
     "lib"
   ],
@@ -18,32 +20,20 @@
     "url": "https://github.com/logto-io/js.git",
     "directory": "packages/browser"
   },
-  "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.2.0",
+    "@silverhand/essentials": "^2.6.2",
     "js-base64": "^3.7.4"
   },
   "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.50",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.5.0",
     "eslint": "^8.38.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
-    "jest-location-mock": "^1.0.9",
     "jest-matcher-specific-error": "^1.0.0",
     "lint-staged": "^13.0.0",
     "prettier": "^2.8.7",
@@ -57,5 +47,13 @@
   "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": "jest --silent --coverage"
+  }
+}

package/lib/index.mjs

@@ -1,23 +0,0 @@
-import BaseClient, { createRequester } from '@logto/client';
-export { LogtoClientError, LogtoError, LogtoRequestError, OidcError, Prompt, ReservedScope, UserScope } from '@logto/client';
-import { BrowserStorage } from './storage.mjs';
-import { generateCodeChallenge, generateCodeVerifier, generateState } from './utils/generators.mjs';
-
-const navigate = (url) => {
-    window.location.assign(url);
-};
-class LogtoClient extends BaseClient {
-    constructor(config) {
-        const requester = createRequester(fetch);
-        super(config, {
-            requester,
-            navigate,
-            storage: new BrowserStorage(config.appId),
-            generateCodeChallenge,
-            generateCodeVerifier,
-            generateState,
-        });
-    }
-}
-
-export { LogtoClient as default };

package/lib/storage.mjs

@@ -1,28 +0,0 @@
-const logtoStorageItemKeyPrefix = `logto`;
-class BrowserStorage {
-    constructor(appId) {
-        this.storageKey = `${logtoStorageItemKeyPrefix}:${appId}`;
-    }
-    async getItem(key) {
-        if (key === 'signInSession') {
-            return sessionStorage.getItem(this.storageKey);
-        }
-        return localStorage.getItem(`${this.storageKey}:${key}`);
-    }
-    async setItem(key, value) {
-        if (key === 'signInSession') {
-            sessionStorage.setItem(this.storageKey, value);
-            return;
-        }
-        localStorage.setItem(`${this.storageKey}:${key}`, value);
-    }
-    async removeItem(key) {
-        if (key === 'signInSession') {
-            sessionStorage.removeItem(this.storageKey);
-            return;
-        }
-        localStorage.removeItem(`${this.storageKey}:${key}`);
-    }
-}
-
-export { BrowserStorage, logtoStorageItemKeyPrefix };