@azure/msal-browser 4.13.2 → 4.15.0

package/src/custom_auth/core/network_client/custom_auth_api/SignupApiClient.ts

@@ -0,0 +1,141 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { GrantType } from "../../../CustomAuthConstants.js";
+import { BaseApiClient } from "./BaseApiClient.js";
+import * as CustomAuthApiEndpoint from "./CustomAuthApiEndpoint.js";
+import {
+    SignUpChallengeRequest,
+    SignUpContinueWithAttributesRequest,
+    SignUpContinueWithOobRequest,
+    SignUpContinueWithPasswordRequest,
+    SignUpStartRequest,
+} from "./types/ApiRequestTypes.js";
+import {
+    SignUpChallengeResponse,
+    SignUpContinueResponse,
+    SignUpStartResponse,
+} from "./types/ApiResponseTypes.js";
+
+export class SignupApiClient extends BaseApiClient {
+    /**
+     * Start the sign-up flow
+     */
+    async start(params: SignUpStartRequest): Promise<SignUpStartResponse> {
+        const result = await this.request<SignUpStartResponse>(
+            CustomAuthApiEndpoint.SIGNUP_START,
+            {
+                username: params.username,
+                ...(params.password && { password: params.password }),
+                ...(params.attributes && {
+                    attributes: JSON.stringify(params.attributes),
+                }),
+                challenge_type: params.challenge_type,
+            },
+            params.telemetryManager,
+            params.correlationId
+        );
+
+        this.ensureContinuationTokenIsValid(
+            result.continuation_token,
+            params.correlationId
+        );
+
+        return result;
+    }
+
+    /**
+     * Request challenge (e.g., OTP)
+     */
+    async requestChallenge(
+        params: SignUpChallengeRequest
+    ): Promise<SignUpChallengeResponse> {
+        const result = await this.request<SignUpChallengeResponse>(
+            CustomAuthApiEndpoint.SIGNUP_CHALLENGE,
+            {
+                continuation_token: params.continuation_token,
+                challenge_type: params.challenge_type,
+            },
+            params.telemetryManager,
+            params.correlationId
+        );
+
+        this.ensureContinuationTokenIsValid(
+            result.continuation_token,
+            params.correlationId
+        );
+
+        return result;
+    }
+
+    /**
+     * Continue sign-up flow with code.
+     */
+    async continueWithCode(
+        params: SignUpContinueWithOobRequest
+    ): Promise<SignUpContinueResponse> {
+        const result = await this.request<SignUpContinueResponse>(
+            CustomAuthApiEndpoint.SIGNUP_CONTINUE,
+            {
+                continuation_token: params.continuation_token,
+                grant_type: GrantType.OOB,
+                oob: params.oob,
+            },
+            params.telemetryManager,
+            params.correlationId
+        );
+
+        this.ensureContinuationTokenIsValid(
+            result.continuation_token,
+            params.correlationId
+        );
+
+        return result;
+    }
+
+    async continueWithPassword(
+        params: SignUpContinueWithPasswordRequest
+    ): Promise<SignUpContinueResponse> {
+        const result = await this.request<SignUpContinueResponse>(
+            CustomAuthApiEndpoint.SIGNUP_CONTINUE,
+            {
+                continuation_token: params.continuation_token,
+                grant_type: GrantType.PASSWORD,
+                password: params.password,
+            },
+            params.telemetryManager,
+            params.correlationId
+        );
+
+        this.ensureContinuationTokenIsValid(
+            result.continuation_token,
+            params.correlationId
+        );
+
+        return result;
+    }
+
+    async continueWithAttributes(
+        params: SignUpContinueWithAttributesRequest
+    ): Promise<SignUpContinueResponse> {
+        const result = await this.request<SignUpContinueResponse>(
+            CustomAuthApiEndpoint.SIGNUP_CONTINUE,
+            {
+                continuation_token: params.continuation_token,
+                grant_type: GrantType.ATTRIBUTES,
+                attributes: JSON.stringify(params.attributes),
+            },
+            params.telemetryManager,
+            params.correlationId
+        );
+
+        this.ensureContinuationTokenIsValid(
+            result.continuation_token,
+            params.correlationId
+        );
+
+        return result;
+    }
+}

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiErrorCodes.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export const CONTINUATION_TOKEN_MISSING = "continuation_token_missing";
+export const INVALID_RESPONSE_BODY = "invalid_response_body";
+export const EMPTY_RESPONSE = "empty_response";
+export const UNSUPPORTED_CHALLENGE_TYPE = "unsupported_challenge_type";
+export const ACCESS_TOKEN_MISSING = "access_token_missing";
+export const ID_TOKEN_MISSING = "id_token_missing";
+export const REFRESH_TOKEN_MISSING = "refresh_token_missing";
+export const INVALID_EXPIRES_IN = "invalid_expires_in";
+export const INVALID_TOKEN_TYPE = "invalid_token_type";
+export const HTTP_REQUEST_FAILED = "http_request_failed";
+export const INVALID_REQUEST = "invalid_request";
+export const USER_NOT_FOUND = "user_not_found";
+export const INVALID_GRANT = "invalid_grant";
+export const CREDENTIAL_REQUIRED = "credential_required";
+export const ATTRIBUTES_REQUIRED = "attributes_required";
+export const USER_ALREADY_EXISTS = "user_already_exists";
+export const INVALID_POLL_STATUS = "invalid_poll_status";
+export const PASSWORD_CHANGE_FAILED = "password_change_failed";
+export const PASSWORD_RESET_TIMEOUT = "password_reset_timeout";
+export const CLIENT_INFO_MISSING = "client_info_missing";
+export const EXPIRED_TOKEN = "expired_token";

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiErrorResponseTypes.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export interface InvalidAttribute {
+    name: string;
+    reason: string;
+}
+
+/**
+ * Detailed error interface for Microsoft Entra signup errors
+ */
+export interface ApiErrorResponse {
+    error: string;
+    error_description: string;
+    correlation_id: string;
+    error_codes?: number[];
+    suberror?: string;
+    continuation_token?: string;
+    timestamp?: string;
+    trace_id?: string;
+    required_attributes?: Array<UserAttribute>;
+    invalid_attributes?: Array<UserAttribute>;
+}
+
+export interface UserAttribute {
+    name: string;
+    type?: string;
+    required?: boolean;
+    options?: UserAttributeOption;
+}
+
+export interface UserAttributeOption {
+    regex?: string;
+}

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiRequestTypes.ts

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ApiRequestBase } from "./ApiTypesBase.js";
+
+/* Sign-in API request types */
+export interface SignInInitiateRequest extends ApiRequestBase {
+    challenge_type: string;
+    username: string;
+}
+
+export interface SignInChallengeRequest extends ApiRequestBase {
+    challenge_type: string;
+    continuation_token: string;
+}
+
+interface SignInTokenRequestBase extends ApiRequestBase {
+    continuation_token: string;
+    scope: string;
+}
+
+export interface SignInPasswordTokenRequest extends SignInTokenRequestBase {
+    password: string;
+}
+
+export interface SignInOobTokenRequest extends SignInTokenRequestBase {
+    oob: string;
+}
+
+export interface SignInContinuationTokenRequest extends SignInTokenRequestBase {
+    username: string;
+}
+
+/* Sign-up API request types */
+export interface SignUpStartRequest extends ApiRequestBase {
+    username: string;
+    challenge_type: string;
+    password?: string;
+    attributes?: Record<string, string>;
+}
+
+export interface SignUpChallengeRequest extends ApiRequestBase {
+    continuation_token: string;
+    challenge_type: string;
+}
+
+interface SignUpContinueRequestBase extends ApiRequestBase {
+    continuation_token: string;
+}
+
+export interface SignUpContinueWithOobRequest
+    extends SignUpContinueRequestBase {
+    oob: string;
+}
+
+export interface SignUpContinueWithPasswordRequest
+    extends SignUpContinueRequestBase {
+    password: string;
+}
+
+export interface SignUpContinueWithAttributesRequest
+    extends SignUpContinueRequestBase {
+    attributes: Record<string, string>;
+}
+
+/* Reset password API request types */
+export interface ResetPasswordStartRequest extends ApiRequestBase {
+    challenge_type: string;
+    username: string;
+}
+
+export interface ResetPasswordChallengeRequest extends ApiRequestBase {
+    challenge_type: string;
+    continuation_token: string;
+}
+
+export interface ResetPasswordContinueRequest extends ApiRequestBase {
+    continuation_token: string;
+    oob: string;
+}
+
+export interface ResetPasswordSubmitRequest extends ApiRequestBase {
+    continuation_token: string;
+    new_password: string;
+}
+
+export interface ResetPasswordPollCompletionRequest extends ApiRequestBase {
+    continuation_token: string;
+}

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiResponseTypes.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ApiResponseBase } from "./ApiTypesBase.js";
+
+interface ContinuousResponse extends ApiResponseBase {
+    continuation_token?: string;
+}
+
+interface InitiateResponse extends ContinuousResponse {
+    challenge_type?: string;
+}
+
+interface ChallengeResponse extends ApiResponseBase {
+    continuation_token?: string;
+    challenge_type?: string;
+    binding_method?: string;
+    challenge_channel?: string;
+    challenge_target_label?: string;
+    code_length?: number;
+}
+
+/* Sign-in API response types */
+export type SignInInitiateResponse = InitiateResponse;
+
+export type SignInChallengeResponse = ChallengeResponse;
+
+export interface SignInTokenResponse extends ApiResponseBase {
+    token_type: "Bearer";
+    scope: string;
+    expires_in: number;
+    access_token: string;
+    refresh_token: string;
+    id_token: string;
+    client_info: string;
+    ext_expires_in?: number;
+}
+
+/* Sign-up API response types */
+export type SignUpStartResponse = InitiateResponse;
+
+export interface SignUpChallengeResponse extends ChallengeResponse {
+    interval?: number;
+}
+
+export type SignUpContinueResponse = InitiateResponse;
+
+/* Reset password API response types */
+export type ResetPasswordStartResponse = InitiateResponse;
+
+export type ResetPasswordChallengeResponse = ChallengeResponse;
+
+export interface ResetPasswordContinueResponse extends ContinuousResponse {
+    expires_in: number;
+}
+
+export interface ResetPasswordSubmitResponse extends ContinuousResponse {
+    poll_interval: number;
+}
+
+export interface ResetPasswordPollCompletionResponse
+    extends ContinuousResponse {
+    status: string;
+}

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiSuberrors.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export const PASSWORD_TOO_WEAK = "password_too_weak";
+export const PASSWORD_TOO_SHORT = "password_too_short";
+export const PASSWORD_TOO_LONG = "password_too_long";
+export const PASSWORD_RECENTLY_USED = "password_recently_used";
+export const PASSWORD_BANNED = "password_banned";
+export const PASSWORD_IS_INVALID = "password_is_invalid";
+export const INVALID_OOB_VALUE = "invalid_oob_value";
+export const ATTRIBUTE_VALIATION_FAILED = "attribute_validation_failed";
+export const NATIVEAUTHAPI_DISABLED = "nativeauthapi_disabled";

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiTypesBase.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ServerTelemetryManager } from "@azure/msal-common/browser";
+
+export type ApiRequestBase = {
+    correlationId: string;
+    telemetryManager: ServerTelemetryManager;
+};
+
+export type ApiResponseBase = {
+    correlation_id: string;
+};

package/src/custom_auth/core/network_client/http_client/FetchHttpClient.ts

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { HttpMethod, IHttpClient, RequestBody } from "./IHttpClient.js";
+import { HttpError } from "../../error/HttpError.js";
+import { AADServerParamKeys, Logger } from "@azure/msal-common/browser";
+import {
+    FailedSendRequest,
+    NoNetworkConnectivity,
+} from "../../error/HttpErrorCodes.js";
+
+/**
+ * Implementation of IHttpClient using fetch.
+ */
+export class FetchHttpClient implements IHttpClient {
+    constructor(private logger: Logger) {}
+
+    async sendAsync(
+        url: string | URL,
+        options: RequestInit
+    ): Promise<Response> {
+        const headers = options.headers as Record<string, string>;
+        const correlationId =
+            headers?.[AADServerParamKeys.CLIENT_REQUEST_ID] || undefined;
+
+        try {
+            this.logger.verbosePii(`Sending request to ${url}`, correlationId);
+
+            const startTime = performance.now();
+            const response = await fetch(url, options);
+            const endTime = performance.now();
+
+            this.logger.verbosePii(
+                `Request to '${url}' completed in ${
+                    endTime - startTime
+                }ms with status code ${response.status}`,
+                correlationId
+            );
+
+            return response;
+        } catch (e) {
+            this.logger.errorPii(
+                `Failed to send request to ${url}: ${e}`,
+                correlationId
+            );
+
+            if (!window.navigator.onLine) {
+                throw new HttpError(
+                    NoNetworkConnectivity,
+                    `No network connectivity: ${e}`,
+                    correlationId
+                );
+            }
+
+            throw new HttpError(
+                FailedSendRequest,
+                `Failed to send request: ${e}`,
+                correlationId
+            );
+        }
+    }
+
+    async post(
+        url: string | URL,
+        body: RequestBody,
+        headers: Record<string, string> = {}
+    ): Promise<Response> {
+        return this.sendAsync(url, {
+            method: HttpMethod.POST,
+            headers,
+            body,
+        });
+    }
+
+    async get(
+        url: string | URL,
+        headers: Record<string, string> = {}
+    ): Promise<Response> {
+        return this.sendAsync(url, {
+            method: HttpMethod.GET,
+            headers,
+        });
+    }
+}

package/src/custom_auth/core/network_client/http_client/IHttpClient.ts

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export type RequestBody =
+    | string
+    | ArrayBuffer
+    | DataView
+    | Blob
+    | File
+    | URLSearchParams
+    | FormData
+    | ReadableStream;
+/**
+ * Interface for HTTP client.
+ */
+export interface IHttpClient {
+    /**
+     * Sends a request.
+     * @param url The URL to send the request to.
+     * @param options Additional fetch options.
+     */
+    sendAsync(url: string | URL, options: RequestInit): Promise<Response>;
+
+    /**
+     * Sends a POST request.
+     * @param url The URL to send the request to.
+     * @param body The body of the request.
+     * @param headers Optional headers for the request.
+     */
+    post(
+        url: string | URL,
+        body: RequestBody,
+        headers?: Record<string, string>
+    ): Promise<Response>;
+
+    /**
+     * Sends a GET request.
+     * @param url The URL to send the request to.
+     * @param headers Optional headers for the request.
+     */
+    get(url: string | URL, headers?: Record<string, string>): Promise<Response>;
+}
+
+/**
+ * Represents an HTTP method type.
+ */
+export const HttpMethod = {
+    GET: "GET",
+    POST: "POST",
+    PUT: "PUT",
+    DELETE: "DELETE",
+} as const;

package/src/custom_auth/core/telemetry/PublicApiId.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * The public API ids should be claim in the MSAL telemtry tracker.
+ * All the following ids are hardcoded; so we need to find a way to claim them in the future and update them here.
+ */
+
+// Sign in
+export const SIGN_IN_WITH_CODE_START = 100001;
+export const SIGN_IN_WITH_PASSWORD_START = 100002;
+export const SIGN_IN_SUBMIT_CODE = 100003;
+export const SIGN_IN_SUBMIT_PASSWORD = 100004;
+export const SIGN_IN_RESEND_CODE = 100005;
+export const SIGN_IN_AFTER_SIGN_UP = 100006;
+export const SIGN_IN_AFTER_PASSWORD_RESET = 100007;
+
+// Sign up
+export const SIGN_UP_WITH_PASSWORD_START = 100021;
+export const SIGN_UP_START = 100022;
+export const SIGN_UP_SUBMIT_CODE = 100023;
+export const SIGN_UP_SUBMIT_PASSWORD = 100024;
+export const SIGN_UP_SUBMIT_ATTRIBUTES = 100025;
+export const SIGN_UP_RESEND_CODE = 100026;
+
+// Password reset
+export const PASSWORD_RESET_START = 100041;
+export const PASSWORD_RESET_SUBMIT_CODE = 100042;
+export const PASSWORD_RESET_SUBMIT_PASSWORD = 100043;
+export const PASSWORD_RESET_RESEND_CODE = 100044;
+
+// Get account
+export const ACCOUNT_GET_ACCOUNT = 100061;
+export const ACCOUNT_SIGN_OUT = 100062;
+export const ACCOUNT_GET_ACCESS_TOKEN = 100063;

package/src/custom_auth/core/utils/ArgumentValidator.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { InvalidArgumentError } from "../error/InvalidArgumentError.js";
+
+export function ensureArgumentIsNotNullOrUndefined<T>(
+    argName: string,
+    argValue: T | undefined | null,
+    correlationId?: string
+): asserts argValue is T {
+    if (argValue === null || argValue === undefined) {
+        throw new InvalidArgumentError(argName, correlationId);
+    }
+}
+
+export function ensureArgumentIsNotEmptyString(
+    argName: string,
+    argValue: string | undefined,
+    correlationId?: string
+): void {
+    if (!argValue || argValue.trim() === "") {
+        throw new InvalidArgumentError(argName, correlationId);
+    }
+}

package/src/custom_auth/core/utils/UrlUtils.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ParsedUrlError } from "../error/ParsedUrlError.js";
+import { InvalidUrl } from "../error/ParsedUrlErrorCodes.js";
+
+export function parseUrl(url: string): URL {
+    try {
+        return new URL(url);
+    } catch (e) {
+        throw new ParsedUrlError(
+            InvalidUrl,
+            `The URL "${url}" is invalid: ${e}`
+        );
+    }
+}
+
+export function buildUrl(baseUrl: string, path: string): URL {
+    const newBaseUrl = !baseUrl.endsWith("/") ? `${baseUrl}/` : baseUrl;
+    const newPath = path.startsWith("/") ? path.slice(1) : path;
+    const url = new URL(newPath, newBaseUrl);
+    return url;
+}