@asgardeo/javascript 0.0.1 → 0.1.0

package/dist/models/application-native-authentication.d.ts

@@ -0,0 +1,82 @@
+export interface ApplicationNativeAuthenticationInitiateResponse {
+    flowId: string;
+    flowStatus: ApplicationNativeAuthenticationFlowStatus;
+    flowType: ApplicationNativeAuthenticationFlowType;
+    nextStep: {
+        stepType: ApplicationNativeAuthenticationStepType;
+        authenticators: ApplicationNativeAuthenticationAuthenticator[];
+    };
+    links: ApplicationNativeAuthenticationLink[];
+}
+export declare enum ApplicationNativeAuthenticationFlowStatus {
+    SuccessCompleted = "SUCCESS_COMPLETED",
+    FailCompleted = "FAIL_COMPLETED",
+    FailIncomplete = "FAIL_INCOMPLETE",
+    Incomplete = "INCOMPLETE"
+}
+export declare enum ApplicationNativeAuthenticationFlowType {
+    Authentication = "AUTHENTICATION"
+}
+export declare enum ApplicationNativeAuthenticationStepType {
+    AuthenticatorPrompt = "AUTHENTICATOR_PROMPT",
+    MultOptionsPrompt = "MULTI_OPTIONS_PROMPT"
+}
+export interface ApplicationNativeAuthenticationAuthenticator {
+    authenticatorId: string;
+    authenticator: string;
+    idp: string;
+    metadata: {
+        i18nKey: string;
+        promptType: ApplicationNativeAuthenticationAuthenticatorPromptType;
+        params: {
+            param: string;
+            type: ApplicationNativeAuthenticationAuthenticatorParamType;
+            order: number;
+            i18nKey: string;
+            displayName: string;
+            confidential: boolean;
+        }[];
+    };
+    requiredParams: string[];
+}
+export interface ApplicationNativeAuthenticationLink {
+    name: string;
+    href: string;
+    method: string;
+}
+export interface ApplicationNativeAuthenticationHandleRequestPayload {
+    flowId: string;
+    selectedAuthenticator: {
+        authenticatorId: string;
+        params: Record<string, string>;
+    };
+}
+export interface ApplicationNativeAuthenticationHandleResponse {
+    flowStatus: string;
+    authData: Record<string, any>;
+}
+export declare enum ApplicationNativeAuthenticationAuthenticatorParamType {
+    String = "STRING",
+    Integer = "INTEGER",
+    MultiValued = "MULTI_VALUED"
+}
+export declare enum ApplicationNativeAuthenticationAuthenticatorExtendedParamType {
+    Otp = "OTPCode"
+}
+export declare enum ApplicationNativeAuthenticationAuthenticatorKnownIdPType {
+    Local = "LOCAL"
+}
+export declare enum ApplicationNativeAuthenticationAuthenticatorPromptType {
+    /**
+     * Prompt for user input, typically for username/password or similar credentials.
+     */
+    UserPrompt = "USER_PROMPT",
+    /**
+     * Prompt for internal system use, such as API keys or tokens.
+     */
+    InternalPrompt = "INTERNAL_PROMPT",
+    /**
+     * Prompt for redirection to another page or service.
+     */
+    RedirectionPrompt = "REDIRECTION_PROMPT"
+}

package/dist/models/client.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { User } from './user';
+import { User, UserProfile } from './user';
 export type SignInOptions = Record<string, unknown>;
 export type SignOutOptions = Record<string, unknown>;
 /**
@@ -35,6 +35,12 @@ export interface AsgardeoClient<T> {
      * @returns User object containing user details.
      */
     getUser(): Promise<User>;
+    /**
+     * Fetches the user profile along with its schemas and a flattened version of the profile.
+     *
+     * @returns A promise resolving to a UserProfile object containing the user's profile information.
+     */
+    getUserProfile(): Promise<UserProfile>;
     /**
      * Initializes the authentication client with provided configuration.
      *
@@ -51,7 +57,7 @@ export interface AsgardeoClient<T> {
     isLoading(): boolean;
     /**
      * Checks if a user is signed in.
-     * FIXME: This should be integrated with the existing isAuthenticated method which returns a Promise.
+     * FIXME: This should be integrated with the existing isSignedIn method which returns a Promise.
      *
      * @returns Boolean indicating sign-in status.
      */

package/dist/models/config.d.ts

@@ -16,8 +16,9 @@
  * under the License.
  */
 import { ThemeConfig, ThemeMode } from '../theme/types';
+import { I18nBundle } from './i18n';
 import { RecursivePartial } from './utility-types';
-export interface BaseConfig<T = unknown> {
+export interface BaseConfig<T = unknown> extends WithPreferences {
     /**
      * Optional URL where the authorization server should redirect after authentication.
      * This must match one of the allowed redirect URIs configured in your IdP.
@@ -57,6 +58,8 @@ export interface BaseConfig<T = unknown> {
      * scopes: ["openid", "profile", "email"]
      */
     scopes?: string | string[] | undefined;
+}
+export interface WithPreferences {
     /**
      * Preferences for customizing the Asgardeo UI components
      */
@@ -73,9 +76,31 @@ export interface ThemePreferences {
      */
     overrides?: RecursivePartial<ThemeConfig>;
 }
+export interface I18nPreferences {
+    /**
+     * The language to use for translations.
+     * Defaults to the browser's default language.
+     */
+    language?: string;
+    /**
+     * The fallback language to use if translations are not available in the specified language.
+     * Defaults to 'en-US'.
+     */
+    fallbackLanguage?: string;
+    /**
+     * Custom translations to override default ones.
+     */
+    bundles?: {
+        [key: string]: I18nBundle;
+    };
+}
 export interface Preferences {
     /**
      * Theme preferences for the Asgardeo UI components
      */
     theme?: ThemePreferences;
+    /**
+     * Internationalization preferences for the Asgardeo UI components
+     */
+    i18n?: I18nPreferences;
 }

package/dist/models/crypto.d.ts

@@ -87,7 +87,7 @@ export interface Crypto<T = any> {
      * @param idToken - ID Token to be verified.
      * @param jwk - JWK to be used for verification.
      * @param algorithms - Algorithms to be used for verification.
-     * @param clientID - Client ID to be used for verification.
+     * @param clientId - Client ID to be used for verification.
      * @param issuer - Issuer to be used for verification.
      * @param subject - Subject to be used for verification.
      * @param clockTolerance - Clock tolerance to be used for verification.
@@ -96,5 +96,5 @@ export interface Crypto<T = any> {
      *
      * @throws if the id_token is invalid.
      */
-    verifyJwt(idToken: string, jwk: JWKInterface, algorithms: string[], clientID: string, issuer: string, subject: string, clockTolerance?: number, validateJwtIssuer?: boolean): Promise<boolean>;
+    verifyJwt(idToken: string, jwk: JWKInterface, algorithms: string[], clientId: string, issuer: string, subject: string, clockTolerance?: number, validateJwtIssuer?: boolean): Promise<boolean>;
 }

package/dist/{__legacy__/models/custom-grant.d.ts → models/field.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * 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
@@ -15,12 +15,16 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-export interface CustomGrantConfig {
-    id: string;
-    data: any;
-    signInRequired: boolean;
-    attachToken: boolean;
-    returnsSession: boolean;
-    tokenEndpoint?: string;
-    shouldReplayAfterRefresh?: boolean;
+export declare enum FieldType {
+    Text = "TEXT",
+    Password = "PASSWORD",
+    Email = "EMAIL",
+    Number = "NUMBER",
+    Select = "SELECT",
+    Checkbox = "CHECKBOX",
+    Radio = "RADIO",
+    Otp = "OTP",
+    Date = "DATE",
+    Time = "TIME",
+    Textarea = "TEXTAREA"
 }

package/dist/models/i18n.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 I18nTranslations {
+    'elements.buttons.signIn': string;
+    'elements.buttons.signOut': string;
+    'elements.buttons.signUp': string;
+    'elements.buttons.facebook': string;
+    'elements.buttons.google': string;
+    'elements.buttons.github': string;
+    'elements.buttons.microsoft': string;
+    'elements.buttons.linkedin': string;
+    'elements.buttons.ethereum': string;
+    'elements.buttons.multi.option': string;
+    'elements.buttons.social': string;
+    'elements.fields.placeholder': string;
+    'signin.title': string;
+    'email.otp.title': string;
+    'email.otp.subtitle': string;
+    'email.otp.submit.button': string;
+    'identifier.first.title': string;
+    'identifier.first.subtitle': string;
+    'identifier.first.submit.button': string;
+    'sms.otp.title': string;
+    'sms.otp.subtitle': string;
+    'sms.otp.submit.button': string;
+    'totp.title': string;
+    'totp.subtitle': string;
+    'totp.submit.button': string;
+    'username.password.submit.button': string;
+    'username.password.title': string;
+    'username.password.subtitle': string;
+    'messages.loading': string;
+    'errors.title': string;
+    'errors.sign.in.initialization': string;
+    'errors.sign.in.flow.failure': string;
+    'errors.sign.in.flow.completion.failure': string;
+    'errors.sign.in.flow.passkeys.failure': string;
+    'errors.sign.in.flow.passkeys.completion.failure': string;
+}
+export type I18nTextDirection = 'ltr' | 'rtl';
+export interface I18nMetadata {
+    localeCode: string;
+    countryCode: string;
+    languageCode: string;
+    displayName: string;
+    direction: I18nTextDirection;
+}
+export interface I18nBundle {
+    metadata: I18nMetadata;
+    translations: I18nTranslations;
+}

package/dist/{__legacy__/models/authorization-url.d.ts → models/oauth-request.d.ts}

@@ -15,9 +15,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-export type AuthorizationURLParams = Omit<GetAuthURLConfig, "forceInit">;
-export interface StrictGetAuthURLConfig {
+export type AuthorizeRequestUrlParams = Omit<ExtendedAuthorizeRequestUrlParams, 'forceInit'>;
+export interface KnownExtendedAuthorizeRequestUrlParams {
     fidp?: string;
     forceInit?: boolean;
 }
-export type GetAuthURLConfig = StrictGetAuthURLConfig & Record<string, string | boolean>;
+export type ExtendedAuthorizeRequestUrlParams = KnownExtendedAuthorizeRequestUrlParams & Record<string, string | boolean>;

package/dist/models/oauth-response.d.ts

@@ -15,20 +15,4 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-/**
- * Enum representing different OAuth response modes.
- */
-export declare enum ResponseMode {
-    /**
-     * Response is returned as POST parameters in an HTML form.
-     */
-    FormPost = "form_post",
-    /**
-     * Response is returned as query parameters in the URL.
-     */
-    Query = "query",
-    /**
-     * Response is returned directly to the client.
-     */
-    Direct = "direct"
-}
+export type OAuthResponseMode = 'form_post' | 'query' | 'direct';

package/dist/models/scim2-schema.d.ts

@@ -45,6 +45,9 @@ export interface Schema {
     /** Schema attributes */
     attributes: SchemaAttribute[];
 }
+export interface FlattenedSchema extends Schema {
+    schemaId: string;
+}
 /**
  * Well-known SCIM2 schema IDs
  */

package/dist/{__legacy__/models/data.d.ts → models/session.d.ts}

@@ -25,3 +25,7 @@ export interface SessionData {
     session_state: string;
     created_at: number;
 }
+export interface UserSession {
+    scopes: string[];
+    sessionState: string;
+}

package/dist/models/store.d.ts

@@ -21,7 +21,7 @@ import { OIDCEndpoints } from './oidc-endpoints';
  * Implementations can include various storage backends like browser storage,
  * memory cache, or distributed caches like Redis or Memcached.
  */
-export interface Store {
+export interface Storage {
     /**
      * Stores a value with the specified key.
      *

package/dist/models/token.d.ts

@@ -119,3 +119,50 @@ export interface AccessTokenApiResponse {
      */
     token_type: string;
 }
+/**
+ * Interface for the standard (required) claims of an ID Token payload.
+ */
+export interface IdTokenPayloadStandardClaims {
+    /**
+     * The audience for which this token is intended.
+     */
+    aud: string | string[];
+    /**
+     * The unique identifier of the user to whom the ID token belongs.
+     */
+    sub: string;
+    /**
+     * The issuer identifier for the issuer of the response.
+     */
+    iss: string;
+    /**
+     * The email of the user.
+     */
+    email?: string;
+    /**
+     * The username the user prefers to be called.
+     */
+    preferred_username?: string;
+    /**
+     * The tenant domain of the user.
+     */
+    tenant_domain?: string;
+}
+/**
+ * Interface for ID Token payload including custom claims.
+ */
+export interface IdTokenPayload extends IdTokenPayloadStandardClaims {
+    /**
+     * Other custom claims.
+     */
+    [claim: string]: any;
+}
+export interface TokenExchangeRequestConfig {
+    id: string;
+    data: any;
+    signInRequired: boolean;
+    attachToken: boolean;
+    returnsSession: boolean;
+    tokenEndpoint?: string;
+    shouldReplayAfterRefresh?: boolean;
+}

package/dist/models/user.d.ts

@@ -16,91 +16,18 @@
  * 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;
+export interface KnownUser {
+    username?: string;
+    email?: string;
+    givenName?: string;
+    familyName?: string;
+    displayName?: 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;
+export interface User extends KnownUser {
+    [key: string]: any;
 }
-/**
- * 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;
+export interface UserProfile {
     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;
+    profile: User;
+    flattenedProfile: User;
 }
-export default User;

package/dist/theme/types.d.ts

@@ -31,7 +31,6 @@ export interface ThemeColors {
             main: string;
         };
     };
-    surface: string;
     text: {
         primary: string;
         secondary: string;

package/dist/utils/deepMerge.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Recursively merges the properties of source objects into a target object.
+ * Similar to Lodash's merge function, this creates a deep copy and merges
+ * nested objects recursively. Arrays and non-plain objects are replaced entirely.
+ *
+ * @param target - The target object to merge into
+ * @param sources - One or more source objects to merge from
+ * @returns A new object with merged properties
+ *
+ * @example
+ * ```typescript
+ * const obj1 = { a: 1, b: { x: 1, y: 2 } };
+ * const obj2 = { b: { y: 3, z: 4 }, c: 3 };
+ * const result = deepMerge(obj1, obj2);
+ * // Result: { a: 1, b: { x: 1, y: 3, z: 4 }, c: 3 }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const config = { theme: { colors: { primary: 'blue' } } };
+ * const userPrefs = { theme: { colors: { secondary: 'red' } } };
+ * const merged = deepMerge(config, userPrefs);
+ * // Result: { theme: { colors: { primary: 'blue', secondary: 'red' } } }
+ * ```
+ */
+declare const deepMerge: <T extends Record<string, any>>(target: T, ...sources: Array<Record<string, any> | undefined | null>) => T;
+export default deepMerge;

package/dist/utils/extractTenantDomainFromIdTokenPayload.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { IdTokenPayload } from '../models/id-token';
+import { IdTokenPayload } from '../models/token';
 /**
  * Extracts the tenant domain from the ID token payload.
  *

package/dist/utils/extractUserClaimsFromIdToken.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { IdTokenPayload } from '../models/id-token';
+import { IdTokenPayload } from '../models/token';
 /**
  * Removes standard protocol-specific claims from the ID token payload
  * and returns a camelCased object of user-specific claims.

package/dist/utils/flattenUserSchema.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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, FlattenedSchema } from '../models/scim2-schema';
+/**
+ * Flattens nested schema attributes into a flat structure for easier processing
+ *
+ * This function processes SCIM2 schemas and creates a flattened representation by:
+ * - Processing sub-attributes and creating dot-notation names (e.g., 'name.givenName')
+ * - Adding schema ID reference to each flattened attribute
+ * - Preserving all original attribute properties while adding schema context
+ * - Only including leaf-level attributes (sub-attributes) and top-level simple attributes
+ *
+ * @param schemas - Array of SCIM2 schemas containing nested attribute structures
+ * @returns Array of flattened schema attributes with dot-notation names and schema references
+ *
+ * @example
+ * ```typescript
+ * const schemas = [
+ *   {
+ *     id: 'urn:ietf:params:scim:schemas:core:2.0:User',
+ *     attributes: [
+ *       {
+ *         name: 'userName',
+ *         type: 'string',
+ *         multiValued: false
+ *       },
+ *       {
+ *         name: 'name',
+ *         type: 'complex',
+ *         multiValued: false,
+ *         subAttributes: [
+ *           { name: 'givenName', type: 'string', multiValued: false },
+ *           { name: 'familyName', type: 'string', multiValued: false }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * ];
+ *
+ * const flattened = flattenUserSchema(schemas);
+ * // Result: [
+ * //   { name: 'userName', type: 'string', multiValued: false, schemaId: 'urn:ietf:params:scim:schemas:core:2.0:User' },
+ * //   { name: 'name.givenName', type: 'string', multiValued: false, schemaId: 'urn:ietf:params:scim:schemas:core:2.0:User' },
+ * //   { name: 'name.familyName', type: 'string', multiValued: false, schemaId: 'urn:ietf:params:scim:schemas:core:2.0:User' }
+ * // ]
+ * ```
+ */
+declare const flattenUserSchema: (schemas: Schema[]) => FlattenedSchema[];
+export default flattenUserSchema;