@asgardeo/javascript 0.0.1

package/dist/models/store.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 { OIDCEndpoints } from './oidc-endpoints';
+/**
+ * Interface representing a key-value storage mechanism.
+ * Implementations can include various storage backends like browser storage,
+ * memory cache, or distributed caches like Redis or Memcached.
+ */
+export interface Store {
+    /**
+     * Stores a value with the specified key.
+     *
+     * @param key - The unique identifier for the stored value
+     * @param value - The string value to store
+     * @returns A promise that resolves when the value is successfully stored
+     * @throws Error if storage operation fails
+     */
+    setData(key: string, value: string): Promise<void>;
+    /**
+     * Retrieves a value by its key.
+     *
+     * @param key - The key of the value to retrieve
+     * @returns A promise that resolves with the stored value
+     * @throws Error if the key doesn't exist or retrieval fails
+     */
+    getData(key: string): Promise<string>;
+    /**
+     * Removes a value from the store.
+     *
+     * @param key - The key of the value to remove
+     * @returns A promise that resolves when the value is successfully removed
+     * @throws Error if removal fails or the key doesn't exist
+     */
+    removeData(key: string): Promise<void>;
+}
+/**
+ * Represents the possible value types that can be stored in the temporary data storage.
+ */
+export type TemporaryStoreValue = string | string[] | boolean | number | OIDCEndpoints;
+/**
+ * Represents a key-value store for temporary data storage.
+ */
+export type TemporaryStore = {
+    [key: string]: TemporaryStoreValue;
+};
+/**
+ * Enum representing different types of data stores used in the application.
+ */
+export declare enum Stores {
+    /**
+     * Store for configuration data that defines the application's behavior and settings.
+     */
+    ConfigData = "config_data",
+    /**
+     * Store for OpenID Connect provider metadata, including endpoints and configuration.
+     */
+    OIDCProviderMetaData = "oidc_provider_meta_data",
+    /**
+     * Store for user session-related data like tokens and authentication state.
+     */
+    SessionData = "session_data",
+    /**
+     * Store for temporary data that needs to persist only for a short duration.
+     */
+    TemporaryData = "temporary_data"
+}

package/dist/models/token.d.ts

@@ -0,0 +1,121 @@
+/**
+ * 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.
+ */
+/**
+ * Represents a processed token response with standardized camelCase properties.
+ * This interface provides a clean, normalized structure for token data after
+ * processing the raw response from the authentication server.
+ *
+ * The properties in this interface follow JavaScript/TypeScript naming conventions
+ * and provide a more ergonomic API for client applications.
+ */
+export interface TokenResponse {
+    /**
+     * The bearer token used for authenticating API requests.
+     * This token should be included in the Authorization header
+     * of subsequent API requests.
+     */
+    accessToken: string;
+    /**
+     * JSON Web Token (JWT) containing user identity information.
+     * This token can be decoded to access user claims and metadata
+     * without additional server requests.
+     */
+    idToken: string;
+    /**
+     * Duration in seconds until the access token expires.
+     * Applications should refresh the token before this time
+     * to maintain uninterrupted access.
+     */
+    expiresIn: string;
+    /**
+     * Space-separated list of OAuth scopes granted to the application.
+     * These scopes determine what resources and actions the application
+     * has permission to access.
+     */
+    scope: string;
+    /**
+     * Token used to obtain new access tokens without re-authentication.
+     * Store this securely as it enables long-term access to the user's
+     * account through the refresh flow.
+     */
+    refreshToken: string;
+    /**
+     * The type of token issued, typically "Bearer".
+     * This indicates how the token should be used in
+     * API request Authorization headers.
+     */
+    tokenType: string;
+    /**
+     * Unix timestamp (in seconds) when the token was created.
+     * Used in combination with expiresIn to determine when
+     * the token needs to be refreshed.
+     */
+    createdAt: number;
+}
+/**
+ * Represents the raw token response received directly from the authentication server.
+ * This interface maintains the original snake_case property names as received in
+ * the server response before processing into the standardized TokenResponse format.
+ *
+ * The properties in this interface exactly match the OAuth2/OIDC server response
+ * format before any transformation or normalization is applied.
+ */
+export interface AccessTokenApiResponse {
+    /**
+     * Raw access token string from the server.
+     * This is the bearer token in its original format
+     * before any processing or validation.
+     */
+    access_token: string;
+    /**
+     * Raw expiration time in seconds.
+     * Indicates how long the access token will be valid
+     * from the time it was issued.
+     */
+    expires_in: string;
+    /**
+     * Server-provided creation timestamp in Unix seconds.
+     * Used to track when the token was originally issued
+     * and calculate absolute expiration time.
+     */
+    created_at: number;
+    /**
+     * Raw ID token string containing encoded user information.
+     * This JWT can be decoded to access standardized claims
+     * about the authenticated user.
+     */
+    id_token: string;
+    /**
+     * Raw refresh token string from the server.
+     * Used in its original format to request new access tokens
+     * when they expire.
+     */
+    refresh_token: string;
+    /**
+     * Raw space-separated scope string defining access permissions.
+     * Lists the OAuth scopes that were granted during the
+     * authorization process.
+     */
+    scope: string;
+    /**
+     * Raw token type identifier from the server.
+     * Typically "Bearer", indicating how the token should
+     * be used in API requests.
+     */
+    token_type: string;
+}

package/dist/models/user.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 { Schema } from './scim2-schema';
+/**
+ * Type for the Meta object in SCIM2 responses
+ */
+export interface UserMeta {
+    created: string;
+    location: string;
+    lastModified: string;
+    resourceType: string;
+}
+/**
+ * Type for the Role object in SCIM2 responses
+ */
+export interface UserRole {
+    audienceValue: string;
+    display: string;
+    audienceType: string;
+    value: string;
+    $ref: string;
+    audienceDisplay: string;
+}
+/**
+ * Type for the Name object in SCIM2 responses
+ */
+export interface UserName {
+    formatted: string;
+    givenName: string;
+    familyName: string;
+}
+/**
+ * Represents a user in the Asgardeo system.
+ *
+ * @remarks
+ * This interface defines the user properties based on the SCIM2 schema.
+ * WSO2 specific properties are flattened to the root level for easier access.
+ *
+ * @example
+ * ```typescript
+ * const user: User = {
+ *   emails: ["user@example.com"],
+ *   profileUrl: "https://gravatar.com/avatar/123",
+ *   meta: {
+ *     created: "2021-06-21T11:28:21.800618Z",
+ *     location: "https://api.asgardeo.io/scim2/Users/123",
+ *     lastModified: "2025-04-30T06:46:48.520896Z",
+ *     resourceType: "User"
+ *   },
+ *   name: {
+ *     formatted: "John Smith",
+ *     givenName: "John",
+ *     familyName: "Smith"
+ *   },
+ *   userName: "john@example.com",
+ *   id: "123",
+ *   // Flattened WSO2 schema properties
+ *   accountState: "UNLOCKED",
+ *   accountLocked: "false",
+ *   photoUrl: "https://gravatar.com/avatar/123",
+ *   emailVerified: "true",
+ *   lastLogonTime: "1749098996152"
+ * };
+ * ```
+ */
+export interface User {
+    emails: string[];
+    profileUrl?: string;
+    meta: UserMeta;
+    schemas: Schema[];
+    roles?: UserRole[];
+    name: UserName;
+    id: string;
+    userName: string;
+    accountState?: string;
+    accountLocked?: string;
+    failedLoginLockoutCount?: string;
+    failedTOTPAttempts?: string;
+    failedLoginAttempts?: string;
+    totpEnabled?: string;
+    photoUrl?: string;
+    emailVerified?: string;
+    backupCodeEnabled?: string;
+    lastLogonTime?: string;
+    signedUpRegion?: string;
+    unlockTime?: string;
+    isReadOnlyUser?: string;
+    failedLoginAttemptsBeforeSuccess?: string;
+    [key: string]: any;
+}
+export default User;

package/dist/models/utility-types.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>;
+};

package/dist/theme/createTheme.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { RecursivePartial } from '../models/utility-types';
+import { Theme, ThemeConfig } from './types';
+declare const createTheme: (config?: RecursivePartial<ThemeConfig>, isDark?: boolean) => Theme;
+export default createTheme;

package/dist/theme/types.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+export interface ThemeColors {
+    primary: {
+        main: string;
+        contrastText: string;
+    };
+    secondary: {
+        main: string;
+        contrastText: string;
+    };
+    background: {
+        surface: string;
+        disabled: string;
+        body: {
+            main: string;
+        };
+    };
+    surface: string;
+    text: {
+        primary: string;
+        secondary: string;
+    };
+    border: string;
+    error: {
+        main: string;
+        contrastText: string;
+    };
+}
+export interface ThemeConfig {
+    colors: ThemeColors;
+    spacing: {
+        unit: number;
+    };
+    borderRadius: {
+        small: string;
+        medium: string;
+        large: string;
+    };
+}
+export interface Theme extends ThemeConfig {
+    cssVariables: Record<string, string>;
+}
+export type ThemeMode = 'light' | 'dark' | 'system';

package/dist/utils/extractPkceStorageKeyFromState.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Extracts the PKCE key from a state parameter string.
+ *
+ * @param state - The state parameter string containing the request index.
+ * @returns The PKCE key string in the format `pkce_code_verifier_${index}`.
+ *
+ * @example
+ * ```typescript
+ * const state = "request_1";
+ * const pkceKey = extractPkceStorageKeyFromState(state);
+ * // Returns: "pkce_code_verifier_1"
+ * ```
+ */
+declare const extractPkceStorageKeyFromState: (state: string) => string;
+export default extractPkceStorageKeyFromState;

package/dist/utils/extractTenantDomainFromIdTokenPayload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { IdTokenPayload } from '../models/id-token';
+/**
+ * Extracts the tenant domain from the ID token payload.
+ *
+ * @deprecated since v1.0.6 — This utility assumes a legacy tenant extraction pattern from the `sub` claim,
+ * which may not be reliable. Will be removed in a future version.
+ *
+ * @param payload - The ID token payload containing the `sub` claim.
+ * @param subjectSeparator - The separator used in the `sub` claim to split the user identifier and tenant domain.
+ *
+ * Consider extracting the tenant domain using a dedicated claim (e.g., `tenant_domain`) when available.
+ */
+declare const extractTenantDomainFromIdTokenPayload: (payload: IdTokenPayload, subjectSeparator?: string) => string;
+export default extractTenantDomainFromIdTokenPayload;

package/dist/utils/extractUserClaimsFromIdToken.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+import { IdTokenPayload } from '../models/id-token';
+/**
+ * Removes standard protocol-specific claims from the ID token payload
+ * and returns a camelCased object of user-specific claims.
+ *
+ * @param payload The raw ID token payload.
+ * @returns A cleaned-up, camelCased object containing only user-specific claims.
+ *
+ * @example
+ * ````typescript
+ * const idTokenPayload = {
+ *   iss: 'https://example.com',
+ *   aud: 'client_id',
+ *   exp: 1712345678,
+ *   iat: 1712345670,
+ *   email: 'user@example.com'
+ *  };
+ *
+ * const userClaims = extractUserClaimsFromIdToken(idTokenPayload);
+ * // // userClaims will be:
+ * // {
+ * //   email: 'user@example.com'
+ * // }
+ * ```
+ */
+declare const extractUserClaimsFromIdToken: (payload: IdTokenPayload) => Record<string, unknown>;
+export default extractUserClaimsFromIdToken;

package/dist/utils/generatePkceStorageKey.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2025, 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.
+ */
+import { TemporaryStore } from '../models/store';
+/**
+ * Generates the next available PKCE storage key based on the current temporary data.
+ *
+ * The generated key will follow the format: `pkce_code_verifier_<index>`, where `<index>` is incremented
+ * based on the highest existing index in the provided storage object.
+ *
+ * @param tempStore - The object that holds temporary PKCE-related data (e.g., sessionStorage).
+ *
+ * @returns A new unique PKCE storage key to store the next `code_verifier`.
+ *
+ * @example
+ * const key = generatePkceStorageKey(sessionStorage);
+ * // Returns: "pkce_code_verifier_3" (if existing keys are pkce_code_verifier_0 to _2)
+ */
+declare const generatePkceStorageKey: (tempStore: TemporaryStore) => string;
+export default generatePkceStorageKey;

package/dist/utils/generateStateParamForRequestCorrelation.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ * Generates a state parameter for request correlation by combining an optional state string with a request index.
+ *
+ * @param pkceKey - The PKCE key containing the index (format: 'pkce_code_verifier_[index]').
+ * @param state - Optional state string to prepend to the request correlation.
+ * @returns A state parameter string in the format '[state_]request_[index]'.
+ *
+ * @example
+ * const pkceKey = "pkce_code_verifier_1";
+ * const result = generateStateParamForRequestCorrelation(pkceKey, "myState");
+ * // Returns: "myState_request_1"
+ *
+ * const resultNoState = generateStateParamForRequestCorrelation(pkceKey);
+ * // Returns: "request_1"
+ */
+declare const generateStateParamForRequestCorrelation: (pkceKey: string, state?: string) => string;
+export default generateStateParamForRequestCorrelation;

package/dist/utils/removeTrailingSlash.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+/**
+ * Removes a trailing slash from a path string if it exists.
+ *
+ * @param path - The string path to process
+ * @returns The path without a trailing slash
+ *
+ * @example
+ * ```typescript
+ * removeTrailingSlash('/path/to/something/') // returns '/path/to/something'
+ * removeTrailingSlash('/path/to/something') // returns '/path/to/something'
+ * ```
+ */
+declare const removeTrailingSlash: (path: string) => string;
+export default removeTrailingSlash;