@supabase/ssr/dist/main/cookies.d.ts

Use the Supabase JavaScript library in popular server-side rendering (SSR) frameworks.

import type { CookieMethodsServer, CookieMethodsServerDeprecated, CookieMethodsBrowser, CookieMethodsBrowserDeprecated, CookieOptions, CookieOptionsWithName, GetAllCookies, SetAllCookies } from "./types";
export declare function isPkceVerifierSlotKey(key: string): boolean;
/**
 * Matches auth-js's index of pending PKCE flow ids,
 * `<storageKey>-flows-code-verifier`. Storage adapters cannot enumerate keys,
 * so this entry is what makes the verifier slots discoverable for eviction and
 * for teardown on sign-out.
 */
export declare function isPkceFlowIndexKey(key: string): boolean;
/**
 * Creates a storage client that handles cookies correctly for browser and
 * server clients with or without properly provided cookie methods.
 *
 * @param options The options passed to createBrowserClient or createServer client.
 *
 * @param isServerClient Whether it's called from createServerClient.
 */
export declare function createStorageFromOptions(options: {
    cookieEncoding: "raw" | "base64url";
    cookies?: CookieMethodsBrowser | CookieMethodsBrowserDeprecated | CookieMethodsServer | CookieMethodsServerDeprecated;
    cookieOptions?: CookieOptionsWithName;
}, isServerClient: boolean): {
    getAll: (keyHints: string[]) => ReturnType<GetAllCookies>;
    setAll: SetAllCookies;
    setItems: {
        [key: string]: string;
    };
    removedItems: {
        [key: string]: boolean;
    };
    storage: {
        isServer: boolean;
        getItem: (key: string) => Promise<string | null>;
        setItem: (key: string, value: string) => Promise<void>;
        removeItem: (key: string) => Promise<void>;
    };
};
/**
 * When createServerClient needs to apply the created storage to cookies, it
 * should call this function which handles correcly setting cookies for stored
 * and removed items in the storage.
 */
export declare function applyServerStorage({ getAll, setAll, setItems, removedItems, }: {
    getAll: (keyHints: string[]) => ReturnType<GetAllCookies>;
    setAll: SetAllCookies;
    setItems: {
        [name: string]: string;
    };
    removedItems: {
        [name: string]: boolean;
    };
}, options: {
    cookieEncoding: "raw" | "base64url";
    cookieOptions?: CookieOptions | null;
}): Promise<void>;