@xata.io/client 0.0.0-beta.44b2150 → 0.0.0-beta.4e4e7fc

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -9,265 +13,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-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_client, _RestRepository_fetch, _RestRepository_table;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
-const filters_1 = require("./schema/filters");
-const pagination_1 = require("./schema/pagination");
-const query_1 = require("./schema/query");
-const errors_1 = require("./util/errors");
-class Repository extends query_1.Query {
-}
-exports.Repository = Repository;
-class RestRepository extends Repository {
-    constructor(client, table) {
-        super(null, table, {});
-        _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");
-        const doWeHaveFetch = typeof fetch !== 'undefined';
-        const isInjectedFetchProblematic = !__classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch;
-        if (doWeHaveFetch) {
-            __classPrivateFieldSet(this, _RestRepository_fetch, fetch, "f");
-        }
-        else if (isInjectedFetchProblematic) {
-            throw new Error(errors_1.errors.falsyFetchImplementation);
-        }
-        else {
-            __classPrivateFieldSet(this, _RestRepository_fetch, __classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch, "f");
-        }
-    }
-    request(method, path, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { databaseURL, apiKey } = __classPrivateFieldGet(this, _RestRepository_client, "f").options;
-            const branch = yield __classPrivateFieldGet(this, _RestRepository_client, "f").getBranch();
-            const fetchImpl = __classPrivateFieldGet(this, _RestRepository_fetch, "f");
-            const resp = yield fetchImpl(`${databaseURL}:${branch}${path}`, {
-                method,
-                headers: {
-                    Accept: '*/*',
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${apiKey}`
-                },
-                body: JSON.stringify(body)
-            });
-            if (!resp.ok) {
-                try {
-                    const json = yield resp.json();
-                    const message = json.message;
-                    if (typeof message === 'string') {
-                        throw new XataError(message, resp.status);
-                    }
-                }
-                catch (err) {
-                    if (err instanceof XataError)
-                        throw err;
-                    // Ignore errors for other reasons.
-                    // For example if the response's body cannot be parsed as JSON
-                }
-                throw new XataError(resp.statusText, resp.status);
-            }
-            if (resp.status === 204)
-                return undefined;
-            return resp.json();
-        });
-    }
-    create(object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const record = transformObjectLinks(object);
-            const response = yield this.request('POST', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/data`, record);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            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 records = objects.map((object) => transformObjectLinks(object));
-            const response = yield this.request('POST', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/bulk`, { records });
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            // TODO: Use filer.$any() to get all the records
-            const finalObjects = yield Promise.all(response.recordIDs.map((id) => this.read(id)));
-            if (finalObjects.some((object) => !object)) {
-                throw new Error('The server failed to save the record');
-            }
-            return finalObjects;
-        });
-    }
-    read(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.request('GET', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/data/${id}`);
-                if (!response)
-                    return null;
-                return __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), response);
-            }
-            catch (err) {
-                if (err.status === 404)
-                    return null;
-                throw err;
-            }
-        });
-    }
-    update(id, object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.request('PUT', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/data/${id}`, object);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            // TODO: Review this, not sure we are properly initializing the object
-            return __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), response);
-        });
-    }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.request('DELETE', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/data/${id}`);
-        });
-    }
-    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 response = yield this.request('POST', `/tables/${__classPrivateFieldGet(this, _RestRepository_table, "f")}/query`, body);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            const { meta, records: objects } = response;
-            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();
-class RestRespositoryFactory {
-    createRepository(client, table) {
-        return new RestRepository(client, table);
-    }
-}
-exports.RestRespositoryFactory = RestRespositoryFactory;
-class BaseClient {
-    constructor(options, links) {
-        if (!options.databaseURL || !options.apiKey || !options.branch) {
-            throw new Error('Options databaseURL, apiKey and branch are required');
-        }
-        this.options = options;
-        this.links = links;
-    }
-    initObject(table, object) {
-        const o = {};
-        Object.assign(o, object);
-        const tableLinks = this.links[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 (this.branch)
-                return this.branch;
-            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) {
-                        this.branch = branch;
-                        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;
+exports.XataError = void 0;
 class XataError extends Error {
     constructor(message, status) {
         super(message);
@@ -275,16 +22,5 @@ class XataError extends Error {
     }
 }
 exports.XataError = XataError;
-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 });
-    }, {});
-};
+__exportStar(require("./api"), exports);
 __exportStar(require("./schema"), exports);

package/dist/schema/index.d.ts

@@ -1 +1,5 @@
 export * from './operators';
+export type { XataRecord } from './record';
+export { Repository, RestRepository, RestRespositoryFactory, BaseClient } from './repository';
+export type { XataClientOptions } from './repository';
+export { Query } from './query';

package/dist/schema/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,4 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Query = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
 __exportStar(require("./operators"), exports);
+var repository_1 = require("./repository");
+Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });
+Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_1.RestRepository; } });
+Object.defineProperty(exports, "RestRespositoryFactory", { enumerable: true, get: function () { return repository_1.RestRespositoryFactory; } });
+Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
+var query_1 = require("./query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });

package/dist/schema/query.d.ts

@@ -1,78 +1,13 @@
 import { XataRecord, Repository } from '..';
+import { FilterExpression, SortExpression, PageConfig, ColumnsFilter } from '../api/schemas';
 import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
 import { PaginationOptions, Page, Paginable, PaginationQueryMeta } from './pagination';
 import { Selectable, SelectableColumn, Select } from './selection';
-export declare type QueryOptions<T> = {
+export declare type QueryOptions<T extends XataRecord> = {
     page?: PaginationOptions;
-    columns?: Array<keyof Selectable<T>>;
+    columns?: Extract<keyof Selectable<T>, string>[];
     sort?: SortFilter<T> | SortFilter<T>[];
 };
-export declare type FilterExpression = {
-    $exists?: string;
-    $existsNot?: string;
-    $any?: FilterList;
-    $all?: FilterList;
-    $none?: FilterList;
-    $not?: FilterList;
-} & {
-    [key: string]: FilterColumn;
-};
-export declare type FilterList = FilterExpression | FilterExpression[];
-export declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
-/**
- * @maxProperties 1
- * @minProperties 1
- */
-export declare type FilterColumnIncludes = {
-    $includes?: FilterPredicate;
-    $includesAny?: FilterPredicate;
-    $includesAll?: FilterPredicate;
-    $includesNone?: FilterPredicate;
-};
-export declare type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
-/**
- * @maxProperties 1
- * @minProperties 1
- */
-export declare type FilterPredicateOp = {
-    $any?: FilterPredicate[];
-    $all?: FilterPredicate[];
-    $none?: FilterPredicate | FilterPredicate[];
-    $not?: FilterPredicate | FilterPredicate[];
-    $is?: FilterValue | FilterValue[];
-    $isNot?: FilterValue | FilterValue[];
-    $lt?: FilterRangeValue;
-    $le?: FilterRangeValue;
-    $gt?: FilterRangeValue;
-    $ge?: FilterRangeValue;
-    $contains?: string;
-    $startsWith?: string;
-    $endsWith?: string;
-    $pattern?: string;
-};
-export declare type FilterPredicateRangeOp = {
-    $lt?: FilterRangeValue;
-    $le?: FilterRangeValue;
-    $gt?: FilterRangeValue;
-    $ge?: FilterRangeValue;
-};
-export declare type FilterRangeValue = number | string;
-export declare type FilterValue = number | string | boolean;
-export declare type SortExpression = string[] | {
-    [key: string]: SortOrder;
-} | {
-    [key: string]: SortOrder;
-}[];
-export declare type SortOrder = 'asc' | 'desc';
-export declare type PageConfig = {
-    after?: string;
-    before?: string;
-    first?: string;
-    last?: string;
-    size?: number;
-    offset?: number;
-};
-export declare type ColumnsFilter = string[];
 export declare type QueryTableOptions = {
     filter: FilterExpression;
     sort?: SortExpression;

package/dist/schema/query.js

@@ -77,19 +77,19 @@ class Query {
         return __classPrivateFieldGet(this, _Query_data, "f");
     }
     any(...queries) {
-        const $any = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$any)).flat();
+        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"));
     }
     all(...queries) {
-        const $all = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$all)).flat();
+        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"));
     }
     not(...queries) {
-        const $not = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$not)).flat();
+        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"));
     }
     none(...queries) {
-        const $none = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$none)).flat();
+        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) {

package/dist/schema/record.d.ts

@@ -0,0 +1,10 @@
+import { Selectable } from './selection';
+export interface XataRecord {
+    id: string;
+    xata: {
+        version: number;
+    };
+    read(): Promise<this>;
+    update(data: Partial<Selectable<this>>): Promise<this>;
+    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,52 @@
+import { FetchImpl } from '../api/fetcher';
+import { Page } from './pagination';
+import { Query, QueryOptions } from './query';
+import { XataRecord } from './record';
+import { Selectable, SelectableColumn, Select } from './selection';
+export declare type Links = Record<string, Array<string[]>>;
+export declare abstract class Repository<T extends XataRecord> extends Query<T> {
+    abstract create(object: Selectable<T>): Promise<T>;
+    abstract createMany(objects: Selectable<T>[]): Promise<T[]>;
+    abstract read(id: string): Promise<T | null>;
+    abstract update(id: string, object: Partial<Selectable<T>>): Promise<T>;
+    abstract upsert(id: string, object: Selectable<T>): Promise<T>;
+    abstract delete(id: string): void;
+    abstract query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+}
+export declare class RestRepository<T extends XataRecord> extends Repository<T> {
+    #private;
+    constructor(client: BaseClient<any>, table: string);
+    create(object: Selectable<T>): Promise<T>;
+    createMany(objects: T[]): Promise<T[]>;
+    read(recordId: string): Promise<T | null>;
+    update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
+    upsert(recordId: string, object: Selectable<T>): Promise<T>;
+    delete(recordId: string): Promise<void>;
+    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+}
+interface RepositoryFactory {
+    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+}
+export declare class RestRespositoryFactory implements RepositoryFactory {
+    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+}
+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?: FetchImpl;
+    databaseURL?: string;
+    branch: BranchStrategyOption;
+    apiKey: string;
+    repositoryFactory?: RepositoryFactory;
+};
+export declare class BaseClient<D extends 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 {};