@asgardeo/react 0.5.0 → 0.5.1

package/dist/AsgardeoReactClient.d.ts

@@ -35,10 +35,11 @@ declare class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactC
     isLoading(): boolean;
     isInitialized(): Promise<boolean>;
     isSignedIn(): Promise<boolean>;
+    getConfiguration(): T;
     signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
     signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: EmbeddedFlowExecuteRequestConfig, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
-    signOut(options?: SignOutOptions, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
-    signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
+    signOut(options?: SignOutOptions, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
     signUp(options?: SignUpOptions): Promise<void>;
     signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
 }

package/dist/api/{scim2/createOrganization.d.ts → createOrganization.d.ts}

@@ -15,39 +15,26 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Organization } from '@asgardeo/browser';
+import { Organization, CreateOrganizationConfig as BaseCreateOrganizationConfig } from '@asgardeo/browser';
 /**
- * Interface for organization creation payload.
+ * Configuration for the createOrganization request (React-specific)
  */
-export interface CreateOrganizationPayload {
+export interface CreateOrganizationConfig extends Omit<BaseCreateOrganizationConfig, 'fetcher'> {
     /**
-     * Organization description.
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
      */
-    description: string;
-    /**
-     * Organization handle/slug.
-     */
-    orgHandle?: string;
-    /**
-     * Organization name.
-     */
-    name: string;
-    /**
-     * Parent organization ID.
-     */
-    parentId: string;
-    /**
-     * Organization type.
-     */
-    type: 'TENANT';
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
 }
 /**
  * Creates a new organization.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
  *
  * @param config - Configuration object containing baseUrl, payload and optional request config.
  * @returns A promise that resolves with the created organization information.
  * @example
  * ```typescript
+ * // Using default Asgardeo SPA client httpClient
  * try {
  *   const organization = await createOrganization({
  *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
@@ -66,9 +53,29 @@ export interface CreateOrganizationPayload {
  *   }
  * }
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const organization = await createOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     payload: {
+ *       description: "Share your screens",
+ *       name: "Team Viewer",
+ *       orgHandle: "team-viewer",
+ *       parentId: "f4825104-4948-40d9-ab65-a960eee3e3d5",
+ *       type: "TENANT"
+ *     },
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to create organization:', error.message);
+ *   }
+ * }
+ * ```
  */
-declare const createOrganization: ({ baseUrl, payload, ...requestConfig }: Partial<Request> & {
-    baseUrl: string;
-    payload: CreateOrganizationPayload;
-}) => Promise<Organization>;
+declare const createOrganization: ({ fetcher, ...requestConfig }: CreateOrganizationConfig) => Promise<Organization>;
 export default createOrganization;

package/dist/api/{scim2/getAllOrganizations.d.ts → getAllOrganizations.d.ts}

@@ -15,23 +15,26 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Organization } from '@asgardeo/browser';
+import { GetAllOrganizationsConfig as BaseGetAllOrganizationsConfig, PaginatedOrganizationsResponse } from '@asgardeo/browser';
 /**
- * Interface for paginated organization response.
+ * Configuration for the getAllOrganizations request (React-specific)
  */
-export interface PaginatedOrganizationsResponse {
-    hasMore?: boolean;
-    nextCursor?: string;
-    organizations: Organization[];
-    totalCount?: number;
+export interface GetAllOrganizationsConfig extends Omit<BaseGetAllOrganizationsConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
 }
 /**
  * Retrieves all organizations with pagination support.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
  *
  * @param config - Configuration object containing baseUrl, optional query parameters, and request config.
  * @returns A promise that resolves with the paginated organizations information.
  * @example
  * ```typescript
+ * // Using default Asgardeo SPA client httpClient
  * try {
  *   const response = await getAllOrganizations({
  *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
@@ -46,11 +49,25 @@ export interface PaginatedOrganizationsResponse {
  *   }
  * }
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const response = await getAllOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false,
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(response.organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
  */
-declare const getAllOrganizations: ({ baseUrl, filter, limit, recursive, ...requestConfig }: Partial<Request> & {
-    baseUrl: string;
-    filter?: string;
-    limit?: number;
-    recursive?: boolean;
-}) => Promise<PaginatedOrganizationsResponse>;
+declare const getAllOrganizations: ({ fetcher, ...requestConfig }: GetAllOrganizationsConfig) => Promise<PaginatedOrganizationsResponse>;
 export default getAllOrganizations;

package/dist/api/{scim2/getMeOrganizations.d.ts → getMeOrganizations.d.ts}

@@ -15,14 +15,26 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Organization } from '@asgardeo/browser';
+import { Organization, GetMeOrganizationsConfig as BaseGetMeOrganizationsConfig } from '@asgardeo/browser';
+/**
+ * Configuration for the getMeOrganizations request (React-specific)
+ */
+export interface GetMeOrganizationsConfig extends Omit<BaseGetMeOrganizationsConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
 /**
  * Retrieves the organizations associated with the current user.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
  *
  * @param config - Configuration object containing baseUrl, optional query parameters, and request config.
  * @returns A promise that resolves with the organizations information.
  * @example
  * ```typescript
+ * // Using default Asgardeo SPA client httpClient
  * try {
  *   const organizations = await getMeOrganizations({
  *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
@@ -39,14 +51,27 @@ import { Organization } from '@asgardeo/browser';
  *   }
  * }
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const organizations = await getMeOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     after: "",
+ *     before: "",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false,
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
  */
-declare const getMeOrganizations: ({ baseUrl, after, authorizedAppName, before, filter, limit, recursive, ...requestConfig }: Partial<Request> & {
-    baseUrl: string;
-    after?: string;
-    authorizedAppName?: string;
-    before?: string;
-    filter?: string;
-    limit?: number;
-    recursive?: boolean;
-}) => Promise<Organization[]>;
+declare const getMeOrganizations: ({ fetcher, ...requestConfig }: GetMeOrganizationsConfig) => Promise<Organization[]>;
 export default getMeOrganizations;

package/dist/api/{scim2/getOrganization.d.ts → getOrganization.d.ts}

@@ -15,32 +15,26 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { GetOrganizationConfig as BaseGetOrganizationConfig, OrganizationDetails } from '@asgardeo/browser';
 /**
- * Extended organization interface with additional properties
+ * Configuration for the getOrganization request (React-specific)
  */
-export interface OrganizationDetails {
-    attributes?: Record<string, any>;
-    created?: string;
-    description?: string;
-    id: string;
-    lastModified?: string;
-    name: string;
-    orgHandle: string;
-    parent?: {
-        id: string;
-        ref: string;
-    };
-    permissions?: string[];
-    status?: string;
-    type?: string;
+export interface GetOrganizationConfig extends Omit<BaseGetOrganizationConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
 }
 /**
  * Retrieves detailed information for a specific organization.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
  *
  * @param config - Configuration object containing baseUrl, organizationId, and request config.
  * @returns A promise that resolves with the organization details.
  * @example
  * ```typescript
+ * // Using default Asgardeo SPA client httpClient
  * try {
  *   const organization = await getOrganization({
  *     baseUrl: "https://api.asgardeo.io/t/dxlab",
@@ -53,9 +47,23 @@ export interface OrganizationDetails {
  *   }
  * }
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const organization = await getOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/dxlab",
+ *     organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organization:', error.message);
+ *   }
+ * }
+ * ```
  */
-declare const getOrganization: ({ baseUrl, organizationId, ...requestConfig }: Partial<Request> & {
-    baseUrl: string;
-    organizationId: string;
-}) => Promise<OrganizationDetails>;
+declare const getOrganization: ({ fetcher, ...requestConfig }: GetOrganizationConfig) => Promise<OrganizationDetails>;
 export default getOrganization;

package/dist/api/getSchemas.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { Schema, GetSchemasConfig as BaseGetSchemasConfig } from '@asgardeo/browser';
+/**
+ * Configuration for the getSchemas request (React-specific)
+ */
+export interface GetSchemasConfig extends Omit<BaseGetSchemasConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves the SCIM2 schemas from the specified endpoint.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the SCIM2 schemas information.
+ * @example
+ * ```typescript
+ * // Using default Asgardeo SPA client httpClient
+ * try {
+ *   const schemas = await getSchemas({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Schemas",
+ *   });
+ *   console.log(schemas);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get schemas:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const schemas = await getSchemas({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Schemas",
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(schemas);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get schemas:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getSchemas: ({ fetcher, ...requestConfig }: GetSchemasConfig) => Promise<Schema[]>;
+export default getSchemas;

package/dist/api/getScim2Me.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { User, GetScim2MeConfig as BaseGetScim2MeConfig } from '@asgardeo/browser';
+/**
+ * Configuration for the getScim2Me request (React-specific)
+ */
+export interface GetScim2MeConfig extends Omit<BaseGetScim2MeConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves the user profile information from the specified SCIM2 /Me endpoint.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
+ *
+ * @param requestConfig - Request configuration object.
+ * @returns A promise that resolves with the user profile information.
+ * @example
+ * ```typescript
+ * // Using default Asgardeo SPA client httpClient
+ * try {
+ *   const userProfile = await getScim2Me({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Me",
+ *   });
+ *   console.log(userProfile);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get user profile:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * try {
+ *   const userProfile = await getScim2Me({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Me",
+ *     fetcher: customFetchFunction
+ *   });
+ *   console.log(userProfile);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get user profile:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getScim2Me: ({ fetcher, ...requestConfig }: GetScim2MeConfig) => Promise<User>;
+export default getScim2Me;

package/dist/api/updateMeProfile.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { User, UpdateMeProfileConfig as BaseUpdateMeProfileConfig } from '@asgardeo/browser';
+/**
+ * Configuration for the updateMeProfile request (React-specific)
+ */
+export interface UpdateMeProfileConfig extends Omit<BaseUpdateMeProfileConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Updates the user profile information at the specified SCIM2 Me endpoint.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
+ *
+ * @param config - Configuration object with URL, payload and optional request config.
+ * @returns A promise that resolves with the updated user profile information.
+ * @example
+ * ```typescript
+ * // Using default Asgardeo SPA client httpClient
+ * await updateMeProfile({
+ *   url: "https://api.asgardeo.io/t/<ORG>/scim2/Me",
+ *   payload: { "urn:scim:wso2:schema": { mobileNumbers: ["0777933830"] } }
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * await updateMeProfile({
+ *   url: "https://api.asgardeo.io/t/<ORG>/scim2/Me",
+ *   payload: { "urn:scim:wso2:schema": { mobileNumbers: ["0777933830"] } },
+ *   fetcher: customFetchFunction
+ * });
+ * ```
+ */
+declare const updateMeProfile: ({ fetcher, ...requestConfig }: UpdateMeProfileConfig) => Promise<User>;
+export default updateMeProfile;

package/dist/api/{scim2/updateOrganization.d.ts → updateOrganization.d.ts}

@@ -15,14 +15,22 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { OrganizationDetails } from './getOrganization';
+import { UpdateOrganizationConfig as BaseUpdateOrganizationConfig, OrganizationDetails, createPatchOperations } from '@asgardeo/browser';
+/**
+ * Configuration for the updateOrganization request (React-specific)
+ */
+export interface UpdateOrganizationConfig extends Omit<BaseUpdateOrganizationConfig, 'fetcher'> {
+    /**
+     * Optional custom fetcher function. If not provided, the Asgardeo SPA client's httpClient will be used
+     * which is a wrapper around axios http.request
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
 /**
  * Updates the organization information using the Organizations Management API.
+ * This function uses the Asgardeo SPA client's httpClient by default, but allows for custom fetchers.
  *
- * @param baseUrl - The base URL for the API.
- * @param organizationId - The ID of the organization to update.
- * @param operations - Array of patch operations to apply.
- * @param requestConfig - Additional request config if needed.
+ * @param config - Configuration object with baseUrl, organizationId, operations and optional request config.
  * @returns A promise that resolves with the updated organization information.
  * @example
  * ```typescript
@@ -49,26 +57,20 @@ import { OrganizationDetails } from './getOrganization';
  *   ]
  * });
  * ```
- */
-declare const updateOrganization: ({ baseUrl, organizationId, operations, ...requestConfig }: {
-    baseUrl: string;
-    organizationId: string;
-    operations: Array<{
-        operation: "REPLACE" | "ADD" | "REMOVE";
-        path: string;
-        value?: any;
-    }>;
-} & Partial<Request>) => Promise<OrganizationDetails>;
-/**
- * Helper function to convert field updates to patch operations format.
- * Uses REMOVE operation when the value is empty, otherwise uses REPLACE.
  *
- * @param payload - Object containing field updates
- * @returns Array of patch operations
+ * @example
+ * ```typescript
+ * // Using custom fetcher
+ * await updateOrganization({
+ *   baseUrl: "https://api.asgardeo.io/t/<ORG>",
+ *   organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *   operations: [
+ *     { operation: "REPLACE", path: "/name", value: "Updated Organization Name" }
+ *   ],
+ *   fetcher: customFetchFunction
+ * });
+ * ```
  */
-export declare const createPatchOperations: (payload: Record<string, any>) => Array<{
-    operation: "REPLACE" | "REMOVE";
-    path: string;
-    value?: any;
-}>;
+declare const updateOrganization: ({ fetcher, ...requestConfig }: UpdateOrganizationConfig) => Promise<OrganizationDetails>;
+export { createPatchOperations };
 export default updateOrganization;