@xata.io/client 0.6.0 → 0.7.2

package/dist/schema/operators.d.ts

@@ -1,72 +1,74 @@
-import { Constraint } from './filters';
-declare type ComparableType = number | Date;
+import { ArrayFilter, ComparableType, ComparableTypeFilter, ExistanceFilter, PropertyFilter, StringTypeFilter } from './filters';
+import { SelectableColumn } from './selection';
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
-export declare const gt: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const gt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const ge: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const ge: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const gte: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const gte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than the given value.
  */
-export declare const lt: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const lt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const lte: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const lte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const le: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are not null.
  */
-export declare const exists: (column: string) => Constraint<string>;
+export declare const exists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that are null.
  */
-export declare const notExists: (column: string) => Constraint<string>;
+export declare const notExists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that start with the given prefix.
  */
-export declare const startsWith: (value: string) => Constraint<string>;
+export declare const startsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that end with the given suffix.
  */
-export declare const endsWith: (value: string) => Constraint<string>;
+export declare const endsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that match the given pattern.
  */
-export declare const pattern: (value: string) => Constraint<string>;
+export declare const pattern: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that are equal to the given value.
  */
-export declare const is: <T>(value: T) => Constraint<T>;
+export declare const is: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that are not equal to the given value.
  */
-export declare const isNot: <T>(value: T) => Constraint<T>;
+export declare const isNot: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that contain the given value.
  */
-export declare const contains: <T>(value: T) => Constraint<T>;
+export declare const contains: (value: string) => StringTypeFilter;
 /**
- * Operator to restrict results to only arrays that include the given value.
+ * Operator to restrict results if some array items match the predicate.
  */
-export declare const includes: (value: string) => Constraint<string>;
+export declare const includes: <T>(value: T) => ArrayFilter<T>;
 /**
- * Operator to restrict results to only arrays that include a value matching the given substring.
+ * Operator to restrict results if all array items match the predicate.
  */
-export declare const includesSubstring: (value: string) => Constraint<string>;
+export declare const includesAll: <T>(value: T) => ArrayFilter<T>;
 /**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
+ * Operator to restrict results if none array items match the predicate.
  */
-export declare const includesPattern: (value: string) => Constraint<string>;
-export declare const includesAll: (value: string) => Constraint<string>;
-export {};
+export declare const includesNone: <T>(value: T) => ArrayFilter<T>;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+export declare const includesAny: <T>(value: T) => ArrayFilter<T>;

package/dist/schema/operators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
+exports.includesAny = exports.includesNone = exports.includesAll = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
@@ -71,21 +71,23 @@ exports.isNot = isNot;
  */
 const contains = (value) => ({ $contains: value });
 exports.contains = contains;
-// TODO: these can only be applied to columns of type "multiple"
 /**
- * Operator to restrict results to only arrays that include the given value.
+ * Operator to restrict results if some array items match the predicate.
  */
 const includes = (value) => ({ $includes: value });
 exports.includes = includes;
 /**
- * Operator to restrict results to only arrays that include a value matching the given substring.
+ * Operator to restrict results if all array items match the predicate.
  */
-const includesSubstring = (value) => ({ $includesSubstring: value });
-exports.includesSubstring = includesSubstring;
-/**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
- */
-const includesPattern = (value) => ({ $includesPattern: value });
-exports.includesPattern = includesPattern;
 const includesAll = (value) => ({ $includesAll: value });
 exports.includesAll = includesAll;
+/**
+ * Operator to restrict results if none array items match the predicate.
+ */
+const includesNone = (value) => ({ $includesNone: value });
+exports.includesNone = includesNone;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+const includesAny = (value) => ({ $includesAny: value });
+exports.includesAny = includesAny;

package/dist/schema/query.d.ts

@@ -1,10 +1,11 @@
 import { FilterExpression } from '../api/schemas';
 import { NonEmptyArray, RequiredBy } from '../util/types';
-import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
+import { Filter } from './filters';
 import { Page, Paginable, PaginationOptions, PaginationQueryMeta } from './pagination';
 import { XataRecord } from './record';
 import { Repository } from './repository';
 import { SelectableColumn, SelectedPick, ValueAtColumn } from './selection';
+import { SortDirection, SortFilter } from './sorting';
 export declare type QueryOptions<T extends XataRecord> = {
     page?: PaginationOptions;
     columns?: NonEmptyArray<SelectableColumn<T>>;
@@ -28,25 +29,25 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    any(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    any(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical AND between the given subqueries.
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    all(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    all(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    not(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    not(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    none(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    none(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object adding one or more constraints. Examples:
      *
@@ -60,11 +61,10 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord
      * })
      * ```
      *
-     * @param constraints
      * @returns A new Query object.
      */
-    filter(constraints: FilterConstraints<Record>): Query<Record, Result>;
-    filter<F extends SelectableColumn<Record>>(column: F, value: FilterConstraints<ValueAtColumn<Record, F>> | DeepConstraint<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    filter(filters: Filter<Record>): Query<Record, Result>;
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.

package/dist/schema/record.d.ts

@@ -62,5 +62,5 @@ export declare type EditableData<O extends BaseData> = {
         id: string;
     } : NonNullable<O[K]> extends XataRecord ? {
         id: string;
-    } | undefined : O[K];
+    } | null | undefined : O[K];
 };

package/dist/schema/repository.d.ts

@@ -1,9 +1,11 @@
 import { FetchImpl } from '../api/fetcher';
+import { Dictionary, GetArrayInnerType, StringKeys } from '../util/types';
 import { Page } from './pagination';
 import { Query } from './query';
 import { BaseData, EditableData, Identifiable, XataRecord } from './record';
 import { SelectedPick } from './selection';
-export declare type Links = Record<string, Array<string[]>>;
+declare type TableLink = string[];
+export declare type LinkDictionary = Dictionary<TableLink[]>;
 /**
  * Common interface for performing operations on a table.
  */
@@ -21,20 +23,39 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @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: EditableData<Data>[]): Promise<SelectedPick<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<SelectedPick<Record, ['*']> | null>;
+    /**
+     * Partially update a single record.
+     * @param object An object with its id and the columns to be updated.
+     * @returns The full persisted 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<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, ['*']>[]>;
+    /**
+     * 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.
@@ -43,31 +64,72 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @returns The full persisted 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 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, SelectedPick<Record, ['*']>> {
     #private;
-    constructor(client: BaseClient<any>, table: string);
+    constructor(client: BaseClient<any>, table: string, links?: LinkDictionary);
     create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
-    createMany(objects: 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, ['*']>>;
-    delete(recordId: string): Promise<void>;
+    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,19 +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']>>;
+    }>;
 }
 export {};