@asgardeo/javascript 0.1.1 → 0.1.3

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,10 +15,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { AllOrganizationsApiResponse } from '../models/organization';
 import { EmbeddedFlowExecuteRequestConfig, EmbeddedFlowExecuteRequestPayload, EmbeddedFlowExecuteResponse } from './embedded-flow';
 import { EmbeddedSignInFlowHandleRequestPayload } from './embedded-signin-flow';
 import { Organization } from './organization';
 import { User, UserProfile } from './user';
+import { TokenResponse } from './token';
 export type SignInOptions = Record<string, unknown>;
 export type SignOutOptions = Record<string, unknown>;
 export type SignUpOptions = Record<string, unknown>;
@@ -34,36 +36,38 @@ export type SignUpOptions = Record<string, unknown>;
  */
 export interface AsgardeoClient<T> {
     /**
-     * Gets the users associated organizations.
+     * Gets the current signed-in user's associated organizations.
      *
      * @returns Associated organizations.
      */
-    getOrganizations(): Promise<Organization[]>;
+    getMyOrganizations(options?: any, sessionId?: string): Promise<Organization[]>;
+    getAllOrganizations(options?: any, sessionId?: string): Promise<AllOrganizationsApiResponse>;
     /**
      * Gets the current organization of the user.
      *
      * @returns The current organization if available, otherwise null.
      */
-    getCurrentOrganization(): Promise<Organization | 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>;
+    switchOrganization(organization: Organization, sessionId?: string): Promise<TokenResponse | Response>;
     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.
      *

package/dist/models/config.d.ts

@@ -40,6 +40,20 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * 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}"
@@ -91,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'.
      */

package/dist/models/i18n.d.ts

@@ -55,6 +55,16 @@ export interface I18nTranslations {
     'organization.switcher.create.organization': string;
     'organization.switcher.manage.organizations': string;
     'organization.switcher.manage.button': string;
+    'organization.switcher.organizations.title': string;
+    'organization.switcher.switch.button': string;
+    'organization.switcher.no.access': string;
+    'organization.switcher.status.label': string;
+    'organization.switcher.showing.count': string;
+    'organization.switcher.refresh.button': string;
+    'organization.switcher.load.more': string;
+    'organization.switcher.loading.more': string;
+    'organization.switcher.no.organizations': string;
+    'organization.switcher.error.prefix': string;
     'organization.profile.title': string;
     'organization.profile.loading': string;
     'organization.profile.error': string;

package/dist/models/organization.d.ts

@@ -22,3 +22,12 @@ export interface Organization {
     ref?: string;
     status?: string;
 }
+/**
+ * Interface for paginated organization response.
+ */
+export interface AllOrganizationsApiResponse {
+    hasMore?: boolean;
+    nextCursor?: string;
+    organizations: Organization[];
+    totalCount?: number;
+}

package/dist/theme/createTheme.d.ts

@@ -4,7 +4,23 @@
  * 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
+ * You may obtain a cop  // Shadows
+  if (theme.shadows?.small) {
+    cssVars[`--${prefix}-shadow-small`] = theme.shadows.small;
+  }
+  if (theme.shadows?.medium) {
+    cssVars[`--${prefix}-shadow-medium`] = theme.shadows.medium;
+  }
+  if (theme.shadows?.large) {
+    cssVars[`--${prefix}-shadow-large`] = theme.shadows.large;
+  }
+
+  // Typography - Font Family
+  if (theme.typography?.fontFamily) {
+    cssVars[`--${prefix}-typography-fontFamily`] = theme.typography.fontFamily;
+  }
+
+  // Typography - Font Sizesense at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *

package/dist/theme/types.d.ts

@@ -15,7 +15,43 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+export interface ThemeTypography {
+    fontFamily: string;
+    fontSizes: {
+        xs: string;
+        sm: string;
+        md: string;
+        lg: string;
+        xl: string;
+        '2xl': string;
+        '3xl': string;
+    };
+    fontWeights: {
+        normal: number;
+        medium: number;
+        semibold: number;
+        bold: number;
+    };
+    lineHeights: {
+        tight: number;
+        normal: number;
+        relaxed: number;
+    };
+}
 export interface ThemeColors {
+    action: {
+        active: string;
+        hover: string;
+        hoverOpacity: number;
+        selected: string;
+        selectedOpacity: number;
+        disabled: string;
+        disabledBackground: string;
+        disabledOpacity: number;
+        focus: string;
+        focusOpacity: number;
+        activatedOpacity: number;
+    };
     background: {
         body: {
             main: string;
@@ -64,8 +100,183 @@ export interface ThemeConfig {
     spacing: {
         unit: number;
     };
+    typography: {
+        fontFamily: string;
+        fontSizes: {
+            xs: string;
+            sm: string;
+            md: string;
+            lg: string;
+            xl: string;
+            '2xl': string;
+            '3xl': string;
+        };
+        fontWeights: {
+            normal: number;
+            medium: number;
+            semibold: number;
+            bold: number;
+        };
+        lineHeights: {
+            tight: number;
+            normal: number;
+            relaxed: number;
+        };
+    };
+    /**
+     * Image assets configuration
+     */
+    images?: ThemeImages;
+    /**
+     * The prefix used for CSS variables.
+     * @default 'asgardeo' (from VendorConstants.VENDOR_PREFIX)
+     */
+    cssVarPrefix?: string;
+}
+export interface ThemeVars {
+    colors: {
+        action: {
+            active: string;
+            hover: string;
+            hoverOpacity: string;
+            selected: string;
+            selectedOpacity: string;
+            disabled: string;
+            disabledBackground: string;
+            disabledOpacity: string;
+            focus: string;
+            focusOpacity: string;
+            activatedOpacity: string;
+        };
+        primary: {
+            main: string;
+            contrastText: string;
+        };
+        secondary: {
+            main: string;
+            contrastText: string;
+        };
+        background: {
+            surface: string;
+            disabled: string;
+            body: {
+                main: string;
+            };
+        };
+        error: {
+            main: string;
+            contrastText: string;
+        };
+        success: {
+            main: string;
+            contrastText: string;
+        };
+        warning: {
+            main: string;
+            contrastText: string;
+        };
+        text: {
+            primary: string;
+            secondary: string;
+        };
+        border: string;
+    };
+    spacing: {
+        unit: string;
+    };
+    borderRadius: {
+        small: string;
+        medium: string;
+        large: string;
+    };
+    shadows: {
+        small: string;
+        medium: string;
+        large: string;
+    };
+    typography: {
+        fontFamily: string;
+        fontSizes: {
+            xs: string;
+            sm: string;
+            md: string;
+            lg: string;
+            xl: string;
+            '2xl': string;
+            '3xl': string;
+        };
+        fontWeights: {
+            normal: string;
+            medium: string;
+            semibold: string;
+            bold: string;
+        };
+        lineHeights: {
+            tight: string;
+            normal: string;
+            relaxed: string;
+        };
+    };
+    images?: {
+        favicon?: {
+            url?: string;
+            title?: string;
+            alt?: string;
+        };
+        logo?: {
+            url?: string;
+            title?: string;
+            alt?: string;
+        };
+        [key: string]: {
+            url?: string;
+            title?: string;
+            alt?: string;
+        } | undefined;
+    };
 }
 export interface Theme extends ThemeConfig {
     cssVariables: Record<string, string>;
+    vars: ThemeVars;
+}
+export type ThemeMode = 'light' | 'dark' | 'system' | 'class';
+export interface ThemeDetection {
+    /**
+     * The CSS class name to detect for dark mode (without the dot)
+     * @default 'dark'
+     */
+    darkClass?: string;
+    /**
+     * The CSS class name to detect for light mode (without the dot)
+     * @default 'light'
+     */
+    lightClass?: string;
+}
+export interface ThemeImage {
+    /**
+     * The URL of the image
+     */
+    url?: string;
+    /**
+     * The title/alt text for the image
+     */
+    title?: string;
+    /**
+     * Alternative text for accessibility
+     */
+    alt?: string;
+}
+export interface ThemeImages {
+    /**
+     * Favicon configuration
+     */
+    favicon?: ThemeImage;
+    /**
+     * Logo configuration
+     */
+    logo?: ThemeImage;
+    /**
+     * Allow for additional custom images
+     */
+    [key: string]: ThemeImage | undefined;
 }
-export type ThemeMode = 'light' | 'dark' | 'system';

package/dist/utils/deriveOrganizationHandleFromBaseUrl.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Extracts the organization handle from an Asgardeo base URL.
+ *
+ * This function parses Asgardeo URLs with the standard pattern:
+ * - https://dev.asgardeo.io/t/{orgHandle}
+ * - https://stage.asgardeo.io/t/{orgHandle}
+ * - https://prod.asgardeo.io/t/{orgHandle}
+ * - https://{subdomain}.asgardeo.io/t/{orgHandle}
+ *
+ * @param baseUrl - The base URL of the Asgardeo identity server
+ * @returns The extracted organization handle
+ * @throws {AsgardeoRuntimeError} When the URL doesn't match the expected Asgardeo pattern,
+ *   indicating a custom domain is configured and organizationHandle must be provided explicitly
+ *
+ * @example
+ * ```typescript
+ * // Standard Asgardeo URLs
+ * const handle1 = deriveOrganizationHandleFromBaseUrl('https://dev.asgardeo.io/t/dxlab');
+ * // Returns: 'dxlab'
+ *
+ * const handle2 = deriveOrganizationHandleFromBaseUrl('https://stage.asgardeo.io/t/myorg');
+ * // Returns: 'myorg'
+ *
+ * // Custom domain - throws error
+ * deriveOrganizationHandleFromBaseUrl('https://custom.example.com/auth');
+ * // Throws: AsgardeoRuntimeError
+ * ```
+ */
+declare const deriveOrganizationHandleFromBaseUrl: (baseUrl?: string) => string;
+export default deriveOrganizationHandleFromBaseUrl;