nucleus-core-ts 0.8.0

package/dist/src/Client/ApiCaller/types.d.ts

@@ -0,0 +1,907 @@
+import type { NucleusConfigOptions, NucleusTable, PaginationMeta, StandardQueryParams, StandardReturn } from "../../types";
+import type { HttpMethod } from "../ServerFetch/types";
+import type { SystemTables } from "./system-tables";
+export type { HttpMethod };
+export interface ApiResponse<TSuccess, TError> {
+    isSuccess: boolean;
+    data?: TSuccess;
+    errors?: TError;
+    code?: number | null;
+    message?: string;
+}
+export type EndpointMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+export interface EndpointDefinition<TPayload = unknown, TSuccess = unknown, TError = unknown> {
+    method: EndpointMethod;
+    path: string;
+    isPublic?: boolean;
+    isFormData?: boolean;
+    _payload: TPayload;
+    _success: TSuccess;
+    _error: TError;
+}
+export type BaseErrorResponse = {
+    message: string;
+    code?: string;
+    details?: unknown;
+};
+export type ListResponse<T> = StandardReturn<{
+    items: T[];
+    meta: PaginationMeta;
+}>;
+export type SingleResponse<T> = StandardReturn<T | null>;
+export type MutationResponse<T> = StandardReturn<T>;
+export type DeleteResponse = StandardReturn<null>;
+type EntityMethodMap = {
+    GET: "GET";
+    POST: "ADD";
+    PUT: "UPDATE";
+    PATCH: "PATCH";
+    DELETE: "DELETE";
+};
+type Singularize<S extends string> = S extends `${infer Base}ies` ? `${Base}y` : S extends `${infer Base}ses` ? `${Base}s` : S extends `${infer Base}s` ? Base : S;
+export type EntityEndpointKey<TTableName extends string, TMethod extends keyof EntityMethodMap> = TMethod extends "GET" ? `GET_${Uppercase<TTableName>}` : `${EntityMethodMap[TMethod]}_${Uppercase<Singularize<TTableName>>}`;
+export type BulkEndpointKey<TTableName extends string, TMethod extends "POST" | "PUT" | "DELETE"> = `BULK_${EntityMethodMap[TMethod]}_${Uppercase<TTableName>}`;
+export interface LoginPayload {
+    email: string;
+    password: string;
+    rememberMe?: boolean;
+}
+export interface UserData {
+    id: string;
+    email: string;
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+    createdBy: string | null;
+    updatedBy: string | null;
+    verifiedAt: string | null;
+    lastLoginAt: string | null;
+    loginCount: number;
+    isLocked: boolean;
+    lockedUntil: string | null;
+    failedLoginAttempts: number;
+    isGod: boolean;
+    profile: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type LoginSuccessData = {
+    user: UserData;
+    accessToken?: string;
+    sessionId?: string;
+};
+export type LoginSuccess = StandardReturn<LoginSuccessData>;
+export interface RegisterPayload {
+    email: string;
+    password: string;
+}
+export type RegisterSuccessData = {
+    user: UserData;
+    accessToken?: string;
+    sessionId?: string;
+};
+export type RegisterSuccess = StandardReturn<RegisterSuccessData>;
+export type RefreshSuccessData = {
+    accessToken: string;
+    sessionId?: string;
+};
+export type RefreshSuccess = StandardReturn<RefreshSuccessData>;
+export type MeResponse = StandardReturn<UserData>;
+export interface PasswordChangePayload {
+    currentPassword: string;
+    newPassword: string;
+}
+export interface PasswordSetPayload {
+    newPassword: string;
+    userId: string;
+}
+export interface PasswordResetRequestPayload {
+    email: string;
+}
+export interface PasswordResetConfirmPayload {
+    token: string;
+    newPassword: string;
+    confirmPassword: string;
+}
+export type PasswordResetResponse = StandardReturn<{
+    message: string;
+}>;
+export interface MagicLinkPayload {
+    email: string;
+}
+export interface InvitePayload {
+    email: string;
+}
+export type InviteResponse = StandardReturn<UserData>;
+export interface EmailVerificationPayload {
+    token: string;
+}
+export interface EmailVerificationResponse {
+    success: boolean;
+    message: string;
+    data?: {
+        redirectUrl: string;
+        verified: boolean;
+    };
+}
+export interface ResendVerificationPayload {
+    email: string;
+}
+export interface ResendVerificationResponse {
+    success: boolean;
+    message: string;
+    data?: {
+        cooldownSeconds?: number;
+        cooldownRemaining?: number;
+        canResendAt?: string;
+        attemptsRemaining?: number;
+        maxAttemptsReached?: boolean;
+        attemptsUsed?: number;
+        maxAttempts?: number;
+    };
+}
+export interface SessionInfo {
+    id: string;
+    userId: string;
+    deviceFingerprint?: string;
+    deviceName?: string;
+    deviceType?: string;
+    browserName?: string;
+    browserVersion?: string;
+    osName?: string;
+    osVersion?: string;
+    ipAddress?: string;
+    locationCountry?: string;
+    locationCity?: string;
+    locationCoordinates?: string;
+    lastActivityAt?: string;
+    createdAt?: string;
+    expiresAt?: string;
+    revokedAt?: string;
+    revokedReason?: string;
+    isCurrent?: boolean;
+    loginMethod?: string;
+    trustScore?: number;
+    approvalStatus?: "approved" | "pending" | "rejected";
+    approvalToken?: string;
+    approvalRequestedAt?: string;
+    approvalRespondedAt?: string;
+}
+export type SessionsListResponse = StandardReturn<{
+    sessions: SessionInfo[];
+    currentSessionId?: string;
+    totalCount: number;
+}>;
+export type SessionCurrentResponse = StandardReturn<SessionInfo>;
+export type SessionRevokePayload = {
+    _sessionId: string;
+    reason?: string;
+};
+export type SessionRevokeResponse = StandardReturn<{
+    message: string;
+}>;
+export type SessionRevokeAllPayload = {
+    excludeCurrent?: boolean;
+    reason?: string;
+};
+export type SessionRevokeAllResponse = StandardReturn<{
+    message: string;
+}>;
+export type SessionStatsResponse = StandardReturn<{
+    activeSessions: number;
+    uniqueDevices: number;
+    uniqueIpAddresses: number;
+}>;
+export type SessionsPendingResponse = StandardReturn<{
+    sessions: (SessionInfo & {
+        approvalStatus?: string;
+        approvalRequestedAt?: string;
+    })[];
+    totalCount: number;
+}>;
+export type SessionApprovePayload = {
+    token: string;
+};
+export type SessionApproveResponse = StandardReturn<{
+    message: string;
+}>;
+export type SessionRejectPayload = {
+    token: string;
+};
+export type SessionRejectResponse = StandardReturn<{
+    message: string;
+}>;
+export type CaptchaGeneratePayload = {
+    type?: "math" | "image" | "puzzle" | "text";
+    difficulty?: "easy" | "medium" | "hard";
+};
+export type CaptchaGenerateResponse = StandardReturn<{
+    challengeId: string;
+    type: "math" | "image" | "puzzle" | "text";
+    question: string;
+    imageData?: string;
+    puzzleData?: {
+        pieces: Array<{
+            id: number;
+            x: number;
+            y: number;
+        }>;
+    };
+    expiresAt: number;
+}>;
+export type CaptchaValidatePayload = {
+    challengeId: string;
+    answer: string;
+};
+export type CaptchaValidateResponse = StandardReturn<{
+    valid: boolean;
+    message?: string;
+    attemptsRemaining?: number;
+}>;
+export type AuthFeatureConfig = {
+    route?: string;
+    isPublic?: boolean;
+    enabled?: boolean;
+};
+export type AuthenticationConfig = {
+    enabled?: boolean;
+    login?: AuthFeatureConfig & {
+        rememberMe?: boolean;
+    };
+    register?: AuthFeatureConfig;
+    logout?: AuthFeatureConfig;
+    refresh?: AuthFeatureConfig;
+    me?: AuthFeatureConfig & {
+        includeProfile?: boolean;
+        includeAddresses?: boolean;
+        includePhones?: boolean;
+        includeFiles?: boolean;
+    };
+    passwordChange?: AuthFeatureConfig;
+    passwordSet?: AuthFeatureConfig;
+    passwordReset?: AuthFeatureConfig & {
+        redirectUrl?: string;
+    };
+    sessions?: AuthFeatureConfig & {
+        maxActiveSessions?: number;
+        inactivityTimeout?: string;
+        allowMultipleDevices?: boolean;
+        trustNewDevices?: boolean;
+        notifyOnNewDevice?: boolean;
+    };
+    magicLink?: AuthFeatureConfig & {
+        verifyRoute?: string;
+        expiresIn?: string;
+        redirectUrl?: string;
+    };
+    invite?: AuthFeatureConfig & {
+        tokenExpiresIn?: string;
+        redirectUrl?: string;
+    };
+    emailVerification?: AuthFeatureConfig & {
+        resendRoute?: string;
+    };
+};
+export declare const AUTH_ENDPOINT_CONFIGS: {
+    login: {
+        key: "LOGIN";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: LoginPayload;
+        _success: LoginSuccess;
+        _error: BaseErrorResponse;
+    };
+    register: {
+        key: "REGISTER";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: RegisterPayload;
+        _success: RegisterSuccess;
+        _error: BaseErrorResponse;
+    };
+    logout: {
+        key: "LOGOUT";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: undefined;
+        _success: {
+            message: string;
+        };
+        _error: BaseErrorResponse;
+    };
+    refresh: {
+        key: "REFRESH";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: undefined;
+        _success: RefreshSuccess;
+        _error: BaseErrorResponse;
+    };
+    me: {
+        key: "ME";
+        method: "GET";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: undefined;
+        _success: MeSuccessResponse;
+        _error: BaseErrorResponse;
+    };
+    passwordChange: {
+        key: "PASSWORD_CHANGE";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: PasswordChangePayload;
+        _success: {
+            message: string;
+        };
+        _error: BaseErrorResponse;
+    };
+    passwordSet: {
+        key: "PASSWORD_SET";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: PasswordSetPayload;
+        _success: {
+            message: string;
+        };
+        _error: BaseErrorResponse;
+    };
+    passwordReset: {
+        key: "PASSWORD_RESET_REQUEST";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        subEndpoints: ({
+            key: "PASSWORD_RESET_REQUEST";
+            method: "POST";
+            suffix: string;
+            _payload: PasswordResetRequestPayload;
+            _success: PasswordResetResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "PASSWORD_RESET_CONFIRM";
+            method: "POST";
+            suffix: string;
+            _payload: PasswordResetConfirmPayload;
+            _success: PasswordResetResponse;
+            _error: BaseErrorResponse;
+        })[];
+    };
+    sessions: {
+        key: "SESSIONS";
+        method: "GET";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        subEndpoints: ({
+            key: "SESSIONS";
+            method: "GET";
+            suffix: string;
+            _payload: undefined;
+            _success: SessionsListResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_CURRENT";
+            method: "GET";
+            suffix: string;
+            _payload: undefined;
+            _success: SessionCurrentResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_STATS";
+            method: "GET";
+            suffix: string;
+            _payload: undefined;
+            _success: SessionStatsResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_PENDING";
+            method: "GET";
+            suffix: string;
+            _payload: undefined;
+            _success: SessionsPendingResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_REVOKE";
+            method: "DELETE";
+            suffix: string;
+            _payload: SessionRevokePayload;
+            _success: SessionRevokeResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_REVOKE_ALL";
+            method: "DELETE";
+            suffix: string;
+            _payload: SessionRevokeAllPayload;
+            _success: SessionRevokeAllResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_APPROVE";
+            method: "POST";
+            suffix: string;
+            _payload: SessionApprovePayload;
+            _success: SessionApproveResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "SESSIONS_REJECT";
+            method: "POST";
+            suffix: string;
+            _payload: SessionRejectPayload;
+            _success: SessionRejectResponse;
+            _error: BaseErrorResponse;
+        })[];
+    };
+    magicLink: {
+        key: "MAGIC_LINK";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        subEndpoints: ({
+            key: "MAGIC_LINK";
+            method: "POST";
+            suffix: string;
+            _payload: MagicLinkPayload;
+            _success: StandardReturn<{
+                message: string;
+            }>;
+            _error: BaseErrorResponse;
+            routeKey?: undefined;
+        } | {
+            key: "MAGIC_LINK_VERIFY";
+            method: "GET";
+            suffix: string;
+            routeKey: "verifyRoute";
+            _payload: {
+                token: string;
+            };
+            _success: LoginSuccess;
+            _error: BaseErrorResponse;
+        })[];
+    };
+    invite: {
+        key: "INVITE";
+        method: "POST";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        _payload: InvitePayload;
+        _success: InviteResponse;
+        _error: BaseErrorResponse;
+    };
+    emailVerification: {
+        key: "VERIFY_EMAIL";
+        method: "GET";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        subEndpoints: ({
+            key: "VERIFY_EMAIL";
+            method: "GET";
+            suffix: string;
+            _payload: EmailVerificationPayload;
+            _success: EmailVerificationResponse;
+            _error: BaseErrorResponse;
+            routeKey?: undefined;
+            defaultRoute?: undefined;
+        } | {
+            key: "RESEND_VERIFICATION";
+            method: "POST";
+            suffix: string;
+            routeKey: "resendRoute";
+            defaultRoute: "/resend-verification";
+            _payload: ResendVerificationPayload;
+            _success: ResendVerificationResponse;
+            _error: BaseErrorResponse;
+        })[];
+    };
+    captcha: {
+        key: "CAPTCHA";
+        method: "GET";
+        defaultRoute: string;
+        defaultIsPublic: boolean;
+        subEndpoints: ({
+            key: "CAPTCHA_GENERATE";
+            method: "GET";
+            suffix: string;
+            _payload: CaptchaGeneratePayload;
+            _success: CaptchaGenerateResponse;
+            _error: BaseErrorResponse;
+        } | {
+            key: "CAPTCHA_VALIDATE";
+            method: "POST";
+            suffix: string;
+            _payload: CaptchaValidatePayload;
+            _success: CaptchaValidateResponse;
+            _error: BaseErrorResponse;
+        })[];
+    };
+};
+export type AuthFeatureKey = keyof typeof AUTH_ENDPOINT_CONFIGS;
+type AuthEndpointMap = {
+    login: {
+        key: "LOGIN";
+        definition: EndpointDefinition<LoginPayload, LoginSuccess, BaseErrorResponse>;
+    };
+    register: {
+        key: "REGISTER";
+        definition: EndpointDefinition<RegisterPayload, RegisterSuccess, BaseErrorResponse>;
+    };
+    logout: {
+        key: "LOGOUT";
+        definition: EndpointDefinition<undefined, {
+            message: string;
+        }, BaseErrorResponse>;
+    };
+    refresh: {
+        key: "REFRESH";
+        definition: EndpointDefinition<undefined, RefreshSuccess, BaseErrorResponse>;
+    };
+    me: {
+        key: "ME";
+        definition: EndpointDefinition<undefined, Record<string, unknown>, BaseErrorResponse>;
+    };
+    passwordChange: {
+        key: "PASSWORD_CHANGE";
+        definition: EndpointDefinition<PasswordChangePayload, {
+            message: string;
+        }, BaseErrorResponse>;
+    };
+    passwordSet: {
+        key: "PASSWORD_SET";
+        definition: EndpointDefinition<PasswordSetPayload, {
+            message: string;
+        }, BaseErrorResponse>;
+    };
+    passwordReset: {
+        keys: ["PASSWORD_RESET_REQUEST", "PASSWORD_RESET_CONFIRM"];
+        definitions: {
+            PASSWORD_RESET_REQUEST: EndpointDefinition<PasswordResetRequestPayload, PasswordResetResponse, BaseErrorResponse>;
+            PASSWORD_RESET_CONFIRM: EndpointDefinition<PasswordResetConfirmPayload, PasswordResetResponse, BaseErrorResponse>;
+        };
+    };
+    sessions: {
+        keys: [
+            "SESSIONS",
+            "SESSIONS_CURRENT",
+            "SESSIONS_STATS",
+            "SESSIONS_PENDING",
+            "SESSIONS_REVOKE",
+            "SESSIONS_REVOKE_ALL",
+            "SESSIONS_APPROVE",
+            "SESSIONS_REJECT"
+        ];
+        definitions: {
+            SESSIONS: EndpointDefinition<undefined, SessionsListResponse, BaseErrorResponse>;
+            SESSIONS_CURRENT: EndpointDefinition<undefined, SessionCurrentResponse, BaseErrorResponse>;
+            SESSIONS_STATS: EndpointDefinition<undefined, SessionStatsResponse, BaseErrorResponse>;
+            SESSIONS_PENDING: EndpointDefinition<undefined, SessionsPendingResponse, BaseErrorResponse>;
+            SESSIONS_REVOKE: EndpointDefinition<SessionRevokePayload, SessionRevokeResponse, BaseErrorResponse>;
+            SESSIONS_REVOKE_ALL: EndpointDefinition<SessionRevokeAllPayload, SessionRevokeAllResponse, BaseErrorResponse>;
+            SESSIONS_APPROVE: EndpointDefinition<SessionApprovePayload, SessionApproveResponse, BaseErrorResponse>;
+            SESSIONS_REJECT: EndpointDefinition<SessionRejectPayload, SessionRejectResponse, BaseErrorResponse>;
+        };
+    };
+    magicLink: {
+        keys: ["MAGIC_LINK", "MAGIC_LINK_VERIFY"];
+        definitions: {
+            MAGIC_LINK: EndpointDefinition<MagicLinkPayload, StandardReturn<{
+                message: string;
+            }>, BaseErrorResponse>;
+            MAGIC_LINK_VERIFY: EndpointDefinition<{
+                token: string;
+            }, LoginSuccess, BaseErrorResponse>;
+        };
+    };
+    invite: {
+        key: "INVITE";
+        definition: EndpointDefinition<InvitePayload, InviteResponse, BaseErrorResponse>;
+    };
+    emailVerification: {
+        keys: ["VERIFY_EMAIL", "RESEND_VERIFICATION"];
+        definitions: {
+            VERIFY_EMAIL: EndpointDefinition<EmailVerificationPayload, EmailVerificationResponse, BaseErrorResponse>;
+            RESEND_VERIFICATION: EndpointDefinition<ResendVerificationPayload, ResendVerificationResponse, BaseErrorResponse>;
+        };
+    };
+    captcha: {
+        keys: ["CAPTCHA_GENERATE", "CAPTCHA_VALIDATE"];
+        definitions: {
+            CAPTCHA_GENERATE: EndpointDefinition<CaptchaGeneratePayload, CaptchaGenerateResponse, BaseErrorResponse>;
+            CAPTCHA_VALIDATE: EndpointDefinition<CaptchaValidatePayload, CaptchaValidateResponse, BaseErrorResponse>;
+        };
+    };
+};
+type ExtractSingleAuthEndpoint<TAuth extends AuthenticationConfig, TFeature extends keyof AuthEndpointMap> = TFeature extends keyof TAuth ? TAuth[TFeature] extends {
+    enabled: true;
+} | {
+    enabled?: true;
+} ? TFeature extends "passwordReset" | "magicLink" | "sessions" | "emailVerification" | "captcha" ? AuthEndpointMap[TFeature] extends {
+    definitions: infer D;
+} ? D : never : AuthEndpointMap[TFeature] extends {
+    key: infer K;
+    definition: infer D;
+} ? K extends string ? {
+    [P in K]: D;
+} : never : never : Record<string, never> : Record<string, never>;
+export type GeneratedAuthEndpoints<TAuth extends AuthenticationConfig> = TAuth["enabled"] extends false ? Record<string, never> : ExtractSingleAuthEndpoint<TAuth, "login"> & ExtractSingleAuthEndpoint<TAuth, "register"> & ExtractSingleAuthEndpoint<TAuth, "logout"> & ExtractSingleAuthEndpoint<TAuth, "refresh"> & ExtractSingleAuthEndpoint<TAuth, "me"> & ExtractSingleAuthEndpoint<TAuth, "passwordChange"> & ExtractSingleAuthEndpoint<TAuth, "passwordSet"> & ExtractSingleAuthEndpoint<TAuth, "passwordReset"> & ExtractSingleAuthEndpoint<TAuth, "sessions"> & ExtractSingleAuthEndpoint<TAuth, "magicLink"> & ExtractSingleAuthEndpoint<TAuth, "invite"> & ExtractSingleAuthEndpoint<TAuth, "emailVerification"> & ExtractSingleAuthEndpoint<TAuth, "captcha">;
+export type AuthEndpointDefinitions = {
+    LOGIN: EndpointDefinition<LoginPayload, LoginSuccess, BaseErrorResponse>;
+    REGISTER: EndpointDefinition<RegisterPayload, RegisterSuccess, BaseErrorResponse>;
+    LOGOUT: EndpointDefinition<undefined, {
+        message: string;
+    }, BaseErrorResponse>;
+    REFRESH: EndpointDefinition<undefined, RefreshSuccess, BaseErrorResponse>;
+    ME: EndpointDefinition<undefined, MeSuccessResponse, BaseErrorResponse>;
+    PASSWORD_CHANGE: EndpointDefinition<PasswordChangePayload, {
+        message: string;
+    }, BaseErrorResponse>;
+    PASSWORD_SET: EndpointDefinition<PasswordSetPayload, {
+        message: string;
+    }, BaseErrorResponse>;
+    PASSWORD_RESET_REQUEST: EndpointDefinition<PasswordResetRequestPayload, PasswordResetResponse, BaseErrorResponse>;
+    PASSWORD_RESET_CONFIRM: EndpointDefinition<PasswordResetConfirmPayload, PasswordResetResponse, BaseErrorResponse>;
+    SESSIONS: EndpointDefinition<undefined, SessionsListResponse, BaseErrorResponse>;
+    SESSIONS_CURRENT: EndpointDefinition<undefined, SessionCurrentResponse, BaseErrorResponse>;
+    SESSIONS_STATS: EndpointDefinition<undefined, SessionStatsResponse, BaseErrorResponse>;
+    SESSIONS_PENDING: EndpointDefinition<undefined, SessionsPendingResponse, BaseErrorResponse>;
+    SESSIONS_REVOKE: EndpointDefinition<SessionRevokePayload, SessionRevokeResponse, BaseErrorResponse>;
+    SESSIONS_REVOKE_ALL: EndpointDefinition<SessionRevokeAllPayload, SessionRevokeAllResponse, BaseErrorResponse>;
+    SESSIONS_APPROVE: EndpointDefinition<SessionApprovePayload, SessionApproveResponse, BaseErrorResponse>;
+    SESSIONS_REJECT: EndpointDefinition<SessionRejectPayload, SessionRejectResponse, BaseErrorResponse>;
+    MAGIC_LINK: EndpointDefinition<MagicLinkPayload, StandardReturn<{
+        message: string;
+    }>, BaseErrorResponse>;
+    MAGIC_LINK_VERIFY: EndpointDefinition<{
+        token: string;
+    }, LoginSuccess, BaseErrorResponse>;
+    INVITE: EndpointDefinition<InvitePayload, InviteResponse, BaseErrorResponse>;
+    VERIFY_EMAIL: EndpointDefinition<EmailVerificationPayload, EmailVerificationResponse, BaseErrorResponse>;
+    RESEND_VERIFICATION: EndpointDefinition<ResendVerificationPayload, ResendVerificationResponse, BaseErrorResponse>;
+    CAPTCHA_GENERATE: EndpointDefinition<CaptchaGeneratePayload, CaptchaGenerateResponse, BaseErrorResponse>;
+    CAPTCHA_VALIDATE: EndpointDefinition<CaptchaValidatePayload, CaptchaValidateResponse, BaseErrorResponse>;
+};
+export type EntityRecord = Record<string, unknown>;
+export type GenerateEntityEndpoints<TTable extends NucleusTable> = {
+    [K in EntityEndpointKey<TTable["table_name"], "GET">]: EndpointDefinition<StandardQueryParams, ListResponse<EntityRecord>, BaseErrorResponse>;
+} & {
+    [K in `GET_${Uppercase<Singularize<TTable["table_name"]>>}_BY_ID`]: EndpointDefinition<{
+        id: string;
+    }, SingleResponse<EntityRecord>, BaseErrorResponse>;
+} & {
+    [K in EntityEndpointKey<TTable["table_name"], "POST">]: EndpointDefinition<EntityRecord, MutationResponse<EntityRecord>, BaseErrorResponse>;
+} & {
+    [K in EntityEndpointKey<TTable["table_name"], "PUT">]: EndpointDefinition<EntityRecord & {
+        id: string;
+    }, MutationResponse<EntityRecord>, BaseErrorResponse>;
+} & {
+    [K in EntityEndpointKey<TTable["table_name"], "PATCH">]: EndpointDefinition<Partial<EntityRecord> & {
+        id: string;
+    }, MutationResponse<EntityRecord>, BaseErrorResponse>;
+} & {
+    [K in EntityEndpointKey<TTable["table_name"], "DELETE">]: EndpointDefinition<{
+        id: string;
+    }, DeleteResponse, BaseErrorResponse>;
+};
+export interface EndpointState<TSuccess, TError> {
+    isPending: boolean;
+    data: TSuccess | null;
+    error: TError | null;
+    code: number | null;
+}
+export interface StartOptions<TPayload, TSuccess, TError> {
+    payload: TPayload;
+    onAfterHandle?: (data: TSuccess) => void;
+    onErrorHandle?: (error: TError, code?: number | null) => void;
+}
+export interface EndpointAction<TPayload, TSuccess, TError> {
+    state: EndpointState<TSuccess, TError>;
+    start: (options: StartOptions<TPayload, TSuccess, TError>) => void;
+}
+export type EndpointActions<TEndpoints extends Record<string, EndpointDefinition>> = {
+    [K in keyof TEndpoints]: EndpointAction<TEndpoints[K]["_payload"], TEndpoints[K]["_success"], TEndpoints[K]["_error"]>;
+};
+export interface CookieStore {
+    get: (name: string) => {
+        value: string;
+    } | undefined;
+    set: (name: string, value: string, options?: Record<string, unknown>) => void;
+    delete: (name: string) => void;
+}
+export interface HeadersStore {
+    get: (name: string) => string | null;
+    forEach: (callback: (value: string, key: string) => void) => void;
+}
+export interface ServerFactoryConfig {
+    baseUrl: string;
+    tokenNames?: {
+        accessToken?: string;
+        refreshToken?: string;
+        sessionToken?: string;
+    };
+    debug?: boolean;
+}
+export interface ClientHookConfig<TEndpoints extends Record<string, EndpointDefinition>> {
+    endpoints: TEndpoints;
+    factory: <K extends keyof TEndpoints>(endpoint: K, payload: TEndpoints[K]["_payload"]) => Promise<ApiResponse<TEndpoints[K]["_success"], TEndpoints[K]["_error"]>>;
+}
+export type ExtraEndpoints = Record<string, EndpointDefinition>;
+export interface ApiCallerConfig<TConfig extends NucleusConfigOptions, TExtra extends ExtraEndpoints = Record<string, never>> {
+    config: TConfig;
+    extraEndpoints?: TExtra;
+    serverConfig: ServerFactoryConfig;
+    getCookies: () => Promise<CookieStore>;
+    getHeaders: () => Promise<HeadersStore>;
+}
+type ExtractTableNames<T extends readonly {
+    table_name: string;
+}[]> = T[number]["table_name"];
+type GenerateEntityEndpointKeys<TTableName extends string> = `GET_${Uppercase<TTableName>}` | `GET_${Uppercase<Singularize<TTableName>>}_BY_ID` | `GET_${Uppercase<TTableName>}_DISTINCT` | `ADD_${Uppercase<Singularize<TTableName>>}` | `UPDATE_${Uppercase<Singularize<TTableName>>}` | `PATCH_${Uppercase<Singularize<TTableName>>}` | `DELETE_${Uppercase<Singularize<TTableName>>}`;
+type GenerateBulkEndpointKeys<TTableName extends string> = `BULK_ADD_${Uppercase<TTableName>}` | `BULK_UPDATE_${Uppercase<TTableName>}` | `BULK_DELETE_${Uppercase<TTableName>}`;
+type EntityEndpointDefinitionFor<TKey extends string> = TKey extends `GET_${string}_BY_ID` ? EndpointDefinition<{
+    id: string;
+}, SingleResponse<EntityRecord>, BaseErrorResponse> : TKey extends `GET_${string}_DISTINCT` ? EndpointDefinition<{
+    field: string;
+}, StandardReturn<{
+    value: unknown;
+}[]>, BaseErrorResponse> : TKey extends `GET_${string}` ? EndpointDefinition<StandardQueryParams | undefined, ListResponse<EntityRecord>, BaseErrorResponse> : TKey extends `ADD_${string}` ? EndpointDefinition<EntityRecord, MutationResponse<EntityRecord>, BaseErrorResponse> : TKey extends `UPDATE_${string}` ? EndpointDefinition<EntityRecord & {
+    id: string;
+}, MutationResponse<EntityRecord>, BaseErrorResponse> : TKey extends `PATCH_${string}` ? EndpointDefinition<Partial<EntityRecord> & {
+    id: string;
+}, MutationResponse<EntityRecord>, BaseErrorResponse> : TKey extends `DELETE_${string}` ? EndpointDefinition<{
+    id: string;
+}, DeleteResponse, BaseErrorResponse> : TKey extends `BULK_ADD_${string}` ? EndpointDefinition<EntityRecord[], MutationResponse<EntityRecord[]>, BaseErrorResponse> : TKey extends `BULK_UPDATE_${string}` ? EndpointDefinition<{
+    id: string;
+    data: EntityRecord;
+}[], MutationResponse<EntityRecord[]>, BaseErrorResponse> : TKey extends `BULK_DELETE_${string}` ? EndpointDefinition<string[], StandardReturn<{
+    deleted: number;
+}>, BaseErrorResponse> : EndpointDefinition;
+export type GeneratedEndpointsFromConfig<TEntities extends readonly {
+    table_name: string;
+    bulk_endpoints_enabled?: boolean;
+}[]> = {
+    [K in GenerateEntityEndpointKeys<ExtractTableNames<TEntities>>]: EntityEndpointDefinitionFor<K>;
+} & {
+    [K in GenerateBulkEndpointKeys<ExtractTableNames<TEntities>>]: EntityEndpointDefinitionFor<K>;
+};
+export type AllGeneratedEndpoints<TEntities extends readonly {
+    table_name: string;
+    bulk_endpoints_enabled?: boolean;
+}[], TExtra extends Record<string, EndpointDefinition> = Record<string, never>> = GeneratedEndpointsFromConfig<TEntities> & AuthEndpointDefinitions & TExtra;
+type NucleusColumnTypeToTS<T extends string> = T extends "integer" | "smallint" | "bigint" | "serial" | "smallserial" | "bigserial" | "real" | "doublePrecision" | "numeric" | "decimal" ? number : T extends "text" | "varchar" | "char" | "uuid" ? string : T extends "boolean" ? boolean : T extends "date" | "time" | "timestamp" | "timestamptz" ? Date | string : T extends "json" | "jsonb" ? unknown : unknown;
+type SnakeToCamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${T}${Capitalize<SnakeToCamelCase<U>>}` : S;
+type ColumnsToEntity<TColumns extends readonly {
+    name: string;
+    type: string;
+}[]> = {
+    [C in TColumns[number] as SnakeToCamelCase<C["name"]>]: NucleusColumnTypeToTS<C["type"]>;
+};
+type BaseEntityFields = {
+    id: string;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+};
+type EntityFromConfig<TEntity extends {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+}> = TEntity["columns"] extends readonly {
+    name: string;
+    type: string;
+}[] ? TEntity["add_base_columns"] extends true ? BaseEntityFields & ColumnsToEntity<TEntity["columns"]> : ColumnsToEntity<TEntity["columns"]> : BaseEntityFields;
+type FindEntityByName<TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+}[], TName extends string> = TEntities extends readonly [infer First, ...infer Rest] ? First extends {
+    table_name: TName;
+} ? First : Rest extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+}[] ? FindEntityByName<Rest, TName> : never : never;
+type SingularToPlural<T extends string> = T extends `${infer Base}ss` ? `${Base}sses` : T extends `${infer Base}s` ? `${Base}ses` : T extends `${infer Base}x` ? `${Base}xes` : T extends `${infer Base}z` ? `${Base}zes` : T extends `${infer Base}ch` ? `${Base}ches` : T extends `${infer Base}sh` ? `${Base}shes` : T extends `${infer Base}y` ? `${Base}ies` : `${T}s`;
+type FindEntityByNameOrSingular<TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+}[], TName extends string> = FindEntityByName<TEntities, TName> extends never ? FindEntityByName<TEntities, SingularToPlural<TName>> : FindEntityByName<TEntities, TName>;
+type EntityEndpointDefinitionWithTypes<TKey extends string, TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+}[]> = TKey extends `GET_${infer TableName}_BY_ID` ? EndpointDefinition<{
+    id: string;
+}, SingleResponse<EntityFromConfig<FindEntityByName<TEntities, Lowercase<TableName>>>>, BaseErrorResponse> : TKey extends `GET_${infer _TableName}_DISTINCT` ? EndpointDefinition<{
+    field: string;
+}, StandardReturn<{
+    value: unknown;
+}[]>, BaseErrorResponse> : TKey extends `GET_${infer TableName}` ? EndpointDefinition<StandardQueryParams | undefined, ListResponse<EntityFromConfig<FindEntityByName<TEntities, Lowercase<TableName>>>>, BaseErrorResponse> : TKey extends `ADD_${infer SingularName}` ? EndpointDefinition<Partial<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>>, MutationResponse<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>>, BaseErrorResponse> : TKey extends `UPDATE_${infer SingularName}` ? EndpointDefinition<Partial<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>> & {
+    id: string;
+}, MutationResponse<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>>, BaseErrorResponse> : TKey extends `PATCH_${infer SingularName}` ? EndpointDefinition<Partial<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>> & {
+    id: string;
+}, MutationResponse<EntityFromConfig<FindEntityByNameOrSingular<TEntities, Lowercase<SingularName>>>>, BaseErrorResponse> : TKey extends `DELETE_${infer _SingularName}` ? EndpointDefinition<{
+    id: string;
+}, DeleteResponse, BaseErrorResponse> : EndpointDefinition;
+export type GeneratedEndpointsWithEntityTypes<TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+    bulk_endpoints_enabled?: boolean;
+}[]> = {
+    [K in GenerateEntityEndpointKeys<ExtractTableNames<TEntities>>]: EntityEndpointDefinitionWithTypes<K, TEntities>;
+} & {
+    [K in GenerateBulkEndpointKeys<ExtractTableNames<TEntities>>]: EntityEndpointDefinitionFor<K>;
+};
+type SystemTableEndpoints = GeneratedEndpointsWithEntityTypes<SystemTables>;
+export type AllGeneratedEndpointsWithEntityTypes<TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+    bulk_endpoints_enabled?: boolean;
+}[], TExtra extends Record<string, EndpointDefinition> = Record<string, never>> = GeneratedEndpointsWithEntityTypes<TEntities> & AuthEndpointDefinitions & SystemTableEndpoints & TExtra;
+export type AllGeneratedEndpointsWithConfig<TConfig extends {
+    entities: readonly {
+        table_name: string;
+        columns?: readonly {
+            name: string;
+            type: string;
+        }[];
+        add_base_columns?: boolean;
+        bulk_endpoints_enabled?: boolean;
+    }[];
+    authentication?: AuthenticationConfig;
+}, TExtra extends Record<string, EndpointDefinition> = Record<string, never>> = GeneratedEndpointsWithEntityTypes<TConfig["entities"]> & (TConfig["authentication"] extends AuthenticationConfig ? GeneratedAuthEndpoints<TConfig["authentication"]> : AuthEndpointDefinitions) & TExtra;
+export type InferEntity<TEntities extends readonly {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+}[], TName extends string> = FindEntityByNameOrSingular<TEntities, TName> extends infer TEntity ? TEntity extends {
+    table_name: string;
+    columns?: readonly {
+        name: string;
+        type: string;
+    }[];
+    add_base_columns?: boolean;
+} ? EntityFromConfig<TEntity> : never : never;
+export type SystemUserEntity = InferEntity<SystemTables, "users">;
+export type SystemProfileEntity = InferEntity<SystemTables, "profiles">;
+export type SystemAddressEntity = InferEntity<SystemTables, "addresses">;
+export type SystemPhoneEntity = InferEntity<SystemTables, "phones">;
+export type SystemFileEntity = InferEntity<SystemTables, "files">;
+export type SystemRoleEntity = InferEntity<SystemTables, "roles">;
+export type SystemClaimEntity = InferEntity<SystemTables, "claims">;
+export type SystemRoleClaimEntity = InferEntity<SystemTables, "role_claims">;
+export type SystemUserRoleEntity = InferEntity<SystemTables, "user_roles">;
+export type MeResponseData = {
+    user: SystemUserEntity;
+    profile: SystemProfileEntity | null;
+    addresses: SystemAddressEntity[];
+    phones: SystemPhoneEntity[];
+    files: SystemFileEntity[];
+    roles: SystemRoleEntity[];
+};
+export type MeSuccessResponse = StandardReturn<MeResponseData>;
+//# sourceMappingURL=types.d.ts.map