@logto/js 4.1.2 → 4.1.4

package/lib/core/sign-in.d.ts

@@ -1,11 +1,10 @@
 import { Prompt } from '../consts/index.js';
 import type { FirstScreen, InteractionMode } from '../types/index.js';
-/** @experimental Don't use this type as it's under development. */
 export type DirectSignInOptions = {
     /**
      * The method to be used for the direct sign-in.
      */
-    method: 'social';
+    method: 'social' | 'sso';
     /**
      * The target to be used for the direct sign-in.
      *
@@ -24,8 +23,6 @@ export type SignInUriParameters = {
     prompt?: Prompt | Prompt[];
     /**
      * The first screen to be shown in the sign-in experience.
-     *
-     * @experimental Don't use this field as it's under development.
      */
     firstScreen?: FirstScreen;
     /** The first screen to be shown in the sign-in experience. */
@@ -39,7 +36,7 @@ export type SignInUriParameters = {
     /**
      * Parameters for direct sign-in.
      *
-     * @experimental Don't use this field as it's under development.
+     * @see {@link https://docs.logto.io/docs/references/openid-connect/authentication-parameters/#direct-sign-in Direct sign-in} for more information.
      */
     directSignIn?: DirectSignInOptions;
     /**

package/lib/index.cjs

@@ -32,6 +32,7 @@ exports.LogtoError = errors.LogtoError;
 exports.LogtoRequestError = errors.LogtoRequestError;
 exports.OidcError = errors.OidcError;
 exports.isLogtoRequestError = errors.isLogtoRequestError;
+exports.isLogtoRequestErrorJson = errors.isLogtoRequestErrorJson;
 exports.decodeIdToken = idToken.decodeIdToken;
 exports.decodeAccessToken = accessToken.decodeAccessToken;
 exports.withDefaultScopes = scopes.withDefaultScopes;

package/lib/index.js

@@ -5,7 +5,7 @@ export { generateSignInUri } from './core/sign-in.js';
 export { generateSignOutUri } from './core/sign-out.js';
 export { fetchUserInfo } from './core/user-info.js';
 export { parseUriParameters, verifyAndParseCodeFromCallbackUri } from './utils/callback-uri.js';
-export { LogtoError, LogtoRequestError, OidcError, isLogtoRequestError } from './utils/errors.js';
+export { LogtoError, LogtoRequestError, OidcError, isLogtoRequestError, isLogtoRequestErrorJson } from './utils/errors.js';
 export { decodeIdToken } from './utils/id-token.js';
 export { decodeAccessToken } from './utils/access-token.js';
 export { withDefaultScopes, withReservedScopes } from './utils/scopes.js';

package/lib/utils/errors.cjs

@@ -18,24 +18,36 @@ class LogtoError extends Error {
         super(logtoErrorCodes[code]);
         this.code = code;
         this.data = data;
+        this.name = 'LogtoError';
     }
 }
 const isLogtoRequestError = (data) => {
+    if (!arbitraryObject.isArbitraryObject(data)) {
+        return false;
+    }
+    return data instanceof Error && data.name === 'LogtoRequestError';
+};
+const isLogtoRequestErrorJson = (data) => {
     if (!arbitraryObject.isArbitraryObject(data)) {
         return false;
     }
     return typeof data.code === 'string' && typeof data.message === 'string';
 };
 class LogtoRequestError extends Error {
-    constructor(code, message) {
+    constructor(code, message, 
+    /** The original response object from the server. */
+    cause) {
         super(message);
         this.code = code;
+        this.cause = cause;
+        this.name = 'LogtoRequestError';
     }
 }
 class OidcError {
     constructor(error, errorDescription) {
         this.error = error;
         this.errorDescription = errorDescription;
+        this.name = 'OidcError';
     }
 }
 
@@ -43,3 +55,4 @@ exports.LogtoError = LogtoError;
 exports.LogtoRequestError = LogtoRequestError;
 exports.OidcError = OidcError;
 exports.isLogtoRequestError = isLogtoRequestError;
+exports.isLogtoRequestErrorJson = isLogtoRequestErrorJson;

package/lib/utils/errors.d.ts

@@ -12,20 +12,28 @@ declare const logtoErrorCodes: Readonly<{
 export type LogtoErrorCode = keyof typeof logtoErrorCodes;
 export declare class LogtoError extends Error {
     code: LogtoErrorCode;
-    data: unknown;
+    data?: unknown;
+    name: string;
     constructor(code: LogtoErrorCode, data?: unknown);
 }
-export declare const isLogtoRequestError: (data: unknown) => data is {
+export declare const isLogtoRequestError: (data: unknown) => data is LogtoRequestError;
+export declare const isLogtoRequestErrorJson: (data: unknown) => data is {
     code: string;
     message: string;
 };
 export declare class LogtoRequestError extends Error {
     code: string;
-    constructor(code: string, message: string);
+    /** The original response object from the server. */
+    cause?: Response | undefined;
+    name: string;
+    constructor(code: string, message: string, 
+    /** The original response object from the server. */
+    cause?: Response | undefined);
 }
 export declare class OidcError {
     error: string;
     errorDescription?: string | undefined;
+    name: string;
     constructor(error: string, errorDescription?: string | undefined);
 }
 export {};

package/lib/utils/errors.js

@@ -16,25 +16,37 @@ class LogtoError extends Error {
         super(logtoErrorCodes[code]);
         this.code = code;
         this.data = data;
+        this.name = 'LogtoError';
     }
 }
 const isLogtoRequestError = (data) => {
+    if (!isArbitraryObject(data)) {
+        return false;
+    }
+    return data instanceof Error && data.name === 'LogtoRequestError';
+};
+const isLogtoRequestErrorJson = (data) => {
     if (!isArbitraryObject(data)) {
         return false;
     }
     return typeof data.code === 'string' && typeof data.message === 'string';
 };
 class LogtoRequestError extends Error {
-    constructor(code, message) {
+    constructor(code, message, 
+    /** The original response object from the server. */
+    cause) {
         super(message);
         this.code = code;
+        this.cause = cause;
+        this.name = 'LogtoRequestError';
     }
 }
 class OidcError {
     constructor(error, errorDescription) {
         this.error = error;
         this.errorDescription = errorDescription;
+        this.name = 'OidcError';
     }
 }
 
-export { LogtoError, LogtoRequestError, OidcError, isLogtoRequestError };
+export { LogtoError, LogtoRequestError, OidcError, isLogtoRequestError, isLogtoRequestErrorJson };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/js",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -27,7 +27,7 @@
     "@silverhand/eslint-config": "^6.0.1",
     "@silverhand/ts-config": "^6.0.0",
     "@types/node": "^20.11.19",
-    "@vitest/coverage-v8": "^1.4.0",
+    "@vitest/coverage-v8": "^1.6.0",
     "angular-auth-oidc-client": "^17.0.0",
     "eslint": "^8.57.0",
     "happy-dom": "^14.0.0",
@@ -36,7 +36,7 @@
     "prettier": "^3.0.0",
     "rollup": "^4.0.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.4.0"
+    "vitest": "^1.6.0"
   },
   "eslintConfig": {
     "extends": "@silverhand"