@xata.io/client 0.2.2 → 0.5.0

package/dist/schema/query.js

@@ -0,0 +1,254 @@
+"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 __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var _Query_table, _Query_repository, _Query_data;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Query = void 0;
+const lang_1 = require("../util/lang");
+const pagination_1 = require("./pagination");
+/**
+ * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
+ *
+ * Query objects are immutable. Any method that adds more constraints or options to the query will return
+ * a new Query object containing the both the previous and the new constraints and options.
+ */
+class Query {
+    constructor(repository, table, data, parent) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        _Query_table.set(this, void 0);
+        _Query_repository.set(this, void 0);
+        _Query_data.set(this, { filter: {} });
+        // Implements pagination
+        this.meta = { page: { cursor: 'start', more: true } };
+        this.records = [];
+        __classPrivateFieldSet(this, _Query_table, table, "f");
+        if (repository) {
+            __classPrivateFieldSet(this, _Query_repository, repository, "f");
+        }
+        else {
+            __classPrivateFieldSet(this, _Query_repository, this, "f");
+        }
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$any = (_b = (_a = data.filter) === null || _a === void 0 ? void 0 : _a.$any) !== null && _b !== void 0 ? _b : (_c = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _c === void 0 ? void 0 : _c.$any;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$all = (_e = (_d = data.filter) === null || _d === void 0 ? void 0 : _d.$all) !== null && _e !== void 0 ? _e : (_f = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _f === void 0 ? void 0 : _f.$all;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$not = (_h = (_g = data.filter) === null || _g === void 0 ? void 0 : _g.$not) !== null && _h !== void 0 ? _h : (_j = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _j === void 0 ? void 0 : _j.$not;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$none = (_l = (_k = data.filter) === null || _k === void 0 ? void 0 : _k.$none) !== null && _l !== void 0 ? _l : (_m = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _m === void 0 ? void 0 : _m.$none;
+        __classPrivateFieldGet(this, _Query_data, "f").sort = (_o = data.sort) !== null && _o !== void 0 ? _o : parent === null || parent === void 0 ? void 0 : parent.sort;
+        __classPrivateFieldGet(this, _Query_data, "f").columns = (_q = (_p = data.columns) !== null && _p !== void 0 ? _p : parent === null || parent === void 0 ? void 0 : parent.columns) !== null && _q !== void 0 ? _q : ['*'];
+        this.any = this.any.bind(this);
+        this.all = this.all.bind(this);
+        this.not = this.not.bind(this);
+        this.filter = this.filter.bind(this);
+        this.sort = this.sort.bind(this);
+        this.none = this.none.bind(this);
+        Object.defineProperty(this, 'table', { enumerable: false });
+        Object.defineProperty(this, 'repository', { enumerable: false });
+    }
+    getQueryOptions() {
+        return __classPrivateFieldGet(this, _Query_data, "f");
+    }
+    /**
+     * Builds a new query object representing a logical OR between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
+    any(...queries) {
+        const $any = queries.map((query) => query.getQueryOptions().filter);
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $any } }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    /**
+     * Builds a new query object representing a logical AND between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
+    all(...queries) {
+        const $all = queries.map((query) => query.getQueryOptions().filter);
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    /**
+     * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
+    not(...queries) {
+        const $not = queries.map((query) => query.getQueryOptions().filter);
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $not } }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    /**
+     * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
+    none(...queries) {
+        const $none = queries.map((query) => query.getQueryOptions().filter);
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $none } }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    filter(a, b) {
+        if (arguments.length === 1) {
+            const constraints = Object.entries(a).map(([column, constraint]) => ({ [column]: constraint }));
+            const $all = (0, lang_1.compact)([__classPrivateFieldGet(this, _Query_data, "f").filter.$all].flat().concat(constraints));
+            return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
+        }
+        else {
+            const column = a;
+            const value = b;
+            const $all = (0, lang_1.compact)([__classPrivateFieldGet(this, _Query_data, "f").filter.$all].flat().concat({ [column]: value }));
+            return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
+        }
+    }
+    /**
+     * Builds a new query with a new sort option.
+     * @param column The column name.
+     * @param direction The direction. Either ascending or descending.
+     * @returns A new Query object.
+     */
+    sort(column, direction) {
+        const sort = Object.assign(Object.assign({}, __classPrivateFieldGet(this, _Query_data, "f").sort), { [column]: direction });
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { sort }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    /**
+     * Builds a new query specifying the set of columns to be returned in the query response.
+     * @param columns Array of column names to be returned by the query.
+     * @returns A new Query object.
+     */
+    select(columns) {
+        return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { columns }, __classPrivateFieldGet(this, _Query_data, "f"));
+    }
+    getPaginated(options = {}) {
+        return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
+    }
+    [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_1, _b;
+            try {
+                for (var _c = __asyncValues(this.getIterator(1)), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const [record] = _d.value;
+                    yield yield __await(record);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    getIterator(chunk, options = {}) {
+        return __asyncGenerator(this, arguments, function* getIterator_1() {
+            let offset = 0;
+            let end = false;
+            while (!end) {
+                const { records, meta } = yield __await(this.getPaginated(Object.assign(Object.assign({}, options), { page: { size: chunk, offset } })));
+                yield yield __await(records);
+                offset += chunk;
+                end = !meta.page.more;
+            }
+        });
+    }
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
+    getMany(options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { records } = yield this.getPaginated(options);
+            return records;
+        });
+    }
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
+    getAll(chunk = pagination_1.PAGINATION_MAX_SIZE, options = {}) {
+        var e_2, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = [];
+            try {
+                for (var _b = __asyncValues(this.getIterator(chunk, options)), _c; _c = yield _b.next(), !_c.done;) {
+                    const page = _c.value;
+                    results.push(...page);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            return results;
+        });
+    }
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
+    getOne(options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
+            return records[0] || null;
+        });
+    }
+    /**async deleteAll(): Promise<number> {
+      // TODO: Return number of affected rows
+      return 0;
+    }**/
+    nextPage(size, offset) {
+        return this.firstPage(size, offset);
+    }
+    previousPage(size, offset) {
+        return this.firstPage(size, offset);
+    }
+    firstPage(size, offset) {
+        return this.getPaginated({ page: { size, offset } });
+    }
+    lastPage(size, offset) {
+        return this.getPaginated({ page: { size, offset, before: 'end' } });
+    }
+    hasNextPage() {
+        return this.meta.page.more;
+    }
+}
+exports.Query = Query;

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