@thunderid/browser 0.0.4 → 0.1.0

package/dist/utils/SPAUtils.d.ts

@@ -0,0 +1,145 @@
+/**
+ * Copyright (c) 2026, 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 { SignOutError } from '../models/SignOutError';
+/**
+ * Static utility methods for SPA authentication flows including PKCE storage,
+ * sign-out URL management, and URL-based state detection.
+ */
+declare class SPAUtils {
+    private constructor();
+    /**
+     * Removes the `code` search parameter from the current URL without a page reload.
+     */
+    static removeAuthorizationCode(): void;
+    /**
+     * Retrieves a PKCE verifier from sessionStorage.
+     *
+     * @param pkceKey - The storage key for the PKCE verifier.
+     * @returns The stored verifier string, or an empty string if not found.
+     */
+    static getPKCE(pkceKey: string): string;
+    /**
+     * Persists a PKCE verifier in sessionStorage.
+     *
+     * @param pkceKey - The storage key.
+     * @param pkce - The PKCE verifier value.
+     */
+    static setPKCE(pkceKey: string, pkce: string): void;
+    /**
+     * Persists the post-sign-out redirect URL for the given client and instance.
+     *
+     * @param url - The sign-out redirect URL.
+     * @param clientId - The OAuth2 client ID.
+     * @param instanceId - The client instance ID.
+     */
+    static setSignOutURL(url: string, clientId: string, instanceId: number): void;
+    /**
+     * Retrieves the stored sign-out redirect URL for the given client and instance.
+     *
+     * @param clientId - The OAuth2 client ID.
+     * @param instanceId - The client instance ID.
+     * @returns The stored sign-out URL, or an empty string.
+     */
+    static getSignOutUrl(clientId: string, instanceId: number): string;
+    /**
+     * Removes a PKCE verifier from sessionStorage.
+     *
+     * @param pkceKey - The storage key to remove.
+     */
+    static removePKCE(pkceKey: string): void;
+    /**
+     * Determines whether the `signIn` method should continue based on the `callOnlyOnRedirect` flag.
+     *
+     * @param callOnlyOnRedirect - True if the call should only proceed when redirected back from the IdP.
+     * @param authorizationCode - Authorization code passed directly (form_post mode).
+     * @returns `true` if sign-in should proceed.
+     */
+    static canContinueSignIn(callOnlyOnRedirect: boolean, authorizationCode?: string): boolean;
+    /**
+     * Returns `true` if silent sign-in is in progress (silent-state present in the URL).
+     */
+    static isInitializedSilentSignIn(): boolean;
+    /**
+     * Returns `true` if the `signIn` method was already called this navigation
+     * (auth code or error is present in the URL, but not a silent flow).
+     */
+    static wasSignInCalled(): boolean;
+    /**
+     * Returns `true` if a silent sign-in was previously initialized in this session.
+     */
+    static wasSilentSignInCalled(): boolean;
+    /**
+     * Checks whether the current URL indicates a successful sign-out redirect.
+     * Clears the query string and session data if `true`.
+     *
+     * @param isSignOutSuccessful - Static method from the JS client for URL inspection.
+     * @param clearSession - Callback to clear session data after successful sign-out.
+     * @returns `true` if the sign-out completed successfully.
+     */
+    static isSignOutSuccessful(isSignOutSuccessfulFn: (url: string) => boolean, clearSession: () => Promise<void>): Promise<boolean>;
+    /**
+     * Checks whether the current URL indicates a sign-out failure.
+     * Returns the error details if present, or `false` otherwise.
+     *
+     * @param didSignOutFailFn - Static method from the JS client for URL inspection.
+     * @returns The `SignOutError` if sign-out failed, or `false`.
+     */
+    static didSignOutFail(didSignOutFailFn: (url: string) => boolean): boolean | SignOutError;
+    /**
+     * Returns `true` if the URL contains a silent sign-in state parameter.
+     */
+    static isSilentStatePresentInURL(): boolean;
+    /**
+     * Returns `true` if the current URL contains an authorization code (`code` parameter).
+     *
+     * @param params - Search params string (defaults to `window.location.search`).
+     */
+    static hasAuthSearchParamsInURL(params?: string): boolean;
+    /**
+     * Returns `true` if the current URL contains an OAuth2 error parameter
+     * (but not a sign-out success state).
+     *
+     * @param url - URL to inspect (defaults to `window.location.href`).
+     */
+    static hasErrorInURL(url?: string): boolean;
+    /**
+     * Returns `true` if no prompt-none request has been sent yet this session.
+     */
+    static canSendPromptNoneRequest(): boolean;
+    /**
+     * Records whether a prompt-none request has been sent.
+     *
+     * @param canSend - `true` marks the request as sent.
+     */
+    static setPromptNoneRequestSent(canSend: boolean): void;
+    /**
+     * Waits until the browser has redirected (non-blocking delay).
+     *
+     * @param time - Time to wait in seconds (default: 3).
+     */
+    static waitTillPageRedirect(time?: number): Promise<void>;
+    /**
+     * Returns a Promise that resolves when `condition()` returns `true`.
+     *
+     * @param condition - Predicate to poll.
+     * @param timeout - Poll interval in milliseconds (default: 500).
+     */
+    static until: (condition: () => boolean, timeout?: number) => Promise<void>;
+}
+export default SPAUtils;
+//# sourceMappingURL=SPAUtils.d.ts.map

package/dist/utils/SPAUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SPAUtils.d.ts","sourceRoot":"","sources":["../../src/utils/SPAUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAWH,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;GAGG;AACH,cAAM,QAAQ;IAEZ,OAAO;IAEP;;OAEG;WACW,uBAAuB,IAAI,IAAI;IAM7C;;;;;OAKG;WACW,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAI9C;;;;;OAKG;WACW,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI1D;;;;;;OAMG;WACW,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAOpF;;;;;;OAMG;WACW,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IAQzE;;;;OAIG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI/C;;;;;;OAMG;WACW,iBAAiB,CAAC,kBAAkB,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO;IAQjG;;OAEG;WACW,yBAAyB,IAAI,OAAO;IAIlD;;;OAGG;WACW,eAAe,IAAI,OAAO;IAUxC;;OAEG;WACW,qBAAqB,IAAI,OAAO;IAM9C;;;;;;;OAOG;WACiB,mBAAmB,CACrC,qBAAqB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,EAC/C,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAChC,OAAO,CAAC,OAAO,CAAC;IAYnB;;;;;;OAMG;WACW,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,GAAG,YAAY;IAiBhG;;OAEG;WACW,yBAAyB,IAAI,OAAO;IAMlD;;;;OAIG;WACW,wBAAwB,CAAC,MAAM,GAAE,MAA+B,GAAG,OAAO;IAMxF;;;;;OAKG;WACW,aAAa,CAAC,GAAG,GAAE,MAA6B,GAAG,OAAO;IASxE;;OAEG;WACW,wBAAwB,IAAI,OAAO;IAMjD;;;;OAIG;WACW,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAI9D;;;;OAIG;WACiB,oBAAoB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtE;;;;;OAKG;IACH,OAAc,KAAK,GAAI,WAAW,MAAM,OAAO,EAAE,gBAAa,KAAG,OAAO,CAAC,IAAI,CAAC,CAU5E;CACH;AAED,eAAe,QAAQ,CAAC"}

package/dist/{__legacy__/models/session-management-helper.d.ts → utils/SessionManagementHelper.d.ts}

@@ -16,9 +16,28 @@
  * under the License.
  */
 import { ExtendedAuthorizeRequestUrlParams } from '@thunderid/javascript';
+/**
+ * Interface for the session management helper returned by {@link createSessionManagementHelper}.
+ */
 export interface SessionManagementHelperInterface {
+    /** Starts session polling and sets up the RP iframe. */
     initialize(clientId: string, checkSessionEndpoint: string, getSessionState: () => Promise<string>, interval: number, sessionRefreshInterval: number, redirectURL: string, getSignInUrl: (params?: ExtendedAuthorizeRequestUrlParams) => Promise<string>): void;
+    /**
+     * Processes a prompt-none response when the page is loaded inside the prompt-none iframe.
+     * Returns `true` if the current page load was a prompt-none response.
+     */
     receivePromptNoneResponse(setSessionState?: (sessionState: string | null) => Promise<void>): Promise<boolean>;
-    reset(): any;
+    /** Clears the session check and refresh intervals. */
+    reset(): void;
 }
-//# sourceMappingURL=session-management-helper.d.ts.map
+/**
+ * Factory that creates an OIDC Session Management helper using an RP iframe and polling.
+ * Appends a hidden RP iframe to the document and returns the helper interface.
+ *
+ * @param signOut - Returns the sign-out URL for the current session.
+ * @param setSessionState - Stores a new session state from a prompt-none response.
+ * @returns A `SessionManagementHelperInterface` instance.
+ */
+export declare const createSessionManagementHelper: (signOut: () => Promise<string>, setSessionState: (sessionState: string) => void) => Promise<SessionManagementHelperInterface>;
+export default createSessionManagementHelper;
+//# sourceMappingURL=SessionManagementHelper.d.ts.map

package/dist/utils/SessionManagementHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SessionManagementHelper.d.ts","sourceRoot":"","sources":["../../src/utils/SessionManagementHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAC,iCAAiC,EAAuB,MAAM,uBAAuB,CAAC;AA0B9F;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,wDAAwD;IACxD,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,oBAAoB,EAAE,MAAM,EAC5B,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACtC,QAAQ,EAAE,MAAM,EAChB,sBAAsB,EAAE,MAAM,EAC9B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,CAAC,MAAM,CAAC,EAAE,iCAAiC,KAAK,OAAO,CAAC,MAAM,CAAC,GAC5E,IAAI,CAAC;IACR;;;OAGG;IACH,yBAAyB,CAAC,eAAe,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9G,sDAAsD;IACtD,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GACxC,SAAS,MAAM,OAAO,CAAC,MAAM,CAAC,EAC9B,iBAAiB,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,KAC9C,OAAO,CAAC,gCAAgC,CAuO1C,CAAC;AAEF,eAAe,6BAA6B,CAAC"}

package/dist/utils/http.d.ts

@@ -15,37 +15,24 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ThunderIDSPAClient } from '../__legacy__/client';
+import ThunderIDBrowserClient from '../ThunderIDBrowserClient';
 /**
- * Creates an HTTP utility for making requests using a specific ThunderIDSPAClient instance.
+ * Creates an HTTP utility for making authenticated requests using a `ThunderIDBrowserClient` instance.
  *
- * @param instanceId - Optional instance ID for multi-instance support. Defaults to 0.
- * @returns An object with request and requestAll methods bound to the specified instance.
- *
- * @remarks
- * This utility provides methods to make single or multiple HTTP requests for a specific instance.
+ * @param client - The browser client instance to use for requests.
+ * @returns An object with `request` and `requestAll` methods bound to the provided client.
  *
  * @example
  * ```typescript
- * // Use default instance
- * const httpClient = http();
- *
- * // Use specific instance
- * const httpInstance1 = http(1);
- * const httpInstance2 = http(2);
+ * const auth = new ThunderIDBrowserClient();
+ * await auth.initialize(config);
+ * const httpClient = http(auth);
+ * const response = await httpClient.request({ url: '/api/data', method: 'GET' });
  * ```
  */
-export declare const http: (instanceId?: number) => {
-    request: typeof ThunderIDSPAClient.prototype.httpRequest;
-    requestAll: typeof ThunderIDSPAClient.prototype.httpRequestAll;
-};
-/**
- * Default HTTP utility using instance 0.
- * For multi-instance support, use http(instanceId) instead.
- */
-declare const _default: {
-    request: typeof ThunderIDSPAClient.prototype.httpRequest;
-    requestAll: typeof ThunderIDSPAClient.prototype.httpRequestAll;
+declare const http: (client: ThunderIDBrowserClient) => {
+    request: typeof ThunderIDBrowserClient.prototype.httpRequest;
+    requestAll: typeof ThunderIDBrowserClient.prototype.httpRequestAll;
 };
-export default _default;
+export default http;
 //# sourceMappingURL=http.d.ts.map

package/dist/utils/http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAExD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GACf,mBAAc,KACb;IACD,OAAO,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC;IACzD,UAAU,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,cAAc,CAAC;CAqBhE,CAAC;AAEF;;;GAGG;;aA3BQ,OAAO,kBAAkB,CAAC,SAAS,CAAC,WAAW;gBAC5C,OAAO,kBAAkB,CAAC,SAAS,CAAC,cAAc;;AA2BhE,wBAAsB"}
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAE/D;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,IAAI,GACR,QAAQ,sBAAsB,KAC7B;IACD,OAAO,EAAE,OAAO,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC;IAC7D,UAAU,EAAE,OAAO,sBAAsB,CAAC,SAAS,CAAC,cAAc,CAAC;CAMpE,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thunderid/browser",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "Browser runtime SDK for ThunderID",
   "keywords": [
     "thunderid",
@@ -56,14 +56,16 @@
     "randombytes": "2.1.0",
     "stream-browserify": "3.0.0",
     "tslib": "2.8.1",
-    "@thunderid/javascript": "^0.0.4"
+    "@thunderid/javascript": "^0.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "pnpm clean && node rolldown.config.js && tsc -p tsconfig.lib.json --emitDeclarationOnly --outDir dist",
-    "clean": "rimraf dist",
+    "build": "pnpm clean:dist &&  node rolldown.config.js && tsc -p tsconfig.lib.json --emitDeclarationOnly --outDir dist",
+    "clean": "pnpm clean:node_modules && pnpm clean:dist",
+    "clean:dist": "rimraf dist",
+    "clean:node_modules": "rimraf node_modules",
     "format:check": "prettier --check --cache .",
     "format:fix": "prettier --write --cache .",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.cjs,.mjs",