@xata.io/client 0.0.0-beta.26144eb → 0.0.0-beta.2ab8b47

package/dist/schema/record.d.ts

@@ -1,4 +1,4 @@
-import { Selectable } from './selection';
+import { SelectedPick } from './selection';
 /**
  * Represents an identifiable record from the database.
  */
@@ -8,6 +8,9 @@ export interface Identifiable {
      */
     id: string;
 }
+export interface BaseData {
+    [key: string]: any;
+}
 /**
  * Represents a persisted record from the database.
  */
@@ -24,14 +27,14 @@ export interface XataRecord extends Identifiable {
     /**
      * Retrieves a refreshed copy of the current record from the database.
      */
-    read(): Promise<this>;
+    read(): Promise<SelectedPick<this, ['*']> | null>;
     /**
      * Performs a partial update of the current record. On success a new object is
      * returned and the current object is not mutated.
      * @param data The columns and their values that have to be updated.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
-    update(data: Partial<Selectable<this>>): Promise<this>;
+    update(data: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<SelectedPick<this, ['*']>>;
     /**
      * Performs a deletion of the current record in the database.
      *
@@ -39,3 +42,25 @@ export interface XataRecord extends Identifiable {
      */
     delete(): Promise<void>;
 }
+export declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update'> & {
+    /**
+     * Retrieves a refreshed copy of the current record from the database.
+     */
+    read(): Promise<SelectedPick<Record, ['*']> | null>;
+    /**
+     * Performs a partial update of the current record. On success a new object is
+     * returned and the current object is not mutated.
+     * @param data The columns and their values that have to be updated.
+     * @returns A new record containing the latest values for all the columns of the current record.
+     */
+    update(data: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<SelectedPick<Record, ['*']>>;
+};
+export declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
+export declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
+export declare type EditableData<O extends BaseData> = {
+    [K in keyof O]: O[K] extends XataRecord ? {
+        id: string;
+    } : NonNullable<O[K]> extends XataRecord ? {
+        id: string;
+    } | null | undefined : O[K];
+};

package/dist/schema/record.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isXataRecord = exports.isIdentifiable = void 0;
+const lang_1 = require("../util/lang");
+function isIdentifiable(x) {
+    return (0, lang_1.isObject)(x) && (0, lang_1.isString)(x === null || x === void 0 ? void 0 : x.id);
+}
+exports.isIdentifiable = isIdentifiable;
+function isXataRecord(x) {
+    var _a;
+    return (isIdentifiable(x) && typeof (x === null || x === void 0 ? void 0 : x.xata) === 'object' && typeof ((_a = x === null || x === void 0 ? void 0 : x.xata) === null || _a === void 0 ? void 0 : _a.version) === 'number');
+}
+exports.isXataRecord = isXataRecord;

package/dist/schema/repository.d.ts

@@ -1,109 +1,134 @@
-import { FetchImpl } from '../api/fetcher';
+import { SchemaNamespaceResult } from '.';
+import { FetcherExtraProps } from '../api/fetcher';
+import { Dictionary } from '../util/types';
 import { Page } from './pagination';
-import { Query, QueryOptions } from './query';
-import { XataRecord } from './record';
-import { Selectable, SelectableColumn, Select } from './selection';
-export declare type Links = Record<string, Array<string[]>>;
+import { Query } from './query';
+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<T extends XataRecord> extends Query<T> {
+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 record in the table.
+     * 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(object: Selectable<T>): Promise<T>;
+    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: Selectable<T>[]): Promise<T[]>;
+    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<T | 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: Selectable<T>): Promise<T>;
+    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<Selectable<T>>): Promise<T>;
+    abstract update(id: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * 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, ['*']>[]>;
     /**
-     * Updates or inserts a single record. If a record exists with the given id,
+     * 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: Selectable<T>): Promise<T>;
+    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<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R>>;
-}
-export declare class RestRepository<T extends XataRecord> extends Repository<T> {
-    #private;
-    constructor(client: BaseClient<any>, table: string);
-    create(object: Selectable<T>): Promise<T>;
-    createMany(objects: T[]): Promise<T[]>;
-    read(recordId: string): Promise<T | null>;
-    update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
-    insert(recordId: string, object: Selectable<T>): Promise<T>;
-    updateOrInsert(recordId: string, object: Selectable<T>): Promise<T>;
-    delete(recordId: string): Promise<void>;
-    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options?: Options): Promise<Page<T, typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R>>;
-}
-interface RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
-}
-export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
-}
-declare type BranchStrategyValue = string | undefined | null;
-declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
-declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
-declare type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
-export declare type XataClientOptions = {
+    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>;
     /**
-     * Fetch implementation. This option is only required if the runtime does not include a fetch implementation
-     * available in the global scope. If you are running your code on Deno or Cloudflare workers for example,
-     * you won't need to provide a specific fetch implementation. But for most versions of Node.js you'll need
-     * to provide one. Such as cross-fetch, node-fetch or isomorphic-fetch.
+     * 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.
      */
-    fetch?: FetchImpl;
-    databaseURL?: string;
-    branch: BranchStrategyOption;
+    abstract delete(ids: string[]): Promise<void>;
     /**
-     * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
+     * 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.
      */
-    apiKey: string;
-    repositoryFactory?: RepositoryFactory;
-};
-export declare class BaseClient<D extends Record<string, Repository<any>>> {
+    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, SelectedPick<Record, ['*']>> {
     #private;
-    options: XataClientOptions;
-    db: D;
-    constructor(options: XataClientOptions, links?: Links);
-    initObject<T>(table: string, object: object): T;
-    getBranch(): Promise<string>;
+    constructor(options: {
+        table: string;
+        links?: LinkDictionary;
+        getFetchProps: () => Promise<FetcherExtraProps>;
+        schemaNamespace: SchemaNamespaceResult<any>;
+    });
+    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>>;
 }
 export {};