@xata.io/client 0.0.0-beta.21c5d41 → 0.0.0-beta.2781f49

package/dist/schema/repository.js

@@ -26,20 +26,22 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
-var _RestRepository_instances, _RestRepository_client, _RestRepository_fetch, _RestRepository_table, _RestRepository_getFetchProps, _BaseClient_links, _BaseClient_branch;
+var _RestRepository_instances, _RestRepository_client, _RestRepository_fetch, _RestRepository_table, _RestRepository_getFetchProps, _RestRepository_insertRecordWithoutId, _RestRepository_insertRecordWithId, _RestRepository_bulkInsertTableRecords, _RestRepository_updateRecordWithID, _RestRepository_upsertRecordWithID, _RestRepository_deleteRecord, _BaseClient_links, _BaseClient_branch;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
 const api_1 = require("../api");
-const filters_1 = require("./filters");
+const lang_1 = require("../util/lang");
 const pagination_1 = require("./pagination");
 const query_1 = require("./query");
+const record_1 = require("./record");
+const sorting_1 = require("./sorting");
 /**
  * Common interface for performing operations on a table.
  */
 class Repository extends query_1.Query {
 }
 exports.Repository = Repository;
-class RestRepository extends Repository {
+class RestRepository extends query_1.Query {
     constructor(client, table) {
         var _a;
         super(null, table, {});
@@ -58,98 +60,126 @@ class RestRepository extends Repository {
         }
         __classPrivateFieldSet(this, _RestRepository_fetch, fetchImpl, "f");
     }
-    create(object) {
+    create(a, b) {
         return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const record = transformObjectLinks(object);
-            const response = yield (0, api_1.insertRecord)(Object.assign({ pathParams: {
-                    workspace: '{workspaceId}',
-                    dbBranchName: '{dbBranch}',
-                    tableName: __classPrivateFieldGet(this, _RestRepository_table, "f")
-                }, body: record }, fetchProps));
-            const finalObject = yield this.read(response.id);
-            if (!finalObject) {
-                throw new Error('The server failed to save the record');
+            // Create many records
+            if (Array.isArray(a)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_bulkInsertTableRecords).call(this, a);
             }
-            return finalObject;
-        });
-    }
-    createMany(objects) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const records = objects.map((object) => transformObjectLinks(object));
-            const response = yield (0, api_1.bulkInsertTableRecords)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f") }, body: { records } }, fetchProps));
-            const finalObjects = yield this.any(...response.recordIDs.map((id) => this.filter('id', id))).getAll();
-            if (finalObjects.length !== objects.length) {
-                throw new Error('The server failed to save some records');
+            // Create one record with id as param
+            if ((0, lang_1.isString)(a) && (0, lang_1.isObject)(b)) {
+                if (a === '')
+                    throw new Error("The id can't be empty");
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_insertRecordWithId).call(this, a, b);
+            }
+            // Create one record with id as property
+            if ((0, lang_1.isObject)(a) && (0, lang_1.isString)(a.id)) {
+                if (a.id === '')
+                    throw new Error("The id can't be empty");
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_insertRecordWithId).call(this, a.id, Object.assign(Object.assign({}, a), { id: undefined }));
             }
-            return finalObjects;
+            // Create one record without id
+            if ((0, lang_1.isObject)(a)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_insertRecordWithoutId).call(this, a);
+            }
+            throw new Error('Invalid arguments for create method');
         });
     }
+    // TODO: Add column support: https://github.com/xataio/openapi/issues/139
     read(recordId) {
         return __awaiter(this, void 0, void 0, function* () {
             const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const response = yield (0, api_1.getRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
-            return __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), response);
-        });
-    }
-    update(recordId, object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const response = yield (0, api_1.updateRecordWithID)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId }, body: object }, fetchProps));
-            const item = yield this.read(response.id);
-            if (!item)
-                throw new Error('The server failed to save the record');
-            return item;
+            try {
+                const response = yield (0, api_1.getRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
+                return __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), response);
+            }
+            catch (e) {
+                if ((0, lang_1.isObject)(e) && e.status === 404) {
+                    return null;
+                }
+                throw e;
+            }
         });
     }
-    insert(recordId, object) {
+    update(a, b) {
         return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const record = transformObjectLinks(object);
-            const response = yield (0, api_1.insertRecordWithID)(Object.assign({ pathParams: {
-                    workspace: '{workspaceId}',
-                    dbBranchName: '{dbBranch}',
-                    tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"),
-                    recordId
-                }, body: record }, fetchProps));
-            const finalObject = yield this.read(response.id);
-            if (!finalObject) {
-                throw new Error('The server failed to save the record');
+            // Update many records
+            if (Array.isArray(a)) {
+                if (a.length > 100) {
+                    // TODO: Implement bulk update when API has support for it
+                    console.warn('Bulk update operation is not optimized in the Xata API yet, this request might be slow');
+                }
+                return Promise.all(a.map((object) => this.update(object)));
+            }
+            // Update one record with id as param
+            if ((0, lang_1.isString)(a) && (0, lang_1.isObject)(b)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_updateRecordWithID).call(this, a, b);
             }
-            return finalObject;
+            // Update one record with id as property
+            if ((0, lang_1.isObject)(a) && (0, lang_1.isString)(a.id)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_updateRecordWithID).call(this, a.id, Object.assign(Object.assign({}, a), { id: undefined }));
+            }
+            throw new Error('Invalid arguments for update method');
         });
     }
-    updateOrInsert(recordId, object) {
+    createOrUpdate(a, b) {
         return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            const response = yield (0, api_1.upsertRecordWithID)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId }, body: object }, fetchProps));
-            const item = yield this.read(response.id);
-            if (!item)
-                throw new Error('The server failed to save the record');
-            return item;
+            // Create or update many records
+            if (Array.isArray(a)) {
+                if (a.length > 100) {
+                    // TODO: Implement bulk update when API has support for it
+                    console.warn('Bulk update operation is not optimized in the Xata API yet, this request might be slow');
+                }
+                return Promise.all(a.map((object) => this.createOrUpdate(object)));
+            }
+            // Create or update one record with id as param
+            if ((0, lang_1.isString)(a) && (0, lang_1.isObject)(b)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_upsertRecordWithID).call(this, a, b);
+            }
+            // Create or update one record with id as property
+            if ((0, lang_1.isObject)(a) && (0, lang_1.isString)(a.id)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_upsertRecordWithID).call(this, a.id, Object.assign(Object.assign({}, a), { id: undefined }));
+            }
+            throw new Error('Invalid arguments for createOrUpdate method');
         });
     }
     delete(recordId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
-            yield (0, api_1.deleteRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
+            // Delete many records
+            if (Array.isArray(recordId)) {
+                if (recordId.length > 100) {
+                    // TODO: Implement bulk delete when API has support for it
+                    console.warn('Bulk delete operation is not optimized in the Xata API yet, this request might be slow');
+                }
+                yield Promise.all(recordId.map((id) => this.delete(id)));
+                return;
+            }
+            // Delete one record with id as param
+            if ((0, lang_1.isString)(recordId)) {
+                yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_deleteRecord).call(this, recordId);
+                return;
+            }
+            // Delete one record with id as property
+            if ((0, lang_1.isObject)(recordId) && (0, lang_1.isString)(recordId.id)) {
+                yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_deleteRecord).call(this, recordId.id);
+                return;
+            }
+            throw new Error('Invalid arguments for delete method');
         });
     }
-    query(query, options = {}) {
-        var _a, _b, _c;
+    query(query) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const data = query.getQueryOptions();
             const body = {
-                filter: Object.values(data.filter).some(Boolean) ? data.filter : undefined,
-                sort: (_a = (0, filters_1.buildSortFilter)(options === null || options === void 0 ? void 0 : options.sort)) !== null && _a !== void 0 ? _a : data.sort,
-                page: (_b = options === null || options === void 0 ? void 0 : options.page) !== null && _b !== void 0 ? _b : data.page,
-                columns: (_c = options === null || options === void 0 ? void 0 : options.columns) !== null && _c !== void 0 ? _c : data.columns
+                filter: Object.values((_a = data.filter) !== null && _a !== void 0 ? _a : {}).some(Boolean) ? data.filter : undefined,
+                sort: data.sort ? (0, sorting_1.buildSortFilter)(data.sort) : undefined,
+                page: data.page,
+                columns: data.columns
             };
             const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
             const { meta, records: objects } = yield (0, api_1.queryTable)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f") }, body }, fetchProps));
             const records = objects.map((record) => __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), record));
-            // TODO: We should properly type this any
             return new pagination_1.Page(query, meta, records);
         });
     }
@@ -172,6 +202,72 @@ _RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _
             }
         };
     });
+}, _RestRepository_insertRecordWithoutId = function _RestRepository_insertRecordWithoutId(object) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        const record = transformObjectLinks(object);
+        const response = yield (0, api_1.insertRecord)(Object.assign({ pathParams: {
+                workspace: '{workspaceId}',
+                dbBranchName: '{dbBranch}',
+                tableName: __classPrivateFieldGet(this, _RestRepository_table, "f")
+            }, body: record }, fetchProps));
+        const finalObject = yield this.read(response.id);
+        if (!finalObject) {
+            throw new Error('The server failed to save the record');
+        }
+        return finalObject;
+    });
+}, _RestRepository_insertRecordWithId = function _RestRepository_insertRecordWithId(recordId, object) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        const record = transformObjectLinks(object);
+        const response = yield (0, api_1.insertRecordWithID)(Object.assign({ pathParams: {
+                workspace: '{workspaceId}',
+                dbBranchName: '{dbBranch}',
+                tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"),
+                recordId
+            }, body: record, queryParams: { createOnly: true } }, fetchProps));
+        const finalObject = yield this.read(response.id);
+        if (!finalObject) {
+            throw new Error('The server failed to save the record');
+        }
+        return finalObject;
+    });
+}, _RestRepository_bulkInsertTableRecords = function _RestRepository_bulkInsertTableRecords(objects) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        const records = objects.map((object) => transformObjectLinks(object));
+        const response = yield (0, api_1.bulkInsertTableRecords)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f") }, body: { records } }, fetchProps));
+        const finalObjects = yield this.any(...response.recordIDs.map((id) => this.filter('id', id))).getAll();
+        if (finalObjects.length !== objects.length) {
+            throw new Error('The server failed to save some records');
+        }
+        return finalObjects;
+    });
+}, _RestRepository_updateRecordWithID = function _RestRepository_updateRecordWithID(recordId, object) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        const record = transformObjectLinks(object);
+        const response = yield (0, api_1.updateRecordWithID)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId }, body: record }, fetchProps));
+        const item = yield this.read(response.id);
+        if (!item)
+            throw new Error('The server failed to save the record');
+        return item;
+    });
+}, _RestRepository_upsertRecordWithID = function _RestRepository_upsertRecordWithID(recordId, object) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        const response = yield (0, api_1.upsertRecordWithID)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId }, body: object }, fetchProps));
+        const item = yield this.read(response.id);
+        if (!item)
+            throw new Error('The server failed to save the record');
+        return item;
+    });
+}, _RestRepository_deleteRecord = function _RestRepository_deleteRecord(recordId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+        yield (0, api_1.deleteRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
+    });
 };
 class RestRespositoryFactory {
     createRepository(client, table) {
@@ -198,43 +294,31 @@ class BaseClient {
         });
     }
     initObject(table, object) {
-        const o = {};
-        Object.assign(o, object);
+        const result = {};
+        Object.assign(result, object);
         const tableLinks = __classPrivateFieldGet(this, _BaseClient_links, "f")[table] || [];
         for (const link of tableLinks) {
             const [field, linkTable] = link;
-            const value = o[field];
-            if (value && typeof value === 'object') {
-                const { id } = value;
-                if (Object.keys(value).find((col) => col === 'id')) {
-                    o[field] = this.initObject(linkTable, value);
-                }
-                else if (id) {
-                    o[field] = {
-                        id,
-                        get: () => {
-                            return this.db[linkTable].read(id);
-                        }
-                    };
-                }
+            const value = result[field];
+            if (value && (0, lang_1.isObject)(value)) {
+                result[field] = this.initObject(linkTable, value);
             }
         }
         const db = this.db;
-        o.read = function () {
-            return db[table].read(o['id']);
+        result.read = function () {
+            return db[table].read(result['id']);
         };
-        o.update = function (data) {
-            return db[table].update(o['id'], data);
+        result.update = function (data) {
+            return db[table].update(result['id'], data);
         };
-        o.delete = function () {
-            return db[table].delete(o['id']);
+        result.delete = function () {
+            return db[table].delete(result['id']);
         };
         for (const prop of ['read', 'update', 'delete']) {
-            Object.defineProperty(o, prop, { enumerable: false });
+            Object.defineProperty(result, prop, { enumerable: false });
         }
-        // TODO: links and rev links
-        Object.freeze(o);
-        return o;
+        Object.freeze(result);
+        return result;
     }
     getBranch() {
         var e_1, _a;
@@ -272,12 +356,8 @@ _BaseClient_links = new WeakMap(), _BaseClient_branch = new WeakMap();
 const isBranchStrategyBuilder = (strategy) => {
     return typeof strategy === 'function';
 };
-// TODO: We can find a better implementation for links
 const transformObjectLinks = (object) => {
     return Object.entries(object).reduce((acc, [key, value]) => {
-        if (value && typeof value === 'object' && typeof value.id === 'string') {
-            return Object.assign(Object.assign({}, acc), { [key]: value.id });
-        }
-        return Object.assign(Object.assign({}, acc), { [key]: value });
+        return Object.assign(Object.assign({}, acc), { [key]: (0, record_1.isIdentifiable)(value) ? value.id : value });
     }, {});
 };

package/dist/schema/selection.d.ts

@@ -1,12 +1,25 @@
-import { StringKeys, UnionToIntersection, Values } from '../util/types';
-import { Query } from './query';
-import { BaseData, Identifiable, XataRecord } from './record';
-declare type Queries<T> = {
-    [key in keyof T as T[key] extends Query<any, any> ? key : never]: T[key];
-};
-export declare type Selectable<T extends BaseData> = T & Partial<Identifiable>;
-export declare type SelectableColumn<O> = '*' | (O extends Array<unknown> ? never : O extends Record<string, any> ? '*' | Values<{
-    [K in StringKeys<O>]: O[K] extends Record<string, any> ? `${K}.${SelectableColumn<O[K]>}` : K;
-}> : '');
-export declare type Select<T, K extends SelectableColumn<T>> = UnionToIntersection<K extends keyof T ? Pick<T, K> : T> & Queries<T> & XataRecord;
+import { If, IsArray, IsObject, StringKeys, UnionToIntersection, Values } from '../util/types';
+import { Link, XataRecord } from './record';
+export declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
+export declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
+    [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
+}>>;
+export declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<O[K] extends XataRecord ? (V extends SelectableColumn<O[K]> ? {
+    V: ValueAtColumn<O[K], V>;
+} : never) : O[K]> : never : never;
+declare type MAX_RECURSION = 5;
+declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
+    [K in DataProps<O>]: If<IsArray<NonNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
+    If<IsObject<NonNullable<O[K]>>, NonNullable<O[K]> extends XataRecord ? SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<NonNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
+    K>>;
+}>, never>;
+declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
+declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
+    [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
+} : unknown : Key extends DataProps<O> ? {
+    [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
+} : Key extends '*' ? {
+    [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
+} : unknown;
+declare type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
 export {};

package/dist/schema/selection.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/schema/selection.spec.js

@@ -0,0 +1,203 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-floating-promises */
+Object.defineProperty(exports, "__esModule", { value: true });
+//                              SelectableColumn<O>                            //
+// --------------------------------------------------------------------------- //
+const validTeamColumns = [
+    '*',
+    'id',
+    'name',
+    'owner.*',
+    'owner.address.*',
+    'owner.address',
+    'owner.address.street'
+];
+// @ts-expect-error
+const invalidFullNameTeamColumn = 'full_name';
+// @ts-expect-error
+const invalidPartialTeamColumn = 'owner.address.';
+// @ts-expect-error
+const invalidDeleteTeamColumn = 'owner.delete';
+// @ts-expect-error
+const invalidReadTeamColumn = 'owner.read.*';
+//                              ValueAtColumn<O, P>                            //
+// --------------------------------------------------------------------------- //
+const labelsValue = ['foo'];
+// @ts-expect-error
+const invalidLabelsValue = [1];
+//                            SelectedRecordPick<O, Key>                        //
+// ---------------------------------------------------------------------------- //
+function test1(user) {
+    var _a, _b, _c, _d;
+    user.id;
+    user.read();
+    user.full_name;
+    (_a = user.address) === null || _a === void 0 ? void 0 : _a.street;
+    // @ts-expect-error
+    user.team.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.id;
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.read();
+    // @ts-expect-error
+    (_d = user.team) === null || _d === void 0 ? void 0 : _d.name;
+    user.partner.id;
+    user.partner.read();
+    // @ts-expect-error
+    user.partner.full_name;
+    user.team = null;
+    // @ts-expect-error
+    user.partner = null;
+}
+function test2(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    user.id;
+    user.read();
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner;
+    (_f = (_e = user.team) === null || _e === void 0 ? void 0 : _e.owner) === null || _f === void 0 ? void 0 : _f.id;
+    (_h = (_g = user.team) === null || _g === void 0 ? void 0 : _g.owner) === null || _h === void 0 ? void 0 : _h.read();
+    // @ts-expect-error
+    (_k = (_j = user.team) === null || _j === void 0 ? void 0 : _j.owner) === null || _k === void 0 ? void 0 : _k.full_name;
+    // @ts-expect-error
+    user.full_name = null;
+    user.email = null;
+    user.email = '';
+    // @ts-expect-error
+    user.email = 2;
+    if (user.team) {
+        // @ts-expect-error
+        user.team.name = null;
+        user.team.labels = null;
+        user.team.labels = ['foo'];
+        // @ts-expect-error
+        user.team.labels = [1];
+    }
+}
+function test3(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = user.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    (_j = (_h = user.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+}
+function test4(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = user.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    // @ts-expect-error
+    (_j = (_h = user.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+    (_l = (_k = user.team) === null || _k === void 0 ? void 0 : _k.owner) === null || _l === void 0 ? void 0 : _l.address;
+    (_p = (_o = (_m = user.team) === null || _m === void 0 ? void 0 : _m.owner) === null || _o === void 0 ? void 0 : _o.address) === null || _p === void 0 ? void 0 : _p.street;
+    (_s = (_r = (_q = user.team) === null || _q === void 0 ? void 0 : _q.owner) === null || _r === void 0 ? void 0 : _r.address) === null || _s === void 0 ? void 0 : _s.zipcode;
+}
+function test5(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    user.settings;
+    (_a = user.settings) === null || _a === void 0 ? void 0 : _a.theme;
+    (_b = user.settings) === null || _b === void 0 ? void 0 : _b.language;
+    (_c = user.settings) === null || _c === void 0 ? void 0 : _c.signin;
+    (_e = (_d = user.settings) === null || _d === void 0 ? void 0 : _d.signin) === null || _e === void 0 ? void 0 : _e.email;
+    (_g = (_f = user.settings) === null || _f === void 0 ? void 0 : _f.signin) === null || _g === void 0 ? void 0 : _g.github;
+    // @ts-expect-error
+    (_h = user.settings) === null || _h === void 0 ? void 0 : _h.id;
+    // @ts-expect-error
+    (_j = user.settings) === null || _j === void 0 ? void 0 : _j.read();
+    // @ts-expect-error
+    (_l = (_k = user.settings) === null || _k === void 0 ? void 0 : _k.signin) === null || _l === void 0 ? void 0 : _l.id;
+    user.settings = null;
+    user.nonNullable.nested.value = 2;
+    // @ts-expect-error
+    user.nonNullable = null;
+    // @ts-expect-error
+    user.nonNullable.nested.value = null;
+}
+function test6(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    user.settings;
+    (_a = user.settings) === null || _a === void 0 ? void 0 : _a.theme;
+    (_b = user.settings) === null || _b === void 0 ? void 0 : _b.language;
+    (_c = user.settings) === null || _c === void 0 ? void 0 : _c.signin;
+    (_e = (_d = user.settings) === null || _d === void 0 ? void 0 : _d.signin) === null || _e === void 0 ? void 0 : _e.email;
+    (_g = (_f = user.settings) === null || _f === void 0 ? void 0 : _f.signin) === null || _g === void 0 ? void 0 : _g.github;
+    // @ts-expect-error
+    (_h = user.settings) === null || _h === void 0 ? void 0 : _h.id;
+    // @ts-expect-error
+    (_j = user.settings) === null || _j === void 0 ? void 0 : _j.read();
+    // @ts-expect-error
+    (_l = (_k = user.settings) === null || _k === void 0 ? void 0 : _k.signin) === null || _l === void 0 ? void 0 : _l.id;
+    user.nonNullable.nested.value = 2;
+    user.nonNullable.nested.deep.depths.of.numbers = [1, 2, 3];
+    // @ts-expect-error
+    user.nonNullable.nested.deep.depths.of.numbers = 'invalid-string';
+    user.settings = null;
+    // @ts-expect-error
+    user.nonNullable = null;
+    // @ts-expect-error
+    user.nonNullable.nested.value = null;
+}
+function test7(user) {
+    var _a, _b;
+    user.partner;
+    user.partner.id;
+    user.partner.read();
+    user.partner.full_name;
+    // @ts-expect-error
+    user.partner.full_name = null;
+    user.partner.address;
+    // @ts-expect-error
+    user.team.id;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    // @ts-expect-error
+    user.team.read();
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    user.partner = null;
+    user.team = null;
+}
+function test8(user) {
+    var _a, _b;
+    user.partner;
+    user.partner.id;
+    user.partner.read();
+    user.partner.full_name;
+    // @ts-expect-error
+    user.partner.full_name = null;
+    user.partner.address;
+    // @ts-expect-error
+    user.team.id;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    // @ts-expect-error
+    user.team.read();
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    user.partner = null;
+    user.team = null;
+}
+test('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

package/dist/schema/sorting.d.ts

@@ -0,0 +1,17 @@
+import { SingleOrArray, Values } from '../util/types';
+import { XataRecord } from './record';
+import { SelectableColumn } from './selection';
+export declare type SortDirection = 'asc' | 'desc';
+export declare type SortFilterExtended<T extends XataRecord> = {
+    column: SelectableColumn<T>;
+    direction?: SortDirection;
+};
+export declare type SortFilter<T extends XataRecord> = SelectableColumn<T> | SortFilterExtended<T>;
+export declare type ApiSortFilter<T extends XataRecord> = SingleOrArray<Values<{
+    [key in SelectableColumn<T>]: {
+        [K in key]: SortDirection;
+    };
+}>>;
+export declare function isSortFilterString<T extends XataRecord>(value: any): value is SelectableColumn<T>;
+export declare function isSortFilterObject<T extends XataRecord>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
+export declare function buildSortFilter<T extends XataRecord>(filter: SingleOrArray<SortFilter<T>>): ApiSortFilter<T>;