sveltekit-oidc - v2.0.1
    Preparing search index...

    Type Alias OIDCInstance<TIdentity, TRequestData>

    type OIDCInstance<
        TIdentity extends OIDCUserClaims = OIDCUserClaims,
        TRequestData = undefined,
    > = {
        backChannelLogoutHandler: <T extends MinimalRequestEvent = RequestEvent>() => MinimalRequestHandler<
            T,
        >;
        callbackHandler: <T extends MinimalRequestEvent = RequestEvent>(
            handlerOptions?: OIDCCallbackHandlerOptions<TIdentity>,
        ) => MinimalRequestHandler<T>;
        clearSession: (cookies: Cookies) => Promise<void>;
        createActions: (
            actionOptions?: OIDCActionOptions,
        ) => Readonly<{ login: Action; logout: Action }>;
        createRequestContext: (
            event: MinimalRequestEvent,
        ) => Promise<OIDCHandleLocals<TIdentity, TRequestData>>;
        getMetadata: () => Promise<OIDCDiscoveryDocument>;
        getPublicSession: (
            event: MinimalRequestEvent & { depends?: (dependency: string) => void },
        ) => Promise<OIDCPublicSession<TIdentity> | null>;
        getSession: (
            event: { cookies: Cookies },
        ) => Promise<OIDCSession<TIdentity> | null>;
        getSessionManagementConfig: () => Promise<OIDCSessionManagementConfig>;
        handle: Handle;
        handleBackChannelLogout: (event: MinimalRequestEvent) => Promise<Response>;
        handleCallback: (
            event: MinimalRequestEvent,
        ) => Promise<OIDCCallbackResult<TIdentity>>;
        login: (
            event: MinimalRequestEvent,
            loginOptions?: OIDCLoginOptions,
        ) => Promise<never>;
        loginHandler: <T extends MinimalRequestEvent = RequestEvent>(
            defaults?: OIDCLoginOptions,
        ) => MinimalRequestHandler<T>;
        logout: (
            event: MinimalRequestEvent,
            logoutOptions?: OIDCLogoutOptions,
        ) => Promise<never>;
        logoutHandler: <T extends MinimalRequestEvent = RequestEvent>(
            defaults?: OIDCLogoutOptions,
        ) => MinimalRequestHandler<T>;
        requireAuth: (
            event: { cookies: Cookies; url: URL },
            returnTo?: string,
        ) => Promise<OIDCSession<TIdentity>>;
        toPublicSession: (
            context: OIDCHandleLocals<TIdentity, TRequestData> | null | undefined,
            depends?: (dependency: string) => void,
        ) => OIDCPublicSession<TIdentity> | null;
    }

    Type Parameters

    Index

    Properties

    backChannelLogoutHandler: <T extends MinimalRequestEvent = RequestEvent>() => MinimalRequestHandler<
        T,
    >
    callbackHandler: <T extends MinimalRequestEvent = RequestEvent>(
        handlerOptions?: OIDCCallbackHandlerOptions<TIdentity>,
    ) => MinimalRequestHandler<T>
    clearSession: (cookies: Cookies) => Promise<void>
    createActions: (
        actionOptions?: OIDCActionOptions,
    ) => Readonly<{ login: Action; logout: Action }>
    createRequestContext: (
        event: MinimalRequestEvent,
    ) => Promise<OIDCHandleLocals<TIdentity, TRequestData>>
    getMetadata: () => Promise<OIDCDiscoveryDocument>
    getPublicSession: (
        event: MinimalRequestEvent & { depends?: (dependency: string) => void },
    ) => Promise<OIDCPublicSession<TIdentity> | null>
    getSession: (
        event: { cookies: Cookies },
    ) => Promise<OIDCSession<TIdentity> | null>
    getSessionManagementConfig: () => Promise<OIDCSessionManagementConfig>
    handle: Handle
    handleBackChannelLogout: (event: MinimalRequestEvent) => Promise<Response>
    handleCallback: (
        event: MinimalRequestEvent,
    ) => Promise<OIDCCallbackResult<TIdentity>>
    login: (
        event: MinimalRequestEvent,
        loginOptions?: OIDCLoginOptions,
    ) => Promise<never>
    loginHandler: <T extends MinimalRequestEvent = RequestEvent>(
        defaults?: OIDCLoginOptions,
    ) => MinimalRequestHandler<T>
    logout: (
        event: MinimalRequestEvent,
        logoutOptions?: OIDCLogoutOptions,
    ) => Promise<never>
    logoutHandler: <T extends MinimalRequestEvent = RequestEvent>(
        defaults?: OIDCLogoutOptions,
    ) => MinimalRequestHandler<T>
    requireAuth: (
        event: { cookies: Cookies; url: URL },
        returnTo?: string,
    ) => Promise<OIDCSession<TIdentity>>
    toPublicSession: (
        context: OIDCHandleLocals<TIdentity, TRequestData> | null | undefined,
        depends?: (dependency: string) => void,
    ) => OIDCPublicSession<TIdentity> | null

    Projects an already-loaded request context without repeating any server work.