auth0 6.4.0 → 7.1.0

package/dist/cjs/auth/database.d.ts

@@ -1,157 +0,0 @@
-import { InitOverride, JSONApiResponse, TextApiResponse } from "../lib/models.js";
-import { BaseAuthAPI } from "./base-auth-api.js";
-export interface SignUpRequest {
-    /**
-     * The client_id of your client.
-     * Use if you want to override the class's `clientId`
-     */
-    client_id?: string;
-    /**
-     * The user's email address.
-     */
-    email: string;
-    /**
-     * The user's desired password.
-     */
-    password: string;
-    /**
-     * The name of the database configured to your client.
-     */
-    connection: string;
-    /**
-     * The user's username. Only valid if the connection requires a username.
-     */
-    username?: string;
-    /**
-     * The user's given name(s).
-     */
-    given_name?: string;
-    /**
-     * The user's family name(s).
-     */
-    family_name?: string;
-    /**
-     * The user's full name.
-     */
-    name?: string;
-    /**
-     *The user's nickname.
-     */
-    nickname?: string;
-    /**
-     * A URI pointing to the user's picture.
-     */
-    picture?: string;
-    /**
-     * The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties. Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.
-     */
-    user_metadata?: {
-        [key: string]: unknown;
-    };
-}
-export interface SignUpResponse {
-    /**
-     * Email address of the new user.
-     */
-    email: string;
-    /**
-     * Indicates whether the email has been verified or not.
-     */
-    email_verified: boolean;
-    /**
-     * The server can return `_id`, `id` or `user_id` depending on various factors.
-     * For convenience we expose it here as just `id`.
-     */
-    id: string;
-    /**
-     * Username of this user.
-     */
-    username?: string;
-    /**
-     * The user's given name(s).
-     */
-    given_name?: string;
-    /**
-     * The user's family name(s).
-     */
-    family_name?: string;
-    /**
-     * The user's full name.
-     */
-    name?: string;
-    /**
-     *The user's nickname.
-     */
-    nickname?: string;
-    /**
-     * A URI pointing to the user's picture.
-     */
-    picture?: string;
-    /**
-     * The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties. Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.
-     */
-    user_metadata?: {
-        [key: string]: unknown;
-    };
-}
-export interface ChangePasswordRequest {
-    /**
-     * The client_id of your client.
-     * Use if you want to override the class's `clientId`
-     */
-    client_id?: string;
-    /**
-     * The user's email address.
-     */
-    email: string;
-    /**
-     * The name of the database configured to your client.
-     */
-    connection: string;
-    /**
-     * The organization_id of the Organization associated with the user.
-     */
-    organization?: string;
-}
-/**
- * Sign-up and change-password for Database & Active Directory authentication services.
- */
-export declare class Database extends BaseAuthAPI {
-    /**
-     * Given a user's credentials, and a connection, this endpoint will create a new user using active authentication.
-     *
-     * This endpoint only works for database connections.
-     *
-     * See: https://auth0.com/docs/api/authentication#signup
-     *
-     * @example
-     * ```js
-     * var data = {
-     *   email: '{EMAIL}',
-     *   password: '{PASSWORD}',
-     *   connection: 'Username-Password-Authentication'
-     * };
-     *
-     * await auth0.database.signUp(data);
-     * ```
-     */
-    signUp(bodyParameters: SignUpRequest, initOverrides?: InitOverride): Promise<JSONApiResponse<SignUpResponse>>;
-    /**
-     * Given a user's email address and a connection, Auth0 will send a change password email.
-     *
-     * This endpoint only works for database connections.
-     *
-     * See: https://auth0.com/docs/api/authentication#change-password
-     *
-     * @example
-     * ```js
-     * var data = {
-     *   email: '{EMAIL}',
-     *   connection: 'Username-Password-Authentication'
-     * };
-     *
-     * await auth0.database.changePassword(data);
-     * ```
-     */
-    changePassword(bodyParameters: ChangePasswordRequest, initOverrides?: InitOverride): Promise<TextApiResponse>;
-}

package/dist/cjs/auth/database.js

@@ -1,94 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Database = void 0;
-const models_js_1 = require("../lib/models.js");
-const runtime_js_1 = require("../lib/runtime.js");
-const base_auth_api_js_1 = require("./base-auth-api.js");
-/**
- * Sign-up and change-password for Database & Active Directory authentication services.
- */
-class Database extends base_auth_api_js_1.BaseAuthAPI {
-    /**
-     * Given a user's credentials, and a connection, this endpoint will create a new user using active authentication.
-     *
-     * This endpoint only works for database connections.
-     *
-     * See: https://auth0.com/docs/api/authentication#signup
-     *
-     * @example
-     * ```js
-     * var data = {
-     *   email: '{EMAIL}',
-     *   password: '{PASSWORD}',
-     *   connection: 'Username-Password-Authentication'
-     * };
-     *
-     * await auth0.database.signUp(data);
-     * ```
-     */
-    signUp(bodyParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: call this `validateRequiredParams` so we can use with bodyParameters in the auth api
-            (0, runtime_js_1.validateRequiredRequestParams)(bodyParameters, ["email", "password", "connection"]);
-            const response = yield this.request({
-                path: "/dbconnections/signup",
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                },
-                body: Object.assign({ client_id: this.clientId }, bodyParameters),
-            }, initOverrides);
-            // Transform the response to ensure id field is always available
-            const jsonResponse = yield models_js_1.JSONApiResponse.fromResponse(response);
-            if (jsonResponse.data) {
-                const data = jsonResponse.data;
-                // Map _id or user_id to id
-                if (!data.id && (data._id || data.user_id)) {
-                    data.id = data._id || data.user_id;
-                }
-            }
-            return jsonResponse;
-        });
-    }
-    /**
-     * Given a user's email address and a connection, Auth0 will send a change password email.
-     *
-     * This endpoint only works for database connections.
-     *
-     * See: https://auth0.com/docs/api/authentication#change-password
-     *
-     * @example
-     * ```js
-     * var data = {
-     *   email: '{EMAIL}',
-     *   connection: 'Username-Password-Authentication'
-     * };
-     *
-     * await auth0.database.changePassword(data);
-     * ```
-     */
-    changePassword(bodyParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, runtime_js_1.validateRequiredRequestParams)(bodyParameters, ["email", "connection"]);
-            const response = yield this.request({
-                path: "/dbconnections/change_password",
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                },
-                body: Object.assign({ client_id: this.clientId }, bodyParameters),
-            }, initOverrides);
-            return models_js_1.TextApiResponse.fromResponse(response);
-        });
-    }
-}
-exports.Database = Database;

package/dist/cjs/auth/id-token-validator.d.ts

@@ -1,18 +0,0 @@
-import { AuthenticationClientOptions } from "./base-auth-api.js";
-export declare class IdTokenValidatorError extends Error {
-}
-export interface IDTokenValidateOptions {
-    nonce?: string;
-    maxAge?: number;
-    organization?: string;
-}
-export declare class IDTokenValidator {
-    private jwks;
-    private alg;
-    private audience;
-    private issuer;
-    private clockTolerance;
-    private secret;
-    constructor({ domain, clientId, clientSecret, headers, timeoutDuration, idTokenSigningAlg, clockTolerance, }: AuthenticationClientOptions);
-    validate(idToken: string, { nonce, maxAge, organization }?: IDTokenValidateOptions): Promise<void>;
-}

package/dist/cjs/auth/id-token-validator.js

@@ -1,158 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IDTokenValidator = exports.IdTokenValidatorError = void 0;
-const jose = __importStar(require("jose"));
-const DEFAULT_CLOCK_TOLERANCE = 60; // secs
-class IdTokenValidatorError extends Error {
-}
-exports.IdTokenValidatorError = IdTokenValidatorError;
-class IDTokenValidator {
-    constructor({ domain, clientId, clientSecret, headers, timeoutDuration, idTokenSigningAlg = "RS256", clockTolerance = DEFAULT_CLOCK_TOLERANCE, }) {
-        this.jwks = jose.createRemoteJWKSet(new URL(`https://${domain}/.well-known/jwks.json`), {
-            timeoutDuration,
-            headers,
-        });
-        this.alg = idTokenSigningAlg;
-        this.audience = clientId;
-        this.secret = new TextEncoder().encode(clientSecret);
-        this.issuer = `https://${domain}/`;
-        this.clockTolerance = clockTolerance;
-    }
-    validate(idToken_1) {
-        return __awaiter(this, arguments, void 0, function* (idToken, { nonce, maxAge, organization } = {}) {
-            const secret = this.alg === "HS256" ? this.secret : this.jwks;
-            const header = jose.decodeProtectedHeader(idToken);
-            const payload = jose.decodeJwt(idToken);
-            // Check algorithm
-            if (header.alg !== "RS256" && header.alg !== "HS256") {
-                throw new Error(`Signature algorithm of "${header.alg}" is not supported. Expected the ID token to be signed with "RS256" or "HS256".`);
-            }
-            // Issuer
-            if (!payload.iss || typeof payload.iss !== "string") {
-                throw new IdTokenValidatorError("Issuer (iss) claim must be a string present in the ID token");
-            }
-            if (payload.iss !== this.issuer) {
-                throw new IdTokenValidatorError(`Issuer (iss) claim mismatch in the ID token; expected "${this.issuer}", found "${payload.iss}"`);
-            }
-            // Subject
-            if (!payload.sub || typeof payload.sub !== "string") {
-                throw new IdTokenValidatorError("Subject (sub) claim must be a string present in the ID token");
-            }
-            // Audience
-            if (!payload.aud || !(typeof payload.aud === "string" || Array.isArray(payload.aud))) {
-                throw new IdTokenValidatorError("Audience (aud) claim must be a string or array of strings present in the ID token");
-            }
-            if (Array.isArray(payload.aud) && !payload.aud.includes(this.audience)) {
-                throw new IdTokenValidatorError(`Audience (aud) claim mismatch in the ID token; expected "${this.audience}" but was not one of "${payload.aud.join(", ")}"`);
-            }
-            else if (typeof payload.aud === "string" && payload.aud !== this.audience) {
-                throw new IdTokenValidatorError(`Audience (aud) claim mismatch in the ID token; expected "${this.audience}" but found "${payload.aud}"`);
-            }
-            // Organization
-            if (organization) {
-                if (organization.indexOf("org_") === 0) {
-                    if (!payload.org_id || typeof payload.org_id !== "string") {
-                        throw new Error("Organization Id (org_id) claim must be a string present in the ID token");
-                    }
-                }
-                else {
-                    if (!payload.org_name || typeof payload.org_name !== "string") {
-                        throw new Error("Organization Name (org_name) claim must be a string present in the ID token");
-                    }
-                }
-            }
-            // Time validation (epoch)
-            const now = Math.floor(Date.now() / 1000);
-            // Expires at
-            if (!payload.exp || typeof payload.exp !== "number") {
-                throw new IdTokenValidatorError("Expiration Time (exp) claim must be a number present in the ID token");
-            }
-            const expTime = payload.exp + this.clockTolerance;
-            if (now > expTime) {
-                throw new IdTokenValidatorError(`Expiration Time (exp) claim error in the ID token; current time (${now}) is after expiration time (${expTime})`);
-            }
-            // Issued at
-            if (!payload.iat || typeof payload.iat !== "number") {
-                throw new IdTokenValidatorError("Issued At (iat) claim must be a number present in the ID token");
-            }
-            // Nonce
-            if (nonce || payload.nonce) {
-                if (!payload.nonce || typeof payload.nonce !== "string") {
-                    throw new IdTokenValidatorError("Nonce (nonce) claim must be a string present in the ID token");
-                }
-                if (payload.nonce !== nonce) {
-                    throw new IdTokenValidatorError(`Nonce (nonce) claim mismatch in the ID token; expected "${nonce}", found "${payload.nonce}"`);
-                }
-            }
-            // Authorized party
-            if (Array.isArray(payload.aud) && payload.aud.length > 1) {
-                if (!payload.azp || typeof payload.azp !== "string") {
-                    throw new IdTokenValidatorError("Authorized Party (azp) claim must be a string present in the ID token when Audience (aud) claim has multiple values");
-                }
-                if (payload.azp !== this.audience) {
-                    throw new IdTokenValidatorError(`Authorized Party (azp) claim mismatch in the ID token; expected "${this.audience}", found "${payload.azp}"`);
-                }
-            }
-            // Authentication time
-            if (maxAge) {
-                if (!payload.auth_time || typeof payload.auth_time !== "number") {
-                    throw new IdTokenValidatorError("Authentication Time (auth_time) claim must be a number present in the ID token when Max Age (max_age) is specified");
-                }
-                const authValidUntil = payload.auth_time + maxAge + this.clockTolerance;
-                if (now > authValidUntil) {
-                    throw new IdTokenValidatorError(`Authentication Time (auth_time) claim in the ID token indicates that too much time has passed since the last end-user authentication. Currrent time (${now}) is after last auth at ${authValidUntil}`);
-                }
-            }
-            yield jose.jwtVerify(idToken, secret, {
-                issuer: this.issuer,
-                audience: this.audience,
-                clockTolerance: this.clockTolerance,
-                maxTokenAge: maxAge,
-                algorithms: ["HS256", "RS256"],
-            });
-        });
-    }
-}
-exports.IDTokenValidator = IDTokenValidator;

package/dist/cjs/auth/index.d.ts

@@ -1,65 +0,0 @@
-import { IBackchannel } from "./backchannel.js";
-import { AuthenticationClientOptions } from "./base-auth-api.js";
-import { Database } from "./database.js";
-import { OAuth } from "./oauth.js";
-import { Passwordless } from "./passwordless.js";
-import { ICustomTokenExchange } from "./tokenExchange.js";
-export * from "./database.js";
-export * from "./oauth.js";
-export * from "./passwordless.js";
-export { IDTokenValidateOptions, IdTokenValidatorError } from "./id-token-validator.js";
-export { AuthApiError, AuthenticationClientOptions } from "./base-auth-api.js";
-/**
- * Auth0 Authentication API Client
- *
- * Provides access to Auth0's authentication endpoints for login, signup,
- * passwordless authentication, and token exchange operations.
- *
- * @group Authentication API
- *
- * @example Basic setup
- * ```typescript
- * import { AuthenticationClient } from 'auth0';
- *
- * const auth0 = new AuthenticationClient({
- *   domain: 'your-tenant.auth0.com',
- *   clientId: 'your-client-id'
- * });
- * ```
- *
- * @example OAuth login
- * ```typescript
- * // Exchange authorization code for tokens
- * const tokenSet = await auth0.oauth.authorizationCodeGrant({
- *   code: 'auth-code',
- *   redirect_uri: 'https://app.example.com/callback'
- * });
- * ```
- *
- * @example Database operations
- * ```typescript
- * // Create user
- * const user = await auth0.database.signUp({
- *   connection: 'Username-Password-Authentication',
- *   username: 'john@example.com',
- *   password: 'secure-password123'
- * });
- * ```
- */
-export declare class AuthenticationClient {
-    /** Database connection operations (signup, change password) */
-    database: Database;
-    /** OAuth 2.0 and OIDC operations (authorization, token exchange) */
-    oauth: OAuth;
-    /** Passwordless authentication (email/SMS) */
-    passwordless: Passwordless;
-    /** Back-channel authentication (CIBA) */
-    backchannel: IBackchannel;
-    /** Custom token exchange operations */
-    tokenExchange: ICustomTokenExchange;
-    /**
-     * Create a new Authentication API client
-     * @param options - Configuration options for the client
-     */
-    constructor(options: AuthenticationClientOptions);
-}

package/dist/cjs/auth/index.js

@@ -1,80 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthenticationClient = exports.AuthApiError = exports.IdTokenValidatorError = void 0;
-const backchannel_js_1 = require("./backchannel.js");
-const database_js_1 = require("./database.js");
-const oauth_js_1 = require("./oauth.js");
-const passwordless_js_1 = require("./passwordless.js");
-const tokenExchange_js_1 = require("./tokenExchange.js");
-__exportStar(require("./database.js"), exports);
-__exportStar(require("./oauth.js"), exports);
-__exportStar(require("./passwordless.js"), exports);
-var id_token_validator_js_1 = require("./id-token-validator.js");
-Object.defineProperty(exports, "IdTokenValidatorError", { enumerable: true, get: function () { return id_token_validator_js_1.IdTokenValidatorError; } });
-var base_auth_api_js_1 = require("./base-auth-api.js");
-Object.defineProperty(exports, "AuthApiError", { enumerable: true, get: function () { return base_auth_api_js_1.AuthApiError; } });
-/**
- * Auth0 Authentication API Client
- *
- * Provides access to Auth0's authentication endpoints for login, signup,
- * passwordless authentication, and token exchange operations.
- *
- * @group Authentication API
- *
- * @example Basic setup
- * ```typescript
- * import { AuthenticationClient } from 'auth0';
- *
- * const auth0 = new AuthenticationClient({
- *   domain: 'your-tenant.auth0.com',
- *   clientId: 'your-client-id'
- * });
- * ```
- *
- * @example OAuth login
- * ```typescript
- * // Exchange authorization code for tokens
- * const tokenSet = await auth0.oauth.authorizationCodeGrant({
- *   code: 'auth-code',
- *   redirect_uri: 'https://app.example.com/callback'
- * });
- * ```
- *
- * @example Database operations
- * ```typescript
- * // Create user
- * const user = await auth0.database.signUp({
- *   connection: 'Username-Password-Authentication',
- *   username: 'john@example.com',
- *   password: 'secure-password123'
- * });
- * ```
- */
-class AuthenticationClient {
-    /**
-     * Create a new Authentication API client
-     * @param options - Configuration options for the client
-     */
-    constructor(options) {
-        this.database = new database_js_1.Database(options);
-        this.oauth = new oauth_js_1.OAuth(options);
-        this.passwordless = new passwordless_js_1.Passwordless(options);
-        this.backchannel = new backchannel_js_1.Backchannel(options);
-        this.tokenExchange = new tokenExchange_js_1.CustomTokenExchange(options);
-    }
-}
-exports.AuthenticationClient = AuthenticationClient;