@logto/client 3.0.3 → 3.1.1

package/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://github.com/logto-io/js/actions/workflows/main.yml/badge.svg)](https://github.com/logto-io/js/actions/workflows/main.yml)
 [![Codecov](https://img.shields.io/codecov/c/github/logto-io/js)](https://app.codecov.io/gh/logto-io/js?branch=master)
 
-The Logto JavaScript Client SDK written in TypeScript. Check out our [docs](https://docs.logto.io/sdk/JavaScript/client/) for more information.
+The Logto JavaScript Client SDK written in TypeScript.
 
 ## Installation
 
@@ -42,7 +42,7 @@ To implement a platform-specific SDK, you should implement the following adapter
 5. generateCodeVerifier: generate code verifier.
 6. generateCodeChallenge: generate code challenge.
 
-See the [adapters.ts](./src/adapter.ts) for more information.
+See the [adapters](./src/adapter/index.ts) for more information.
 
 ## Resources
 

package/lib/client.d.ts

@@ -17,6 +17,10 @@ export type SignInOptions = {
      * Note: If specified, it will override the prompt value in Logto configs.
      */
     prompt?: SignInUriParameters['prompt'];
+    /**
+     * Clear cached tokens from storage before sign-in. Defaults to: `true`
+     */
+    clearTokens?: boolean;
 } & Pick<SignInUriParameters, 'interactionMode' | 'firstScreen' | 'identifiers' | 'loginHint' | 'directSignIn' | 'extraParams'>;
 /**
  * The Logto base client class that provides the essential methods for

package/lib/client.js

@@ -115,7 +115,7 @@ class StandardLogtoClient {
     async getIdTokenClaims() {
         const idToken = await this.getIdToken();
         if (!idToken) {
-            throw new LogtoClientError('not_authenticated');
+            throw new LogtoClientError('not_authenticated', 'ID token not found');
         }
         return decodeIdToken(idToken);
     }
@@ -158,7 +158,7 @@ class StandardLogtoClient {
         return fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
     async signIn(options, mode, hint) {
-        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, identifiers, interactionMode, loginHint, directSignIn, extraParams, prompt, } = typeof options === 'string' || options instanceof URL
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, identifiers, interactionMode, loginHint, directSignIn, extraParams, prompt, clearTokens, } = typeof options === 'string' || options instanceof URL
             ? {
                 redirectUri: options,
                 postRedirectUri: undefined,
@@ -169,6 +169,7 @@ class StandardLogtoClient {
                 directSignIn: undefined,
                 extraParams: undefined,
                 prompt: undefined,
+                clearTokens: true,
             }
             : options;
         const redirectUri = redirectUriUrl.toString();
@@ -198,7 +199,7 @@ class StandardLogtoClient {
         });
         await Promise.all([
             this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),
-            this.clearAllTokens(),
+            clearTokens === false ? undefined : this.clearAllTokens(),
         ]);
         await this.adapter.navigate(signInUri, { redirectUri, for: 'sign-in' });
     }
@@ -272,7 +273,7 @@ class StandardLogtoClient {
     async getAccessTokenByRefreshToken(resource, organizationId) {
         const currentRefreshToken = await this.getRefreshToken();
         if (!currentRefreshToken) {
-            throw new LogtoClientError('not_authenticated');
+            throw new LogtoClientError('not_authenticated', 'Refresh token not found');
         }
         const accessTokenKey = buildAccessTokenKey(resource, organizationId);
         const { appId: clientId } = this.logtoConfig;

package/lib/mock.d.ts

@@ -36,22 +36,22 @@ export declare const accessToken = "access_token_value";
 export declare const refreshToken = "new_refresh_token_value";
 export declare const idToken = "id_token_value";
 export declare const currentUnixTimeStamp: number;
-export declare const mockFetchOidcConfig: (delay?: number) => Mock<unknown[], Promise<OidcConfigResponse>>;
-export declare const fetchOidcConfig: Mock<unknown[], Promise<OidcConfigResponse>>;
-export declare const requester: Mock<any, any>;
-export declare const failingRequester: Mock<any, any>;
-export declare const navigate: Mock<any, any>;
-export declare const generateCodeChallenge: Mock<[], Promise<string>>;
-export declare const generateCodeVerifier: Mock<[], string>;
-export declare const generateState: Mock<[], string>;
+export declare const mockFetchOidcConfig: (delay?: number) => Mock<() => Promise<OidcConfigResponse>>;
+export declare const fetchOidcConfig: Mock<() => Promise<OidcConfigResponse>>;
+export declare const requester: Mock<(...args: any[]) => any>;
+export declare const failingRequester: Mock<(...args: any[]) => any>;
+export declare const navigate: Mock<(...args: any[]) => any>;
+export declare const generateCodeChallenge: Mock<() => Promise<string>>;
+export declare const generateCodeVerifier: Mock<() => string>;
+export declare const generateState: Mock<() => string>;
 export declare const createAdapters: (withCache?: boolean) => {
-    requester: Mock<any, any>;
+    requester: Mock<(...args: any[]) => any>;
     storage: MockedStorage;
     unstable_cache: import("@silverhand/essentials").Optional<MockedStorage>;
-    navigate: Mock<any, any>;
-    generateCodeChallenge: Mock<[], Promise<string>>;
-    generateCodeVerifier: Mock<[], string>;
-    generateState: Mock<[], string>;
+    navigate: Mock<(...args: any[]) => any>;
+    generateCodeChallenge: Mock<() => Promise<string>>;
+    generateCodeVerifier: Mock<() => string>;
+    generateState: Mock<() => string>;
 };
 export declare const createClient: (prompt?: Prompt, storage?: MockedStorage, withCache?: boolean, scopes?: string[]) => LogtoClientWithAccessors;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/client",
-  "version": "3.0.3",
+  "version": "3.1.1",
   "type": "module",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -24,20 +24,20 @@
     "@silverhand/essentials": "^2.9.2",
     "camelcase-keys": "^9.1.3",
     "jose": "^5.2.2",
-    "@logto/js": "^5.0.2"
+    "@logto/js": "^5.1.0"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",
     "@silverhand/ts-config": "^6.0.0",
     "@types/node": "^22.0.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^2.1.9",
     "eslint": "^8.57.0",
-    "happy-dom": "^15.10.2",
+    "happy-dom": "^16.0.0",
     "lint-staged": "^15.0.0",
     "nock": "14.0.0-beta.19",
     "prettier": "^3.0.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.9"
   },
   "eslintConfig": {
     "extends": "@silverhand"