@asgardeo/auth-spa
Version:
Asgardeo Auth SPA SDK to be used in Single-Page Applications.
55 lines • 2.13 kB
TypeScript
/**
* Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* WSO2 Inc. 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 { AuthClientConfig } from "@asgardeo/auth-js";
import { Storage } from "../models/storage";
export interface SPAConfig {
/**
* Enable OIDC Session Management with PR Iframe.
* @remarks If the consumer app the OP is hosted in different domains,
* third party cookies has to be enabled for this to work properly.
*/
enableOIDCSessionManagement?: boolean;
checkSessionInterval?: number;
sessionRefreshInterval?: number;
resourceServerURLs?: string[];
authParams?: Record<string, string>;
periodicTokenRefresh?: boolean;
autoLogoutOnTokenRefreshError?: boolean;
}
/**
* SDK Client config parameters.
*/
export interface MainThreadClientConfig extends SPAConfig {
/**
* 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 {
/**
* 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;
}
export declare type Config = MainThreadClientConfig | WebWorkerClientConfig;
export declare type AuthSPAClientConfig = AuthClientConfig<Config>;
//# sourceMappingURL=client-config.d.ts.map