payload-rest-client/dist/types.d.ts

A typesafe rest api client for the payload cms.

import { CE_To_CEFactory, CustomEndpoints } from "./customEndpoints";
export type Config = {
    collections: {
        [k: string]: any;
    };
    collectionsSelect: {
        [k: string]: any;
    };
    collectionsJoins: {
        [k: string]: {
            [k: string]: string;
        };
    };
    globals: {
        [k: string]: any;
    };
    globalsSelect: {
        [k: string]: any;
    };
};
export type Doc = {
    id: string | number;
};
export type DocWithAuth = {
    email: string;
    password?: string | null;
};
export type Collections<CONFIG extends Config> = CONFIG["collections"];
export type CollectionsJoins<CONFIG extends Config> = CONFIG["collectionsJoins"];
export type CollectionsSelect<CONFIG extends Config> = CONFIG["collectionsSelect"];
export type Globals<CONFIG extends Config> = CONFIG["globals"];
export type GlobalsSelect<CONFIG extends Config> = CONFIG["globalsSelect"];
export type CollectionsApi<CONFIG extends Config, LOCALES, DOC extends Doc, JOINS, SELECT> = {
    find: (params?: FindParams<CONFIG, LOCALES, DOC, JOINS, SELECT>) => Promise<FindResult<DOC>>;
    findById: (params: FindByIdParams<CONFIG, LOCALES, DOC, JOINS, SELECT>) => Promise<DOC>;
    count: (params: CountParams<DOC>) => Promise<CountResult>;
    create: (params: CreateParams<LOCALES, DOC>) => Promise<CreateResult<DOC>>;
    createDraft: (params: CreateDraftParams<LOCALES, DOC>) => Promise<CreateDraftResult<DOC>>;
    update: (params: UpdateParams<LOCALES, DOC>) => Promise<UpdateResult<DOC>>;
    updateById: (params: UpdateByIdParams<LOCALES, DOC>) => Promise<UpdateByIdResult<DOC>>;
    delete: (params?: DeleteParams<LOCALES, DOC>) => Promise<DeleteResult<DOC>>;
    deleteById: (params: DeleteByIdParams<LOCALES, DOC>) => Promise<DOC>;
};
export type CollectionsWithAuthApi<CONFIG extends Config, LOCALES, DOC extends Doc, JOINS, SELECT> = CollectionsApi<CONFIG, LOCALES, DOC, JOINS, SELECT> & {
    login: (params: LoginParams) => Promise<LoginResult<DOC>>;
    logout: (params: LogoutParams) => Promise<LogoutResult>;
    unlock: (params: UnlockParams) => Promise<UnlockResult>;
    "refresh-token": (params: RefreshTokenParams) => Promise<RefreshTokenResult<DOC>>;
    me: (params: MeParams) => Promise<MeResult<DOC>>;
    "forgot-password": (params: ForgotPasswordParams) => Promise<ForgotPasswordResult>;
    "reset-password": (params: ResetPasswordParams) => Promise<ResetPasswordResult<DOC>>;
};
export type GlobalsApi<LOCALES, GLOBAL> = {
    get: (params?: BaseParams<LOCALES>) => Promise<GLOBAL>;
    update: (params: UpdateGlobalParams<LOCALES, GLOBAL>) => Promise<GLOBAL>;
};
export type RPC<CONFIG extends Config, LOCALES, CE> = {
    collections: {
        [P in keyof Collections<CONFIG>]: Collections<CONFIG>[P] extends DocWithAuth ? CollectionsWithAuthApi<CONFIG, LOCALES, Collections<CONFIG>[P], CollectionsJoins<CONFIG>[P], CollectionsSelect<CONFIG>[P]> : CollectionsApi<CONFIG, LOCALES, Collections<CONFIG>[P], CollectionsJoins<CONFIG>[P], CollectionsSelect<CONFIG>[P]>;
    };
    globals: {
        [P in keyof Globals<CONFIG>]: GlobalsApi<LOCALES, Globals<CONFIG>[P]>;
    };
    access: AccessApi<Collections<CONFIG>, Globals<CONFIG>>;
    custom: CE;
};
export type GetAdditionalFetchOptionsParams = {
    type?: "collection" | "global" | "custom";
    slug?: string;
    method: string;
    url: string;
};
export type ClientOptions<CE extends CustomEndpoints = any> = {
    apiUrl: string;
    cache?: RequestCache;
    headers?: HeadersInit;
    debug?: boolean;
    getAdditionalFetchOptions?: (params: GetAdditionalFetchOptionsParams) => any;
    customFetchFn?: typeof fetch;
    customEndpoints?: CE_To_CEFactory<CE>;
};
export type MessageResult = {
    message: string;
};
export type Operand<T> = {
    equals: T;
} | {
    not_equals: T;
} | {
    greater_than: T;
} | {
    greater_than_equal: T;
} | {
    less_than: T;
} | {
    less_than_equal: T;
} | {
    like: string;
} | {
    contains: string;
} | {
    in: string;
} | {
    not_in: string;
} | {
    all: string;
} | {
    exists: boolean;
} | {
    near: string;
};
export type Filter<T> = {
    [P in keyof T]?: Operand<T[P]>;
} | {
    and: Array<Filter<T>>;
} | {
    or: Array<Filter<T>>;
};
export type JoinParams<DOC extends Doc> = {
    sort?: keyof DOC extends string ? keyof DOC | `-${keyof DOC}` : never;
    where?: Filter<DOC>;
    limit?: number;
};
export type BaseParams<LOCALES> = {
    depth?: number;
    locale?: LOCALES;
    fallbackLocale?: LOCALES | "null" | "false" | "none";
    [p: string]: any;
};
export type FindParams<CONFIG extends Config, LOCALES, DOC extends Doc, JOINS, SELECT> = BaseParams<LOCALES> & {
    sort?: keyof DOC extends string ? keyof DOC | `-${keyof DOC}` : never;
    where?: Filter<DOC>;
    limit?: number;
    page?: number;
    select?: SELECT;
    populate?: Partial<CollectionsSelect<CONFIG>>;
    joins?: {
        [P in keyof JOINS]?: JOINS[P] extends keyof Collections<CONFIG> ? JoinParams<Collections<CONFIG>[JOINS[P]]> : never;
    };
};
export type FindByIdParams<CONFIG extends Config, LOCALES, DOC extends Doc, JOINS, SELECT> = BaseParams<LOCALES> & {
    id: DOC["id"];
    select?: SELECT;
    populate?: Partial<CollectionsSelect<CONFIG>>;
    joins?: {
        [P in keyof JOINS]?: JOINS[P] extends keyof Collections<CONFIG> ? JoinParams<Collections<CONFIG>[JOINS[P]]> : never;
    };
};
export type FindResult<DOC extends Doc> = {
    docs: DOC[];
    totalDocs: number;
    limit: number;
    totalPages: number;
    page?: number;
    pagingCounter: number;
    hasPrevPage: boolean;
    hasNextPage: boolean;
    prevPage?: number | null | undefined;
    nextPage?: number | null | undefined;
};
export type CountParams<DOC extends Doc> = {
    where?: Filter<DOC>;
    [p: string]: any;
};
export type CountResult = {
    totalDocs: number;
};
export type CreateParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    draft?: false;
    doc: Omit<DOC, "id" | "createdAt" | "updatedAt"> & {
        id?: string;
        createdAt?: string;
        updatedAt?: string;
    };
};
export type CreateResult<DOC extends Doc> = {
    message: string;
    doc: DOC;
};
export type CreateDraftParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    doc: Partial<CreateParams<LOCALES, DOC>["doc"]>;
};
export type CreateDraftResult<DOC extends Doc> = {
    message: string;
    doc: Partial<DOC>;
};
export type UpdateParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    patch: Partial<DOC>;
    where?: Filter<DOC>;
};
export type UpdateResult<DOC extends Doc> = {
    docs: DOC[];
    errors: string[];
};
export type UpdateByIdParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    id: DOC["id"];
    patch: Partial<DOC>;
};
export type UpdateGlobalParams<LOCALES, GLOBAL> = BaseParams<LOCALES> & {
    patch: Partial<GLOBAL>;
};
export type UpdateByIdResult<DOC extends Doc> = {
    message: string;
    doc: DOC;
};
export type DeleteParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    where?: Filter<DOC>;
};
export type DeleteByIdParams<LOCALES, DOC extends Doc> = BaseParams<LOCALES> & {
    id: DOC["id"];
};
export type DeleteResult<DOC extends Doc> = {
    docs: DOC[];
    errors: string[];
};
export type LoginParams = {
    email: string;
    password: string;
};
export type LoginResult<DOC extends Doc> = {
    message: string;
    user: DOC;
    token: string;
    exp: number;
};
export type LogoutParams = void;
export type LogoutResult = MessageResult;
export type UnlockParams = {
    email: string;
};
export type UnlockResult = MessageResult;
export type RefreshTokenParams = void;
export type RefreshTokenResult<DOC extends Doc> = {
    message: string;
    refreshedToken: string;
    exp: number;
    user: {
        id: DOC["id"];
        email: string;
        collection: string;
    };
};
export type MeParams = void;
export type MeResult<DOC extends Doc> = {
    collection: string;
    user: DOC & {
        _strategy: string;
    };
    token: string;
    exp: number;
};
export type ForgotPasswordParams = {
    email: string;
};
export type ForgotPasswordResult = MessageResult;
export type ResetPasswordParams = {
    token: string;
    password: string;
};
export type ResetPasswordResult<DOC extends Doc> = {
    message: string;
    user: DOC;
    token: string;
};
type JoinField = {
    hasNextPage?: boolean | null;
};
type AccessSettings = {
    create?: true;
    read?: true;
    update?: true;
};
type MapFieldsToAccessSettings<T> = {
    [P in keyof T]-?: P extends "id" ? never : T[P] extends JoinField ? true | AccessSettings : T[P] extends object | undefined ? MapFieldsToAccessSettings<T[P]> : true | AccessSettings;
};
type MapCollectionToAccessSettings<T> = {
    fields: true | MapFieldsToAccessSettings<T>;
    create?: true;
    read?: true;
    update?: true;
    delete?: true;
};
type MapGlobalsToAccessSettings<T> = {
    fields: true | MapFieldsToAccessSettings<T>;
    read?: true;
    update?: true;
};
type AccessResult<COLLECTIONS, GLOBALS> = {
    [P in keyof COLLECTIONS]: MapCollectionToAccessSettings<COLLECTIONS[P]>;
} & {
    [P in keyof GLOBALS]: MapGlobalsToAccessSettings<GLOBALS[P]>;
};
type AccessApi<COLLECTIONS, GLOBALS> = () => Promise<AccessResult<COLLECTIONS, GLOBALS>>;
export {};