@asgardeo/javascript 0.1.0 → 0.1.2

package/dist/models/branding-preference.d.ts

@@ -0,0 +1,248 @@
+/**
+ * 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.
+ */
+/**
+ * Interface for color configuration with multiple variants.
+ */
+export interface ColorVariants {
+    contrastText?: string;
+    dark?: string;
+    inverted?: string;
+    light?: string;
+    main?: string;
+}
+/**
+ * Interface for text color configuration.
+ */
+export interface TextColors {
+    primary?: string;
+    secondary?: string;
+}
+/**
+ * Interface for button styling configuration.
+ */
+export interface ButtonStyle {
+    base?: {
+        background?: {
+            backgroundColor?: string;
+        };
+        border?: {
+            borderColor?: string;
+            borderRadius?: string;
+        };
+        font?: {
+            color?: string;
+        };
+    };
+}
+/**
+ * Interface for buttons configuration.
+ */
+export interface ButtonsConfig {
+    externalConnection?: ButtonStyle;
+    primary?: ButtonStyle;
+    secondary?: ButtonStyle;
+}
+/**
+ * Interface for color palette configuration.
+ */
+export interface ColorsConfig {
+    alerts?: {
+        error?: ColorVariants;
+        info?: ColorVariants;
+        neutral?: ColorVariants;
+        warning?: ColorVariants;
+    };
+    background?: {
+        body?: ColorVariants;
+        surface?: ColorVariants;
+    };
+    illustrations?: {
+        accent1?: ColorVariants;
+        accent2?: ColorVariants;
+        accent3?: ColorVariants;
+        primary?: ColorVariants;
+        secondary?: ColorVariants;
+    };
+    outlined?: {
+        default?: string;
+    };
+    primary?: ColorVariants;
+    secondary?: ColorVariants;
+    text?: TextColors;
+}
+/**
+ * Interface for footer configuration.
+ */
+export interface FooterConfig {
+    border?: {
+        borderColor?: string;
+    };
+    font?: {
+        color?: string;
+    };
+}
+/**
+ * Interface for image configuration.
+ */
+export interface ImageConfig {
+    altText?: string;
+    imgURL?: string;
+    title?: string;
+}
+/**
+ * Interface for images configuration.
+ */
+export interface ImagesConfig {
+    favicon?: Partial<ImageConfig>;
+    logo?: Partial<ImageConfig>;
+    myAccountLogo?: Partial<ImageConfig>;
+}
+/**
+ * Interface for input styling configuration.
+ */
+export interface InputsConfig {
+    base?: {
+        background?: {
+            backgroundColor?: string;
+        };
+        border?: {
+            borderColor?: string;
+            borderRadius?: string;
+        };
+        font?: {
+            color?: string;
+        };
+        labels?: {
+            font?: {
+                color?: string;
+            };
+        };
+    };
+}
+/**
+ * Interface for login box configuration.
+ */
+export interface LoginBoxConfig {
+    background?: {
+        backgroundColor?: string;
+    };
+    border?: {
+        borderColor?: string;
+        borderRadius?: string;
+        borderWidth?: string;
+    };
+    font?: {
+        color?: string;
+    };
+}
+/**
+ * Interface for login page configuration.
+ */
+export interface LoginPageConfig {
+    background?: {
+        backgroundColor?: string;
+    };
+    font?: {
+        color?: string;
+    };
+}
+/**
+ * Interface for typography configuration.
+ */
+export interface TypographyConfig {
+    font?: {
+        color?: string;
+        fontFamily?: string;
+        importURL?: string;
+    };
+    heading?: {
+        font?: {
+            color?: string;
+        };
+    };
+}
+/**
+ * Interface for theme variant configuration (LIGHT/DARK).
+ */
+export interface ThemeVariant {
+    buttons?: ButtonsConfig;
+    colors?: ColorsConfig;
+    footer?: FooterConfig;
+    images?: ImagesConfig;
+    inputs?: InputsConfig;
+    loginBox?: LoginBoxConfig;
+    loginPage?: LoginPageConfig;
+    typography?: TypographyConfig;
+}
+/**
+ * Interface for branding preference layout configuration.
+ */
+export interface BrandingLayout {
+    activeLayout?: string;
+    sideImg?: {
+        altText?: string;
+        imgURL?: string;
+    };
+}
+/**
+ * Interface for organization details configuration.
+ */
+export interface BrandingOrganizationDetails {
+    displayName?: string;
+    supportEmail?: string;
+}
+/**
+ * Interface for URL configurations.
+ */
+export interface UrlsConfig {
+    cookiePolicyURL?: string;
+    privacyPolicyURL?: string;
+    termsOfUseURL?: string;
+    selfSignUpURL?: string;
+}
+/**
+ * Interface for branding preference theme configuration.
+ */
+export interface BrandingTheme {
+    activeTheme?: string;
+    LIGHT?: ThemeVariant;
+    DARK?: ThemeVariant;
+}
+/**
+ * Interface for branding preference configuration.
+ */
+export interface BrandingPreferenceConfig {
+    configs?: {
+        isBrandingEnabled?: boolean;
+        removeDefaultBranding?: boolean;
+        selfSignUpEnabled?: boolean;
+    };
+    layout?: BrandingLayout;
+    organizationDetails?: BrandingOrganizationDetails;
+    theme?: BrandingTheme;
+    urls?: UrlsConfig;
+}
+/**
+ * Interface for branding preference configuration.
+ */
+export interface BrandingPreference {
+    type?: string;
+    name?: string;
+    locale?: string;
+    preference?: BrandingPreferenceConfig;
+}

package/dist/models/client.d.ts

@@ -15,9 +15,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { EmbeddedFlowExecuteRequestConfig, EmbeddedFlowExecuteRequestPayload, EmbeddedFlowExecuteResponse } from './embedded-flow';
+import { EmbeddedSignInFlowHandleRequestPayload } from './embedded-signin-flow';
+import { Organization } from './organization';
 import { User, UserProfile } from './user';
 export type SignInOptions = Record<string, unknown>;
 export type SignOutOptions = Record<string, unknown>;
+export type SignUpOptions = Record<string, unknown>;
 /**
  * Interface defining the core functionality for Asgardeo authentication clients.
  *
@@ -29,18 +33,38 @@ export type SignOutOptions = Record<string, unknown>;
  * ```
  */
 export interface AsgardeoClient<T> {
+    /**
+     * Gets the users associated organizations.
+     *
+     * @returns Associated organizations.
+     */
+    getOrganizations(options?: any): Promise<Organization[]>;
+    /**
+     * Gets the current organization of the user.
+     *
+     * @returns The current organization if available, otherwise null.
+     */
+    getCurrentOrganization(sessionId?: string): Promise<Organization | null>;
+    /**
+     * Switches the current organization to the specified one.
+     * @param organization - The organization to switch to.
+     * @returns A promise that resolves when the switch is complete.
+     */
+    switchOrganization(organization: Organization): Promise<void>;
+    getConfiguration(): T;
+    updateUserProfile(payload: any, userId?: string): Promise<User>;
     /**
      * Gets user information from the session.
      *
      * @returns User object containing user details.
      */
-    getUser(): Promise<User>;
+    getUser(options?: any): 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>;
+    getUserProfile(options?: any): Promise<UserProfile>;
     /**
      * Initializes the authentication client with provided configuration.
      *
@@ -66,9 +90,21 @@ export interface AsgardeoClient<T> {
      * Initiates the sign-in process for the user.
      *
      * @param options - Optional sign-in options like additional parameters to be sent in the authorize request, etc.
+     * @param sessionId - Optional session ID to be used for sign-in.
+     * @param onSignInSuccess - Callback function to be executed upon successful sign-in.
      * @returns Promise resolving the user upon successful sign in.
      */
-    signIn(options?: SignInOptions): Promise<User>;
+    signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    /**
+     * Initiates an embedded (App-Native) sign-in flow for the user.
+     *
+     * @param payload - The payload containing the necessary information to execute the embedded sign-in flow.
+     * @param request - The request object containing URL and parameters for the sign-in flow HTTP request.
+     * @param sessionId - Optional session ID to be used for sign-in.
+     * @param onSignInSuccess - Callback function to be executed upon successful sign-in.
+     * @returns A promise that resolves to an EmbeddedFlowExecuteResponse containing the flow execution details.
+     */
+    signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: EmbeddedFlowExecuteRequestConfig<EmbeddedSignInFlowHandleRequestPayload>, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
     /**
      * Signs out the currently signed-in user.
      *
@@ -76,7 +112,7 @@ export interface AsgardeoClient<T> {
      * @param afterSignOut - Callback function to be executed after sign-out is complete.
      * @returns A promise that resolves to true if sign-out is successful
      */
-    signOut(options?: SignOutOptions, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
+    signOut(options?: SignOutOptions, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
     /**
      * Signs out the currently signed-in user with an optional session ID.
      *
@@ -86,5 +122,19 @@ export interface AsgardeoClient<T> {
      * @param afterSignOut - Callback function to be executed after sign-out is complete.
      * @returns A promise that resolves to true if sign-out is successful
      */
-    signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
+    signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    /**
+     * Initiates a redirection-based sign-up process for the user.
+     *
+     * @param options - Optional sign-up options like additional parameters to be sent in the sign-up request, etc.
+     * @returns Promise resolving to the user upon successful sign up.
+     */
+    signUp(options?: SignUpOptions): Promise<void>;
+    /**
+     * Initiates an embedded (App-Native) sign-up flow for the user.
+     *
+     * @param payload - The payload containing the necessary information to execute the embedded sign-up flow.
+     * @returns A promise that resolves to an EmbeddedFlowExecuteResponse containing the flow execution details.
+     */
+    signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
 }

package/dist/models/config.d.ts

@@ -15,9 +15,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ThemeConfig, ThemeMode } from '../theme/types';
 import { I18nBundle } from './i18n';
 import { RecursivePartial } from './utility-types';
+import { ThemeConfig, ThemeMode } from '../theme/types';
 export interface BaseConfig<T = unknown> extends WithPreferences {
     /**
      * Optional URL where the authorization server should redirect after authentication.
@@ -29,6 +29,31 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * For production: "https://your-app.com/api/auth/callback"
      */
     afterSignInUrl?: string | undefined;
+    /**
+     * Optional URL where the authorization server should redirect after sign out.
+     * This must match one of the allowed post logout redirect URIs configured in your IdP
+     * and is used to redirect the user after they have signed out.
+     * If not provided, the framework layer will use the default sign out URL based on the
+     *
+     * @example
+     * For development: "http://localhost:3000/api/auth/signout"
+     * For production: "https://your-app.com/api/auth/signout"
+     */
+    afterSignOutUrl?: string | undefined;
+    /**
+     * Optional organization handle for the Organization in Asgardeo.
+     * This is used to identify the organization in the Asgardeo identity server in cases like Branding, etc.
+     * If not provided, the framework layer will try to use the `baseUrl` to determine the organization handle.
+     * @remarks This is mandatory if a custom domain is configured for the Asgardeo organization.
+     */
+    organizationHandle?: string | undefined;
+    /**
+     * Optional UUID of the Asgardeo application.
+     * This is used to identify the application in the Asgardeo identity server for Application Branding,
+     * obtaining the access URL in the sign-up flow, etc.
+     * If not provided, the framework layer will use the default application ID based on the application.
+     */
+    applicationId?: string | undefined;
     /**
      * The base URL of the Asgardeo identity server.
      * Example: "https://api.asgardeo.io/t/{org_name}"
@@ -58,6 +83,19 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * scopes: ["openid", "profile", "email"]
      */
     scopes?: string | string[] | undefined;
+    /**
+     * Optional URL to redirect the user to sign-in.
+     * By default, this will be the sign-in page of Asgardeo.
+     * If you want to use a custom sign-in page, you can provide the URL here and use the `SignIn` component to render it.
+     */
+    signInUrl?: string | undefined;
+    /**
+     * Optional URL to redirect the user to sign-up.
+     * By default, this will be the sign-up page of Asgardeo.
+     * If you want to use a custom sign-up page, you can provide the URL here
+     * and use the `SignUp` component to render it.
+     */
+    signUpUrl?: string | undefined;
 }
 export interface WithPreferences {
     /**
@@ -67,6 +105,10 @@ export interface WithPreferences {
 }
 export type Config<T = unknown> = BaseConfig<T>;
 export interface ThemePreferences {
+    /**
+     * Inherit from Branding from WSO2 Identity Server or Asgardeo.
+     */
+    inheritFromBranding?: boolean;
     /**
      * The theme mode to use. Defaults to 'system'.
      */
@@ -78,29 +120,29 @@ export interface ThemePreferences {
 }
 export interface I18nPreferences {
     /**
-     * The language to use for translations.
-     * Defaults to the browser's default language.
+     * Custom translations to override default ones.
      */
-    language?: string;
+    bundles?: {
+        [key: string]: I18nBundle;
+    };
     /**
      * 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.
+     * The language to use for translations.
+     * Defaults to the browser's default language.
      */
-    bundles?: {
-        [key: string]: I18nBundle;
-    };
+    language?: string;
 }
 export interface Preferences {
-    /**
-     * Theme preferences for the Asgardeo UI components
-     */
-    theme?: ThemePreferences;
     /**
      * Internationalization preferences for the Asgardeo UI components
      */
     i18n?: I18nPreferences;
+    /**
+     * Theme preferences for the Asgardeo UI components
+     */
+    theme?: ThemePreferences;
 }

package/dist/models/embedded-flow.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 declare enum EmbeddedFlowType {
+    Registration = "REGISTRATION"
+}
+export interface EmbeddedFlowExecuteRequestPayload {
+    actionId?: string;
+    flowType: EmbeddedFlowType;
+    inputs?: Record<string, any>;
+}
+export interface EmbeddedFlowExecuteResponse {
+    data: EmbeddedSignUpFlowData;
+    flowId: string;
+    flowStatus: EmbeddedFlowStatus;
+    type: EmbeddedFlowResponseType;
+}
+export declare enum EmbeddedFlowStatus {
+    Complete = "COMPLETE",
+    Incomplete = "INCOMPLETE"
+}
+export declare enum EmbeddedFlowResponseType {
+    Redirection = "REDIRECTION",
+    View = "VIEW"
+}
+export interface EmbeddedSignUpFlowData {
+    components?: EmbeddedFlowComponent[];
+    redirectURL?: string;
+}
+export interface EmbeddedFlowComponent {
+    components: EmbeddedFlowComponent[];
+    config: Record<string, any>;
+    id: string;
+    type: EmbeddedFlowComponentType;
+    variant?: string;
+}
+export declare enum EmbeddedFlowComponentType {
+    Button = "BUTTON",
+    Checkbox = "CHECKBOX",
+    Divider = "DIVIDER",
+    Form = "FORM",
+    Image = "IMAGE",
+    Input = "INPUT",
+    Radio = "RADIO",
+    Select = "SELECT",
+    Typography = "TYPOGRAPHY"
+}
+export interface EmbeddedFlowExecuteRequestConfig<T = any> extends Partial<Request> {
+    baseUrl?: string;
+    payload?: T;
+    url?: string;
+}

package/dist/models/embedded-signin-flow.d.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 EmbeddedSignInFlowInitiateResponse {
+    flowId: string;
+    flowStatus: EmbeddedSignInFlowStatus;
+    flowType: EmbeddedSignInFlowType;
+    links: EmbeddedSignInFlowLink[];
+    nextStep: {
+        authenticators: EmbeddedSignInFlowAuthenticator[];
+        stepType: EmbeddedSignInFlowStepType;
+    };
+}
+export declare enum EmbeddedSignInFlowStatus {
+    FailCompleted = "FAIL_COMPLETED",
+    FailIncomplete = "FAIL_INCOMPLETE",
+    Incomplete = "INCOMPLETE",
+    SuccessCompleted = "SUCCESS_COMPLETED"
+}
+export declare enum EmbeddedSignInFlowType {
+    Authentication = "AUTHENTICATION"
+}
+export declare enum EmbeddedSignInFlowStepType {
+    AuthenticatorPrompt = "AUTHENTICATOR_PROMPT",
+    MultiOptionsPrompt = "MULTI_OPTIONS_PROMPT"
+}
+export interface EmbeddedSignInFlowAuthenticator {
+    authenticator: string;
+    authenticatorId: string;
+    idp: string;
+    metadata: {
+        i18nKey: string;
+        params: {
+            confidential: boolean;
+            displayName: string;
+            i18nKey: string;
+            order: number;
+            param: string;
+            type: EmbeddedSignInFlowAuthenticatorParamType;
+        }[];
+        promptType: EmbeddedSignInFlowAuthenticatorPromptType;
+    };
+    requiredParams: string[];
+}
+export interface EmbeddedSignInFlowLink {
+    href: string;
+    method: string;
+    name: string;
+}
+export interface EmbeddedSignInFlowHandleRequestPayload {
+    flowId: string;
+    selectedAuthenticator: {
+        authenticatorId: string;
+        params: Record<string, string>;
+    };
+}
+export interface EmbeddedSignInFlowHandleResponse {
+    authData: Record<string, any>;
+    flowStatus: string;
+}
+export declare enum EmbeddedSignInFlowAuthenticatorParamType {
+    Integer = "INTEGER",
+    MultiValued = "MULTI_VALUED",
+    String = "STRING"
+}
+export declare enum EmbeddedSignInFlowAuthenticatorExtendedParamType {
+    Otp = "OTPCode"
+}
+export declare enum EmbeddedSignInFlowAuthenticatorKnownIdPType {
+    Local = "LOCAL"
+}
+export declare enum EmbeddedSignInFlowAuthenticatorPromptType {
+    /**
+     * 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",
+    /**
+     * Prompt for user input, typically for username/password or similar credentials.
+     */
+    UserPrompt = "USER_PROMPT"
+}

package/dist/models/flow.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 declare enum FlowMode {
+    /**
+     * This mode is suitable for embedded sign-in, sign-up, etc. flows where the authentication
+     * UIs are rendered within the application.
+     * @see {@link https://is.docs.wso2.com/en/7.1.0/references/app-native-authentication/}
+     */
+    Embedded = "DIRECT",
+    /**
+     * Traditional redirect based sign-in, sign-up, etc. flows where the authentication
+     * UIs are from a external Identity Provider (ex: WSO2 Identity Server or Asgardeo).
+     */
+    Redirect = "REDIRECTION"
+}

package/dist/models/i18n.d.ts

@@ -29,6 +29,9 @@ export interface I18nTranslations {
     'elements.buttons.social': string;
     'elements.fields.placeholder': string;
     'signin.title': string;
+    'signin.subtitle': string;
+    'signup.title': string;
+    'signup.subtitle': string;
     'email.otp.title': string;
     'email.otp.subtitle': string;
     'email.otp.submit.button': string;
@@ -44,6 +47,27 @@ export interface I18nTranslations {
     'username.password.submit.button': string;
     'username.password.title': string;
     'username.password.subtitle': string;
+    'organization.switcher.select.organization': string;
+    'organization.switcher.switch.organization': string;
+    'organization.switcher.loading.organizations': string;
+    'organization.switcher.members': string;
+    'organization.switcher.member': string;
+    'organization.switcher.create.organization': string;
+    'organization.switcher.manage.organizations': string;
+    'organization.switcher.manage.button': string;
+    'organization.profile.title': string;
+    'organization.profile.loading': string;
+    'organization.profile.error': string;
+    'organization.create.title': string;
+    'organization.create.name.label': string;
+    'organization.create.name.placeholder': string;
+    'organization.create.handle.label': string;
+    'organization.create.handle.placeholder': string;
+    'organization.create.description.label': string;
+    'organization.create.description.placeholder': string;
+    'organization.create.button': string;
+    'organization.create.creating': string;
+    'organization.create.cancel': string;
     'messages.loading': string;
     'errors.title': string;
     'errors.sign.in.initialization': string;