@asgardeo/javascript 0.1.19 → 0.1.21

package/dist/models/client.d.ts

@@ -40,6 +40,11 @@ export interface AsgardeoClient<T> {
      * @returns Associated organizations.
      */
     getMyOrganizations(options?: any, sessionId?: string): Promise<Organization[]>;
+    /**
+     * 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 current organization of the user.
@@ -53,6 +58,10 @@ export interface AsgardeoClient<T> {
      * @returns A promise that resolves when the switch is complete.
      */
     switchOrganization(organization: Organization, sessionId?: string): Promise<TokenResponse | Response>;
+    /**
+     * 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).
@@ -60,6 +69,11 @@ export interface AsgardeoClient<T> {
      * @param sessionId - Optional session ID to be used for the token exchange.
      */
     exchangeToken(config: TokenExchangeRequestConfig, sessionId?: string): Promise<TokenResponse | Response>;
+    /**
+     * 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.
+     */
     updateUserProfile(payload: any, userId?: string): Promise<User>;
     /**
      * Gets user information from the session.
@@ -172,4 +186,9 @@ export interface AsgardeoClient<T> {
      * @returns A promise that resolves to the access token string.
      */
     getAccessToken(sessionId?: string): Promise<string>;
+    /**
+     * Clears the session for the specified session ID.
+     * @param sessionId - Optional session ID to clear the session for.
+     */
+    clearSession(sessionId?: string): void;
 }

package/dist/models/config.d.ts

@@ -18,6 +18,7 @@
 import { I18nBundle } from '@asgardeo/i18n';
 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.
@@ -100,6 +101,12 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
      * Not recommended for public clients like browser applications.
      */
     clientSecret?: string | undefined;
+    /**
+     * Optional platform where the application is running.
+     * This helps the SDK to optimize its behavior based on the platform.
+     * If not provided, the SDK will attempt to auto-detect the platform.
+     */
+    platform?: keyof typeof Platform;
     /**
      * The scopes to request during authentication.
      * Accepts either a space-separated string or an array of strings.

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

@@ -16,6 +16,7 @@
  * under the License.
  */
 export declare enum EmbeddedFlowType {
+    Authentication = "AUTHENTICATION",
     Registration = "REGISTRATION"
 }
 export interface EmbeddedFlowExecuteRequestPayload {

package/dist/models/platforms.d.ts

@@ -30,6 +30,8 @@ export declare enum Platform {
     Asgardeo = "ASGARDEO",
     /** WSO2 Identity Server (on-prem or custom domains) */
     IdentityServer = "IDENTITY_SERVER",
+    /** @experimental WSO2 Asgardeo V2 */
+    AsgardeoV2 = "AsgardeoV2",
     /** Unknown or unsupported platform */
     Unknown = "UNKNOWN"
 }

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

@@ -0,0 +1,78 @@
+/**
+ * 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, EmbeddedFlowResponseType, EmbeddedFlowType } from '../embedded-flow';
+export declare enum EmbeddedSignInFlowStatusV2 {
+    Complete = "COMPLETE",
+    Incomplete = "INCOMPLETE",
+    Error = "ERROR"
+}
+export declare enum EmbeddedSignInFlowTypeV2 {
+    Redirection = "REDIRECTION",
+    View = "VIEW"
+}
+/**
+ * Response structure for the new Asgardeo V2 embedded sign-in flow.
+ * @experimental
+ */
+export interface EmbeddedSignInFlowResponseV2 {
+    flowId: string;
+    flowStatus: EmbeddedSignInFlowStatusV2;
+    type: EmbeddedSignInFlowTypeV2;
+    data: {
+        actions?: {
+            type: EmbeddedFlowResponseType;
+            id: string;
+        }[];
+        inputs?: {
+            name: string;
+            type: string;
+            required: boolean;
+        }[];
+    };
+}
+/**
+ * Response structure for the new Asgardeo V2 embedded sign-in flow when the flow is complete.
+ * @experimental
+ */
+export interface EmbeddedSignInFlowCompleteResponse {
+    redirect_uri: string;
+}
+/**
+ * Request payload for initiating the new Asgardeo V2 embedded sign-in flow.
+ * @experimental
+ */
+export type EmbeddedSignInFlowInitiateRequestV2 = {
+    applicationId: string;
+    flowType: EmbeddedFlowType;
+};
+/**
+ * Request payload for executing steps in the new Asgardeo V2 embedded sign-in flow.
+ * @experimental
+ */
+export interface EmbeddedSignInFlowRequestV2 extends Partial<EmbeddedSignInFlowInitiateRequestV2> {
+    flowId?: string;
+    actionId?: string;
+    inputs?: Record<string, any>;
+}
+/**
+ * Request config for executing the new Asgardeo V2 embedded sign-in flow.
+ * @experimental
+ */
+export interface EmbeddedFlowExecuteRequestConfigV2<T = any> extends EmbeddedFlowExecuteRequestConfig<T> {
+    sessionDataKey?: string;
+}

package/dist/utils/arrayBufferToBase64url.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+/**
+ * Converts an ArrayBuffer to a base64url encoded string.
+ *
+ * Base64url encoding is a URL-safe variant of base64 encoding that:
+ * - Replaces '+' with '-'
+ * - Replaces '/' with '_'
+ * - Removes padding '=' characters
+ *
+ * This encoding is commonly used in JWT tokens, OAuth2 PKCE challenges,
+ * and other web standards where the encoded data needs to be safely
+ * transmitted in URLs or HTTP headers.
+ *
+ * @param buffer - The ArrayBuffer to convert to base64url string
+ * @returns The base64url encoded string representation of the input buffer
+ *
+ * @example
+ * ```typescript
+ * const buffer = new TextEncoder().encode('Hello World');
+ * const encoded = arrayBufferToBase64url(buffer);
+ * console.log(encoded); // "SGVsbG8gV29ybGQ"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Converting crypto random bytes for PKCE challenge
+ * const randomBytes = crypto.getRandomValues(new Uint8Array(32));
+ * const codeVerifier = arrayBufferToBase64url(randomBytes.buffer);
+ * ```
+ */
+declare const arrayBufferToBase64url: (buffer: ArrayBuffer) => string;
+export default arrayBufferToBase64url;

package/dist/utils/base64urlToArrayBuffer.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.
+ */
+/**
+ * Converts a base64url encoded string back to an ArrayBuffer.
+ *
+ * This function performs the inverse operation of base64url encoding by:
+ * - Replacing URL-safe characters: '-' becomes '+', '_' becomes '/'
+ * - Adding back padding '=' characters that were removed during base64url encoding
+ * - Decoding the resulting base64 string to binary data
+ * - Converting the binary data to an ArrayBuffer
+ *
+ * This is commonly used for decoding JWT tokens, OAuth2 PKCE code verifiers,
+ * and other cryptographic data that was encoded using base64url format.
+ *
+ * @param base64url - The base64url encoded string to decode
+ * @returns The ArrayBuffer containing the decoded binary data
+ *
+ * @throws {DOMException} Throws an error if the input string is not valid base64url
+ *
+ * @example
+ * ```typescript
+ * const encoded = 'SGVsbG8gV29ybGQ';
+ * const buffer = base64urlToArrayBuffer(encoded);
+ * const text = new TextDecoder().decode(buffer);
+ * console.log(text); // "Hello World"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Decoding a JWT payload
+ * const jwtPayload = 'eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ';
+ * const payloadBuffer = base64urlToArrayBuffer(jwtPayload);
+ * const payloadJson = new TextDecoder().decode(payloadBuffer);
+ * const payload = JSON.parse(payloadJson);
+ * ```
+ *
+ * @see {@link arrayBufferToBase64url} - The inverse function for encoding ArrayBuffer to base64url
+ */
+declare const base64urlToArrayBuffer: (base64url: string) => ArrayBuffer;
+export default base64urlToArrayBuffer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asgardeo/javascript",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "description": "Framework agnostic JavaScript SDK for Asgardeo.",
   "keywords": [
     "asgardeo",
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "tslib": "^2.8.1",
-    "@asgardeo/i18n": "^0.2.0"
+    "@asgardeo/i18n": "^0.3.1"
   },
   "publishConfig": {
     "access": "public"