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

Auth0 Next.js SDK

import { AuthorizationParameters } from "./authorize.js";
import { ConnectionTokenSet } from "./token-vault.js";
export interface TokenSet {
    accessToken: string;
    idToken?: string;
    scope?: string;
    requestedScope?: string;
    refreshToken?: string;
    expiresAt: number;
    audience?: string;
    token_type?: string;
}
export interface AccessTokenSet {
    accessToken: string;
    scope?: string;
    requestedScope?: string;
    audience: string;
    expiresAt: number;
    token_type?: string;
}
export interface SessionData {
    user: User;
    tokenSet: TokenSet;
    accessTokens?: AccessTokenSet[];
    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;
    /**
     * The organization ID that the user belongs to.
     * This field is populated when the user logs in through an organization.
     */
    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";
/**
 * Logout strategy options for controlling logout endpoint selection.
 */
export type LogoutStrategy = "auto" | "oidc" | "v2";
export interface BackchannelAuthenticationOptions {
    /**
     * Human-readable message to be displayed at the consumption device and authentication device.
     * This allows the user to ensure the transaction initiated by the consumption device is the same that triggers the action on the authentication device.
     */
    bindingMessage: string;
    /**
     * The login hint to inform which user to use.
     */
    loginHint: {
        /**
         * The `sub` claim of the user that is trying to login using Client-Initiated Backchannel Authentication, and to which a push notification to authorize the login will be sent.
         */
        sub: string;
    };
    /**
     * Set a custom expiry time for the CIBA flow in seconds. Defaults to 300 seconds (5 minutes) if not set.
     */
    requestedExpiry?: number;
    /**
     * Optional authorization details to use Rich Authorization Requests (RAR).
     * @see https://auth0.com/docs/get-started/apis/configure-rich-authorization-requests
     */
    authorizationDetails?: AuthorizationDetails[];
    /**
     * Authorization Parameters to be sent with the authorization request.
     */
    authorizationParams?: AuthorizationParameters;
}
export interface BackchannelAuthenticationResponse {
    tokenSet: TokenSet;
    idTokenClaims?: {
        [key: string]: any;
    };
    authorizationDetails?: AuthorizationDetails[];
}
export interface AuthorizationDetails {
    readonly type: string;
    readonly [parameter: string]: unknown;
}
export type GetAccessTokenOptions = {
    refresh?: boolean | null;
    scope?: string | null;
    /**
     * Please note: If you are passing audience, ensure that the used audiences and scopes are
     * part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT).
     * {@link https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token|See Auth0 Documentation on Multi-resource Refresh Tokens}
     */
    audience?: string | null;
};
export type ProxyOptions = {
    proxyPath: string;
    targetBaseUrl: string;
    audience: string;
    scope: string | null;
};
export { AuthorizationParameters, StartInteractiveLoginOptions } from "./authorize.js";
export { AccessTokenForConnectionOptions, ConnectionTokenSet, CustomTokenExchangeOptions, CustomTokenExchangeResponse, GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE, SUBJECT_TOKEN_TYPES } from "./token-vault.js";
export { ConnectAccountOptions, RESPONSE_TYPES } from "./connected-accounts.js";