@asgardeo/javascript 0.0.1

package/dist/constants/PKCEConstants.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Constants related to Proof Key for Code Exchange (PKCE) implementation.
+ * This object contains all the necessary constants for implementing PKCE
+ * flow in the OAuth 2.0 authorization code grant.
+ *
+ * @remarks
+ * PKCE is an extension to the authorization code flow to prevent CSRF and
+ * authorization code injection attacks. The constants are organized into
+ * storage-related sections for managing PKCE state.
+ *
+ * @example
+ * ```typescript
+ * // Using storage keys
+ * const codeVerifierKey = PKCEConstants.Storage.StorageKeys.CODE_VERIFIER;
+ * const separator = PKCEConstants.Storage.StorageKeys.SEPARATOR;
+ * ```
+ */
+declare const PKCEConstants: {
+    /**
+     * Storage-related constants for managing PKCE state
+     */
+    readonly Storage: {
+        /**
+         * Collection of storage keys used in PKCE implementation
+         */
+        readonly StorageKeys: {
+            /**
+             * Key used to store the PKCE code verifier in temporary storage.
+             * The code verifier is a cryptographically random string that is
+             * used to generate the code challenge.
+             */
+            readonly CODE_VERIFIER: "pkce_code_verifier";
+            /**
+             * Separator used in storage keys to create unique identifiers
+             * by combining different parts of the key.
+             */
+            readonly SEPARATOR: "#";
+        };
+    };
+};
+export default PKCEConstants;

package/dist/constants/ScopeConstants.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Constants for OAuth 2.0 and OpenID Connect scopes.
+ * These scopes define the level of access that the client application
+ * is requesting from the authorization server.
+ *
+ * @remarks
+ * Scopes are space-separated strings that represent different permissions.
+ * The 'openid' scope is required for OpenID Connect flows, while other
+ * scopes provide access to different resources or user information.
+ *
+ * @example
+ * ```typescript
+ * // Requesting OpenID Connect authentication
+ * const scope = [ScopeConstants.OPENID];
+ *
+ * // Requesting profile information
+ * const scopes = [ScopeConstants.OPENID, ScopeConstants.PROFILE];
+ * ```
+ */
+declare const ScopeConstants: {
+    /**
+     * The base OpenID Connect scope.
+     * Required for all OpenID Connect flows. Indicates that the client
+     * is initiating an OpenID Connect authentication request.
+     */
+    readonly OPENID: "openid";
+};
+export default ScopeConstants;

package/dist/constants/TokenConstants.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Constants related to OIDC token management and storage.
+ * This object contains configuration values and storage keys
+ * used in token validation and management processes.
+ *
+ * @remarks
+ * The constants are organized into two main sections:
+ * 1. SignatureValidation - Contains supported algorithms for token validation
+ * 2. Storage - Contains keys used for storing token-related data
+ *
+ * @example
+ * ```typescript
+ * // Using signature validation algorithms
+ * const algorithms = TokenConstants.SignatureValidation.SUPPORTED_ALGORITHMS;
+ *
+ * // Using storage keys
+ * const timerKey = TokenConstants.Storage.StorageKeys.REFRESH_TOKEN_TIMER;
+ * ```
+ */
+declare const TokenConstants: {
+    /**
+     * Token signature validation constants.
+     * Contains configurations related to token signature verification.
+     */
+    readonly SignatureValidation: {
+        /**
+         * Fallback array of supported signature algorithms for OIDC token validation.
+         * These values are used when the supported algorithms cannot be retrieved from
+         * the .well-known/openid-configuration endpoint.
+         *
+         * Supported algorithms:
+         * - `RS256` - RSASSA-PKCS1-v1_5 using SHA-256
+         * - `RS512` - RSASSA-PKCS1-v1_5 using SHA-512
+         * - `RS384` - RSASSA-PKCS1-v1_5 using SHA-384
+         * - `PS256` - RSASSA-PSS using SHA-256 and MGF1 with SHA-256
+         */
+        readonly SUPPORTED_ALGORITHMS: readonly ["RS256", "RS512", "RS384", "PS256"];
+    };
+    /**
+     * Storage-related constants for OIDC tokens.
+     * Contains keys used to store token-related data in browser storage.
+     */
+    readonly Storage: {
+        /**
+         * Collection of storage keys used in token management.
+         * These keys are used to store and retrieve token-related
+         * information from browser storage.
+         */
+        readonly StorageKeys: {
+            /**
+             * Key used to store the refresh token timer identifier.
+             * This timer is used to schedule token refresh operations
+             * before the current token expires.
+             */
+            readonly REFRESH_TOKEN_TIMER: "refresh_token_timer";
+        };
+    };
+};
+export default TokenConstants;

package/dist/constants/TokenExchangeConstants.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Constants for OAuth 2.0 Token Exchange operations.
+ * This object contains placeholders used in token exchange requests
+ * and responses for dynamic value substitution.
+ *
+ * @remarks
+ * These placeholders are used in token exchange templates and are replaced
+ * with actual values during request processing. They help in creating
+ * flexible and reusable token exchange configurations.
+ *
+ * @example
+ * ```typescript
+ * // Using placeholders in a token exchange template
+ * const template = `grant_type=urn:ietf:params:oauth:grant-type:token-exchange&subject_token=${TokenExchangeConstants.Placeholders.TOKEN}`;
+ * ```
+ */
+declare const TokenExchangeConstants: {
+    /**
+     * Collection of placeholder strings used in token exchange operations.
+     * These placeholders are replaced with actual values when processing
+     * token exchange requests.
+     */
+    readonly Placeholders: {
+        /**
+         * Placeholder for the token value in exchange requests.
+         * Usually replaced with an access token or refresh token.
+         */
+        readonly TOKEN: "{{token}}";
+        /**
+         * Placeholder for the username in token exchange operations.
+         * Used when user identity needs to be included in the exchange.
+         */
+        readonly USERNAME: "{{username}}";
+        /**
+         * Placeholder for OAuth scopes in token exchange requests.
+         * Replaced with space-separated scope strings.
+         */
+        readonly SCOPE: "{{scope}}";
+        /**
+         * Placeholder for client ID in token exchange operations.
+         * Required for client authentication.
+         */
+        readonly CLIENT_ID: "{{clientID}}";
+        /**
+         * Placeholder for client secret in token exchange operations.
+         * Used for client authentication in confidential client flows.
+         */
+        readonly CLIENT_SECRET: "{{clientSecret}}";
+    };
+};
+export default TokenExchangeConstants;

package/dist/errors/AsgardeoAPIError.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import AsgardeoError from './AsgardeoError';
+/**
+ * Base class for all API-related errors in Asgardeo. This class extends AsgardeoError
+ * and adds support for HTTP status codes and status text.
+ *
+ * @example
+ * ```typescript
+ * throw new AsgardeoAPIError(
+ *   "Failed to fetch user data",
+ *   "API_FETCH_ERROR",
+ *   404,
+ *   "Not Found"
+ * );
+ * ```
+ */
+export default class AsgardeoAPIError extends AsgardeoError {
+    readonly statusCode?: number;
+    readonly statusText?: string;
+    /**
+     * Creates an instance of AsgardeoAPIError.
+     *
+     * @param message - Human-readable description of the error
+     * @param code - A unique error code that identifies the error type
+     * @param statusCode - HTTP status code of the failed request
+     * @param statusText - HTTP status text of the failed request
+     * @param origin - Optional. The SDK origin (e.g. 'react', 'vue'). Defaults to generic 'Asgardeo'
+     * @constructor
+     */
+    constructor(message: string, code: string, origin: string, statusCode?: number, statusText?: string);
+    /**
+     * Returns a string representation of the API error
+     * @returns Formatted error string with name, code, status, and message
+     */
+    toString(): string;
+}

package/dist/errors/AsgardeoError.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Base class for all Asgardeo errors. This class extends the native Error class
+ * and adds support for error codes and proper stack traces. Each error is prefixed
+ * with a shield emoji and the SDK name for easy identification.
+ *
+ * @example
+ * ```typescript
+ * // Create a new error with a message and code
+ * throw new AsgardeoError(
+ *   "Invalid authentication response",
+ *   "AUTH_ERROR"
+ * );
+ *
+ * // Or with a specific SDK name
+ * throw new AsgardeoError(
+ *   "Invalid authentication response",
+ *   "AUTH_ERROR",
+ *   "@asgardeo/react"
+ * );
+ *
+ * // The error message will be formatted as:
+ * // 🛡️ Asgardeo React: Invalid authentication response
+ * //
+ * // (code="AUTH_ERROR")
+ */
+export default class AsgardeoError extends Error {
+    readonly code: string;
+    readonly origin: string;
+    private static resolveOrigin;
+    constructor(message: string, code: string, origin: string);
+    toString(): string;
+}

package/dist/errors/AsgardeoRuntimeError.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import AsgardeoError from './AsgardeoError';
+/**
+ * Base class for all runtime errors in Asgardeo. This class extends AsgardeoError
+ * and adds support for additional error details. Use this class for errors that occur
+ * during runtime execution that are not related to API calls.
+ *
+ * @example
+ * ```typescript
+ * throw new AsgardeoRuntimeError(
+ *   "Failed to parse configuration",
+ *   "CONFIG_PARSE_ERROR",
+ *   { invalidField: "redirectUri" }
+ * );
+ * ```
+ */
+export default class AsgardeoRuntimeError extends AsgardeoError {
+    readonly details?: unknown;
+    /**
+     * Creates an instance of AsgardeoRuntimeError.
+     *
+     * @param message - Human-readable description of the error
+     * @param code - A unique error code that identifies the error type
+     * @param details - Additional details about the error that might be helpful for debugging
+     * @param origin - Optional. The SDK origin (e.g. 'react', 'vue'). Defaults to generic 'Asgardeo'
+     * @constructor
+     */
+    constructor(message: string, code: string, origin: string, details?: unknown);
+    /**
+     * Returns a string representation of the runtime error
+     * @returns Formatted error string with name, code, details, and message
+     */
+    toString(): string;
+}

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export * from './__legacy__/client';
+export * from './__legacy__/models';
+export * from './models/oauth-response';
+export * from './IsomorphicCrypto';
+export * from './__legacy__/exception';
+export * from './__legacy__/data';
+export { default as getUserInfo } from './api/oidc/getUserInfo';
+export { default as TokenConstants } from './constants/TokenConstants';
+export { default as OIDCRequestConstants } from './constants/OIDCRequestConstants';
+export { default as AsgardeoError } from './errors/AsgardeoError';
+export { default as AsgardeoAPIError } from './errors/AsgardeoAPIError';
+export { default as AsgardeoRuntimeError } from './errors/AsgardeoRuntimeError';
+export { AsgardeoClient, SignInOptions, SignOutOptions } from './models/client';
+export { BaseConfig, Config, Preferences, ThemePreferences } from './models/config';
+export { TokenResponse } from './models/token';
+export { Crypto, JWKInterface } from './models/crypto';
+export { IdTokenPayload } from './models/id-token';
+export { OIDCEndpoints } from './models/oidc-endpoints';
+export { Store } from './models/store';
+export { User } from './models/user';
+export { Schema, SchemaAttribute, WellKnownSchemaIds } from './models/scim2-schema';
+export { RecursivePartial } from './models/utility-types';
+export { default as AsgardeoJavaScriptClient } from './AsgardeoJavaScriptClient';
+export { default as createTheme } from './theme/createTheme';
+export { ThemeColors, ThemeConfig, Theme, ThemeMode } from './theme/types';
+export { default as extractUserClaimsFromIdToken } from './utils/extractUserClaimsFromIdToken';
+export { default as extractPkceStorageKeyFromState } from './utils/extractPkceStorageKeyFromState';
+export { default as removeTrailingSlash } from './utils/removeTrailingSlash';