@asgardeo/javascript/dist/utils/getLatestStateParam.d.ts

Framework agnostic JavaScript SDK for Asgardeo.

/**
 * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
 *
 * 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 { TemporaryStore } from '../models/store';
/**
 * Finds the latest state parameter based on the most recent PKCE storage key.
 *
 * This utility combines the functionality of finding the latest PKCE key and generating
 * the corresponding state parameter for request correlation.
 *
 * @param tempStore - The object that holds temporary PKCE-related data (e.g., sessionStorage).
 * @param state - Optional state string to prepend to the request correlation.
 * @returns The latest state parameter string or null if no PKCE keys exist.
 *
 * @example
 * const latestState = getLatestStateParam(sessionStorage, "myState");
 * // Returns: "myState_request_2" (if latest PKCE key is pkce_code_verifier_2)
 *
 * const latestStateNoPrefix = getLatestStateParam(sessionStorage);
 * // Returns: "request_2" (if latest PKCE key is pkce_code_verifier_2)
 *
 * const noKeys = getLatestStateParam(emptyStorage);
 * // Returns: null (if no PKCE keys exist)
 */
declare const getLatestStateParam: (tempStore: TemporaryStore, state?: string) => string | null;
export default getLatestStateParam;