auth0 - npm Package Compare versions

Comparing version 4.16.0 to 4.17.0

dist/cjs/deprecations.d.ts

@@ -18,2 +18,3 @@ import { EmailProviderCreate, EmailProviderUpdate, EmailProviderUpdateCredentials, ClientCreateOidcLogout, ClientOidcLogout, ClientUpdateOidcLogout, PostOrganizations201ResponseEnabledConnectionsInnerConnection } from './management/__generated/models/index.js';
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
@@ -36,2 +37,3 @@ /**
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
@@ -38,0 +40,0 @@ /**

dist/cjs/management/__generated/managers/email-templates-manager.d.ts

@@ -10,3 +10,3 @@ import * as runtime from '../../../lib/runtime.js';
     /**
-     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
+     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
      * Get an email template
@@ -13,0 +13,0 @@ *

dist/cjs/management/__generated/managers/email-templates-manager.js

@@ -34,3 +34,3 @@ "use strict";
     /**
-     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
+     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
      * Get an email template
@@ -37,0 +37,0 @@ *

dist/cjs/management/__generated/managers/prompts-manager.d.ts

 import * as runtime from '../../../lib/runtime.js';
 import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
-import type { GetRendering200Response, PatchRenderingRequest, PromptsSettings, PromptsSettingsUpdate, GetCustomTextByLanguageRequest, GetPartialsRequest, GetRenderingRequest, PatchRenderingOperationRequest, PutCustomTextByLanguageRequest, PutPartialsRequest } from '../models/index.js';
+import type { GetRendering200Response, PatchRendering200Response, PatchRenderingRequest, PromptsSettings, PromptsSettingsUpdate, GetCustomTextByLanguageRequest, GetPartialsRequest, GetRenderingRequest, PatchRenderingOperationRequest, PutCustomTextByLanguageRequest, PutPartialsRequest } from '../models/index.js';
 declare const BaseAPI: typeof runtime.BaseAPI;
@@ -35,4 +35,4 @@ /**
     /**
-     * View the render settings for a specific screen
-     * Get render settings for a prompt
+     * Get render settings for a screen.
+     * Get render settings for a screen
      *
@@ -50,8 +50,36 @@ * @throws {RequiredError}
     /**
-     * Configure the render settings for a specific screen
-     * Configure render settings for a prompt
+     * Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.
      *
+     * <p>
+     *   Example <code>head_tags</code> array. See our <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>documentation</a> on using Liquid variables within head tags.
+     * </p>
+     * <pre>{
+     *   "head_tags": [
+     *     {
+     *       "tag": "script",
+     *       "attributes": {
+     *         "defer": true,
+     *         "src": "URL_TO_ASSET",
+     *         "async": true,
+     *         "integrity": [
+     *           "ASSET_SHA"
+     *         ]
+     *       }
+     *     },
+     *     {
+     *       "tag": "link",
+     *       "attributes": {
+     *         "href": "URL_TO_ASSET",
+     *         "rel": "stylesheet"
+     *       }
+     *     }
+     *   ]
+     * }
+     * </pre>
+     *
+     * Update render settings for a screen
+     *
      * @throws {RequiredError}
      */
-    updateRendering(requestParameters: PatchRenderingOperationRequest, bodyParameters: PatchRenderingRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    updateRendering(requestParameters: PatchRenderingOperationRequest, bodyParameters: PatchRenderingRequest, initOverrides?: InitOverride): Promise<ApiResponse<PatchRendering200Response>>;
     /**
@@ -58,0 +86,0 @@ * Set custom text for a specific prompt. Existing texts will be overwritten.

dist/cjs/management/__generated/managers/prompts-manager.js

@@ -77,4 +77,4 @@ "use strict";
     /**
-     * View the render settings for a specific screen
-     * Get render settings for a prompt
+     * Get render settings for a screen.
+     * Get render settings for a screen
      *
@@ -111,5 +111,33 @@ * @throws {RequiredError}
     /**
-     * Configure the render settings for a specific screen
-     * Configure render settings for a prompt
+     * Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.
      *
+     * <p>
+     *   Example <code>head_tags</code> array. See our <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>documentation</a> on using Liquid variables within head tags.
+     * </p>
+     * <pre>{
+     *   "head_tags": [
+     *     {
+     *       "tag": "script",
+     *       "attributes": {
+     *         "defer": true,
+     *         "src": "URL_TO_ASSET",
+     *         "async": true,
+     *         "integrity": [
+     *           "ASSET_SHA"
+     *         ]
+     *       }
+     *     },
+     *     {
+     *       "tag": "link",
+     *       "attributes": {
+     *         "href": "URL_TO_ASSET",
+     *         "rel": "stylesheet"
+     *       }
+     *     }
+     *   ]
+     * }
+     * </pre>
+     *
+     * Update render settings for a screen
+     *
      * @throws {RequiredError}
@@ -129,3 +157,3 @@ */
         }, initOverrides);
-        return runtime.VoidApiResponse.fromResponse(response);
+        return runtime.JSONApiResponse.fromResponse(response);
     }
@@ -132,0 +160,0 @@ /**

dist/cjs/management/management-client-options.d.ts

@@ -7,3 +7,3 @@ import { ClientOptions } from '../lib/runtime.js';
 export interface ManagementClientOptionsWithToken extends ManagementClientOptions {
-    token: string;
+    token: string | (() => Promise<string>) | (() => string);
 }
@@ -10,0 +10,0 @@ export interface ManagementClientOptionsWithClientSecret extends ManagementClientOptions {

dist/cjs/management/token-provider-middleware.d.ts

 import { FetchParams, Middleware, RequestContext } from '../lib/runtime.js';
 import { ManagementClientOptionsWithClientCredentials, ManagementClientOptionsWithToken } from './management-client-options.js';
 export declare class TokenProviderMiddleware implements Middleware {
-    private tokenProvider;
+    private readonly tokenProvider;
     constructor(options: ManagementClientOptionsWithToken | ManagementClientOptionsWithClientCredentials);
     pre?(context: RequestContext): Promise<FetchParams | void>;
 }

dist/cjs/management/token-provider-middleware.js

@@ -5,2 +5,3 @@ "use strict";
 const token_provider_js_1 = require("./token-provider.js");
+const utils_js_1 = require("../utils.js");
 class TokenProviderMiddleware {
@@ -11,3 +12,3 @@ constructor(options) {
             this.tokenProvider = {
-                getAccessToken: () => Promise.resolve(options.token),
+                getAccessToken: () => (0, utils_js_1.resolveValueToPromise)(options.token),
             };
@@ -14,0 +15,0 @@ }

dist/cjs/utils.d.ts

@@ -15,1 +15,15 @@ /**
 export declare const mtlsPrefix = "mtls";
+type SyncGetter<T> = () => T;
+type AsyncGetter<T> = () => Promise<T>;
+/**
+ * Resolves a value that can be a static value, a synchronous function, or an asynchronous function.
+ *
+ * @template T - The type of the value to be resolved.
+ * @param {T | SyncGetter<T> | AsyncGetter<T>} value - The value to be resolved. It can be:
+ *   - A static value of type T.
+ *   - A synchronous function that returns a value of type T.
+ *   - An asynchronous function that returns a Promise of type T.
+ * @returns {Promise<T>} A promise that resolves to the value of type T.
+ */
+export declare const resolveValueToPromise: <T>(value: T | SyncGetter<T> | AsyncGetter<T>) => Promise<T>;
+export {};

dist/cjs/utils.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mtlsPrefix = exports.generateClientInfo = void 0;
+exports.resolveValueToPromise = exports.mtlsPrefix = exports.generateClientInfo = void 0;
 const version_js_1 = require("./version.js");
@@ -20,2 +20,20 @@ /**
 exports.mtlsPrefix = 'mtls';
+/**
+ * Resolves a value that can be a static value, a synchronous function, or an asynchronous function.
+ *
+ * @template T - The type of the value to be resolved.
+ * @param {T | SyncGetter<T> | AsyncGetter<T>} value - The value to be resolved. It can be:
+ *   - A static value of type T.
+ *   - A synchronous function that returns a value of type T.
+ *   - An asynchronous function that returns a Promise of type T.
+ * @returns {Promise<T>} A promise that resolves to the value of type T.
+ */
+const resolveValueToPromise = async (value) => {
+    if (typeof value === 'function') {
+        const result = value(); // Call the function
+        return result instanceof Promise ? result : Promise.resolve(result); // Handle sync/async
+    }
+    return Promise.resolve(value); // Static value
+};
+exports.resolveValueToPromise = resolveValueToPromise;
 //# sourceMappingURL=utils.js.map

dist/cjs/version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "4.16.0";
+export declare const version = "4.17.0";

dist/cjs/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '4.16.0';
+exports.version = '4.17.0';
 //# sourceMappingURL=version.js.map

dist/esm/deprecations.d.ts

@@ -18,2 +18,3 @@ import { EmailProviderCreate, EmailProviderUpdate, EmailProviderUpdateCredentials, ClientCreateOidcLogout, ClientOidcLogout, ClientUpdateOidcLogout, PostOrganizations201ResponseEnabledConnectionsInnerConnection } from './management/__generated/models/index.js';
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
@@ -36,2 +37,3 @@ /**
     readonly ms365: "ms365";
+    readonly custom: "custom";
 };
@@ -38,0 +40,0 @@ /**

dist/esm/management/__generated/managers/email-templates-manager.d.ts

@@ -10,3 +10,3 @@ import * as runtime from '../../../lib/runtime.js';
     /**
-     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
+     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
      * Get an email template
@@ -13,0 +13,0 @@ *

dist/esm/management/__generated/managers/email-templates-manager.js

@@ -8,3 +8,3 @@ import * as runtime from '../../../lib/runtime.js';
     /**
-     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
+     * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
      * Get an email template
@@ -11,0 +11,0 @@ *

dist/esm/management/__generated/managers/prompts-manager.d.ts

 import * as runtime from '../../../lib/runtime.js';
 import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
-import type { GetRendering200Response, PatchRenderingRequest, PromptsSettings, PromptsSettingsUpdate, GetCustomTextByLanguageRequest, GetPartialsRequest, GetRenderingRequest, PatchRenderingOperationRequest, PutCustomTextByLanguageRequest, PutPartialsRequest } from '../models/index.js';
+import type { GetRendering200Response, PatchRendering200Response, PatchRenderingRequest, PromptsSettings, PromptsSettingsUpdate, GetCustomTextByLanguageRequest, GetPartialsRequest, GetRenderingRequest, PatchRenderingOperationRequest, PutCustomTextByLanguageRequest, PutPartialsRequest } from '../models/index.js';
 declare const BaseAPI: typeof runtime.BaseAPI;
@@ -35,4 +35,4 @@ /**
     /**
-     * View the render settings for a specific screen
-     * Get render settings for a prompt
+     * Get render settings for a screen.
+     * Get render settings for a screen
      *
@@ -50,8 +50,36 @@ * @throws {RequiredError}
     /**
-     * Configure the render settings for a specific screen
-     * Configure render settings for a prompt
+     * Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.
      *
+     * <p>
+     *   Example <code>head_tags</code> array. See our <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>documentation</a> on using Liquid variables within head tags.
+     * </p>
+     * <pre>{
+     *   "head_tags": [
+     *     {
+     *       "tag": "script",
+     *       "attributes": {
+     *         "defer": true,
+     *         "src": "URL_TO_ASSET",
+     *         "async": true,
+     *         "integrity": [
+     *           "ASSET_SHA"
+     *         ]
+     *       }
+     *     },
+     *     {
+     *       "tag": "link",
+     *       "attributes": {
+     *         "href": "URL_TO_ASSET",
+     *         "rel": "stylesheet"
+     *       }
+     *     }
+     *   ]
+     * }
+     * </pre>
+     *
+     * Update render settings for a screen
+     *
      * @throws {RequiredError}
      */
-    updateRendering(requestParameters: PatchRenderingOperationRequest, bodyParameters: PatchRenderingRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    updateRendering(requestParameters: PatchRenderingOperationRequest, bodyParameters: PatchRenderingRequest, initOverrides?: InitOverride): Promise<ApiResponse<PatchRendering200Response>>;
     /**
@@ -58,0 +86,0 @@ * Set custom text for a specific prompt. Existing texts will be overwritten.

dist/esm/management/__generated/managers/prompts-manager.js

@@ -51,4 +51,4 @@ import * as runtime from '../../../lib/runtime.js';
     /**
-     * View the render settings for a specific screen
-     * Get render settings for a prompt
+     * Get render settings for a screen.
+     * Get render settings for a screen
      *
@@ -85,5 +85,33 @@ * @throws {RequiredError}
     /**
-     * Configure the render settings for a specific screen
-     * Configure render settings for a prompt
+     * Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.
      *
+     * <p>
+     *   Example <code>head_tags</code> array. See our <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>documentation</a> on using Liquid variables within head tags.
+     * </p>
+     * <pre>{
+     *   "head_tags": [
+     *     {
+     *       "tag": "script",
+     *       "attributes": {
+     *         "defer": true,
+     *         "src": "URL_TO_ASSET",
+     *         "async": true,
+     *         "integrity": [
+     *           "ASSET_SHA"
+     *         ]
+     *       }
+     *     },
+     *     {
+     *       "tag": "link",
+     *       "attributes": {
+     *         "href": "URL_TO_ASSET",
+     *         "rel": "stylesheet"
+     *       }
+     *     }
+     *   ]
+     * }
+     * </pre>
+     *
+     * Update render settings for a screen
+     *
      * @throws {RequiredError}
@@ -103,3 +131,3 @@ */
         }, initOverrides);
-        return runtime.VoidApiResponse.fromResponse(response);
+        return runtime.JSONApiResponse.fromResponse(response);
     }
@@ -106,0 +134,0 @@ /**

dist/esm/management/management-client-options.d.ts

@@ -7,3 +7,3 @@ import { ClientOptions } from '../lib/runtime.js';
 export interface ManagementClientOptionsWithToken extends ManagementClientOptions {
-    token: string;
+    token: string | (() => Promise<string>) | (() => string);
 }
@@ -10,0 +10,0 @@ export interface ManagementClientOptionsWithClientSecret extends ManagementClientOptions {

dist/esm/management/token-provider-middleware.d.ts

 import { FetchParams, Middleware, RequestContext } from '../lib/runtime.js';
 import { ManagementClientOptionsWithClientCredentials, ManagementClientOptionsWithToken } from './management-client-options.js';
 export declare class TokenProviderMiddleware implements Middleware {
-    private tokenProvider;
+    private readonly tokenProvider;
     constructor(options: ManagementClientOptionsWithToken | ManagementClientOptionsWithClientCredentials);
     pre?(context: RequestContext): Promise<FetchParams | void>;
 }

dist/esm/management/token-provider-middleware.js

 import { TokenProvider } from './token-provider.js';
+import { resolveValueToPromise } from '../utils.js';
 export class TokenProviderMiddleware {
@@ -7,3 +8,3 @@ constructor(options) {
             this.tokenProvider = {
-                getAccessToken: () => Promise.resolve(options.token),
+                getAccessToken: () => resolveValueToPromise(options.token),
             };
@@ -10,0 +11,0 @@ }

dist/esm/utils.d.ts

@@ -15,1 +15,15 @@ /**
 export declare const mtlsPrefix = "mtls";
+type SyncGetter<T> = () => T;
+type AsyncGetter<T> = () => Promise<T>;
+/**
+ * Resolves a value that can be a static value, a synchronous function, or an asynchronous function.
+ *
+ * @template T - The type of the value to be resolved.
+ * @param {T | SyncGetter<T> | AsyncGetter<T>} value - The value to be resolved. It can be:
+ *   - A static value of type T.
+ *   - A synchronous function that returns a value of type T.
+ *   - An asynchronous function that returns a Promise of type T.
+ * @returns {Promise<T>} A promise that resolves to the value of type T.
+ */
+export declare const resolveValueToPromise: <T>(value: T | SyncGetter<T> | AsyncGetter<T>) => Promise<T>;
+export {};

dist/esm/utils.js

@@ -16,2 +16,19 @@ import { version } from './version.js';
 export const mtlsPrefix = 'mtls';
+/**
+ * Resolves a value that can be a static value, a synchronous function, or an asynchronous function.
+ *
+ * @template T - The type of the value to be resolved.
+ * @param {T | SyncGetter<T> | AsyncGetter<T>} value - The value to be resolved. It can be:
+ *   - A static value of type T.
+ *   - A synchronous function that returns a value of type T.
+ *   - An asynchronous function that returns a Promise of type T.
+ * @returns {Promise<T>} A promise that resolves to the value of type T.
+ */
+export const resolveValueToPromise = async (value) => {
+    if (typeof value === 'function') {
+        const result = value(); // Call the function
+        return result instanceof Promise ? result : Promise.resolve(result); // Handle sync/async
+    }
+    return Promise.resolve(value); // Static value
+};
 //# sourceMappingURL=utils.js.map

dist/esm/version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "4.16.0";
+export declare const version = "4.17.0";

dist/esm/version.js

@@ -1,2 +0,2 @@
-export const version = '4.16.0';
+export const version = '4.17.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "auth0",
-  "version": "4.16.0",
+  "version": "4.17.0",
   "description": "SDK for Auth0 API v2",
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.js",

No alert changes

Improved metrics

Total package byte prevSize

2693554

increased by0.59%

Lines of code

69048

increased by0.58%

No dependency changes