@xata.io/client 0.0.0-beta.cae436d → 0.0.0-beta.ccaf25d

package/dist/schema/record.d.ts

@@ -0,0 +1,44 @@
+import { Selectable } from './selection';
+/**
+ * Represents an identifiable record from the database.
+ */
+export interface Identifiable {
+    /**
+     * Unique id of this record.
+     */
+    id: string;
+}
+export interface BaseData {
+    [key: string]: any;
+}
+/**
+ * Represents a persisted record from the database.
+ */
+export interface XataRecord extends Identifiable {
+    /**
+     * Metadata of this record.
+     */
+    xata: {
+        /**
+         * Number that is increased every time the record is updated.
+         */
+        version: number;
+    };
+    /**
+     * Retrieves a refreshed copy of the current record from the database.
+     */
+    read(): Promise<this>;
+    /**
+     * Performs a partial update of the current record. On success a new object is
+     * returned and the current object is not mutated.
+     * @param data The columns and their values that have to be updated.
+     * @returns A new record containing the latest values for all the columns of the current record.
+     */
+    update(data: Partial<Selectable<this>>): Promise<this>;
+    /**
+     * Performs a deletion of the current record in the database.
+     *
+     * @throws If the record was already deleted or if an error happened while performing the deletion.
+     */
+    delete(): Promise<void>;
+}

package/dist/schema/record.js

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

package/dist/schema/repository.d.ts

@@ -0,0 +1,104 @@
+import { FetchImpl } from '../api/fetcher';
+import { Page } from './pagination';
+import { Query, QueryOptions } from './query';
+import { BaseData, XataRecord } from './record';
+import { Select, SelectableColumn } 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> {
+    abstract create(object: Data): Promise<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: Data[]): Promise<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<Record | null>;
+    /**
+     * Insert a single record 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 insert(id: string, object: Data): Promise<Record>;
+    /**
+     * Partially update a single record given its unique id.
+     * @param id The unique id.
+     * @param object The column names and their values that have to be updatd.
+     * @returns The full persisted record.
+     */
+    abstract update(id: string, object: Partial<Data>): Promise<Record>;
+    /**
+     * Updates or inserts 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 updateOrInsert(id: string, object: Data): Promise<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, Options extends QueryOptions<Record>>(query: Query<Record, Result>, options: Options): Promise<Page<Record, typeof options extends {
+        columns: SelectableColumn<Data>[];
+    } ? Select<Data, typeof options['columns'][number]> : Result>>;
+}
+export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Repository<Data, Record> {
+    #private;
+    constructor(client: BaseClient<any>, table: string);
+    create(object: Data): Promise<Record>;
+    createMany(objects: Data[]): Promise<Record[]>;
+    read(recordId: string): Promise<Record | null>;
+    update(recordId: string, object: Partial<Data>): Promise<Record>;
+    insert(recordId: string, object: Data): Promise<Record>;
+    updateOrInsert(recordId: string, object: Data): Promise<Record>;
+    delete(recordId: string): Promise<void>;
+    query<Result extends XataRecord, Options extends QueryOptions<Record>>(query: Query<Record, Result>, options?: Options): Promise<Page<Record, typeof options extends {
+        columns: SelectableColumn<Data>[];
+    } ? Select<Data, typeof options['columns'][number]> : Result>>;
+}
+interface RepositoryFactory {
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data>;
+}
+export declare class RestRespositoryFactory implements RepositoryFactory {
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data>;
+}
+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,280 @@
+"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, _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 pagination_1 = require("./pagination");
+const query_1 = require("./query");
+/**
+ * Common interface for performing operations on a table.
+ */
+class Repository extends query_1.Query {
+}
+exports.Repository = Repository;
+class RestRepository extends Repository {
+    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");
+        // TODO: Remove when integrating with API client
+        const fetchImpl = typeof fetch !== 'undefined' ? fetch : __classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch;
+        if (!fetchImpl) {
+            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(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;
+        });
+    }
+    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;
+        });
+    }
+    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;
+        });
+    }
+    insert(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 }, fetchProps));
+            const finalObject = yield this.read(response.id);
+            if (!finalObject) {
+                throw new Error('The server failed to save the record');
+            }
+            return finalObject;
+        });
+    }
+    updateOrInsert(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, options = {}) {
+        var _a, _b, _c;
+        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
+            };
+            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);
+        });
+    }
+}
+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;
+            }
+        };
+    });
+};
+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 o = {};
+        Object.assign(o, 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: () => {
+                            this.db[linkTable].read(id);
+                        }
+                    };
+                }
+            }
+        }
+        const db = this.db;
+        o.read = function () {
+            return db[table].read(o['id']);
+        };
+        o.update = function (data) {
+            return db[table].update(o['id'], data);
+        };
+        o.delete = function () {
+            return db[table].delete(o['id']);
+        };
+        for (const prop of ['read', 'update', 'delete']) {
+            Object.defineProperty(o, prop, { enumerable: false });
+        }
+        // TODO: links and rev links
+        Object.freeze(o);
+        return o;
+    }
+    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';
+};
+// 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 });
+    }, {});
+};

package/dist/schema/selection.d.ts

@@ -1,16 +1,10 @@
-import { XataRecord } from '..';
 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> ? key : never]: T[key];
+    [key in keyof T as T[key] extends Query<any, 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 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;
 }> : '');

package/dist/util/lang.d.ts

@@ -1 +1,2 @@
 export declare function compact<T>(arr: Array<T | null | undefined>): T[];
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.cae436d",
+  "version": "0.0.0-beta.ccaf25d",
   "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": "cae436d55b8fc4484cc90bba98563e225af8d1a8"
+  "gitHead": "ccaf25d542edca3697b426284844cf7b39bf2bf8"
 }

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"]
+}