@logto/js 2.1.0 → 2.1.2

package/lib/consts/index.cjs

@@ -32,9 +32,19 @@ exports.QueryKey = void 0;
     // Need to align with the OIDC extraParams settings in core
     QueryKey["InteractionMode"] = "interaction_mode";
 })(exports.QueryKey || (exports.QueryKey = {}));
+/** The prompt parameter to be used for the authorization request. */
 exports.Prompt = void 0;
 (function (Prompt) {
+    /**
+     * The Authorization Server MUST prompt the End-User for consent
+     * before returning information to the Client.
+     */
     Prompt["Consent"] = "consent";
+    /**
+     * The Authorization Server MUST prompt the End-User for re-authentication,
+     * forcing the user to log in again. Note the there'll be no Refresh Token
+     * returned in this case.
+     */
     Prompt["Login"] = "login";
 })(exports.Prompt || (exports.Prompt = {}));
 // TODO: @sijie @charles find a proper way to sync scopes constants with core

package/lib/consts/index.d.ts

@@ -29,8 +29,18 @@ export declare enum QueryKey {
     Token = "token",
     InteractionMode = "interaction_mode"
 }
+/** The prompt parameter to be used for the authorization request. */
 export declare enum Prompt {
+    /**
+     * The Authorization Server MUST prompt the End-User for consent
+     * before returning information to the Client.
+     */
     Consent = "consent",
+    /**
+     * The Authorization Server MUST prompt the End-User for re-authentication,
+     * forcing the user to log in again. Note the there'll be no Refresh Token
+     * returned in this case.
+     */
     Login = "login"
 }
 export declare enum ReservedScope {

package/lib/consts/index.js

@@ -30,9 +30,19 @@ var QueryKey;
     // Need to align with the OIDC extraParams settings in core
     QueryKey["InteractionMode"] = "interaction_mode";
 })(QueryKey || (QueryKey = {}));
+/** The prompt parameter to be used for the authorization request. */
 var Prompt;
 (function (Prompt) {
+    /**
+     * The Authorization Server MUST prompt the End-User for consent
+     * before returning information to the Client.
+     */
     Prompt["Consent"] = "consent";
+    /**
+     * The Authorization Server MUST prompt the End-User for re-authentication,
+     * forcing the user to log in again. Note the there'll be no Refresh Token
+     * returned in this case.
+     */
     Prompt["Login"] = "login";
 })(Prompt || (Prompt = {}));
 // TODO: @sijie @charles find a proper way to sync scopes constants with core

package/lib/types/index.d.ts

@@ -2,5 +2,16 @@ export type LogtoRequestErrorBody = {
     code: string;
     message: string;
 };
+/**
+ * A request function that accepts a `fetch`-like function parameters and returns
+ * a promise with the parsed response body.
+ */
 export type Requester = <T>(...args: Parameters<typeof fetch>) => Promise<T>;
+/**
+ * The interaction mode to be used for the authorization request. Note it's not
+ * a part of the OIDC standard, but a Logto-specific extension.
+ *
+ * - `signIn`: The authorization request will be initiated with a sign-in page.
+ * - `signUp`: The authorization request will be initiated with a sign-up page.
+ */
 export type InteractionMode = 'signIn' | 'signUp';

package/lib/utils/access-token.cjs

@@ -2,7 +2,6 @@
 
 var essentials = require('@silverhand/essentials');
 var arbitraryObject = require('./arbitrary-object.cjs');
-var errors = require('./errors.cjs');
 
 // https://docs.logto.io/docs/recipes/protect-your-api/
 function assertAccessTokenClaims(data) {
@@ -29,7 +28,8 @@ function assertAccessTokenClaims(data) {
 const decodeAccessToken = (accessToken) => {
     const { 1: encodedPayload } = accessToken.split('.');
     if (!encodedPayload) {
-        throw new errors.LogtoError('access_token.invalid_token');
+        // Non-JWT format token string
+        return {};
     }
     const json = essentials.urlSafeBase64.decode(encodedPayload);
     const accessTokenClaims = JSON.parse(json);

package/lib/utils/access-token.js

@@ -1,6 +1,5 @@
 import { urlSafeBase64 } from '@silverhand/essentials';
 import { isArbitraryObject } from './arbitrary-object.js';
-import { LogtoError } from './errors.js';
 
 // https://docs.logto.io/docs/recipes/protect-your-api/
 function assertAccessTokenClaims(data) {
@@ -27,7 +26,8 @@ function assertAccessTokenClaims(data) {
 const decodeAccessToken = (accessToken) => {
     const { 1: encodedPayload } = accessToken.split('.');
     if (!encodedPayload) {
-        throw new LogtoError('access_token.invalid_token');
+        // Non-JWT format token string
+        return {};
     }
     const json = urlSafeBase64.decode(encodedPayload);
     const accessTokenClaims = JSON.parse(json);

package/lib/utils/errors.cjs

@@ -12,7 +12,6 @@ const logtoErrorCodes = Object.freeze({
     'callback_uri_verification.missing_code': 'Missing code in the callback URI',
     crypto_subtle_unavailable: 'Crypto.subtle is unavailable in insecure contexts (non-HTTPS).',
     unexpected_response_error: 'Unexpected response error from the server.',
-    'access_token.invalid_token': 'Invalid access token',
 });
 class LogtoError extends Error {
     constructor(code, data) {

package/lib/utils/errors.d.ts

@@ -8,7 +8,6 @@ declare const logtoErrorCodes: Readonly<{
     'callback_uri_verification.missing_code': "Missing code in the callback URI";
     crypto_subtle_unavailable: "Crypto.subtle is unavailable in insecure contexts (non-HTTPS).";
     unexpected_response_error: "Unexpected response error from the server.";
-    'access_token.invalid_token': "Invalid access token";
 }>;
 export type LogtoErrorCode = keyof typeof logtoErrorCodes;
 export declare class LogtoError extends Error {

package/lib/utils/errors.js

@@ -10,7 +10,6 @@ const logtoErrorCodes = Object.freeze({
     'callback_uri_verification.missing_code': 'Missing code in the callback URI',
     crypto_subtle_unavailable: 'Crypto.subtle is unavailable in insecure contexts (non-HTTPS).',
     unexpected_response_error: 'Unexpected response error from the server.',
-    'access_token.invalid_token': 'Invalid access token',
 });
 class LogtoError extends Error {
     constructor(code, data) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/js",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -25,19 +25,19 @@
     "jose": "^4.13.2"
   },
   "devDependencies": {
-    "@silverhand/eslint-config": "^3.0.1",
-    "@silverhand/ts-config": "^3.0.0",
+    "@silverhand/eslint-config": "^4.0.1",
+    "@silverhand/ts-config": "^4.0.0",
     "@swc/core": "^1.3.50",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.5.1",
     "@types/node": "^18.0.0",
-    "eslint": "^8.38.0",
+    "eslint": "^8.44.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
     "jest-matcher-specific-error": "^1.0.0",
     "lint-staged": "^13.0.0",
     "nock": "^13.3.0",
-    "prettier": "^2.8.7",
+    "prettier": "^3.0.0",
     "rollup": "^3.20.2",
     "text-encoder": "^0.0.4",
     "type-fest": "^3.0.0",