@asgardeo/javascript 0.1.1 → 0.1.2

package/dist/AsgardeoJavaScriptClient.d.ts

@@ -30,12 +30,13 @@ import { User, UserProfile } from './models/user';
 declare abstract class AsgardeoJavaScriptClient<T = Config> implements AsgardeoClient<T> {
     abstract switchOrganization(organization: Organization): Promise<void>;
     abstract initialize(config: T): Promise<boolean>;
-    abstract getUser(): Promise<User>;
-    abstract getOrganizations(): Promise<Organization[]>;
-    abstract getCurrentOrganization(): Promise<Organization | null>;
-    abstract getUserProfile(): Promise<UserProfile>;
+    abstract getUser(options?: any): Promise<User>;
+    abstract getOrganizations(options?: any): Promise<Organization[]>;
+    abstract getCurrentOrganization(sessionId?: string): Promise<Organization | null>;
+    abstract getUserProfile(options?: any): Promise<UserProfile>;
     abstract isLoading(): boolean;
     abstract isSignedIn(): Promise<boolean>;
+    abstract updateUserProfile(payload: any, userId?: string): Promise<User>;
     abstract getConfiguration(): T;
     abstract signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
     abstract signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: Request, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;

package/dist/api/getBrandingPreference.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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.
+ */
+import { BrandingPreference } from '../models/branding-preference';
+/**
+ * Configuration for the getBrandingPreference request
+ */
+export interface GetBrandingPreferenceConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The base URL for the API endpoint.
+     */
+    baseUrl: string;
+    /**
+     * Locale for the branding preference
+     */
+    locale?: string;
+    /**
+     * Name of the branding preference
+     */
+    name?: string;
+    /**
+     * Type of the branding preference
+     */
+    type?: string;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves branding preference configuration.
+ *
+ * @param config - Configuration object containing baseUrl, optional query parameters, and request config.
+ * @returns A promise that resolves with the branding preference information.
+ * @example
+ * ```typescript
+ * // Using default fetch
+ * try {
+ *   const response = await getBrandingPreference({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     locale: "en-US",
+ *     name: "my-branding",
+ *     type: "org"
+ *   });
+ *   console.log(response.theme);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get branding preference:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * try {
+ *   const response = await getBrandingPreference({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     locale: "en-US",
+ *     name: "my-branding",
+ *     type: "org",
+ *     fetcher: async (url, config) => {
+ *       const response = await httpClient({
+ *         url,
+ *         method: config.method,
+ *         headers: config.headers,
+ *         ...config
+ *       });
+ *       // Convert axios-like response to fetch-like Response
+ *       return {
+ *         ok: response.status >= 200 && response.status < 300,
+ *         status: response.status,
+ *         statusText: response.statusText,
+ *         json: () => Promise.resolve(response.data),
+ *         text: () => Promise.resolve(typeof response.data === 'string' ? response.data : JSON.stringify(response.data))
+ *       } as Response;
+ *     }
+ *   });
+ *   console.log(response.theme);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get branding preference:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getBrandingPreference: ({ baseUrl, locale, name, type, fetcher, ...requestConfig }: GetBrandingPreferenceConfig) => Promise<BrandingPreference>;
+export default getBrandingPreference;

package/dist/cjs/index.js

@@ -50,6 +50,7 @@ __export(index_exports, {
   createPatchOperations: () => createPatchOperations,
   createTheme: () => createTheme_default,
   deepMerge: () => deepMerge_default,
+  deriveOrganizationHandleFromBaseUrl: () => deriveOrganizationHandleFromBaseUrl_default,
   executeEmbeddedSignInFlow: () => executeEmbeddedSignInFlow_default,
   executeEmbeddedSignUpFlow: () => executeEmbeddedSignUpFlow_default,
   extractPkceStorageKeyFromState: () => extractPkceStorageKeyFromState_default,
@@ -59,6 +60,7 @@ __export(index_exports, {
   generateUserProfile: () => generateUserProfile_default,
   get: () => get_default,
   getAllOrganizations: () => getAllOrganizations_default,
+  getBrandingPreference: () => getBrandingPreference_default,
   getI18nBundles: () => getI18nBundles_default,
   getLatestStateParam: () => getLatestStateParam_default,
   getMeOrganizations: () => getMeOrganizations_default,
@@ -2022,16 +2024,15 @@ var initializeEmbeddedSignInFlow = async ({
       searchParams.append(key, String(value));
     }
   });
-  const { headers: customHeaders, ...otherConfig } = requestConfig;
   const response = await fetch(url ?? `${baseUrl}/oauth2/authorize`, {
+    ...requestConfig,
     method: requestConfig.method || "POST",
     headers: {
       "Content-Type": "application/x-www-form-urlencoded",
       Accept: "application/json",
-      ...customHeaders
+      ...requestConfig.headers
     },
-    body: searchParams.toString(),
-    ...otherConfig
+    body: searchParams.toString()
   });
   if (!response.ok) {
     const errorText = await response.text();
@@ -2063,16 +2064,15 @@ var executeEmbeddedSignInFlow = async ({
       "If an authorization payload is not provided, the request cannot be constructed correctly."
     );
   }
-  const { headers: customHeaders, ...otherConfig } = requestConfig;
   const response = await fetch(url ?? `${baseUrl}/oauth2/authn`, {
+    ...requestConfig,
     method: requestConfig.method || "POST",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
-      ...customHeaders
+      ...requestConfig.headers
     },
-    body: JSON.stringify(payload),
-    ...otherConfig
+    body: JSON.stringify(payload)
   });
   if (!response.ok) {
     const errorText = await response.text();
@@ -2132,19 +2132,18 @@ var executeEmbeddedSignUpFlow = async ({
       "At least one of the baseUrl or url must be provided to execute the embedded sign up flow."
     );
   }
-  const { headers: customHeaders, ...otherConfig } = requestConfig;
   const response = await fetch(url ?? `${baseUrl}/api/server/v1/flow/execute`, {
+    ...requestConfig,
     method: requestConfig.method || "POST",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
-      ...customHeaders
+      ...requestConfig.headers
     },
     body: JSON.stringify({
       ...payload ?? {},
       flowType: "REGISTRATION" /* Registration */
-    }),
-    ...otherConfig
+    })
   });
   if (!response.ok) {
     const errorText = await response.text();
@@ -2174,12 +2173,13 @@ var getUserInfo = async ({ url, ...requestConfig }) => {
     );
   }
   const response = await fetch(url, {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/json",
-      Accept: "application/json"
-    },
-    ...requestConfig
+      Accept: "application/json",
+      ...requestConfig.headers
+    }
   });
   if (!response.ok) {
     const errorText = await response.text();
@@ -2211,13 +2211,13 @@ var getScim2Me = async ({ url, baseUrl, fetcher, ...requestConfig }) => {
   const fetchFn = fetcher || fetch;
   const resolvedUrl = url ?? `${baseUrl}/scim2/Me`;
   const requestInit = {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/scim+json",
       Accept: "application/json",
       ...requestConfig.headers
-    },
-    ...requestConfig
+    }
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2263,13 +2263,13 @@ var getSchemas = async ({ url, baseUrl, fetcher, ...requestConfig }) => {
   const fetchFn = fetcher || fetch;
   const resolvedUrl = url ?? `${baseUrl}/scim2/Schemas`;
   const requestInit = {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
-    },
-    ...requestConfig
+    }
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2331,13 +2331,13 @@ var getAllOrganizations = async ({
   const fetchFn = fetcher || fetch;
   const resolvedUrl = `${baseUrl}/api/server/v1/organizations?${queryParams.toString()}`;
   const requestInit = {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
-    },
-    ...requestConfig
+    }
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2407,14 +2407,14 @@ var createOrganization = async ({
   const fetchFn = fetcher || fetch;
   const resolvedUrl = `${baseUrl}/api/server/v1/organizations`;
   const requestInit = {
+    ...requestConfig,
     method: "POST",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
     },
-    body: JSON.stringify(organizationPayload),
-    ...requestConfig
+    body: JSON.stringify(organizationPayload)
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2482,13 +2482,13 @@ var getMeOrganizations = async ({
   const fetchFn = fetcher || fetch;
   const resolvedUrl = `${baseUrl}/api/users/v1/me/organizations?${queryParams.toString()}`;
   const requestInit = {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
-    },
-    ...requestConfig
+    }
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2549,13 +2549,13 @@ var getOrganization = async ({
   const fetchFn = fetcher || fetch;
   const resolvedUrl = `${baseUrl}/api/server/v1/organizations/${organizationId}`;
   const requestInit = {
+    ...requestConfig,
     method: "GET",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
-    },
-    ...requestConfig
+    }
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2643,14 +2643,14 @@ var updateOrganization = async ({
   const fetchFn = fetcher || fetch;
   const resolvedUrl = `${baseUrl}/api/server/v1/organizations/${organizationId}`;
   const requestInit = {
+    ...requestConfig,
     method: "PATCH",
     headers: {
       "Content-Type": "application/json",
       Accept: "application/json",
       ...requestConfig.headers
     },
-    body: JSON.stringify(operations),
-    ...requestConfig
+    body: JSON.stringify(operations)
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2727,13 +2727,13 @@ var updateMeProfile = async ({
   const resolvedUrl = url ?? `${baseUrl}/scim2/Me`;
   const requestInit = {
     method: "PATCH",
+    ...requestConfig,
     headers: {
+      ...requestConfig.headers,
       "Content-Type": "application/scim+json",
-      Accept: "application/json",
-      ...requestConfig.headers
+      Accept: "application/json"
     },
-    body: JSON.stringify(data),
-    ...requestConfig
+    body: JSON.stringify(data)
   };
   try {
     const response = await fetchFn(resolvedUrl, requestInit);
@@ -2763,6 +2763,75 @@ var updateMeProfile = async ({
 };
 var updateMeProfile_default = updateMeProfile;
 
+// src/api/getBrandingPreference.ts
+var getBrandingPreference = async ({
+  baseUrl,
+  locale,
+  name,
+  type,
+  fetcher,
+  ...requestConfig
+}) => {
+  try {
+    new URL(baseUrl);
+  } catch (error) {
+    throw new AsgardeoAPIError(
+      `Invalid base URL provided. ${error?.toString()}`,
+      "getBrandingPreference-ValidationError-001",
+      "javascript",
+      400,
+      "The provided `baseUrl` does not adhere to the URL schema."
+    );
+  }
+  const queryParams = new URLSearchParams(
+    Object.fromEntries(
+      Object.entries({
+        locale: locale || "",
+        name: name || "",
+        type: type || ""
+      }).filter(([, value]) => Boolean(value))
+    )
+  );
+  const fetchFn = fetcher || fetch;
+  const resolvedUrl = `${baseUrl}/api/server/v1/branding-preference${queryParams.toString() ? `?${queryParams.toString()}` : ""}`;
+  const requestInit = {
+    ...requestConfig,
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json",
+      Accept: "application/json",
+      ...requestConfig.headers
+    }
+  };
+  try {
+    const response = await fetchFn(resolvedUrl, requestInit);
+    if (!response?.ok) {
+      const errorText = await response.text();
+      throw new AsgardeoAPIError(
+        `Failed to get branding preference: ${errorText}`,
+        "getBrandingPreference-ResponseError-001",
+        "javascript",
+        response.status,
+        response.statusText
+      );
+    }
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    if (error instanceof AsgardeoAPIError) {
+      throw error;
+    }
+    throw new AsgardeoAPIError(
+      `Network or parsing error: ${error instanceof Error ? error.message : "Unknown error"}`,
+      "getBrandingPreference-NetworkError-001",
+      "javascript",
+      0,
+      "Network Error"
+    );
+  }
+};
+var getBrandingPreference_default = getBrandingPreference;
+
 // src/constants/ApplicationNativeAuthenticationConstants.ts
 var ApplicationNativeAuthenticationConstants = {
   SupportedAuthenticators: {
@@ -3051,6 +3120,58 @@ var deepMerge = (target, ...sources) => {
 };
 var deepMerge_default = deepMerge;
 
+// src/utils/deriveOrganizationHandleFromBaseUrl.ts
+var deriveOrganizationHandleFromBaseUrl = (baseUrl) => {
+  if (!baseUrl) {
+    throw new AsgardeoRuntimeError(
+      "Base URL is required to derive organization handle.",
+      "javascript-deriveOrganizationHandleFromBaseUrl-ValidationError-001",
+      "javascript",
+      "A valid base URL must be provided to extract the organization handle."
+    );
+  }
+  let parsedUrl;
+  try {
+    parsedUrl = new URL(baseUrl);
+  } catch (error) {
+    throw new AsgardeoRuntimeError(
+      `Invalid base URL format: ${baseUrl}`,
+      "javascript-deriveOrganizationHandleFromBaseUrl-ValidationError-002",
+      "javascript",
+      "The provided base URL does not conform to valid URL syntax."
+    );
+  }
+  const hostname = parsedUrl.hostname.toLowerCase();
+  if (!hostname.endsWith(".asgardeo.io")) {
+    throw new AsgardeoRuntimeError(
+      "Organization handle is required since a custom domain is configured.",
+      "javascript-deriveOrganizationHandleFromBaseUrl-CustomDomainError-001",
+      "javascript",
+      "The provided base URL uses a custom domain. Please provide the organizationHandle explicitly in the configuration."
+    );
+  }
+  const pathSegments = parsedUrl.pathname.split("/").filter((segment) => segment.length > 0);
+  if (pathSegments.length < 2 || pathSegments[0] !== "t") {
+    throw new AsgardeoRuntimeError(
+      "Organization handle is required since a custom domain is configured.",
+      "javascript-deriveOrganizationHandleFromBaseUrl-CustomDomainError-002",
+      "javascript",
+      "The provided base URL does not follow the expected Asgardeo URL pattern (/t/{orgHandle}). Please provide the organizationHandle explicitly in the configuration."
+    );
+  }
+  const organizationHandle = pathSegments[1];
+  if (!organizationHandle || organizationHandle.trim().length === 0) {
+    throw new AsgardeoRuntimeError(
+      "Organization handle is required since a custom domain is configured.",
+      "javascript-deriveOrganizationHandleFromBaseUrl-CustomDomainError-003",
+      "javascript",
+      "The organization handle could not be extracted from the base URL. Please provide the organizationHandle explicitly in the configuration."
+    );
+  }
+  return organizationHandle;
+};
+var deriveOrganizationHandleFromBaseUrl_default = deriveOrganizationHandleFromBaseUrl;
+
 // src/utils/flattenUserSchema.ts
 var flattenUserSchema = (schemas) => {
   const flattenedAttributes = [];
@@ -3410,6 +3531,7 @@ var withVendorCSSClassPrefix_default = withVendorCSSClassPrefix;
   createPatchOperations,
   createTheme,
   deepMerge,
+  deriveOrganizationHandleFromBaseUrl,
   executeEmbeddedSignInFlow,
   executeEmbeddedSignUpFlow,
   extractPkceStorageKeyFromState,
@@ -3419,6 +3541,7 @@ var withVendorCSSClassPrefix_default = withVendorCSSClassPrefix;
   generateUserProfile,
   get,
   getAllOrganizations,
+  getBrandingPreference,
   getI18nBundles,
   getLatestStateParam,
   getMeOrganizations,