@i-novus/oidc-pkce-public-client/dist/index.d.ts

OIDC public client with PKCE for react with tokens sharing by localStorage. React context included

// Generated by dts-bundle-generator v9.0.0

import React from 'react';
import { FC, PropsWithChildren } from 'react';

export type LoginHandler = (accessToken: string) => void;
export type LogoutHandler = () => void;
export type AccessTokenUpdatedHandler = (accessToken: string, oldAccessToken: string) => void;
export type EventType = "login" | "logout" | "accessTokenUpdated";
export declare class OidcClient {
	/**
	 * Client configuration
	 */
	config: Config;
	/**
	 * Признак завершенной инициализации клиента. События будут генерироваться только если инициализация завершена
	 */
	initialised: boolean;
	events: Record<EventType, unknown[]>;
	constructor(oidcClientConfig?: OidcClientConfig);
	on(event: "login", handler: LoginHandler): this;
	on(event: "logout", handler: LogoutHandler): this;
	on(event: "accessTokenUpdated", handler: AccessTokenUpdatedHandler): this;
	off(event: "login", listener: LoginHandler): this;
	off(event: "logout", listener: LogoutHandler): this;
	off(event: "accessTokenUpdated", listener: AccessTokenUpdatedHandler): this;
	emit(event: "login", ...params: Parameters<LoginHandler>): this;
	emit(event: "logout", ...params: Parameters<LogoutHandler>): this;
	emit(event: "accessTokenUpdated", ...params: Parameters<AccessTokenUpdatedHandler>): this;
	/**
	 * Возвращает полный конфиг на основе пользовательского
	 * @param config
	 */
	static getConfig(config: OidcClientConfig): Config;
	/**
	 * Возвращает конфиг oauth сервера
	 */
	getMetadataConfig(): Promise<OidcMetadataConfig>;
	/**
	 * Возвращает промежуточные данные авторизации, если произошел редирект с oauth сервера. Опирается на url
	 */
	getLoginCallbackData(): {
		responseCode: string | null;
		responseId: string | null;
	};
	/**
	 * Инициализирует клиент
	 */
	init({ oidcClientConfig, afterLogin, }?: {
		afterLogin?(oidcClient: OidcClient): Promise<void>;
		oidcClientConfig?: OidcClientConfig;
	}): Promise<void>;
	/**
	 * Делает login, если пользователь не авторизован
	 * @param redirectUri
	 */
	login: Login;
	/**
	 * Делает logout, если пользователь авторизован
	 */
	logout: Logout;
	/**
	 * В бесконечном цикле проверяет, нужно ли обновить токены
	 */
	refreshAccessTokenLoop: () => Promise<void>;
	/**
	 * Устанавливает актуальные токены. Запускает события login или accessTokenUpdated, в зависимости от предыдущего состояния
	 * @param tokenResponse объект с токенами
	 */
	setUserTokens(tokenResponse: TokenResponse): void;
	/**
	 * Возвращает timestamp, когда токен устареет
	 * @param token
	 */
	static getTokenExpireIn(token: string): number;
	/**
	 * Удаляет текущие токены, фактически делает logout
	 */
	removeUserTokens(): void;
	/**
	 * Получает текущие токены
	 */
	getUserTokens(): {
		accessToken: string | null;
		accessTokenExpireIn: number;
		idToken: string | null;
		refreshToken: string | null;
	};
	/**
	 * Проверяет, есть ли активные запросы обновления токена с других вкладок
	 */
	isRefreshRequestsPending(): boolean;
}
export interface OidcClientConfig {
	authority: string;
	clientId: string;
	logoutBackUrl?: string;
	pkce?: boolean;
	responseMode?: "query" | "fragment";
	scope?: string;
	storeKeyPrefix?: string;
}
export interface Config {
	authority: string;
	clientId: string;
	grantType: "authorization_code";
	logoutBackUrl: string;
	pkce: boolean;
	responseMode: "query" | "fragment";
	responseType: "code";
	scope: string;
	storeKeyPrefix: string;
	subjectType: "public";
}
export interface OidcMetadataConfig {
	authorization_endpoint: string;
	end_session_endpoint: string;
	grant_types_supported: Array<"authorization_code">;
	response_modes_supported: Array<"query" | "fragment">;
	response_types_supported: Array<"code">;
	subject_types_supported: Array<"public">;
	token_endpoint: string;
}
export interface LoginCallbackSessionStorageData {
	action: "login";
	codeVerifier: string;
	id: string;
	redirectUri: string;
}
export interface TokenResponse {
	access_token: string;
	id_token: string;
	refresh_token: string;
	token_type: "bearer" | "Bearer";
}
/**
 * Standard JWT claims.
 *
 * @public
 * @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1
 */
export interface JwtClaims {
	/** The "aud" (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the "aud" claim when this claim is present, then the JWT MUST be rejected. In the general case, the "aud" value is an array of case-sensitive strings, each containing a StringOrURI value. In the special case when the JWT has one audience, the "aud" value MAY be a single case-sensitive string containing a StringOrURI value. The interpretation of audience values is generally application specific. */
	aud: string;
	/** The "exp" (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the "exp" claim requires that the current date/time MUST be before the expiration date/time listed in the "exp" claim. Implementers MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a NumericDate value. */
	exp: number;
	/** The "iat" (issued at) claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. Its value MUST be a number containing a NumericDate value. */
	iat?: number;
	/** The "iss" (issuer) claim identifies the principal that issued the JWT. The processing of this claim is generally application specific. The "iss" value is a case-sensitive string containing a StringOrURI value. */
	iss?: string;
	/** The "jti" (JWT ID) claim provides a unique identifier for the JWT. The identifier value MUST be assigned in a manner that ensures that there is a negligible probability that the same value will be accidentally assigned to a different data object; if the application uses multiple issuers, collisions MUST be prevented among values produced by different issuers as well. The "jti" claim can be used to prevent the JWT from being replayed. The "jti" value is a case-sensitive string. */
	jti?: string;
	/** The "nbf" (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing. The processing of the "nbf" claim requires that the current date/time MUST be after or equal to the not-before date/time listed in the "nbf" claim. Implementers MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a NumericDate value. */
	nbf?: number;
	/** The "sub" (subject) claim identifies the principal that is the subject of the JWT. The claims in a JWT are normally statements about the subject. The subject value MUST either be scoped to be locally unique in the context of the issuer or be globally unique. The processing of this claim is generally application specific. The "sub" value is a case-sensitive string containing a StringOrURI value. */
	sub?: string;
}
export type Login = (redirectUri?: string) => Promise<void>;
export type Logout = (config?: {
	beforeLogout?(oidcClient: OidcClient): Promise<void>;
}) => Promise<void>;
export interface OidcContext {
	accessToken: string | null;
	login: Login;
	logout: Logout;
	rawParsedToken: JwtClaims | null;
}
export declare function jwtDecode(token: string): JwtClaims;
export declare const oidcContext: React.Context<OidcContext>;
export declare const OidcContextProvider: FC<PropsWithChildren<{
	oidcClient: OidcClient;
}>>;
export declare const useOidcContext: () => OidcContext;
export interface StoreParams {
	keyPostfix?: string;
}
export interface SetValueStoreParams extends StoreParams {
	expireIn?: number;
}
export interface StoredValue<T = unknown> {
	expireIn: number;
	value: T;
}
export declare function cleanerStart(config: Config): void;
export declare function getStoreKey(config: Config, params?: StoreParams): string;
export declare function setStoreData<T = unknown>(config: Config, value: T, params?: SetValueStoreParams): void;
export declare function removeStoreData(config: Config, params?: StoreParams): void;
export declare function getStoreData<T = unknown>(config: Config, params?: StoreParams): {
	expireIn: number;
	value: T | null;
};
export interface TabStoreParams {
	id: string;
}
export declare function getTabStoreKey(config: Config, params: TabStoreParams): string;
export declare function setTabStoreData<T = unknown>(config: Config, value: T, params: TabStoreParams): void;
export declare function getTabStoreData<T = unknown>(config: Config, params: TabStoreParams): T | null;

export {};