@asgardeo/javascript 0.0.1 → 0.1.1

package/dist/models/client.d.ts

@@ -15,9 +15,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { User } from './user';
+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,12 +33,37 @@ 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.
      *
      * @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 +80,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.
      */
@@ -60,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.
      *
@@ -70,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.
      *
@@ -80,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,10 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ThemeConfig, ThemeMode } from '../theme/types';
+import { I18nBundle } from './i18n';
 import { RecursivePartial } from './utility-types';
-export interface BaseConfig<T = unknown> {
+import { ThemeConfig, ThemeMode } from '../theme/types';
+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.
@@ -28,6 +29,17 @@ export interface BaseConfig<T = unknown> {
      * 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}"
@@ -57,6 +69,21 @@ export interface BaseConfig<T = unknown> {
      * 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 {
     /**
      * Preferences for customizing the Asgardeo UI components
      */
@@ -73,7 +100,29 @@ export interface ThemePreferences {
      */
     overrides?: RecursivePartial<ThemeConfig>;
 }
+export interface I18nPreferences {
+    /**
+     * Custom translations to override default ones.
+     */
+    bundles?: {
+        [key: string]: I18nBundle;
+    };
+    /**
+     * The fallback language to use if translations are not available in the specified language.
+     * Defaults to 'en-US'.
+     */
+    fallbackLanguage?: string;
+    /**
+     * The language to use for translations.
+     * Defaults to the browser's default language.
+     */
+    language?: string;
+}
 export interface Preferences {
+    /**
+     * Internationalization preferences for the Asgardeo UI components
+     */
+    i18n?: I18nPreferences;
     /**
      * Theme preferences for the Asgardeo UI components
      */

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/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/{__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/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

@@ -0,0 +1,90 @@
+/**
+ * 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;
+    'signin.subtitle': string;
+    'signup.title': string;
+    'signup.subtitle': 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;
+    '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;
+    '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/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/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.
      *