supertokens-node/lib/build/types.d.ts

NodeJS driver for SuperTokens core

import RecipeModule from "./recipeModule";
import NormalisedURLDomain from "./normalisedURLDomain";
import NormalisedURLPath from "./normalisedURLPath";
export declare type AppInfo = {
    appName: string;
    websiteDomain: string;
    apiDomain: string;
    apiBasePath?: string;
    websiteBasePath?: string;
};
export declare type NormalisedAppinfo = {
    appName: string;
    websiteDomain: NormalisedURLDomain;
    apiDomain: NormalisedURLDomain;
    apiBasePath: NormalisedURLPath;
    websiteBasePath: NormalisedURLPath;
};
export declare type TypeInput = {
    supertokens: {
        connectionURI: string;
        apiKey?: string;
    };
    apiWebProxyPath?: string;
    appInfo: AppInfo;
    recipeList: RecipeListFunction[];
    telemetry?: boolean;
    isInServerlessEnv?: boolean;
};
export declare const InputSchema: {
    type: string;
    properties: {
        supertokens: {
            type: string;
            properties: {
                connectionURI: {
                    type: string;
                };
                apiKey: {
                    type: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
        appInfo: {
            type: string;
            properties: {
                appName: {
                    type: string;
                };
                websiteDomain: {
                    type: string;
                };
                apiDomain: {
                    type: string;
                };
                apiBasePath: {
                    type: string;
                };
                websiteBasePath: {
                    type: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
        recipeList: {
            type: string;
        };
        telemetry: {
            type: string;
        };
        isInServerlessEnv: {
            type: string;
        };
        apiWebProxyPath: {
            type: string;
        };
    };
    required: string[];
    additionalProperties: boolean;
};
export declare type RecipeListFunction = (appInfo: NormalisedAppinfo, isInServerlessEnv: boolean) => RecipeModule;
export declare type APIHandled = {
    pathWithoutApiBasePath: NormalisedURLPath;
    method: HTTPMethod;
    id: string;
    disabled: boolean;
};
export declare type HTTPMethod = "post" | "get" | "delete" | "put" | "options" | "trace";