auth0 4.0.0-beta.0 → 4.0.0-beta.10

package/dist/esm/auth/passwordless.js

@@ -0,0 +1,158 @@
+import { VoidApiResponse, validateRequiredRequestParams, } from '../lib/runtime.js';
+import { BaseAuthAPI, grant } from './base-auth-api.js';
+import { IDTokenValidator } from './id-token-validator.js';
+/**
+ * Handles passwordless flows using Email and SMS.
+ */
+export class Passwordless extends BaseAuthAPI {
+    constructor(configuration) {
+        super(configuration);
+        this.idTokenValidator = new IDTokenValidator(configuration);
+    }
+    /**
+     * Start passwordless flow sending an email.
+     *
+     * Given the user `email` address, it will send an email with:
+     *
+     * <ul>
+     *   <li>A link (default, `send:"link"`). You can then authenticate with this
+     *     user opening the link and he will be automatically logged in to the
+     *     application. Optionally, you can append/override parameters to the link
+     *     (like `scope`, `redirect_uri`, `protocol`, `response_type`, etc.) using
+     *     `authParams` object.
+     *   </li>
+     *   <li>
+     *     A verification code (`send:"code"`). You can then authenticate with
+     *     this user using the `/oauth/token` endpoint specifying `email` as
+     *     `username` and `code` as `password`.
+     *   </li>
+     * </ul>
+     *
+     * See: https://auth0.com/docs/api/authentication#get-code-or-link
+     *
+     * @example
+     * ```js
+     * const auth0 = new AuthenticationApi({
+     *    domain: 'my-domain.auth0.com',
+     *    clientId: 'myClientId',
+     *    clientSecret: 'myClientSecret'
+     * });
+     *
+     * await auth0.passwordless.sendEmail({
+     *   email: '{EMAIL}',
+     *   send: 'link',
+     *   authParams: {} // Optional auth params.
+     * });
+     * ```
+     */
+    async sendEmail(bodyParameters, initOverrides) {
+        validateRequiredRequestParams(bodyParameters, ['email']);
+        const response = await this.request({
+            path: '/passwordless/start',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: await this.addClientAuthentication({
+                client_id: this.clientId,
+                connection: 'email',
+                ...bodyParameters,
+            }),
+        }, initOverrides);
+        return VoidApiResponse.fromResponse(response);
+    }
+    /**
+     * Start passwordless flow sending an SMS.
+     *
+     * Given the user `phone_number`, it will send a SMS message with a
+     * verification code. You can then authenticate with this user using the
+     * `/oauth/token` endpoint specifying `phone_number` as `username` and `code` as
+     * `password`:
+     *
+     * See: https://auth0.com/docs/api/authentication#get-code-or-link
+     *
+     * @example
+     * ```js
+     * const auth0 = new AuthenticationApi({
+     *    domain: 'my-domain.auth0.com',
+     *    clientId: 'myClientId',
+     *    clientSecret: 'myClientSecret'
+     * });
+     *
+     * await auth0.passwordless.sendSMS({
+     *   phone_number: '{PHONE}'
+     * });
+     * ```
+     */
+    async sendSMS(bodyParameters, initOverrides) {
+        validateRequiredRequestParams(bodyParameters, ['phone_number']);
+        const response = await this.request({
+            path: '/passwordless/start',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: await this.addClientAuthentication({
+                client_id: this.clientId,
+                connection: 'sms',
+                ...bodyParameters,
+            }),
+        }, initOverrides);
+        return VoidApiResponse.fromResponse(response);
+    }
+    /**
+     * Once you have a verification code, use this endpoint to login the user with their email and verification code.
+     *
+     * @example
+     * ```js
+     * const auth0 = new AuthenticationApi({
+     *    domain: 'my-domain.auth0.com',
+     *    clientId: 'myClientId',
+     *    clientSecret: 'myClientSecret'
+     * });
+     *
+     * await auth0.passwordless.loginWithEmail({
+     *   email: 'foo@example.com',
+     *   code: 'ABC123'
+     * });
+     * ```
+     */
+    async loginWithEmail(bodyParameters, options = {}) {
+        validateRequiredRequestParams(bodyParameters, ['email', 'code']);
+        const { email: username, code: otp, ...otherParams } = bodyParameters;
+        return grant('http://auth0.com/oauth/grant-type/passwordless/otp', await this.addClientAuthentication({
+            username,
+            otp,
+            realm: 'email',
+            ...otherParams,
+        }), options, this.clientId, this.idTokenValidator, this.request.bind(this));
+    }
+    /**
+     * Once you have a verification code, use this endpoint to login the user with their phone number and verification code.
+     *
+     * @example
+     * ```js
+     * const auth0 = new AuthenticationApi({
+     *    domain: 'my-domain.auth0.com',
+     *    clientId: 'myClientId',
+     *    clientSecret: 'myClientSecret'
+     * });
+     *
+     * await auth0.passwordless.loginWithSMS({
+     *   phone_number: '0777777777',
+     *   code: 'ABC123'
+     * });
+     * ```
+     */
+    async loginWithSMS(bodyParameters, options = {}) {
+        validateRequiredRequestParams(bodyParameters, ['phone_number', 'code']);
+        const { phone_number: username, code: otp, ...otherParams } = bodyParameters;
+        return grant('http://auth0.com/oauth/grant-type/passwordless/otp', await this.addClientAuthentication({
+            username,
+            otp,
+            realm: 'sms',
+            ...otherParams,
+        }), options, this.clientId, this.idTokenValidator, this.request.bind(this));
+    }
+}
+//# sourceMappingURL=passwordless.js.map

package/dist/esm/auth/passwordless.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passwordless.js","sourceRoot":"","sources":["../../../src/auth/passwordless.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,EACf,6BAA6B,GAC9B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAA+B,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAmE3D;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C,YAAY,aAA0C;QACpD,KAAK,CAAC,aAAa,CAAC,CAAC;QAErB,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,SAAS,CACb,cAAgC,EAChC,aAA4B;QAE5B,6BAA6B,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,qBAAqB;YAC3B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,MAAM,IAAI,CAAC,uBAAuB,CAAC;gBACvC,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,UAAU,EAAE,OAAO;gBACnB,GAAG,cAAc;aAClB,CAAC;SACH,EACD,aAAa,CACd,CAAC;QAEF,OAAO,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,OAAO,CACX,cAA8B,EAC9B,aAA4B;QAE5B,6BAA6B,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAEhE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,qBAAqB;YAC3B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,MAAM,IAAI,CAAC,uBAAuB,CAAC;gBACvC,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,UAAU,EAAE,KAAK;gBACjB,GAAG,cAAc;aAClB,CAAC;SACH,EACD,aAAa,CACd,CAAC;QAEF,OAAO,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAClB,cAAqC,EACrC,UAAwB,EAAE;QAE1B,6BAA6B,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAEjE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,cAAc,CAAC;QAEtE,OAAO,KAAK,CACV,oDAAoD,EACpD,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACjC,QAAQ;YACR,GAAG;YACH,KAAK,EAAE,OAAO;YACd,GAAG,WAAW;SACf,CAAC,EACF,OAAO,EACP,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CACxB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,YAAY,CAChB,cAAmC,EACnC,UAAwB,EAAE;QAE1B,6BAA6B,CAAC,cAAc,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;QAExE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,cAAc,CAAC;QAE7E,OAAO,KAAK,CACV,oDAAoD,EACpD,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACjC,QAAQ;YACR,GAAG;YACH,KAAK,EAAE,KAAK;YACZ,GAAG,WAAW;SACf,CAAC,EACF,OAAO,EACP,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CACxB,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+export * from './management/index.js';
+export * from './auth/index.js';
+export * from './userinfo/index.js';
+export * from './lib/errors.js';

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+export * from './management/index.js';
+export * from './auth/index.js';
+export * from './userinfo/index.js';
+export * from './lib/errors.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC"}

package/dist/esm/lib/errors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Error thrown when the API returns an error response that can't be parsed to a more specific Error instance.
+ */
+export declare class ResponseError extends Error {
+    statusCode: number;
+    body: string;
+    headers: Headers;
+    name: "ResponseError";
+    constructor(statusCode: number, body: string, headers: Headers, msg?: string);
+}
+/**
+ * Error thrown when the request is aborted due to a timeout.
+ */
+export declare class TimeoutError extends Error {
+    name: "TimeoutError";
+    constructor();
+}
+/**
+ * Error thrown when there is a network error.
+ */
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+/**
+ * Error thrown when a required argument was not provided.
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}

package/dist/esm/lib/errors.js

@@ -0,0 +1,42 @@
+/**
+ * Error thrown when the API returns an error response that can't be parsed to a more specific Error instance.
+ */
+export class ResponseError extends Error {
+    constructor(statusCode, body, headers, msg) {
+        super(msg);
+        this.statusCode = statusCode;
+        this.body = body;
+        this.headers = headers;
+        this.name = 'ResponseError';
+    }
+}
+/**
+ * Error thrown when the request is aborted due to a timeout.
+ */
+export class TimeoutError extends Error {
+    constructor() {
+        super('The request was timed out.');
+        this.name = 'TimeoutError';
+    }
+}
+/**
+ * Error thrown when there is a network error.
+ */
+export class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = 'FetchError';
+    }
+}
+/**
+ * Error thrown when a required argument was not provided.
+ */
+export class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = 'RequiredError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/lib/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAEtC,YACS,UAAkB,EAClB,IAAY,EACZ,OAAgB,EACvB,GAAY;QAEZ,KAAK,CAAC,GAAG,CAAC,CAAC;QALJ,eAAU,GAAV,UAAU,CAAQ;QAClB,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAS;QAJhB,SAAI,GAAG,eAAwB,CAAC;IAQzC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAErC;QACE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAF7B,SAAI,GAAG,cAAuB,CAAC;IAGxC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IAEnC,YAAmB,KAAY,EAAE,GAAY;QAC3C,KAAK,CAAC,GAAG,CAAC,CAAC;QADM,UAAK,GAAL,KAAK,CAAO;QADtB,SAAI,GAAG,YAAqB,CAAC;IAGtC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAEtC,YAAmB,KAAa,EAAE,GAAY;QAC5C,KAAK,CAAC,GAAG,CAAC,CAAC;QADM,UAAK,GAAL,KAAK,CAAQ;QADvB,SAAI,GAAG,eAAwB,CAAC;IAGzC,CAAC;CACF"}

package/dist/esm/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './errors.js';
+export * from './models.js';
+export { RetryConfiguration } from './retry.js';

package/dist/esm/lib/index.js

@@ -0,0 +1,3 @@
+export * from './errors.js';
+export * from './models.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC"}

package/dist/esm/lib/middleware/telemetry-middleware.d.ts

@@ -0,0 +1,12 @@
+import { Middleware, ClientOptions, FetchParams, RequestContext } from '../runtime.js';
+/**
+ * @private
+ */
+export declare class TelemetryMiddleware implements Middleware {
+    clientInfo: {
+        name: string;
+        [key: string]: unknown;
+    };
+    constructor(options: ClientOptions);
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+}

package/dist/esm/lib/middleware/telemetry-middleware.js

@@ -0,0 +1,23 @@
+import { generateClientInfo } from '../../utils.js';
+import { base64url } from 'jose';
+/**
+ * @private
+ */
+export class TelemetryMiddleware {
+    constructor(options) {
+        this.clientInfo = options.clientInfo || generateClientInfo();
+    }
+    async pre(context) {
+        if ('string' === typeof this.clientInfo.name && this.clientInfo.name.length > 0) {
+            context.init.headers = {
+                ...context.init.headers,
+                'Auth0-Client': base64url.encode(JSON.stringify(this.clientInfo)),
+            };
+        }
+        return {
+            url: context.url,
+            init: context.init,
+        };
+    }
+}
+//# sourceMappingURL=telemetry-middleware.js.map

package/dist/esm/lib/middleware/telemetry-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry-middleware.js","sourceRoot":"","sources":["../../../../src/lib/middleware/telemetry-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAG9B,YAAY,OAAsB;QAChC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,kBAAkB,EAAE,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,OAAuB;QAChC,IAAI,QAAQ,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/E,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG;gBACrB,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO;gBACvB,cAAc,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAClE,CAAC;SACH;QAED,OAAO;YACL,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/lib/models.d.ts

@@ -0,0 +1,123 @@
+import { RetryConfiguration } from './retry.js';
+/**
+ * @private
+ */
+export type FetchAPI = (url: URL | RequestInfo, init?: RequestInit) => Promise<Response>;
+export interface ClientOptions extends Omit<Configuration, 'baseUrl' | 'parseError' | 'middleware'> {
+    telemetry?: boolean;
+    clientInfo?: {
+        name: string;
+        [key: string]: unknown;
+    };
+}
+export interface Configuration {
+    baseUrl: string;
+    parseError: (response: Response) => Promise<Error>;
+    /**
+     * Provide your own fetch implementation.
+     */
+    fetch?: FetchAPI;
+    /**
+     * Provide a middleware that will run either before the request, after the request or when the request fails.
+     */
+    middleware?: Middleware[];
+    /**
+     * Pass your own http agent to support proxies.
+     */
+    agent?: unknown;
+    /**
+     * Custom headers that will be added to every request.
+     */
+    headers?: HTTPHeaders;
+    /**
+     * Timeout in ms before aborting the request (default 10,000)
+     */
+    timeoutDuration?: number;
+    /**
+     * Retry configuration.
+     */
+    retry?: RetryConfiguration;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers?: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = any | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export type InitOverride = RequestInit | InitOverrideFunction;
+export interface ApiResponse<T> {
+    data: T;
+    headers: Headers;
+    status: number;
+    statusText: string;
+}
+export declare class JSONApiResponse<T> implements ApiResponse<T> {
+    data: T;
+    headers: Headers;
+    readonly status: number;
+    readonly statusText: string;
+    constructor(data: T, headers: Headers, status: number, statusText: string);
+    static fromResponse<T = unknown>(raw: Response): Promise<JSONApiResponse<T>>;
+}
+export declare class VoidApiResponse implements ApiResponse<undefined> {
+    headers: Headers;
+    readonly status: number;
+    readonly statusText: string;
+    data: undefined;
+    constructor(headers: Headers, status: number, statusText: string);
+    static fromResponse(raw: Response): Promise<VoidApiResponse>;
+}
+export declare class TextApiResponse implements ApiResponse<string> {
+    data: string;
+    headers: Headers;
+    readonly status: number;
+    readonly statusText: string;
+    constructor(data: string, headers: Headers, status: number, statusText: string);
+    static fromResponse(raw: Response): Promise<TextApiResponse>;
+}
+export interface FetchParams {
+    url: URL | RequestInfo;
+    init: RequestInit;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: URL | RequestInfo;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: URL | RequestInfo;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: URL | RequestInfo;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void> | FetchParams | void;
+    post?(context: ResponseContext): Promise<Response | void> | Response | void;
+    onError?(context: ErrorContext): Promise<Response | void> | Response | void;
+}

package/dist/esm/lib/models.js

@@ -0,0 +1,35 @@
+export class JSONApiResponse {
+    constructor(data, headers, status, statusText) {
+        this.data = data;
+        this.headers = headers;
+        this.status = status;
+        this.statusText = statusText;
+    }
+    static async fromResponse(raw) {
+        const value = (await raw.json());
+        return new JSONApiResponse(value, raw.headers, raw.status, raw.statusText);
+    }
+}
+export class VoidApiResponse {
+    constructor(headers, status, statusText) {
+        this.headers = headers;
+        this.status = status;
+        this.statusText = statusText;
+    }
+    static async fromResponse(raw) {
+        return new VoidApiResponse(raw.headers, raw.status, raw.statusText);
+    }
+}
+export class TextApiResponse {
+    constructor(data, headers, status, statusText) {
+        this.data = data;
+        this.headers = headers;
+        this.status = status;
+        this.statusText = statusText;
+    }
+    static async fromResponse(raw) {
+        const value = await raw.text();
+        return new TextApiResponse(value, raw.headers, raw.status, raw.statusText);
+    }
+}
+//# sourceMappingURL=models.js.map

package/dist/esm/lib/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/lib/models.ts"],"names":[],"mappings":"AAuFA,MAAM,OAAO,eAAe;IAC1B,YACS,IAAO,EACP,OAAgB,EACd,MAAc,EACd,UAAkB;QAHpB,SAAI,GAAJ,IAAI,CAAG;QACP,YAAO,GAAP,OAAO,CAAS;QACd,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAQ;IAC1B,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,YAAY,CAAc,GAAa;QAClD,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAM,CAAC;QACtC,OAAO,IAAI,eAAe,CAAI,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAChF,CAAC;CACF;AAED,MAAM,OAAO,eAAe;IAE1B,YAAmB,OAAgB,EAAW,MAAc,EAAW,UAAkB;QAAtE,YAAO,GAAP,OAAO,CAAS;QAAW,WAAM,GAAN,MAAM,CAAQ;QAAW,eAAU,GAAV,UAAU,CAAQ;IAAG,CAAC;IAE7F,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAa;QACrC,OAAO,IAAI,eAAe,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;CACF;AAED,MAAM,OAAO,eAAe;IAC1B,YACS,IAAY,EACZ,OAAgB,EACd,MAAc,EACd,UAAkB;QAHpB,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAS;QACd,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAQ;IAC1B,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAa;QACrC,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC/B,OAAO,IAAI,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/dist/esm/lib/retry.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Configure the retry logic for http calls.
+ * By default, this retries any request that returns a 429 3 times.
+ */
+export interface RetryConfiguration {
+    /**
+     * Configure the usage of retries.
+     * Defaults to true on the Management Client and false on the Authentication Client.
+     */
+    enabled?: boolean;
+    /**
+     * Configure the max amount of retries the SDK should do.
+     * Defaults to 5.
+     */
+    maxRetries?: number;
+    /**
+     * Status Codes on which the SDK should trigger retries.
+     * Defaults to [429].
+     */
+    retryWhen?: number[];
+}
+/**
+ * @private
+ * Function that retries the provided action callback for a configurable amount of time, defaults to 3.
+ */
+export declare function retry(action: () => Promise<Response>, { maxRetries, retryWhen }: RetryConfiguration): Promise<Response>;

package/dist/esm/lib/retry.js

@@ -0,0 +1,49 @@
+const MAX_REQUEST_RETRY_JITTER = 250;
+const MAX_REQUEST_RETRY_DELAY = 10000;
+const DEFAULT_NUMBER_RETRIES = 3;
+const MAX_NUMBER_RETRIES = 10;
+const BASE_DELAY = 500;
+/**
+ * @private
+ * Function that returns a random int between a configurable min and max.
+ * @param min The min value
+ * @param max  The max value
+ * @returns {number} The random generated value
+ */
+function getRandomInt(min, max) {
+    min = Math.ceil(min);
+    max = Math.floor(max);
+    return Math.floor(Math.random() * (max - min) + min); // The maximum is exclusive and the minimum is inclusive
+}
+/**
+ * @private
+ * Function that returns a promise which resolves after a configurable amount of milliseconds
+ * @param delay value to be used for the delay
+ * @returns {Promise} A delayed promise
+ */
+async function pause(delay) {
+    return new Promise((resolve) => setTimeout(resolve, delay));
+}
+/**
+ * @private
+ * Function that retries the provided action callback for a configurable amount of time, defaults to 3.
+ */
+export function retry(action, { maxRetries, retryWhen }) {
+    const nrOfTriesToAttempt = Math.min(MAX_NUMBER_RETRIES, maxRetries !== null && maxRetries !== void 0 ? maxRetries : DEFAULT_NUMBER_RETRIES);
+    let nrOfTries = 0;
+    const retryAndWait = async () => {
+        let result;
+        result = await action();
+        if ((retryWhen || [429]).includes(result.status) && nrOfTries < nrOfTriesToAttempt) {
+            nrOfTries++;
+            let wait = BASE_DELAY * Math.pow(2, nrOfTries - 1);
+            wait = getRandomInt(wait + 1, wait + MAX_REQUEST_RETRY_JITTER);
+            wait = Math.min(wait, MAX_REQUEST_RETRY_DELAY);
+            await pause(wait);
+            result = await retryAndWait();
+        }
+        return result;
+    };
+    return retryAndWait();
+}
+//# sourceMappingURL=retry.js.map

package/dist/esm/lib/retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../src/lib/retry.ts"],"names":[],"mappings":"AAAA,MAAM,wBAAwB,GAAG,GAAG,CAAC;AACrC,MAAM,uBAAuB,GAAG,KAAK,CAAC;AACtC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AACjC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,GAAW,EAAE,GAAW;IAC5C,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,wDAAwD;AAChH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,KAAa;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AAC9D,CAAC;AAwBD;;;GAGG;AACH,MAAM,UAAU,KAAK,CACnB,MAA+B,EAC/B,EAAE,UAAU,EAAE,SAAS,EAAsB;IAE7C,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,sBAAsB,CAAC,CAAC;IAC9F,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,MAAgB,CAAC;QAErB,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;QAExB,IAAI,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,GAAG,kBAAkB,EAAE;YAClF,SAAS,EAAE,CAAC;YAEZ,IAAI,IAAI,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;YACnD,IAAI,GAAG,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,wBAAwB,CAAC,CAAC;YAC/D,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;YAE/C,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;YAElB,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;SAC/B;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO,YAAY,EAAE,CAAC;AACxB,CAAC"}

package/dist/esm/lib/runtime.d.ts

@@ -0,0 +1,61 @@
+import { RequestOpts, InitOverrideFunction, Configuration } from './models.js';
+export * from './models.js';
+/**
+ * @private
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private middleware;
+    private fetchApi;
+    private parseError;
+    private timeoutDuration;
+    constructor(configuration: Configuration);
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchWithTimeout;
+    private fetch;
+}
+/**
+ * @private
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ * @private
+ */
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+/**
+ * @private
+ */
+export interface Consume {
+    contentType: string;
+}
+/**
+ * @private
+ */
+export declare function validateRequiredRequestParams<TRequestParams extends {
+    [key: string]: any;
+}>(requestParameters: TRequestParams, keys: Array<Extract<keyof TRequestParams, string>>): void;
+type QueryParamConfig = {
+    isArray?: boolean;
+    isCollectionFormatMulti?: boolean;
+    collectionFormat?: keyof typeof COLLECTION_FORMATS;
+};
+/**
+ * @private
+ */
+export declare function applyQueryParams<TRequestParams extends {
+    [key: string]: any;
+}, Key extends Extract<keyof TRequestParams, string>>(requestParameters: TRequestParams, keys: Array<{
+    key: Key;
+    config: QueryParamConfig;
+}>): Pick<TRequestParams, Key>;
+/**
+ * @private
+ */
+export declare function parseFormParam(originalValue: number | boolean | string | Blob): Promise<string | Blob>;