@asgardeo/javascript 0.0.1 → 0.1.1

package/dist/api/executeEmbeddedSignInFlow.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { EmbeddedFlowExecuteRequestConfig } from '../models/embedded-flow';
+import { EmbeddedSignInFlowHandleResponse } from '../models/embedded-signin-flow';
+declare const executeEmbeddedSignInFlow: ({ url, baseUrl, payload, ...requestConfig }: EmbeddedFlowExecuteRequestConfig) => Promise<EmbeddedSignInFlowHandleResponse>;
+export default executeEmbeddedSignInFlow;

package/dist/api/executeEmbeddedSignUpFlow.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { EmbeddedFlowExecuteResponse, EmbeddedFlowExecuteRequestConfig } from '../models/embedded-flow';
+/**
+ * Executes an embedded signup flow by sending a request to the specified flow execution endpoint.
+ *
+ * @param requestConfig - Request configuration object containing URL and payload.
+ * @returns A promise that resolves with the flow execution response.
+ * @throws AsgardeoAPIError when the request fails or URL is invalid.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const embeddedSignUpResponse = await executeEmbeddedSignUpFlow({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/api/server/v1/flow/execute",
+ *     payload: {
+ *       flowType: "REGISTRATION"
+ *     }
+ *   });
+ *   console.log(embeddedSignUpResponse);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Embedded SignUp flow execution failed:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const executeEmbeddedSignUpFlow: ({ url, baseUrl, payload, ...requestConfig }: EmbeddedFlowExecuteRequestConfig) => Promise<EmbeddedFlowExecuteResponse>;
+export default executeEmbeddedSignUpFlow;

package/dist/api/getAllOrganizations.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { Organization } from '../models/organization';
+/**
+ * Interface for paginated organization response.
+ */
+export interface PaginatedOrganizationsResponse {
+    hasMore?: boolean;
+    nextCursor?: string;
+    organizations: Organization[];
+    totalCount?: number;
+}
+/**
+ * Configuration for the getAllOrganizations request
+ */
+export interface GetAllOrganizationsConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The base URL for the API endpoint.
+     */
+    baseUrl: string;
+    /**
+     * Filter expression for organizations
+     */
+    filter?: string;
+    /**
+     * Maximum number of organizations to return
+     */
+    limit?: number;
+    /**
+     * Whether to include child organizations recursively
+     */
+    recursive?: boolean;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves all organizations with pagination support.
+ *
+ * @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 fetch
+ * try {
+ *   const response = await getAllOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false
+ *   });
+ *   console.log(response.organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * try {
+ *   const response = await getAllOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false,
+ *     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.organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getAllOrganizations: ({ baseUrl, filter, limit, recursive, fetcher, ...requestConfig }: GetAllOrganizationsConfig) => Promise<PaginatedOrganizationsResponse>;
+export default getAllOrganizations;

package/dist/api/getMeOrganizations.d.ts

@@ -0,0 +1,119 @@
+/**
+ * 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 { Organization } from '../models/organization';
+/**
+ * Configuration for the getMeOrganizations request
+ */
+export interface GetMeOrganizationsConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The base URL for the API endpoint.
+     */
+    baseUrl: string;
+    /**
+     * Base64 encoded cursor value for forward pagination
+     */
+    after?: string;
+    /**
+     * Authorized application name filter
+     */
+    authorizedAppName?: string;
+    /**
+     * Base64 encoded cursor value for backward pagination
+     */
+    before?: string;
+    /**
+     * Filter expression for organizations
+     */
+    filter?: string;
+    /**
+     * Maximum number of organizations to return
+     */
+    limit?: number;
+    /**
+     * Whether to include child organizations recursively
+     */
+    recursive?: boolean;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves the organizations associated with the current user.
+ *
+ * @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 fetch
+ * try {
+ *   const organizations = await getMeOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     after: "",
+ *     before: "",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false
+ *   });
+ *   console.log(organizations);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organizations:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * try {
+ *   const organizations = await getMeOrganizations({
+ *     baseUrl: "https://api.asgardeo.io/t/<ORGANIZATION>",
+ *     after: "",
+ *     before: "",
+ *     filter: "",
+ *     limit: 10,
+ *     recursive: false,
+ *     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(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, fetcher, ...requestConfig }: GetMeOrganizationsConfig) => Promise<Organization[]>;
+export default getMeOrganizations;

package/dist/api/getOrganization.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 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.
+ */
+/**
+ * Extended organization interface with additional properties
+ */
+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;
+}
+/**
+ * Configuration for the getOrganization request
+ */
+export interface GetOrganizationConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The base URL for the API endpoint.
+     */
+    baseUrl: string;
+    /**
+     * The ID of the organization to retrieve
+     */
+    organizationId: string;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves detailed information for a specific organization.
+ *
+ * @param config - Configuration object containing baseUrl, organizationId, and request config.
+ * @returns A promise that resolves with the organization details.
+ * @example
+ * ```typescript
+ * // Using default fetch
+ * try {
+ *   const organization = await getOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/dxlab",
+ *     organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1"
+ *   });
+ *   console.log(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organization:', error.message);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using custom fetcher (e.g., axios-based httpClient)
+ * try {
+ *   const organization = await getOrganization({
+ *     baseUrl: "https://api.asgardeo.io/t/dxlab",
+ *     organizationId: "0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1",
+ *     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(organization);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get organization:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getOrganization: ({ baseUrl, organizationId, fetcher, ...requestConfig }: GetOrganizationConfig) => Promise<OrganizationDetails>;
+export default getOrganization;

package/dist/api/getSchemas.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 } from '../models/scim2-schema';
+/**
+ * Configuration for the getSchemas request
+ */
+export interface GetSchemasConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The absolute API endpoint.
+     */
+    url?: string;
+    /**
+     * The base path of the API endpoint.
+     */
+    baseUrl?: string;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves the SCIM2 schemas from the specified endpoint.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the SCIM2 schemas information.
+ * @example
+ * ```typescript
+ * // Using default fetch
+ * 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 (e.g., axios-based httpClient)
+ * try {
+ *   const schemas = await getSchemas({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Schemas",
+ *     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(schemas);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get schemas:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getSchemas: ({ url, baseUrl, fetcher, ...requestConfig }: GetSchemasConfig) => Promise<Schema[]>;
+export default getSchemas;

package/dist/api/getScim2Me.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 } from '../models/user';
+/**
+ * Configuration for the getScim2Me request
+ */
+export interface GetScim2MeConfig extends Omit<RequestInit, 'method'> {
+    /**
+     * The absolute API endpoint.
+     */
+    url?: string;
+    /**
+     * The base path of the API endpoint.
+     */
+    baseUrl?: string;
+    /**
+     * Optional custom fetcher function.
+     * If not provided, native fetch will be used
+     */
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+}
+/**
+ * Retrieves the user profile information from the specified SCIM2 /Me endpoint.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the user profile information.
+ * @example
+ * ```typescript
+ * // Using default fetch
+ * 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 (e.g., axios-based httpClient)
+ * try {
+ *   const userProfile = await getScim2Me({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Me",
+ *     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(userProfile);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get user profile:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getScim2Me: ({ url, baseUrl, fetcher, ...requestConfig }: GetScim2MeConfig) => Promise<User>;
+export default getScim2Me;

package/dist/api/{oidc/getUserInfo.d.ts → getUserInfo.d.ts}

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { User } from '../../models/user';
+import { User } from '../models/user';
 /**
  * Retrieves the user information from the specified OIDC userinfo endpoint.
  *

package/dist/api/initializeEmbeddedSignInFlow.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { EmbeddedFlowExecuteRequestConfig } from '../models/embedded-flow';
+import { EmbeddedSignInFlowInitiateResponse } from '../models/embedded-signin-flow';
+/**
+ * Sends an authorization request to the specified OAuth2/OIDC authorization endpoint.
+ *
+ * @param requestConfig - Request configuration object containing URL and payload.
+ * @returns A promise that resolves with the authorization response.
+ * @throws AsgardeoAPIError when the request fails or URL is invalid.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const authResponse = await initializeEmbeddedSignInFlow({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/oauth2/authorize",
+ *     payload: {
+ *       response_type: "code",
+ *       client_id: "your-client-id",
+ *       redirect_uri: "https://your-app.com/callback",
+ *       scope: "openid profile email",
+ *       state: "random-state-value",
+ *       code_challenge: "your-pkce-challenge",
+ *       code_challenge_method: "S256"
+ *     }
+ *   });
+ *   console.log(authResponse);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Authorization failed:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const initializeEmbeddedSignInFlow: ({ url, baseUrl, payload, ...requestConfig }: EmbeddedFlowExecuteRequestConfig) => Promise<EmbeddedSignInFlowInitiateResponse>;
+export default initializeEmbeddedSignInFlow;