@auth0/nextjs-auth0/dist/types/index.d.ts

Auth0 Next.js SDK

export interface TokenSet {
    accessToken: string;
    idToken?: string;
    scope?: string;
    refreshToken?: string;
    expiresAt: number;
}
export interface ConnectionTokenSet {
    accessToken: string;
    scope?: string;
    expiresAt: number;
    connection: string;
    [key: string]: unknown;
}
export interface SessionData {
    user: User;
    tokenSet: TokenSet;
    internal: {
        sid: string;
        createdAt: number;
    };
    connectionTokenSets?: ConnectionTokenSet[];
    [key: string]: unknown;
}
export interface SessionDataStore {
    /**
     * Gets the session from the store given a session ID.
     */
    get(id: string): Promise<SessionData | null>;
    /**
     * Upsert a session in the store given a session ID and `SessionData`.
     */
    set(id: string, session: SessionData): Promise<void>;
    /**
     * Destroys the session with the given session ID.
     */
    delete(id: string): Promise<void>;
    /**
     * Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
     */
    deleteByLogoutToken?(logoutToken: LogoutToken): Promise<void>;
}
export type LogoutToken = {
    sub?: string;
    sid?: string;
};
export interface User {
    sub: string;
    name?: string;
    nickname?: string;
    given_name?: string;
    family_name?: string;
    picture?: string;
    email?: string;
    email_verified?: boolean;
    org_id?: string;
    [key: string]: any;
}
export type { Auth0ClientOptions, PagesRouterRequest, PagesRouterResponse } from "../server/client.js";
export type { BeforeSessionSavedHook, OnCallbackHook, RoutesOptions, AuthClientOptions, OnCallbackContext, Routes } from "../server/auth-client.js";
export type { TransactionCookieOptions } from "../server/transaction-store.js";
export type { SessionConfiguration, SessionCookieOptions, SessionStoreOptions } from "../server/session/abstract-session-store.js";
export type { CookieOptions, ReadonlyRequestCookies } from "../server/cookies.js";
export type { TransactionStoreOptions, TransactionState } from "../server/transaction-store.js";
export interface StartInteractiveLoginOptions {
    /**
     * Authorization parameters to be passed to the authorization server.
     */
    authorizationParameters?: AuthorizationParameters;
    /**
     * The URL to redirect to after a successful login.
     */
    returnTo?: string;
}
export interface AuthorizationParameters {
    /**
     * The scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
     * Defaults to `"openid profile email offline_access"`.
     */
    scope?: string | null;
    /**
     * The unique identifier of the target API you want to access.
     */
    audience?: string | null;
    /**
     * The URL to which the authorization server will redirect the user after granting authorization.
     */
    redirect_uri?: string | null;
    /**
     * The maximum amount of time, in seconds, after which a user must reauthenticate.
     */
    max_age?: number;
    /**
     * Additional authorization parameters.
     */
    [key: string]: unknown;
}
/**
 * Options for retrieving a connection access token.
 */
export interface AccessTokenForConnectionOptions {
    /**
     * The connection name for while you want to retrieve the access token.
     */
    connection: string;
    /**
     * An optional login hint to pass to the authorization server.
     */
    login_hint?: string;
}
/**
 * Logout strategy options for controlling logout endpoint selection.
 */
export type LogoutStrategy = "auto" | "oidc" | "v2";