@asgardeo/javascript
Version:
Framework agnostic JavaScript SDK for Asgardeo.
77 lines (76 loc) • 2.88 kB
TypeScript
/**
* 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.
*/
/**
* Constants related to OIDC token management and storage.
* This object contains configuration values and storage keys
* used in token validation and management processes.
*
* @remarks
* The constants are organized into two main sections:
* 1. SignatureValidation - Contains supported algorithms for token validation
* 2. Storage - Contains keys used for storing token-related data
*
* @example
* ```typescript
* // Using signature validation algorithms
* const algorithms = TokenConstants.SignatureValidation.SUPPORTED_ALGORITHMS;
*
* // Using storage keys
* const timerKey = TokenConstants.Storage.StorageKeys.REFRESH_TOKEN_TIMER;
* ```
*/
declare const TokenConstants: {
/**
* Token signature validation constants.
* Contains configurations related to token signature verification.
*/
readonly SignatureValidation: {
/**
* Fallback array of supported signature algorithms for OIDC token validation.
* These values are used when the supported algorithms cannot be retrieved from
* the .well-known/openid-configuration endpoint.
*
* Supported algorithms:
* - `RS256` - RSASSA-PKCS1-v1_5 using SHA-256
* - `RS512` - RSASSA-PKCS1-v1_5 using SHA-512
* - `RS384` - RSASSA-PKCS1-v1_5 using SHA-384
* - `PS256` - RSASSA-PSS using SHA-256 and MGF1 with SHA-256
*/
readonly SUPPORTED_ALGORITHMS: readonly ["RS256", "RS512", "RS384", "PS256"];
};
/**
* Storage-related constants for OIDC tokens.
* Contains keys used to store token-related data in browser storage.
*/
readonly Storage: {
/**
* Collection of storage keys used in token management.
* These keys are used to store and retrieve token-related
* information from browser storage.
*/
readonly StorageKeys: {
/**
* Key used to store the refresh token timer identifier.
* This timer is used to schedule token refresh operations
* before the current token expires.
*/
readonly REFRESH_TOKEN_TIMER: "refresh_token_timer";
};
};
};
export default TokenConstants;