@nu-art/db-api-generator/shared/apiV2.d.ts

db-api-generator

import { FirestoreQuery } from '@nu-art/firebase';
import { ApiDefResolver, BodyApi, QueryApi } from '@nu-art/thunderstorm';
import { DB_BaseObject, DB_Object, DBDef, IndexKeys, Metadata, PreDB } from '@nu-art/ts-common';
import { Response_DBSync, UpgradeCollectionBody } from './api';
/**
 * !! Workaround !!
 *
 * there is a typescript bug... should be able to use
 *
 * upsert: BodyApi<DBType, PreDB<DBType>>,
 * patch: BodyApi<DBType, PreDB<DBType>>
 *
 * but something about the type resolution goes wrong and instead of seeing Type<GenericType>, it resolves to Type> which makes no sense
 */
export type ApiStruct_DBApiGenV2<DBType extends DB_Object> = {
    v1: {
        sync: BodyApi<DBType[], FirestoreQuery<DBType>, undefined>;
        query: BodyApi<DBType[], FirestoreQuery<DBType>, FirestoreQuery<DBType> | undefined | {}>;
        queryUnique: QueryApi<DBType, DB_BaseObject, string>;
        upsert: BodyApi<DBType, PreDB<DBType>>;
        upsertAll: BodyApi<DBType[], PreDB<DBType>[]>;
        patch: BodyApi<DBType, PreDB<DBType>>;
        delete: QueryApi<DBType, DB_BaseObject>;
        deleteQuery: BodyApi<DBType[], FirestoreQuery<DBType>>;
        deleteAll: QueryApi<void>;
        upgradeCollection: BodyApi<void, UpgradeCollectionBody>;
        metadata: QueryApi<Metadata<DBType>>;
    };
};
export type ApiStruct_DBApiGenIDBV2<DBType extends DB_Object, Ks extends keyof DBType> = {
    v1: {
        sync: BodyApi<Response_DBSync<DBType>, FirestoreQuery<DBType>, undefined>;
        query: BodyApi<DBType[], FirestoreQuery<DBType>>;
        queryUnique: QueryApi<DBType, DB_BaseObject, string | IndexKeys<DBType, Ks>>;
        upsert: BodyApi<DBType, PreDB<DBType>>;
        upsertAll: BodyApi<DBType[], PreDB<DBType>[]>;
        patch: BodyApi<DBType, IndexKeys<DBType, Ks> & Partial<DBType>>;
        delete: QueryApi<DBType | undefined, DB_BaseObject>;
        deleteQuery: BodyApi<DBType[], FirestoreQuery<DBType>>;
        deleteAll: QueryApi<DBType[]>;
        upgradeCollection: BodyApi<void, UpgradeCollectionBody>;
        metadata: QueryApi<Metadata<DBType>>;
    };
};
export declare const DBApiDefGeneratorV2: <DBType extends DB_Object>(dbDef: DBDef<DBType, "_id">) => import("@nu-art/thunderstorm").ApiDefRouter<ApiStruct_DBApiGenV2<DBType>>;
export declare const DBApiDefGeneratorIDBV2: <DBType extends DB_Object, Ks extends keyof DBType>(dbDef: DBDef<DBType, Ks>) => import("@nu-art/thunderstorm").ApiDefRouter<ApiStruct_DBApiGenIDBV2<DBType, Ks>>;