@xata.io/client 0.0.0-beta.123dd7a → 0.0.0-beta.14375f7

package/dist/schema/repository.js

@@ -0,0 +1,381 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    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, _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 fetch_1 = require("../util/fetch");
+const lang_1 = require("../util/lang");
+const config_1 = require("./config");
+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 query_1.Query {
+    constructor(client, table) {
+        super(null, table, {});
+        _RestRepository_instances.add(this);
+        _RestRepository_client.set(this, void 0);
+        _RestRepository_fetch.set(this, void 0);
+        _RestRepository_table.set(this, void 0);
+        __classPrivateFieldSet(this, _RestRepository_client, client, "f");
+        __classPrivateFieldSet(this, _RestRepository_table, table, "f");
+        __classPrivateFieldSet(this, _RestRepository_fetch, (0, fetch_1.getFetchImplementation)(__classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch), "f");
+    }
+    create(a, b) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Create many records
+            if (Array.isArray(a)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_bulkInsertTableRecords).call(this, a);
+            }
+            // 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 }));
+            }
+            // 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);
+            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;
+            }
+        });
+    }
+    update(a, b) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 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);
+            }
+            // 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');
+        });
+    }
+    createOrUpdate(a, b) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 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* () {
+            // 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) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = query.getQueryOptions();
+            const body = {
+                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));
+            return new pagination_1.Page(query, meta, records);
+        });
+    }
+}
+exports.RestRepository = RestRepository;
+_RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _RestRepository_table = new WeakMap(), _RestRepository_instances = new WeakSet(), _RestRepository_getFetchProps = function _RestRepository_getFetchProps() {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const branch = yield __classPrivateFieldGet(this, _RestRepository_client, "f").getBranch();
+        const apiKey = (_a = __classPrivateFieldGet(this, _RestRepository_client, "f").options.apiKey) !== null && _a !== void 0 ? _a : (0, config_1.getAPIKey)();
+        if (!apiKey) {
+            throw new Error('Could not resolve a valid apiKey');
+        }
+        return {
+            fetchImpl: __classPrivateFieldGet(this, _RestRepository_fetch, "f"),
+            apiKey,
+            apiUrl: '',
+            // Instead of using workspace and dbBranch, we inject a probably CNAME'd URL
+            workspacesApiUrl: (path, params) => {
+                var _a, _b;
+                const baseUrl = (_a = __classPrivateFieldGet(this, _RestRepository_client, "f").options.databaseURL) !== null && _a !== void 0 ? _a : '';
+                const hasBranch = (_b = params.dbBranchName) !== null && _b !== void 0 ? _b : params.branch;
+                const newPath = path.replace(/^\/db\/[^/]+/, hasBranch ? `:${branch}` : '');
+                return baseUrl + newPath;
+            }
+        };
+    });
+}, _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) {
+        return new RestRepository(client, table);
+    }
+}
+exports.RestRespositoryFactory = RestRespositoryFactory;
+function resolveXataClientOptions(options) {
+    const databaseURL = (options === null || options === void 0 ? void 0 : options.databaseURL) || (0, config_1.getDatabaseUrl)() || '';
+    const apiKey = (options === null || options === void 0 ? void 0 : options.apiKey) || (0, config_1.getAPIKey)() || '';
+    const branch = (options === null || options === void 0 ? void 0 : options.branch) ||
+        (() => (0, config_1.getBranch)({
+            apiKey,
+            apiUrl: databaseURL,
+            fetchImpl: (0, fetch_1.getFetchImplementation)(options === null || options === void 0 ? void 0 : options.fetch)
+        }));
+    if (!databaseURL || !apiKey) {
+        throw new Error('Options databaseURL and apiKey are required');
+    }
+    return Object.assign(Object.assign({}, options), { databaseURL,
+        apiKey,
+        branch });
+}
+class BaseClient {
+    constructor(options = {}, links = {}) {
+        _BaseClient_links.set(this, void 0);
+        _BaseClient_branch.set(this, void 0);
+        this.options = resolveXataClientOptions(options);
+        // Make this property not enumerable so it doesn't show up in console.dir, etc.
+        Object.defineProperty(this.options, 'apiKey', { enumerable: false });
+        __classPrivateFieldSet(this, _BaseClient_links, links, "f");
+        const factory = this.options.repositoryFactory || new RestRespositoryFactory();
+        this.db = new Proxy({}, {
+            get: (_target, prop) => {
+                if (typeof prop !== 'string')
+                    throw new Error('Invalid table name');
+                return factory.createRepository(this, prop);
+            }
+        });
+    }
+    initObject(table, 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 = result[field];
+            if (value && (0, lang_1.isObject)(value)) {
+                result[field] = this.initObject(linkTable, value);
+            }
+        }
+        const db = this.db;
+        result.read = function () {
+            return db[table].read(result['id']);
+        };
+        result.update = function (data) {
+            return db[table].update(result['id'], data);
+        };
+        result.delete = function () {
+            return db[table].delete(result['id']);
+        };
+        for (const prop of ['read', 'update', 'delete']) {
+            Object.defineProperty(result, prop, { enumerable: false });
+        }
+        Object.freeze(result);
+        return result;
+    }
+    getBranch() {
+        var e_1, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (__classPrivateFieldGet(this, _BaseClient_branch, "f"))
+                return __classPrivateFieldGet(this, _BaseClient_branch, "f");
+            const { branch: param } = this.options;
+            const strategies = Array.isArray(param) ? [...param] : [param];
+            const evaluateBranch = (strategy) => __awaiter(this, void 0, void 0, function* () {
+                return isBranchStrategyBuilder(strategy) ? yield strategy() : strategy;
+            });
+            try {
+                for (var strategies_1 = __asyncValues(strategies), strategies_1_1; strategies_1_1 = yield strategies_1.next(), !strategies_1_1.done;) {
+                    const strategy = strategies_1_1.value;
+                    const branch = yield evaluateBranch(strategy);
+                    if (branch) {
+                        __classPrivateFieldSet(this, _BaseClient_branch, branch, "f");
+                        return branch;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) yield _a.call(strategies_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            throw new Error('Unable to resolve branch value');
+        });
+    }
+}
+exports.BaseClient = BaseClient;
+_BaseClient_links = new WeakMap(), _BaseClient_branch = new WeakMap();
+const isBranchStrategyBuilder = (strategy) => {
+    return typeof strategy === 'function';
+};
+const transformObjectLinks = (object) => {
+    return Object.entries(object).reduce((acc, [key, value]) => {
+        // Ignore internal properties
+        if (key === 'xata')
+            return acc;
+        // Transform links to identifier
+        return Object.assign(Object.assign({}, acc), { [key]: (0, record_1.isIdentifiable)(value) ? value.id : value });
+    }, {});
+};

package/dist/schema/selection.d.ts

@@ -0,0 +1,25 @@
+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.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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>;

package/dist/schema/sorting.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSortFilter = exports.isSortFilterObject = exports.isSortFilterString = void 0;
+const lang_1 = require("../util/lang");
+function isSortFilterString(value) {
+    return (0, lang_1.isString)(value);
+}
+exports.isSortFilterString = isSortFilterString;
+function isSortFilterObject(filter) {
+    return (0, lang_1.isObject)(filter) && filter.column !== undefined;
+}
+exports.isSortFilterObject = isSortFilterObject;
+function buildSortFilter(filter) {
+    var _a;
+    if (isSortFilterString(filter)) {
+        return { [filter]: 'asc' };
+    }
+    else if (Array.isArray(filter)) {
+        return filter.map((item) => buildSortFilter(item));
+    }
+    else if (isSortFilterObject(filter)) {
+        return { [filter.column]: (_a = filter.direction) !== null && _a !== void 0 ? _a : 'asc' };
+    }
+    else {
+        throw new Error(`Invalid sort filter: ${filter}`);
+    }
+}
+exports.buildSortFilter = buildSortFilter;