@xata.io/client 0.0.0-beta.bdce130 → 0.0.0-beta.c21e40a

package/dist/schema/query.js

@@ -42,9 +42,16 @@ 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;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
         _Query_table.set(this, void 0);
         _Query_repository.set(this, void 0);
         _Query_data.set(this, { filter: {} });
@@ -58,12 +65,14 @@ class Query {
         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 : ['*'];
+        __classPrivateFieldGet(this, _Query_data, "f").filter = (_b = (_a = data.filter) !== null && _a !== void 0 ? _a : parent === null || parent === void 0 ? void 0 : parent.filter) !== null && _b !== void 0 ? _b : {};
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$any = (_d = (_c = data.filter) === null || _c === void 0 ? void 0 : _c.$any) !== null && _d !== void 0 ? _d : (_e = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _e === void 0 ? void 0 : _e.$any;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$all = (_g = (_f = data.filter) === null || _f === void 0 ? void 0 : _f.$all) !== null && _g !== void 0 ? _g : (_h = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _h === void 0 ? void 0 : _h.$all;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$not = (_k = (_j = data.filter) === null || _j === void 0 ? void 0 : _j.$not) !== null && _k !== void 0 ? _k : (_l = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _l === void 0 ? void 0 : _l.$not;
+        __classPrivateFieldGet(this, _Query_data, "f").filter.$none = (_o = (_m = data.filter) === null || _m === void 0 ? void 0 : _m.$none) !== null && _o !== void 0 ? _o : (_p = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _p === void 0 ? void 0 : _p.$none;
+        __classPrivateFieldGet(this, _Query_data, "f").sort = (_q = data.sort) !== null && _q !== void 0 ? _q : parent === null || parent === void 0 ? void 0 : parent.sort;
+        __classPrivateFieldGet(this, _Query_data, "f").columns = (_s = (_r = data.columns) !== null && _r !== void 0 ? _r : parent === null || parent === void 0 ? void 0 : parent.columns) !== null && _s !== void 0 ? _s : ['*'];
+        __classPrivateFieldGet(this, _Query_data, "f").page = (_t = data.page) !== null && _t !== void 0 ? _t : parent === null || parent === void 0 ? void 0 : parent.page;
         this.any = this.any.bind(this);
         this.all = this.all.bind(this);
         this.not = this.not.bind(this);
@@ -76,46 +85,77 @@ class Query {
     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 = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$any)).flat();
+        const $any = queries.map((query) => { var _a; return (_a = query.getQueryOptions().filter) !== null && _a !== void 0 ? _a : {}; });
         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 = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$all)).flat();
+        const $all = queries.map((query) => { var _a; return (_a = query.getQueryOptions().filter) !== null && _a !== void 0 ? _a : {}; });
         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 = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$not)).flat();
+        const $not = queries.map((query) => { var _a; return (_a = query.getQueryOptions().filter) !== null && _a !== void 0 ? _a : {}; });
         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 = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$none)).flat();
+        const $none = queries.map((query) => { var _a; return (_a = query.getQueryOptions().filter) !== null && _a !== void 0 ? _a : {}; });
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $none } }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
     filter(a, b) {
+        var _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));
+            const $all = (0, lang_1.compact)([(_a = __classPrivateFieldGet(this, _Query_data, "f").filter) === null || _a === void 0 ? void 0 : _a.$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 }));
+            const $all = (0, lang_1.compact)([(_b = __classPrivateFieldGet(this, _Query_data, "f").filter) === null || _b === void 0 ? void 0 : _b.$all].flat().concat([{ [a]: b }]));
             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 });
+        var _a;
+        const originalSort = [(_a = __classPrivateFieldGet(this, _Query_data, "f").sort) !== null && _a !== void 0 ? _a : []].flat();
+        const sort = [...originalSort, { 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 __awaiter(this, void 0, void 0, function* () {
-            return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
-        });
+        const query = new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), options, __classPrivateFieldGet(this, _Query_data, "f"));
+        return __classPrivateFieldGet(this, _Query_repository, "f").query(query);
     }
     [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
         return __asyncGenerator(this, arguments, function* _a() {
@@ -141,6 +181,7 @@ class Query {
             let end = false;
             while (!end) {
                 const { records, meta } = yield __await(this.getPaginated(Object.assign(Object.assign({}, options), { page: { size: chunk, offset } })));
+                // Method overloading does not provide type inference for the return type.
                 yield yield __await(records);
                 offset += chunk;
                 end = !meta.page.more;
@@ -150,38 +191,49 @@ class Query {
     getMany(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const { records } = yield this.getPaginated(options);
+            // Method overloading does not provide type inference for the return type.
             return records;
         });
     }
+    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; }
+            }
+            // Method overloading does not provide type inference for the return type.
+            return results;
+        });
+    }
     getOne(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
+            // Method overloading does not provide type inference for the return type.
             return records[0] || null;
         });
     }
-    /**async deleteAll(): Promise<number> {
-      // TODO: Return number of affected rows
-      return 0;
-    }**/
     nextPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
+        return this.firstPage(size, offset);
     }
     previousPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
+        return this.firstPage(size, offset);
     }
     firstPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getPaginated({ page: { size, offset } });
-        });
+        return this.getPaginated({ page: { size, offset } });
     }
     lastPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getPaginated({ page: { size, offset, before: 'end' } });
-        });
+        return this.getPaginated({ page: { size, offset, before: 'end' } });
     }
     hasNextPage() {
         return this.meta.page.more;

package/dist/schema/record.d.ts

@@ -0,0 +1,66 @@
+import { SelectedPick } 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<SelectedPick<this, ['*']> | null>;
+    /**
+     * 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<EditableData<Omit<this, keyof XataRecord>>>): Promise<SelectedPick<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>;
+}
+export declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update'> & {
+    /**
+     * Retrieves a refreshed copy of the current record from the database.
+     */
+    read(): Promise<SelectedPick<Record, ['*']> | null>;
+    /**
+     * 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<EditableData<Omit<Record, keyof XataRecord>>>): Promise<SelectedPick<Record, ['*']>>;
+};
+export declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
+export declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
+export declare type EditableData<O extends BaseData> = {
+    [K in keyof O]: O[K] extends XataRecord ? {
+        id: string;
+    } : NonNullable<O[K]> extends XataRecord ? {
+        id: string;
+    } | undefined : O[K];
+};

package/dist/schema/record.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isXataRecord = exports.isIdentifiable = void 0;
+const lang_1 = require("../util/lang");
+function isIdentifiable(x) {
+    return (0, lang_1.isObject)(x) && (0, lang_1.isString)(x === null || x === void 0 ? void 0 : x.id);
+}
+exports.isIdentifiable = isIdentifiable;
+function isXataRecord(x) {
+    var _a;
+    return (isIdentifiable(x) && typeof (x === null || x === void 0 ? void 0 : x.xata) === 'object' && typeof ((_a = x === null || x === void 0 ? void 0 : x.xata) === null || _a === void 0 ? void 0 : _a.version) === 'number');
+}
+exports.isXataRecord = isXataRecord;

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