@xata.io/client 0.0.0-beta.f12621e → 0.0.0-beta.f46df88

package/dist/schema/repository.d.ts

@@ -0,0 +1,100 @@
+import { FetchImpl } from '../api/fetcher';
+import { Page } from './pagination';
+import { Query } from './query';
+import { BaseData, EditableData, Identifiable, XataRecord } from './record';
+import { SelectedPick } from './selection';
+export declare type Links = Record<string, Array<string[]>>;
+/**
+ * Common interface for performing operations on a table.
+ */
+export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
+    abstract create(object: EditableData<Data> & Partial<Identifiable>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates a single record in the table with a unique id.
+     * @param id The unique id.
+     * @param object Object containing the column names with their values to be stored in the table.
+     * @returns The full persisted record.
+     */
+    abstract create(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates multiple records in the table.
+     * @param objects Array of objects with the column names and the values to be stored in the table.
+     * @returns Array of the persisted records.
+     */
+    abstract createMany(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    /**
+     * Queries a single record from the table given its unique id.
+     * @param id The unique id.
+     * @returns The persisted record for the given id or null if the record could not be found.
+     */
+    abstract read(id: string): Promise<SelectedPick<Record, ['*']> | null>;
+    /**
+     * Partially update a single record given its unique id.
+     * @param id The unique id.
+     * @param object The column names and their values that have to be updatd.
+     * @returns The full persisted record.
+     */
+    abstract update(id: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param id A unique id.
+     * @param object The column names and the values to be persisted.
+     * @returns The full persisted record.
+     */
+    abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Deletes a record given its unique id.
+     * @param id The unique id.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(id: string): void;
+    abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
+}
+export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
+    #private;
+    constructor(client: BaseClient<any>, table: string);
+    create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    createMany(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
+    update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    delete(recordId: string): Promise<void>;
+    query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
+}
+interface RepositoryFactory {
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+}
+export declare class RestRespositoryFactory implements RepositoryFactory {
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+}
+declare type BranchStrategyValue = string | undefined | null;
+declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
+declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
+declare type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
+export declare type XataClientOptions = {
+    /**
+     * Fetch implementation. This option is only required if the runtime does not include a fetch implementation
+     * available in the global scope. If you are running your code on Deno or Cloudflare workers for example,
+     * you won't need to provide a specific fetch implementation. But for most versions of Node.js you'll need
+     * to provide one. Such as cross-fetch, node-fetch or isomorphic-fetch.
+     */
+    fetch?: FetchImpl;
+    databaseURL?: string;
+    branch: BranchStrategyOption;
+    /**
+     * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
+     */
+    apiKey: string;
+    repositoryFactory?: RepositoryFactory;
+};
+export declare class BaseClient<D extends Record<string, Repository<any>> = Record<string, Repository<any>>> {
+    #private;
+    options: XataClientOptions;
+    db: D;
+    constructor(options: XataClientOptions, links?: Links);
+    initObject<T>(table: string, object: object): T;
+    getBranch(): Promise<string>;
+}
+export {};

package/dist/schema/repository.js

@@ -0,0 +1,288 @@
+"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, _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 lang_1 = require("../util/lang");
+const filters_1 = require("./filters");
+const pagination_1 = require("./pagination");
+const query_1 = require("./query");
+const record_1 = require("./record");
+/**
+ * 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) {
+        var _a;
+        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");
+        // TODO: Remove when integrating with API client
+        const globalFetch = typeof fetch !== 'undefined' ? fetch : undefined;
+        const fetchImpl = (_a = __classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch) !== null && _a !== void 0 ? _a : globalFetch;
+        if (!fetchImpl) {
+            /** @todo add a link after docs exist */
+            throw new Error(`The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.`);
+        }
+        __classPrivateFieldSet(this, _RestRepository_fetch, fetchImpl, "f");
+    }
+    create(a, b) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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);
+            }
+            else 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 }));
+            }
+            else if ((0, lang_1.isObject)(a)) {
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_insertRecordWithoutId).call(this, a);
+            }
+            else {
+                throw new Error('Invalid arguments for create method');
+            }
+        });
+    }
+    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');
+            }
+            return finalObjects;
+        });
+    }
+    // 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 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;
+        });
+    }
+    createOrUpdate(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;
+        });
+    }
+    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));
+        });
+    }
+    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: (0, filters_1.buildSortFilter)(data.sort),
+                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() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const branch = yield __classPrivateFieldGet(this, _RestRepository_client, "f").getBranch();
+        return {
+            fetchImpl: __classPrivateFieldGet(this, _RestRepository_fetch, "f"),
+            apiKey: __classPrivateFieldGet(this, _RestRepository_client, "f").options.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;
+    });
+};
+class RestRespositoryFactory {
+    createRepository(client, table) {
+        return new RestRepository(client, table);
+    }
+}
+exports.RestRespositoryFactory = RestRespositoryFactory;
+class BaseClient {
+    constructor(options, links = {}) {
+        _BaseClient_links.set(this, void 0);
+        _BaseClient_branch.set(this, void 0);
+        if (!options.databaseURL || !options.apiKey || !options.branch) {
+            throw new Error('Options databaseURL, apiKey and branch are required');
+        }
+        this.options = options;
+        __classPrivateFieldSet(this, _BaseClient_links, links, "f");
+        const factory = 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]) => {
+        return Object.assign(Object.assign({}, acc), { [key]: (0, record_1.isIdentifiable)(value) ? value.id : value });
+    }, {});
+};

package/dist/schema/selection.d.ts

@@ -1,18 +1,24 @@
-import { XataRecord } from '..';
-import { StringKeys, UnionToIntersection, Values } from '../util/types';
-import { Query } from './query';
-declare type Queries<T> = {
-    [key in keyof T as T[key] extends Query<any> ? key : never]: T[key];
-};
-declare type OmitQueries<T> = {
-    [key in keyof T as T[key] extends Query<any> ? never : key]: T[key];
-};
-declare type OmitMethods<T> = {
-    [key in keyof T as T[key] extends Function ? never : key]: T[key];
-};
-export declare type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, 'id' | 'xata'>;
-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 extends XataRecord, 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]>> ? NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord : unknown;
+} : unknown : Key extends DataProps<O> ? {
+    [K in Key]: NonNullable<O[K]> extends XataRecord ? SelectedPick<NonNullable<O[K]>, ['*']> : O[K];
+} : Key extends '*' ? {
+    [K in keyof NonNullable<O>]: NonNullable<NonNullable<O>[K]> extends XataRecord ? NonNullable<O>[K] extends XataRecord ? Link<NonNullable<O>[K]> : Link<NonNullable<NonNullable<O>[K]>> | null : NonNullable<O>[K];
+} : unknown;
 export {};

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

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

package/dist/schema/selection.spec.js

@@ -0,0 +1,109 @@
+"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 selectedRecordPickTest1(selectedUserBaseRecord) {
+    var _a, _b, _c, _d;
+    selectedUserBaseRecord.id;
+    selectedUserBaseRecord.read();
+    selectedUserBaseRecord.full_name;
+    (_a = selectedUserBaseRecord.address) === null || _a === void 0 ? void 0 : _a.street;
+    // @ts-expect-error
+    selectedUserBaseRecord.team.id;
+    (_b = selectedUserBaseRecord.team) === null || _b === void 0 ? void 0 : _b.id;
+    (_c = selectedUserBaseRecord.team) === null || _c === void 0 ? void 0 : _c.read();
+    // @ts-expect-error
+    (_d = selectedUserBaseRecord.team) === null || _d === void 0 ? void 0 : _d.name;
+    selectedUserBaseRecord.owner.id;
+    selectedUserBaseRecord.owner.read();
+    // @ts-expect-error
+    selectedUserBaseRecord.owner.full_name;
+}
+function selectedRecordPickTest2(selectedUserFullRecord) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    selectedUserFullRecord.id;
+    selectedUserFullRecord.read();
+    selectedUserFullRecord.full_name;
+    (_a = selectedUserFullRecord.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = selectedUserFullRecord.team) === null || _b === void 0 ? void 0 : _b.read();
+    (_c = selectedUserFullRecord.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_d = selectedUserFullRecord.team) === null || _d === void 0 ? void 0 : _d.owner;
+    (_f = (_e = selectedUserFullRecord.team) === null || _e === void 0 ? void 0 : _e.owner) === null || _f === void 0 ? void 0 : _f.id;
+    (_h = (_g = selectedUserFullRecord.team) === null || _g === void 0 ? void 0 : _g.owner) === null || _h === void 0 ? void 0 : _h.read();
+    // @ts-expect-error
+    (_k = (_j = selectedUserFullRecord.team) === null || _j === void 0 ? void 0 : _j.owner) === null || _k === void 0 ? void 0 : _k.full_name;
+    // @ts-expect-error
+    selectedUserFullRecord.full_name = null;
+    selectedUserFullRecord.email = null;
+    selectedUserFullRecord.email = '';
+    // @ts-expect-error
+    selectedUserFullRecord.email = 2;
+    if (selectedUserFullRecord.team) {
+        // @ts-expect-error
+        selectedUserFullRecord.team.name = null;
+        selectedUserFullRecord.team.labels = null;
+        selectedUserFullRecord.team.labels = ['foo'];
+        // @ts-expect-error
+        selectedUserFullRecord.team.labels = [1];
+    }
+}
+function selectedRecordPickTest3(selectedUserNestedRecord) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    selectedUserNestedRecord.id;
+    selectedUserNestedRecord.read();
+    // @ts-expect-error
+    selectedUserNestedRecord.full_name;
+    (_a = selectedUserNestedRecord.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = selectedUserNestedRecord.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = selectedUserNestedRecord.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = selectedUserNestedRecord.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = selectedUserNestedRecord.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    (_j = (_h = selectedUserNestedRecord.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+}
+function selectedRecordPickTest4(selectedUserNestedRecord) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    selectedUserNestedRecord.id;
+    selectedUserNestedRecord.read();
+    // @ts-expect-error
+    selectedUserNestedRecord.full_name;
+    (_a = selectedUserNestedRecord.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = selectedUserNestedRecord.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = selectedUserNestedRecord.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = selectedUserNestedRecord.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = selectedUserNestedRecord.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    // @ts-expect-error
+    (_j = (_h = selectedUserNestedRecord.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+    (_l = (_k = selectedUserNestedRecord.team) === null || _k === void 0 ? void 0 : _k.owner) === null || _l === void 0 ? void 0 : _l.address;
+    (_p = (_o = (_m = selectedUserNestedRecord.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 = selectedUserNestedRecord.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;
+}
+test('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

package/dist/util/lang.d.ts

@@ -0,0 +1,5 @@
+export declare function compact<T>(arr: Array<T | null | undefined>): T[];
+export declare function compactObject<T>(obj: Record<string, T | null | undefined>): Record<string, T>;
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export declare function isObject(value: any): value is object;
+export declare function isString(value: any): value is string;

package/dist/util/lang.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = exports.isObject = exports.compactObject = exports.compact = void 0;
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
+function compact(arr) {
+    return arr.filter(notEmpty);
+}
+exports.compact = compact;
+function compactObject(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(([, value]) => notEmpty(value)));
+}
+exports.compactObject = compactObject;
+function isObject(value) {
+    return value !== undefined && value !== null && typeof value === 'object';
+}
+exports.isObject = isObject;
+function isString(value) {
+    return value !== undefined && value !== null && typeof value === 'string';
+}
+exports.isString = isString;

package/dist/util/types.d.ts

@@ -1,3 +1,13 @@
 export declare type StringKeys<O> = Extract<keyof O, string>;
-export declare type Values<O> = O[keyof O];
+export declare type NumberKeys<O> = Extract<keyof O, number>;
+export declare type Values<O> = O[StringKeys<O>];
 export declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
+export declare type If<Condition, Then, Else> = Condition extends true ? Then : Else;
+export declare type IsObject<T> = T extends Record<string, any> ? true : false;
+export declare type IsArray<T> = T extends Array<any> ? true : false;
+export declare type NonEmptyArray<T> = T[] & {
+    0: T;
+};
+export declare type RequiredBy<T, K extends keyof T> = T & {
+    [P in K]-?: NonNullable<T[P]>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.f12621e",
+  "version": "0.0.0-beta.f46df88",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,5 +20,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "f12621e75d650a761ab49fbb4f1ae4720b1effd8"
+  "gitHead": "f46df88912b2bac2ddae598d9d08efc1f44b00be"
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "lib": ["dom", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": ["src"]
+}

package/dist/util/errors.d.ts

@@ -1,3 +0,0 @@
-export declare const errors: {
-    falsyFetchImplementation: string; /** @todo add a link after docs exist */
-};

package/dist/util/errors.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errors = void 0;
-exports.errors = {
-    falsyFetchImplementation: `The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.
-  
-More in the docs: 
-` /** @todo add a link after docs exist */
-};