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

package/dist/schema/filters.spec.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Single column with implicit is
+const singleColumnWithImplicitIs = { name: 'r2' };
+// Single column with explicit is
+const singleColumnWithExplicitIs = { name: { $is: 'r2' } };
+// Is string
+const isString = { string: 'string' };
+// Is true
+const isTrue = { boolean: true };
+// Is false
+const isFalse = { boolean: false };
+// Is pos int
+const isPosInt = { number: 1234567 };
+// Is neg int
+const isNegInt = { number: -42 };
+// Is float
+const isFloat = { number: 3.14 };
+//  with dots
+const withDots = { 'settings.plan': 'free' };
+// Nested columns
+const nestedColumns = { settings: { plan: 'free' } };
+// Nested columns array
+const nestedColumnsArray = { settings: [{ dark: false }, { plan: 'free' }] };
+// Nested columns any
+const nestedColumnsAny = { settings: { $any: [{ plan: 'free' }, { plan: 'trial' }] } };
+// Nested columns any value
+const nestedColumnsAnyValue = { settings: { plan: { $any: ['free', 'trial'] } } };
+// Or with $any
+const orWithAny = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Multiple columns implicit and
+const multipleColumnsImplicitAnd = { 'settings.dark': true, 'settings.plan': 'free' };
+// Explicit $all with multi-key filter list
+const explicitAllWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $all with filter list
+const explicitAllWithFilterList = {
+    $all: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// Explicit $any with multi-key filter list
+const explicitAnyWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $any with filter list
+const explicitAnyWithFilterList = {
+    $any: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// $any with multiple values
+const anyWithMultipleValues = { number: { $any: [1, 2, 3] } };
+// $none with multiple values
+const noneWithMultipleValues = { number: { $none: [1, 2, 3] } };
+// Exists filter
+const existsFilter = { $exists: 'test' };
+// Not exists filter
+const notExistsFilter = { $notExists: 'test' };
+// Exists with all
+const existsWithAll = { $all: [{ $exists: 'settings' }, { $exists: 'name' }] };
+// Nest any with not
+const nestAnyWithNot = { $not: { $any: { 'settings.dark': true, 'settings.plan': 'free' } } };
+// Mix $all and $any with extra keys
+const mixAllAndAnyWithExtraKeys = {
+    $all: { $any: { 'settings.dark': false, 'settings.plan': 'free' }, name: 'r1' }
+};
+// Range query with less first
+const rangeQueryWithLessFirst = { age: { $lt: 30, $ge: 20 } };
+// Range query with greater first
+const rangeQueryWithGreaterFirst = { age: { $ge: 20, $lt: 30 } };
+// Ordered op
+const orderedOp = { age: { $lt: 30 } };
+// Simple includes
+const simpleIncludes = { labels: { $includes: 'test' } };
+// Simple includes with op
+const simpleIncludesWithOp = { labels: { $includes: { $contains: 'test' } } };
+// Simple includes multiple
+const simpleIncludesMultiple = { labels: { $includes: ['a', 'b', 'c'] } };
+// Simple includes multiple with op
+const simpleIncludesMultipleWithOp = {
+    labels: { $includes: [{ $is: 'a' }, { $is: 'b' }, { $is: 'c' }] }
+};
+// Includes with many comparisons
+const includesWithManyComparisons = {
+    labels: { $includes: { $all: [{ $contains: 'a' }, { $contains: 'b' }] } }
+};
+// Simple includes multiple op and value
+const simpleIncludesMultipleOpAndValue = { labels: { $includes: [{ $contains: 'a' }, 'b'] } };
+// Includes with mode and array of filters
+const includesWithModeAndArrayOfFilters = {
+    labels: { $includesNone: [{ $contains: 'test' }, 'abc', { $endsWith: 'bad' }] }
+};
+// Includes with mix of any and all in predicate position
+const includesWithMixOfAnyAndAllInPredicatePosition = {
+    labels: { $includes: { $any: { $all: [{ $startsWith: 'test' }, { $contains: 'x' }], $any: ['a', 'b'] } } }
+};
+// Simple $includesany
+const simpleIncludesAny = { labels: { $includesAny: 'test' } };
+// Simple $includesall
+const simpleIncludesAll = { labels: { $includesAll: 'test' } };
+// Simple $includesnone
+const simpleIncludesNone = { labels: { $includesNone: 'test' } };
+// Exists value must be string not int
+// @ts-expect-error
+const existsValueMustBeStringNotInt = { $exists: 42 };
+// Exists value must be string not objct
+// @ts-expect-error
+const existsValueMustBeStringNotObject = { $exists: { field: 'settings.unknown' } };
+// Filter by one column
+const filterByOneColumn = { name: 'r1' };
+// Filter with the $is operator
+const filterWithTheIsOperator = { name: { $is: 'r1' } };
+// Filter with dot notation
+const filterWithDotNotation = { 'settings.plan': 'free' };
+// Filter with nested object
+const filterWithNestedObject = { 'settings.plan': { $is: 'free' } };
+// Filter with $any operation
+const filterWithAnyOperation = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Filter with and operations
+const filterWithAndOperations = { 'settings.dark': true, 'settings.plan': 'free' };
+// Filter with both and and any operations
+const filterWithBothAndAndAnyOperations = {
+    $any: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Filter with both and and any operations in array
+const filterWithBothAndAndAnyOperationsInArray = { $any: [{ name: 'r1' }, { name: 'r2' }] };
+// Filter with exists operation
+const filterWithExistsOperation = { $exists: 'settings' };
+// Filter with exists, and and any operations
+const filterWithExistsAndAndAnyOperations = {
+    $all: [{ $exists: 'settings' }, { $exists: 'name' }]
+};
+// Filter with not exists operation
+const filterWithNotExistsOperation = { $notExists: 'settings' };
+// Filter with partial match
+const filterWithPartialMatch = { name: { $contains: 'value' } };
+// Filter with pattern operator
+const filterWithPatternOperator = { name: { $pattern: 'value' } };
+// Filter with $startsWith and $endsWith operators
+const filterWithStartsWithAndEndsWithOperators = {
+    name: { $startsWith: 'value', $endsWith: 'value' }
+};
+// Filter with numeric ranges
+const filterWithNumericRanges = { age: { $lt: 30, $ge: 20 } };
+// Filter with negations
+const filterWithNegations = { $not: { name: 'r1' } };
+// Filter with complex negations
+const filterWithComplexNegations = { $not: { $any: [{ name: 'r1' }, { name: 'r2' }] } };
+// Filter with arrays complex negations
+const filterWithArraysComplexNegations = {
+    labels: {
+        $includes: {
+            $all: [{ $contains: 'label' }, { $not: { $endsWith: '-debug' } }]
+        }
+    }
+};
+// Filters with $includesAll
+const filtersWithIncludesAll = {
+    'settings.labels': {
+        $includesAll: [{ $contains: 'label' }]
+    }
+};
+// Filter with invalid property type
+// @ts-expect-error
+const filterWithInvalidPropertyType = { name: 42 };
+// Filter with invalid dot notation property type
+// @ts-expect-error
+const filterWithInvalidNestedPropertyType = { 'settings.plan': 42 };
+// Filter with invalid nested object property type
+// @ts-expect-error
+const filterWithInvalidNestedObjectPropertyType = { settings: { plan: 42 } };
+// Filter with invalid property $is type
+// @ts-expect-error
+const filterWithInvalidOperator = { name: { $is: 42 } };
+test('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

package/dist/schema/index.d.ts

@@ -1,6 +1,7 @@
 export * from './operators';
 export * from './pagination';
 export { Query } from './query';
-export type { Identifiable, isIdentifiable, isXataRecord, XataRecord } from './record';
+export { isIdentifiable, isXataRecord } from './record';
+export type { Identifiable, XataRecord } from './record';
 export { BaseClient, Repository, RestRepository, RestRespositoryFactory } from './repository';
 export type { XataClientOptions } from './repository';

package/dist/schema/index.js

@@ -14,11 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.BaseClient = exports.Query = void 0;
+exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.BaseClient = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
 __exportStar(require("./operators"), exports);
 __exportStar(require("./pagination"), exports);
 var query_1 = require("./query");
 Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });
+var record_1 = require("./record");
+Object.defineProperty(exports, "isIdentifiable", { enumerable: true, get: function () { return record_1.isIdentifiable; } });
+Object.defineProperty(exports, "isXataRecord", { enumerable: true, get: function () { return record_1.isXataRecord; } });
 var repository_1 = require("./repository");
 Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
 Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });

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/pagination.js

@@ -77,7 +77,6 @@ class Page {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
         });
     }
-    // TODO: We need to add something on the backend if we want a hasPreviousPage
     /**
      * Shortcut method to check if there will be additional results if the next page of results is retrieved.
      * @returns Whether or not there will be additional results in the next page of results.

package/dist/schema/query.d.ts

@@ -1,15 +1,16 @@
 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, SelectedRecordPick, ValueAtColumn } from './selection';
+import { SelectableColumn, SelectedPick, ValueAtColumn } from './selection';
+import { SortDirection, SortFilter } from './sorting';
 export declare type QueryOptions<T extends XataRecord> = {
     page?: PaginationOptions;
     columns?: NonEmptyArray<SelectableColumn<T>>;
     filter?: FilterExpression;
-    sort?: SortFilter<T> | NonEmptyArray<SortFilter<T>>;
+    sort?: SortFilter<T> | SortFilter<T>[];
 };
 /**
  * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
@@ -17,7 +18,7 @@ export declare type QueryOptions<T extends XataRecord> = {
  * Query objects are immutable. Any method that adds more constraints or options to the query will return
  * a new Query object containing the both the previous and the new constraints and options.
  */
-export declare class Query<Record extends XataRecord, Result extends XataRecord> implements Paginable<Record, Result> {
+export declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
     #private;
     readonly meta: PaginationQueryMeta;
     readonly records: Result[];
@@ -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.
@@ -77,12 +77,14 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord>
      * @param columns Array of column names to be returned by the query.
      * @returns A new Query object.
      */
-    select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedRecordPick<Record, NonEmptyArray<K>>>;
+    select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
     getPaginated(): Promise<Page<Record, Result>>;
     getPaginated(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
-    getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedRecordPick<Record, typeof options['columns']>>>;
-    [Symbol.asyncIterator](): AsyncGenerator<Result, void, unknown>;
-    getIterator<Options extends QueryOptions<Record>>(chunk: number, options?: Omit<Options, 'page'>): AsyncGenerator<Result[], void, unknown>;
+    getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<Result>;
+    getIterator(chunk: number): AsyncGenerator<Result[]>;
+    getIterator(chunk: number, options: Omit<QueryOptions<Record>, 'columns' | 'page'>): AsyncGenerator<Result[]>;
+    getIterator<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(chunk: number, options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns a set of results.
      * @param options Additional options to be used when performing the query.
@@ -90,22 +92,24 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord>
      */
     getMany(): Promise<Result[]>;
     getMany(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
-    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedRecordPick<Record, typeof options['columns']>[]>;
+    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns all the results.
      * Warning: If there are a large number of results, this method can have performance implications.
      * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
-    getAll<Options extends QueryOptions<Record>>(chunk?: number, options?: Omit<Options, 'page'>): Promise<Result[]>;
+    getAll(chunk?: number): Promise<Result[]>;
+    getAll(chunk: number | undefined, options: Omit<QueryOptions<Record>, 'columns' | 'page'>): Promise<Result[]>;
+    getAll<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(chunk: number | undefined, options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns the first result.
      * @param options Additional options to be used when performing the query.
      * @returns The first record that matches the query, or null if no record matched the query.
      */
     getOne(): Promise<Result | null>;
-    getOne(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Result | null>;
-    getOne<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedRecordPick<Record, typeof options['columns']> | null>;
+    getOne(options: Omit<QueryOptions<Record>, 'columns' | 'page'>): Promise<Result | null>;
+    getOne<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;

package/dist/schema/query.js

@@ -51,7 +51,7 @@ const pagination_1 = require("./pagination");
  */
 class Query {
     constructor(repository, table, data, parent) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
         _Query_table.set(this, void 0);
         _Query_repository.set(this, void 0);
         _Query_data.set(this, { filter: {} });
@@ -65,14 +65,14 @@ class Query {
         else {
             __classPrivateFieldSet(this, _Query_repository, this, "f");
         }
-        __classPrivateFieldGet(this, _Query_data, "f").filter = {};
-        __classPrivateFieldGet(this, _Query_data, "f").filter.$any = (_b = (_a = data.filter) === null || _a === void 0 ? void 0 : _a.$any) !== null && _b !== void 0 ? _b : (_c = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _c === void 0 ? void 0 : _c.$any;
-        __classPrivateFieldGet(this, _Query_data, "f").filter.$all = (_e = (_d = data.filter) === null || _d === void 0 ? void 0 : _d.$all) !== null && _e !== void 0 ? _e : (_f = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _f === void 0 ? void 0 : _f.$all;
-        __classPrivateFieldGet(this, _Query_data, "f").filter.$not = (_h = (_g = data.filter) === null || _g === void 0 ? void 0 : _g.$not) !== null && _h !== void 0 ? _h : (_j = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _j === void 0 ? void 0 : _j.$not;
-        __classPrivateFieldGet(this, _Query_data, "f").filter.$none = (_l = (_k = data.filter) === null || _k === void 0 ? void 0 : _k.$none) !== null && _l !== void 0 ? _l : (_m = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _m === void 0 ? void 0 : _m.$none;
-        __classPrivateFieldGet(this, _Query_data, "f").sort = (_o = data.sort) !== null && _o !== void 0 ? _o : parent === null || parent === void 0 ? void 0 : parent.sort;
-        __classPrivateFieldGet(this, _Query_data, "f").columns = (_q = (_p = data.columns) !== null && _p !== void 0 ? _p : parent === null || parent === void 0 ? void 0 : parent.columns) !== null && _q !== void 0 ? _q : ['*'];
-        __classPrivateFieldGet(this, _Query_data, "f").page = (_r = data.page) !== null && _r !== void 0 ? _r : parent === null || parent === void 0 ? void 0 : parent.page;
+        __classPrivateFieldGet(this, _Query_data, "f").filter = (_b = (_a = data.filter) !== null && _a !== void 0 ? _a : parent === null || parent === void 0 ? void 0 : parent.filter) !== null && _b !== void 0 ? _b : {};
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$any = (_d = (_c = data.filter) === null || _c === void 0 ? void 0 : _c.$any) !== null && _d !== void 0 ? _d : (_e = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _e === void 0 ? void 0 : _e.$any;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$all = (_g = (_f = data.filter) === null || _f === void 0 ? void 0 : _f.$all) !== null && _g !== void 0 ? _g : (_h = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _h === void 0 ? void 0 : _h.$all;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$not = (_k = (_j = data.filter) === null || _j === void 0 ? void 0 : _j.$not) !== null && _k !== void 0 ? _k : (_l = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _l === void 0 ? void 0 : _l.$not;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$none = (_o = (_m = data.filter) === null || _m === void 0 ? void 0 : _m.$none) !== null && _o !== void 0 ? _o : (_p = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _p === void 0 ? void 0 : _p.$none;
+        __classPrivateFieldGet(this, _Query_data, "f").sort = (_q = data.sort) !== null && _q !== void 0 ? _q : parent === null || parent === void 0 ? void 0 : parent.sort;
+        __classPrivateFieldGet(this, _Query_data, "f").columns = (_s = (_r = data.columns) !== null && _r !== void 0 ? _r : parent === null || parent === void 0 ? void 0 : parent.columns) !== null && _s !== void 0 ? _s : ['*'];
+        __classPrivateFieldGet(this, _Query_data, "f").page = (_t = data.page) !== null && _t !== void 0 ? _t : parent === null || parent === void 0 ? void 0 : parent.page;
         this.any = this.any.bind(this);
         this.all = this.all.bind(this);
         this.not = this.not.bind(this);
@@ -143,7 +143,6 @@ class Query {
         var _a;
         const originalSort = [(_a = __classPrivateFieldGet(this, _Query_data, "f").sort) !== null && _a !== void 0 ? _a : []].flat();
         const sort = [...originalSort, { column, direction }];
-        // @ts-ignore
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { sort }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
     /**
@@ -156,7 +155,6 @@ class Query {
     }
     getPaginated(options = {}) {
         const query = new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), options, __classPrivateFieldGet(this, _Query_data, "f"));
-        // @ts-ignore
         return __classPrivateFieldGet(this, _Query_repository, "f").query(query);
     }
     [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
@@ -183,6 +181,7 @@ class Query {
             let end = false;
             while (!end) {
                 const { records, meta } = yield __await(this.getPaginated(Object.assign(Object.assign({}, options), { page: { size: chunk, offset } })));
+                // Method overloading does not provide type inference for the return type.
                 yield yield __await(records);
                 offset += chunk;
                 end = !meta.page.more;
@@ -192,16 +191,10 @@ class Query {
     getMany(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const { records } = yield this.getPaginated(options);
-            // @ts-ignore
+            // Method overloading does not provide type inference for the return type.
             return records;
         });
     }
-    /**
-     * Performs the query in the database and returns all the results.
-     * Warning: If there are a large number of results, this method can have performance implications.
-     * @param options Additional options to be used when performing the query.
-     * @returns An array of records from the database.
-     */
     getAll(chunk = pagination_1.PAGINATION_MAX_SIZE, options = {}) {
         var e_2, _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -219,13 +212,14 @@ class Query {
                 }
                 finally { if (e_2) throw e_2.error; }
             }
+            // Method overloading does not provide type inference for the return type.
             return results;
         });
     }
     getOne(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
-            // @ts-ignore
+            // Method overloading does not provide type inference for the return type.
             return records[0] || null;
         });
     }

package/dist/schema/record.d.ts

@@ -1,3 +1,4 @@
+import { SelectedPick } from './selection';
 /**
  * Represents an identifiable record from the database.
  */
@@ -26,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<this>): Promise<this>;
+    update(data: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<SelectedPick<this, ['*']>>;
     /**
      * Performs a deletion of the current record in the database.
      *
@@ -41,5 +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,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isXataRecord = exports.isIdentifiable = void 0;
+const lang_1 = require("../util/lang");
 function isIdentifiable(x) {
-    return typeof x === 'object' && typeof (x === null || x === void 0 ? void 0 : x.id) === 'string';
+    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) {