@xata.io/client 0.0.0-alpha.fed4b2b → 0.0.0-beta.036d273

package/dist/schema/repository.d.ts

@@ -1,73 +1,135 @@
 import { FetchImpl } from '../api/fetcher';
+import { Dictionary, GetArrayInnerType, StringKeys } from '../util/types';
 import { Page } from './pagination';
 import { Query } from './query';
-import { BaseData, XataRecord } from './record';
-import { SelectedRecordPick } from './selection';
-export declare type Links = Record<string, Array<string[]>>;
+import { BaseData, EditableData, Identifiable, XataRecord } from './record';
+import { SelectedPick } from './selection';
+declare type TableLink = string[];
+export declare type LinkDictionary = Dictionary<TableLink[]>;
 /**
  * Common interface for performing operations on a table.
  */
-export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedRecordPick<Record, ['*']>> {
-    abstract create(object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
+export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
+    abstract create(object: EditableData<Data> & Partial<Identifiable>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates a single record in the table with a unique id.
+     * @param id The unique id.
+     * @param object Object containing the column names with their values to be stored in the table.
+     * @returns The full persisted record.
+     */
+    abstract create(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     /**
      * Creates multiple records in the table.
      * @param objects Array of objects with the column names and the values to be stored in the table.
      * @returns Array of the persisted records.
      */
-    abstract createMany(objects: BuildData<Data>[]): Promise<SelectedRecordPick<Record, ['*']>[]>;
+    abstract create(objects: Array<EditableData<Data> & Partial<Identifiable>>): Promise<SelectedPick<Record, ['*']>[]>;
     /**
      * Queries a single record from the table given its unique id.
      * @param id The unique id.
      * @returns The persisted record for the given id or null if the record could not be found.
      */
-    abstract read(id: string): Promise<SelectedRecordPick<Record, ['*']> | null>;
+    abstract read(id: string): Promise<SelectedPick<Record, ['*']> | null>;
     /**
-     * Insert a single record with a unique id.
-     * @param id The unique id.
-     * @param object Object containing the column names with their values to be stored in the table.
+     * Partially update a single record.
+     * @param object An object with its id and the columns to be updated.
      * @returns The full persisted record.
      */
-    abstract insert(id: string, object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
+    abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     /**
      * Partially update a single record given its unique id.
      * @param id The unique id.
-     * @param object The column names and their values that have to be updatd.
+     * @param object The column names and their values that have to be updated.
      * @returns The full persisted record.
      */
-    abstract update(id: string, object: Partial<BuildData<Data>>): Promise<SelectedRecordPick<Record, ['*']>>;
+    abstract update(id: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
     /**
-     * Updates or inserts a single record. If a record exists with the given id,
+     * Partially updates multiple records.
+     * @param objects An array of objects with their ids and columns to be updated.
+     * @returns Array of the persisted records.
+     */
+    abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param object Object containing the column names with their values to be persisted in the table.
+     * @returns The full persisted record.
+     */
+    abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
      * @param id A unique id.
      * @param object The column names and the values to be persisted.
      * @returns The full persisted record.
      */
-    abstract updateOrInsert(id: string, object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
+    abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param objects Array of objects with the column names and the values to be stored in the table.
+     * @returns Array of the persisted records.
+     */
+    abstract createOrUpdate(objects: Array<EditableData<Data> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
     /**
      * Deletes a record given its unique id.
      * @param id The unique id.
      * @throws If the record could not be found or there was an error while performing the deletion.
      */
-    abstract delete(id: string): void;
-    abstract query(query: Query<Record, SelectedRecordPick<Record, ['*']>>): Promise<Page<Record, SelectedRecordPick<Record, ['*']>>>;
+    abstract delete(id: string): Promise<void>;
+    /**
+     * Deletes a record given its unique id.
+     * @param id An object with a unique id.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(id: Identifiable): Promise<void>;
+    /**
+     * Deletes a record given a list of unique ids.
+     * @param ids The array of unique ids.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(ids: string[]): Promise<void>;
+    /**
+     * Deletes a record given a list of unique ids.
+     * @param ids An array of objects with unique ids.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(ids: Identifiable[]): Promise<void>;
+    /**
+     * Search for records in the table.
+     * @param query The query to search for.
+     * @param options The options to search with (like: fuzziness)
+     * @returns The found records.
+     */
+    abstract search(query: string, options?: {
+        fuzziness?: number;
+    }): Promise<SelectedPick<Record, ['*']>[]>;
+    abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
-export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedRecordPick<Record, ['*']>> {
+export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
     #private;
-    constructor(client: BaseClient<any>, table: string);
-    create(object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
-    createMany(objects: BuildData<Data>[]): Promise<SelectedRecordPick<Record, ['*']>[]>;
-    read(recordId: string): Promise<SelectedRecordPick<Record, ['*']> | null>;
-    update(recordId: string, object: Partial<BuildData<Data>>): Promise<SelectedRecordPick<Record, ['*']>>;
-    insert(recordId: string, object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
-    updateOrInsert(recordId: string, object: BuildData<Data>): Promise<SelectedRecordPick<Record, ['*']>>;
-    delete(recordId: string): Promise<void>;
-    query(query: Query<Record, SelectedRecordPick<Record, ['*']>>): Promise<Page<Record, SelectedRecordPick<Record, ['*']>>>;
+    constructor(client: BaseClient<any>, table: string, links?: LinkDictionary);
+    create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
+    update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
+    update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
+    createOrUpdate(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    delete(recordId: string | Identifiable | Array<string | Identifiable>): Promise<void>;
+    search(query: string, options?: {
+        fuzziness?: number;
+    }): Promise<SelectedPick<Record, ['*']>[]>;
+    query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
 interface RepositoryFactory {
-    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string, links?: LinkDictionary): Repository<Data & XataRecord>;
 }
 export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string, links?: LinkDictionary): Repository<Data & XataRecord>;
 }
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
@@ -82,26 +144,22 @@ export declare type XataClientOptions = {
      */
     fetch?: FetchImpl;
     databaseURL?: string;
-    branch: BranchStrategyOption;
+    branch?: BranchStrategyOption;
     /**
      * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
      */
-    apiKey: string;
+    apiKey?: string;
     repositoryFactory?: RepositoryFactory;
 };
 export declare class BaseClient<D extends Record<string, Repository<any>> = Record<string, Repository<any>>> {
-    #private;
     options: XataClientOptions;
     db: D;
-    constructor(options: XataClientOptions, links?: Links);
-    initObject<T>(table: string, object: object): T;
-    getBranch(): Promise<string>;
+    constructor(options?: XataClientOptions, links?: LinkDictionary);
+    search<Tables extends StringKeys<D>>(query: string, options?: {
+        fuzziness?: number;
+        tables?: Tables[];
+    }): Promise<{
+        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]: Awaited<ReturnType<D[Model]['search']>>;
+    }>;
 }
-declare type BuildData<O extends BaseData> = {
-    [K in keyof O]: O[K] extends XataRecord ? {
-        id: string;
-    } : NonNullable<O[K]> extends XataRecord ? {
-        id: string;
-    } | undefined : O[K];
-};
 export {};