@asgardeo/auth-spa 3.1.4 → 3.2.0

package/src/constants/storage.ts

@@ -16,23 +16,4 @@
  * under the License.
  */
 
-/**
- * Specifies where the session information should be stored.
- */
-export enum Storage {
-    /**
-     * Stores the session information in the local storage
-     */
-    LocalStorage = "localStorage",
-    /**
-     * Store the session information in the session storage.
-     */
-    SessionStorage = "sessionStorage",
-    /**
-     * Store the session information in the web worker.
-     */
-    WebWorker = "webWorker",
-    BrowserMemory = "browserMemory"
-}
-
 export const TOKEN_REQUEST_CONFIG_KEY = "token_request_config";

package/src/helpers/authentication-helper.ts

@@ -41,8 +41,7 @@ import {
     ERROR_DESCRIPTION,
     PROMPT_NONE_IFRAME,
     REFRESH_ACCESS_TOKEN_ERR0R,
-    RP_IFRAME,
-    Storage
+    RP_IFRAME
 } from "../constants";
 import {
     AuthorizationInfo,
@@ -57,6 +56,7 @@ import {
     WebWorkerClientConfig
 } from "../models";
 import { SPACustomGrantConfig } from "../models/request-custom-grant";
+import { Storage } from "../models/storage";
 import { SPAUtils } from "../utils";
 
 export class AuthenticationHelper<

package/src/helpers/session-management-helper.ts

@@ -27,10 +27,10 @@ import {
     SET_SESSION_STATE_FROM_IFRAME,
     SILENT_SIGN_IN_STATE,
     STATE,
-    STATE_QUERY,
-    Storage
+    STATE_QUERY
 } from "../constants";
 import { AuthorizationInfo, Message, SessionManagementHelperInterface } from "../models";
+import { Storage } from "../models/storage";
 import { SPAUtils } from "../utils";
 
 export const SessionManagementHelper = (() => {

package/src/models/client-config.ts

@@ -17,7 +17,7 @@
 */
 
 import { AuthClientConfig } from "@asgardeo/auth-js";
-import { Storage } from "../constants";
+import { Storage } from "../models/storage";
 
 
 export interface SPAConfig {
@@ -39,11 +39,26 @@ export interface SPAConfig {
  * SDK Client config parameters.
  */
 export interface MainThreadClientConfig extends SPAConfig {
-    storage?: Storage.SessionStorage | Storage.LocalStorage | Storage.BrowserMemory;
+    /**
+     * The storage type to be used for storing the session information.
+     */
+    storage?:
+        | Storage.SessionStorage
+        | Storage.LocalStorage
+        | Storage.BrowserMemory
+        | "sessionStorage"
+        | "localStorage"
+        | "browserMemory";
 }
 
 export interface WebWorkerClientConfig  extends SPAConfig {
-    storage: Storage.WebWorker;
+    /**
+     * The storage type to be used for storing the session information.
+     */
+    storage: Storage.WebWorker | "webWorker";
+    /**
+     * Specifies in seconds how long a request to the web worker should wait before being timed.
+     */
     requestTimeout?: number;
 }
 

package/src/models/client.ts

@@ -62,6 +62,7 @@ export interface MainThreadClientInterface {
     getBasicUserInfo(): Promise<BasicUserInfo>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
     getCryptoHelper(): Promise<CryptoHelper>;
+    getConfigData(): Promise<AuthClientConfig<MainThreadClientConfig>>;
     getIDToken(): Promise<string>;
     getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getAccessToken(): Promise<string>;
@@ -94,6 +95,7 @@ export interface WebWorkerClientInterface {
     revokeAccessToken(): Promise<boolean>;
     getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getBasicUserInfo(): Promise<BasicUserInfo>;
+    getConfigData(): Promise<AuthClientConfig<WebWorkerClientConfig>>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
     getDecodedIDPIDToken(): Promise<DecodedIDTokenPayload>;
     getCryptoHelper(): Promise<CryptoHelper>;

package/src/models/storage.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+
+/**
+ * Enum for the different storage types.
+ */
+export enum Storage {
+  /**
+   * Stores the session information in the local storage
+   */
+  LocalStorage = "localStorage",
+  /**
+   * Store the session information in the session storage.
+   */
+  SessionStorage = "sessionStorage",
+  /**
+   * Store the session information in the web worker.
+   */
+  WebWorker = "webWorker",
+  /**
+   * Store the session information in the browser memory.
+   */
+  BrowserMemory = "browserMemory"
+}