@logto/api 1.35.0 → 1.37.0

package/lib/management.d.ts

@@ -27,6 +27,20 @@ export type CreateManagementApiOptions = {
      */
     apiIndicator?: string;
 };
+/**
+ * Options for creating an API client with custom token authentication.
+ */
+export type CreateApiClientOptions = {
+    /**
+     * The base URL for the Management API.
+     */
+    baseUrl: string;
+    /**
+     * A function that returns a promise resolving to the access token.
+     * This function will be called for each request that requires authentication.
+     */
+    getToken: () => Promise<string>;
+};
 /**
  * Returns the base URL for the Management API based on the tenant ID.
  * @param tenantId The tenant ID to construct the base URL.
@@ -45,6 +59,31 @@ export declare const getManagementApiIndicator: (tenantId: string) => string;
  * This is used when requesting an access token for the Management API.
  */
 export declare const allScope = "all";
+/**
+ * Creates an API client with custom token authentication.
+ *
+ * This function is useful when you need full control over the authentication flow,
+ * such as custom token sources.
+ *
+ * The client automatically skips authentication for `.well-known` endpoints.
+ *
+ * @param options The options including base URL and token getter function.
+ * @returns A configured API client with type-safe methods.
+ * @example
+ * ```ts
+ * import { createApiClient } from '@logto/api/management';
+ *
+ * const client = createApiClient({
+ *   baseUrl: 'https://my-tenant.logto.app',
+ *   getToken: async () => getYourToken(),
+ * });
+ *
+ * const response = await client.GET('/api/applications/{id}', {
+ *   params: { path: { id: 'app-id' } },
+ * });
+ * ```
+ */
+export declare function createApiClient(options: CreateApiClientOptions): Client<paths>;
 type ManagementApiReturnType = {
     /**
      * The API client for the Management API.

package/lib/management.js

@@ -18,6 +18,45 @@ export const getManagementApiIndicator = (tenantId) => `${getBaseUrl(tenantId)}/
  * This is used when requesting an access token for the Management API.
  */
 export const allScope = 'all';
+/**
+ * Creates an API client with custom token authentication.
+ *
+ * This function is useful when you need full control over the authentication flow,
+ * such as custom token sources.
+ *
+ * The client automatically skips authentication for `.well-known` endpoints.
+ *
+ * @param options The options including base URL and token getter function.
+ * @returns A configured API client with type-safe methods.
+ * @example
+ * ```ts
+ * import { createApiClient } from '@logto/api/management';
+ *
+ * const client = createApiClient({
+ *   baseUrl: 'https://my-tenant.logto.app',
+ *   getToken: async () => getYourToken(),
+ * });
+ *
+ * const response = await client.GET('/api/applications/{id}', {
+ *   params: { path: { id: 'app-id' } },
+ * });
+ * ```
+ */
+export function createApiClient(options) {
+    const { baseUrl, getToken } = options;
+    const client = createClient({ baseUrl });
+    client.use({
+        async onRequest({ schemaPath, request }) {
+            if (schemaPath.includes('/.well-known/')) {
+                return;
+            }
+            const token = await getToken();
+            request.headers.set('Authorization', `Bearer ${token}`);
+            return request;
+        },
+    });
+    return client;
+}
 /**
  * Creates a Management API client with the specified tenant ID and options.
  *
@@ -72,21 +111,14 @@ export function createManagementApi(tenantId, options) {
             scope: allScope,
         },
     });
-    const apiClient = createClient({
+    const apiClient = createApiClient({
         baseUrl,
-    });
-    apiClient.use({
-        async onRequest({ schemaPath, request }) {
-            if (schemaPath.includes('/.well-known/')) {
-                // Skip auth for well-known endpoints
-                return;
-            }
+        getToken: async () => {
             const { value, scope } = await clientCredentials.getAccessToken();
             if (scope !== allScope) {
                 console.warn(`The scope "${scope}" is not equal to the expected value "${allScope}". This may cause issues with API access. See https://a.logto.io/m2m-mapi to learn more about configuring machine-to-machine access to the Management API.`);
             }
-            request.headers.set('Authorization', `Bearer ${value}`);
-            return request;
+            return value;
         },
     });
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/api",
-  "version": "1.35.0",
+  "version": "1.37.0",
   "description": "Logto API types and clients.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "homepage": "https://github.com/logto-io/logto#readme",
@@ -11,9 +11,9 @@
   },
   "exports": {
     "./management": {
-      "default": "./lib/management.js",
       "types": "./lib/management.d.ts",
-      "import": "./lib/management.js"
+      "import": "./lib/management.js",
+      "default": "./lib/management.js"
     }
   },
   "files": [
@@ -37,6 +37,7 @@
     "@silverhand/ts-config": "6.0.0",
     "@vitest/coverage-v8": "^3.1.1",
     "eslint": "^8.57.0",
+    "lint-staged": "^15.0.0",
     "openapi-typescript": "^7.8.0",
     "prettier": "^3.5.3",
     "typescript": "^5.5.3",