@asgardeo/javascript 0.1.0 → 0.1.1

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,6 +33,25 @@ export type SignOutOptions = Record<string, unknown>;
  * ```
  */
 export interface AsgardeoClient<T> {
+    /**
+     * Gets the users associated organizations.
+     *
+     * @returns Associated organizations.
+     */
+    getOrganizations(): Promise<Organization[]>;
+    /**
+     * Gets the current organization of the user.
+     *
+     * @returns The current organization if available, otherwise null.
+     */
+    getCurrentOrganization(): 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;
     /**
      * Gets user information from the session.
      *
@@ -66,9 +89,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 +111,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 +121,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,17 @@ 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;
     /**
      * The base URL of the Asgardeo identity server.
      * Example: "https://api.asgardeo.io/t/{org_name}"
@@ -58,6 +69,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 {
     /**
@@ -78,29 +102,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;

package/dist/models/organization.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 Organization {
+    id: string;
+    name: string;
+    orgHandle: string;
+    ref?: string;
+    status?: string;
+}

package/dist/models/token.d.ts

@@ -31,11 +31,11 @@ export interface TokenResponse {
      */
     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.
+     * Unix timestamp (in seconds) when the token was created.
+     * Used in combination with expiresIn to determine when
+     * the token needs to be refreshed.
      */
-    idToken: string;
+    createdAt: number;
     /**
      * Duration in seconds until the access token expires.
      * Applications should refresh the token before this time
@@ -43,29 +43,29 @@ export interface TokenResponse {
      */
     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.
+     * JSON Web Token (JWT) containing user identity information.
+     * This token can be decoded to access user claims and metadata
+     * without additional server requests.
      */
-    scope: string;
+    idToken: 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;
+    /**
+     * 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;
     /**
      * 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.
@@ -82,18 +82,18 @@ export interface AccessTokenApiResponse {
      * 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 expiration time in seconds.
+     * Indicates how long the access token will be valid
+     * from the time it was issued.
+     */
+    expires_in: string;
     /**
      * Raw ID token string containing encoded user information.
      * This JWT can be decoded to access standardized claims
@@ -122,27 +122,39 @@ export interface AccessTokenApiResponse {
 /**
  * Interface for the standard (required) claims of an ID Token payload.
  */
-export interface IdTokenPayloadStandardClaims {
+export interface KnownIdToken {
     /**
      * The audience for which this token is intended.
      */
     aud: string | string[];
     /**
-     * The unique identifier of the user to whom the ID token belongs.
+     * The email of the user.
      */
-    sub: string;
+    email?: string;
     /**
      * The issuer identifier for the issuer of the response.
      */
     iss: string;
     /**
-     * The email of the user.
+     * The unique human readable slug of the organization to which the user belongs.
      */
-    email?: string;
+    org_handle?: string;
+    /**
+     * The unique identifier of the organization to which the user belongs.
+     */
+    org_id?: string;
+    /**
+     * The human readable name of the organization to which the user belongs.
+     */
+    org_name?: string;
     /**
      * The username the user prefers to be called.
      */
     preferred_username?: string;
+    /**
+     * The unique identifier of the user to whom the ID token belongs.
+     */
+    sub: string;
     /**
      * The tenant domain of the user.
      */
@@ -151,18 +163,18 @@ export interface IdTokenPayloadStandardClaims {
 /**
  * Interface for ID Token payload including custom claims.
  */
-export interface IdTokenPayload extends IdTokenPayloadStandardClaims {
+export interface IdToken extends KnownIdToken {
     /**
      * Other custom claims.
      */
     [claim: string]: any;
 }
 export interface TokenExchangeRequestConfig {
-    id: string;
-    data: any;
-    signInRequired: boolean;
     attachToken: boolean;
+    data: any;
+    id: string;
     returnsSession: boolean;
-    tokenEndpoint?: string;
     shouldReplayAfterRefresh?: boolean;
+    signInRequired: boolean;
+    tokenEndpoint?: string;
 }

package/dist/theme/createTheme.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { RecursivePartial } from '../models/utility-types';
 import { Theme, ThemeConfig } from './types';
+import { RecursivePartial } from '../models/utility-types';
 declare const createTheme: (config?: RecursivePartial<ThemeConfig>, isDark?: boolean) => Theme;
 export default createTheme;

package/dist/theme/types.d.ts

@@ -16,40 +16,53 @@
  * under the License.
  */
 export interface ThemeColors {
-    primary: {
+    background: {
+        body: {
+            main: string;
+        };
+        disabled: string;
+        surface: string;
+    };
+    border: string;
+    error: {
+        contrastText: string;
         main: string;
+    };
+    primary: {
         contrastText: string;
+        main: string;
     };
     secondary: {
-        main: string;
         contrastText: string;
+        main: string;
     };
-    background: {
-        surface: string;
-        disabled: string;
-        body: {
-            main: string;
-        };
+    success: {
+        contrastText: string;
+        main: string;
     };
     text: {
         primary: string;
         secondary: string;
     };
-    border: string;
-    error: {
-        main: string;
+    warning: {
         contrastText: string;
+        main: string;
     };
 }
 export interface ThemeConfig {
-    colors: ThemeColors;
-    spacing: {
-        unit: number;
-    };
     borderRadius: {
-        small: string;
+        large: string;
         medium: string;
+        small: string;
+    };
+    colors: ThemeColors;
+    shadows: {
         large: string;
+        medium: string;
+        small: string;
+    };
+    spacing: {
+        unit: number;
     };
 }
 export interface Theme extends ThemeConfig {