@shad-claiborne/basic-oidc 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -1,4 +1,281 @@
-import { IdentityProvider } from "./identity-provider";
+export interface IdentityProviderConfiguration {
+    issuer: string;
+    authorization_endpoint: string;
+    token_endpoint: string;
+    userinfo_endpoint: string;
+    registration_endpoint: string;
+    jwks_uri: string;
+    response_types_supported: string[];
+    response_modes_supported: string[];
+    grant_types_supported: string[];
+    subject_types_supported: string[];
+    id_token_signing_alg_values_supported: string[];
+    scopes_supported: string[];
+    token_endpoint_auth_methods_supported: string[];
+    claims_supported: string[];
+    code_challenge_methods_supported: string[];
+    introspection_endpoint: string;
+    introspection_endpoint_auth_methods_supported: string[];
+    revocation_endpoint: string;
+    revocation_endpoint_auth_methods_supported: string[];
+    end_session_endpoint: string;
+    request_parameter_supported: boolean;
+    request_object_signing_alg_values_supported: string[];
+    device_authorization_endpoint: string;
+    pushed_authorization_request_endpoint: string;
+    backchannel_token_delivery_modes_supported: string[];
+    backchannel_authentication_request_signing_alg_values_supported: string[];
+    dpop_signing_alg_values_supported: string[];
+}
+export interface AuthorizationResponse {
+    code?: string;
+    id_token?: string;
+    state?: string;
+}
+export interface TokenSet {
+    token_type: string;
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+    id_token?: string;
+}
+export interface Identity {
+    sub: string;
+    name?: string;
+    email?: string;
+}
+/**
+ * class AuthorizationRequest
+ */
+export declare class AuthorizationRequest {
+    private client;
+    private responseType;
+    private responseMode;
+    private redirectUri;
+    private scope;
+    private state;
+    private codeChallenge;
+    private codeChallengeMethod;
+    /**
+     * constructor
+     * @param client Client
+     */
+    constructor(client: Client);
+    /**
+     * setRedirectUri
+     * @param uri string
+     */
+    setRedirectUri(uri: string): AuthorizationRequest;
+    /**
+     * setState
+     * @param state string
+     */
+    setState(state: string): AuthorizationRequest;
+    /**
+     * setResponseMode
+     * @param mode string
+     */
+    setResponseMode(mode: string): AuthorizationRequest;
+    /**
+     * setResponseType
+     * @param type string[]
+     */
+    setResponseType(type: string): AuthorizationRequest;
+    /**
+     * setScope
+     * @param scope string[]
+     */
+    setScope(scope: string[]): AuthorizationRequest;
+    /**
+     * setCodeChallenge
+     * @param challenge string
+     * @param method string
+     */
+    setCodeChallenge(challenge: string, method?: string): AuthorizationRequest;
+    /**
+     * toURLSearchParams
+     * @returns URLSearchParams
+     */
+    toURLSearchParams(): URLSearchParams;
+    /**
+     * toURL
+     * @returns URL
+     */
+    toURL(): URL;
+}
+/**
+ * class TokenRequest
+ */
+export declare class TokenRequest {
+    private client;
+    private code;
+    private codeVerifier;
+    private redirectUri;
+    private grantType;
+    private refreshToken;
+    /**
+     * constructor
+     * @param client Client
+     */
+    constructor(client: Client);
+    /**
+     * setCode
+     * @param code string
+     */
+    setCode(code: string): TokenRequest;
+    /**
+     * setRedirectUri
+     * @param uri string
+     */
+    setRedirectUri(uri: string): TokenRequest;
+    /**
+     * setCodeVerifier
+     * @param verifier string
+     */
+    setCodeVerifier(verifier: string): TokenRequest;
+    /**
+     * setGrantType
+     * @param type string
+     */
+    setGrantType(type: string): TokenRequest;
+    /**
+     * setRefreshToken
+     * @param token string
+     */
+    setRefreshToken(token: string): TokenRequest;
+    /**
+     * toURLSearchParams
+     * @returns URLSearchParams
+     */
+    toURLSearchParams(): URLSearchParams;
+}
+/**
+ * class IdentityProvider
+ */
+export declare class IdentityProvider {
+    private config;
+    /**
+     * constructor
+     * @param config IdentityProviderConfiguration
+     */
+    constructor(config: IdentityProviderConfiguration);
+    /**
+     * getAuthorizationEndpoint
+     * @returns string
+     */
+    getAuthorizationEndpoint(): string;
+    /**
+     * getTokenEndpoint
+     * @returns string
+     */
+    getTokenEndpoint(): string;
+    /**
+     * getUserinfoEndpoint
+     * @returns string
+     */
+    getUserinfoEndpoint(): string;
+    /**
+     * getRevocationEndpoint
+     * @returns string
+     */
+    getRevocationEndpoint(): string;
+    /**
+     * isResponseModeSupported
+     * @param mode string
+     * @returns boolean
+     */
+    isResponseModeSupported(mode: string): boolean;
+    /**
+     * isResponseTypeSupported
+     * @param type string[]
+     * @returns boolean
+     */
+    isResponseTypeSupported(type: string): boolean;
+    /**
+     * isScopeSupported
+     * @param scope string[]
+     * @returns boolean
+     */
+    isScopeSupported(scope: string[]): boolean;
+    /**
+     * isChallengeMethodSupported
+     * @param method string
+     * @returns boolean
+     */
+    isChallengeMethodSupported(method: string): boolean;
+    /**
+     * isGrantTypeSupported
+     * @param method string
+     * @returns boolean
+     */
+    isGrantTypeSupported(type: string): boolean;
+    /**
+     * createClient
+     * @returns Client
+     */
+    createClient(id: string, secret: string): Client;
+    /**
+     * getIdentity
+     * @param client Client
+     * @param tokenSet TokenSet
+     * @returns Promise<Identity | null>
+     */
+    getIdentity(client: Client, tokenSet: TokenSet): Promise<Identity | null>;
+}
+/**
+ * class Client
+ */
+export declare class Client {
+    private provider;
+    private clientId;
+    private clientSecret;
+    /**
+     * constructor
+     * @param provider IdentityProvider
+     * @param id string
+     * @param secret string
+     */
+    constructor(provider: IdentityProvider, id: string, secret: string);
+    /**
+     * getProvider
+     * @returns IdentityProvider
+     */
+    getProvider(): IdentityProvider;
+    /**
+     * getClientId
+     * @returns string
+     */
+    getClientId(): string;
+    /**
+     * getClientSecret
+     * @returns string
+     */
+    getClientSecret(): string;
+    /**
+     * newAuthorizationRequest
+     * @returns AuthorizationRequest
+     */
+    newAuthorizationRequest(): AuthorizationRequest;
+    /**
+     * requestAccess
+     * @param authResponse AuthorizationResponse
+     * @param codeVerifier string
+     * @returns Promise<TokenSet>
+     */
+    requestAccess(authResponse: AuthorizationResponse, codeVerifier?: string): Promise<TokenSet>;
+    /**
+     * refreshAccess
+     * @param tokenSet TokenSet
+     * @returns Promise<TokenSet>
+     */
+    refreshAccess(tokenSet: TokenSet): Promise<TokenSet>;
+    /**
+     * revokeAccess
+     * @param tokenSet TokenSet
+     * @returns Promise<void>
+     */
+    revokeAccess(tokenSet: TokenSet): Promise<void>;
+}
 /**
  * createIdentityProvider
  * @param issuer string