@asgardeo/javascript 0.7.1 → 0.7.3

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

@@ -212,16 +212,16 @@ export interface BrandingOrganizationDetails {
 export interface UrlsConfig {
     cookiePolicyURL?: string;
     privacyPolicyURL?: string;
-    termsOfUseURL?: string;
     selfSignUpURL?: string;
+    termsOfUseURL?: string;
 }
 /**
  * Interface for branding preference theme configuration.
  */
 export interface BrandingTheme {
-    activeTheme?: string;
-    LIGHT?: ThemeVariant;
     DARK?: ThemeVariant;
+    LIGHT?: ThemeVariant;
+    activeTheme?: string;
 }
 /**
  * Interface for branding preference configuration.
@@ -241,8 +241,8 @@ export interface BrandingPreferenceConfig {
  * Interface for branding preference configuration.
  */
 export interface BrandingPreference {
-    type?: string;
-    name?: string;
     locale?: string;
+    name?: string;
     preference?: BrandingPreferenceConfig;
+    type?: string;
 }

package/dist/models/client.d.ts

@@ -15,14 +15,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AllOrganizationsApiResponse } from '../models/organization';
+import { SignInOptions, SignOutOptions, SignUpOptions } from './config';
 import { EmbeddedFlowExecuteRequestConfig, EmbeddedFlowExecuteRequestPayload, EmbeddedFlowExecuteResponse } from './embedded-flow';
 import { EmbeddedSignInFlowHandleRequestPayload } from './embedded-signin-flow';
-import { Organization } from './organization';
-import { User, UserProfile } from './user';
-import { TokenExchangeRequestConfig, TokenResponse } from './token';
+import { Organization, AllOrganizationsApiResponse } from './organization';
 import { Storage } from './store';
-import { SignInOptions, SignOutOptions, SignUpOptions } from './config';
+import { TokenExchangeRequestConfig, TokenResponse } from './token';
+import { User, UserProfile } from './user';
 /**
  * Interface defining the core functionality for Asgardeo authentication clients.
  *
@@ -35,46 +34,51 @@ import { SignInOptions, SignOutOptions, SignUpOptions } from './config';
  */
 export interface AsgardeoClient<T> {
     /**
-     * Gets the current signed-in user's associated organizations.
-     *
-     * @returns Associated organizations.
+     * Clears the session for the specified session ID.
+     * @param sessionId - Optional session ID to clear the session for.
      */
-    getMyOrganizations(options?: any, sessionId?: string): Promise<Organization[]>;
+    clearSession(sessionId?: string): void;
     /**
-     * Gets all organizations available to the user.
-     * @param options - Optional parameters for the request.
-     * @param sessionId - Optional session ID to be used for the request.
+     * Decodes a JWT token and returns its payload.
+     * @param token - The JWT token to be decoded.
+     * @returns A promise that resolves to the decoded token payload.
      */
-    getAllOrganizations(options?: any, sessionId?: string): Promise<AllOrganizationsApiResponse>;
+    decodeJwtToken<R = Record<string, unknown>>(token: string): Promise<R>;
     /**
-     * Gets the current organization of the user.
-     *
-     * @returns The current organization if available, otherwise null.
+     * Swaps the current access token with a new one based on the provided configuration (with a grant type).
+     * @param config - Configuration for the token exchange request.
+     * @param sessionId - Optional session ID to be used for the token exchange.
      */
-    getCurrentOrganization(sessionId?: string): Promise<Organization | null>;
+    exchangeToken(config: TokenExchangeRequestConfig, sessionId?: string): Promise<TokenResponse | Response>;
     /**
-     * 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.
+     * Retrieves the access token for the current session.
+     * @param sessionId - Optional session ID to retrieve the access token for a specific session.
+     * @returns A promise that resolves to the access token string.
      */
-    switchOrganization(organization: Organization, sessionId?: string): Promise<TokenResponse | Response>;
+    getAccessToken(sessionId?: string): Promise<string>;
+    /**
+     * Gets all organizations available to the user.
+     * @param options - Optional parameters for the request.
+     * @param sessionId - Optional session ID to be used for the request.
+     */
+    getAllOrganizations(options?: any, sessionId?: string): Promise<AllOrganizationsApiResponse>;
     /**
      * Gets the client configuration.
      * @returns The client configuration.
      */
     getConfiguration(): T;
     /**
-     * Swaps the current access token with a new one based on the provided configuration (with a grant type).
-     * @param config - Configuration for the token exchange request.
-     * @param sessionId - Optional session ID to be used for the token exchange.
+     * Gets the current organization of the user.
+     *
+     * @returns The current organization if available, otherwise null.
      */
-    exchangeToken(config: TokenExchangeRequestConfig, sessionId?: string): Promise<TokenResponse | Response>;
+    getCurrentOrganization(sessionId?: string): Promise<Organization | null>;
     /**
-     * Updates the user profile with the provided payload.
-     * @param payload - The new user profile data.
-     * @param userId - Optional user ID to specify which user's profile to update.
+     * Gets the current signed-in user's associated organizations.
+     *
+     * @returns Associated organizations.
      */
-    updateUserProfile(payload: any, userId?: string): Promise<User>;
+    getMyOrganizations(options?: any, sessionId?: string): Promise<Organization[]>;
     /**
      * Gets user information from the session.
      *
@@ -95,16 +99,6 @@ export interface AsgardeoClient<T> {
      * @returns Promise resolving to boolean indicating success.
      */
     initialize(config: T, storage?: Storage): Promise<boolean>;
-    /**
-     * Re-initializes the client with a new configuration.
-     *
-     * @remarks
-     * This can be partial configuration to update only specific fields.
-     *
-     * @param config - New configuration to re-initialize the client with.
-     * @returns Promise resolving to boolean indicating success.
-     */
-    reInitialize(config: Partial<T>): Promise<boolean>;
     /**
      * Checks if the client is currently loading.
      * This can be used to determine if the client is in the process of initializing or fetching user data.
@@ -119,6 +113,22 @@ export interface AsgardeoClient<T> {
      * @returns Boolean indicating sign-in status.
      */
     isSignedIn(): Promise<boolean>;
+    /**
+     * Re-initializes the client with a new configuration.
+     *
+     * @remarks
+     * This can be partial configuration to update only specific fields.
+     *
+     * @param config - New configuration to re-initialize the client with.
+     * @returns Promise resolving to boolean indicating success.
+     */
+    reInitialize(config: Partial<T>): Promise<boolean>;
+    /**
+     * Sets the session data for the specified session ID.
+     * @param sessionData - The session data to be set.
+     * @param sessionId - Optional session ID to set the session data for.
+     */
+    setSession(sessionData: Record<string, unknown>, sessionId?: string): Promise<void>;
     /**
      * Initiates the sign-in process for the user.
      *
@@ -181,26 +191,15 @@ export interface AsgardeoClient<T> {
      */
     signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
     /**
-     * Retrieves the access token for the current session.
-     * @param sessionId - Optional session ID to retrieve the access token for a specific session.
-     * @returns A promise that resolves to the access token string.
-     */
-    getAccessToken(sessionId?: string): Promise<string>;
-    /**
-     * Sets the session data for the specified session ID.
-     * @param sessionData - The session data to be set.
-     * @param sessionId - Optional session ID to set the session data for.
-     */
-    setSession(sessionData: Record<string, unknown>, sessionId?: string): Promise<void>;
-    /**
-     * Clears the session for the specified session ID.
-     * @param sessionId - Optional session ID to clear the session for.
+     * 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.
      */
-    clearSession(sessionId?: string): void;
+    switchOrganization(organization: Organization, sessionId?: string): Promise<TokenResponse | Response>;
     /**
-     * Decodes a JWT token and returns its payload.
-     * @param token - The JWT token to be decoded.
-     * @returns A promise that resolves to the decoded token payload.
+     * Updates the user profile with the provided payload.
+     * @param payload - The new user profile data.
+     * @param userId - Optional user ID to specify which user's profile to update.
      */
-    decodeJwtToken<T = Record<string, unknown>>(token: string): Promise<T>;
+    updateUserProfile(payload: any, userId?: string): Promise<User>;
 }

package/dist/models/config.d.ts

@@ -16,9 +16,9 @@
  * under the License.
  */
 import { I18nBundle } from '@asgardeo/i18n';
+import { Platform } from './platforms';
 import { RecursivePartial } from './utility-types';
 import { ThemeConfig, ThemeMode } from '../theme/types';
-import { Platform } from './platforms';
 /**
  * Interface representing the additional parameters to be sent in the sign-in request.
  * This can include custom parameters that your authorization server supports.
@@ -88,13 +88,6 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * allowedExternalUrls: ["https://api.example.com", "https://api.another-service.com"]
      */
     allowedExternalUrls?: string[];
-    /**
-     * 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,
@@ -118,6 +111,18 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * Not recommended for public clients like browser applications.
      */
     clientSecret?: string | undefined;
+    /**
+     * Optional instance ID for multi-auth context support.
+     * Use this when you need multiple authentication contexts in the same application.
+     */
+    instanceId?: number;
+    /**
+     * 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 platform where the application is running.
      * This helps the SDK to optimize its behavior based on the platform.
@@ -137,12 +142,27 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * scopes: ["openid", "profile", "email"]
      */
     scopes?: string | string[] | undefined;
+    /**
+     * Optional additional parameters to be sent in the authorize request.
+     * @see {@link SignInOptions} for more details.
+     */
+    signInOptions?: SignInOptions;
     /**
      * 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 additional parameters to be sent in the sign-out request.
+     * @see {@link SignOutOptions} for more details.
+     */
+    signOutOptions?: SignOutOptions;
+    /**
+     * Optional additional parameters to be sent in the sign-up request.
+     * @see {@link SignUpOptions} for more details.
+     */
+    signUpOptions?: SignUpOptions;
     /**
      * Optional URL to redirect the user to sign-up.
      * By default, this will be the sign-up page of Asgardeo.
@@ -150,6 +170,22 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * and use the `SignUp` component to render it.
      */
     signUpUrl?: string | undefined;
+    /**
+     * Storage mechanism to use for storing tokens and session data.
+     * The values should be defined at the framework layer.
+     */
+    storage?: T;
+    /**
+     * Flag to indicate whether the Application session should be synchronized with the IdP session.
+     * @remarks This uses the OIDC iframe base session management feature to keep the application session in sync with the IdP session.
+     * WARNING: This may not work in all browsers due to 3rd party cookie restrictions.
+     * It is recommended to use this feature only if you are aware of the implications and have tested it in your target browsers.
+     * If you are not sure, it is safer to leave this option as `false`.
+     * @example
+     * syncSession: true
+     * @see {@link https://openid.net/specs/openid-connect-session-management-1_0.html#IframeBasedSessionManagement}
+     */
+    syncSession?: boolean;
     /**
      * Token validation configuration.
      * This allows you to configure how the SDK validates tokens received from the authorization server.
@@ -162,6 +198,10 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
          * ID token validation config.
          */
         idToken?: {
+            /**
+             * Allowed leeway for ID tokens (in seconds).
+             */
+            clockTolerance?: number;
             /**
              * Whether to validate ID tokens.
              */
@@ -170,48 +210,8 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
              * Whether to validate the issuer of ID tokens.
              */
             validateIssuer?: boolean;
-            /**
-             * Allowed leeway for ID tokens (in seconds).
-             */
-            clockTolerance?: number;
         };
     };
-    /**
-     * Optional additional parameters to be sent in the authorize request.
-     * @see {@link SignInOptions} for more details.
-     */
-    signInOptions?: SignInOptions;
-    /**
-     * Optional additional parameters to be sent in the sign-out request.
-     * @see {@link SignOutOptions} for more details.
-     */
-    signOutOptions?: SignOutOptions;
-    /**
-     * Optional additional parameters to be sent in the sign-up request.
-     * @see {@link SignUpOptions} for more details.
-     */
-    signUpOptions?: SignUpOptions;
-    /**
-     * Flag to indicate whether the Application session should be synchronized with the IdP session.
-     * @remarks This uses the OIDC iframe base session management feature to keep the application session in sync with the IdP session.
-     * WARNING: This may not work in all browsers due to 3rd party cookie restrictions.
-     * It is recommended to use this feature only if you are aware of the implications and have tested it in your target browsers.
-     * If you are not sure, it is safer to leave this option as `false`.
-     * @example
-     * syncSession: true
-     * @see {@link https://openid.net/specs/openid-connect-session-management-1_0.html#IframeBasedSessionManagement}
-     */
-    syncSession?: boolean;
-    /**
-     * Storage mechanism to use for storing tokens and session data.
-     * The values should be defined at the framework layer.
-     */
-    storage?: T;
-    /**
-     * Optional instance ID for multi-auth context support.
-     * Use this when you need multiple authentication contexts in the same application.
-     */
-    instanceId?: number;
 }
 export interface WithPreferences {
     /**

package/dist/models/crypto.d.ts

@@ -19,12 +19,12 @@
  * JWK Model
  */
 export interface JWKInterface {
-    kty: string;
+    alg: string;
     e: string;
-    use: string;
     kid: string;
-    alg: string;
+    kty: string;
     n: string;
+    use: string;
 }
 /**
  * Cryptographic utility interface for OIDC operations.
@@ -49,14 +49,6 @@ export interface JWKInterface {
  * ```
  */
 export interface Crypto<T = any> {
-    /**
-     * Encode the provided data in base64url format.
-     *
-     * @param value - Data to be encoded.
-     *
-     * @returns Encoded data.
-     */
-    base64URLEncode(value: T): string;
     /**
      * Decode the provided data encoded in base64url format.
      *
@@ -65,6 +57,14 @@ export interface Crypto<T = any> {
      * @returns Decoded data.
      */
     base64URLDecode(value: string): string;
+    /**
+     * Encode the provided data in base64url format.
+     *
+     * @param value - Data to be encoded.
+     *
+     * @returns Encoded data.
+     */
+    base64URLEncode(value: T): string;
     /**
      * Generate random bytes.
      *

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

@@ -40,9 +40,9 @@ export declare enum EmbeddedFlowResponseType {
     View = "VIEW"
 }
 export interface EmbeddedSignUpFlowData {
+    additionalData?: Record<string, any>;
     components?: EmbeddedFlowComponent[];
     redirectURL?: string;
-    additionalData?: Record<string, any>;
 }
 export interface EmbeddedFlowComponent {
     components: EmbeddedFlowComponent[];
@@ -135,15 +135,6 @@ export interface EmbeddedFlowExecuteErrorResponse {
      * @example "FEE-60005" - User provisioning error
      */
     code: string;
-    /**
-     * Brief error message describing what went wrong.
-     *
-     * This is typically a short, high-level description of the error.
-     * For more detailed information, refer to the `description` field.
-     *
-     * @example "Error while provisioning user."
-     */
-    message: string;
     /**
      * Detailed error description with contextual information.
      *
@@ -162,4 +153,13 @@ export interface EmbeddedFlowExecuteErrorResponse {
      * include other flow types (e.g., 'LOGIN', 'PASSWORD_RESET') in the future.
      */
     flowType: 'REGISTRATION';
+    /**
+     * Brief error message describing what went wrong.
+     *
+     * This is typically a short, high-level description of the error.
+     * For more detailed information, refer to the `description` field.
+     *
+     * @example "Error while provisioning user."
+     */
+    message: string;
 }

package/dist/models/field.d.ts

@@ -16,15 +16,15 @@
  * under the License.
  */
 export declare enum FieldType {
-    Text = "TEXT",
-    Password = "PASSWORD",
+    Checkbox = "CHECKBOX",
+    Date = "DATE",
     Email = "EMAIL",
     Number = "NUMBER",
-    Select = "SELECT",
-    Checkbox = "CHECKBOX",
-    Radio = "RADIO",
     Otp = "OTP",
-    Date = "DATE",
-    Time = "TIME",
-    Textarea = "TEXTAREA"
+    Password = "PASSWORD",
+    Radio = "RADIO",
+    Select = "SELECT",
+    Text = "TEXT",
+    Textarea = "TEXTAREA",
+    Time = "TIME"
 }