@xata.io/client 0.0.0-beta.c9e08d0 → 0.0.0-beta.ca9389a

package/dist/index.js

@@ -1,493 +1,20 @@
 "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 __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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.Query = exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
-const errors_1 = require("./util/errors");
-const gt = (value) => ({ $gt: value });
-exports.gt = gt;
-const ge = (value) => ({ $ge: value });
-exports.ge = ge;
-const gte = (value) => ({ $ge: value });
-exports.gte = gte;
-const lt = (value) => ({ $lt: value });
-exports.lt = lt;
-const lte = (value) => ({ $le: value });
-exports.lte = lte;
-const le = (value) => ({ $le: value });
-exports.le = le;
-const exists = (column) => ({ $exists: column });
-exports.exists = exists;
-const notExists = (column) => ({ $notExists: column });
-exports.notExists = notExists;
-const startsWith = (value) => ({ $startsWith: value });
-exports.startsWith = startsWith;
-const endsWith = (value) => ({ $endsWith: value });
-exports.endsWith = endsWith;
-const pattern = (value) => ({ $pattern: value });
-exports.pattern = pattern;
-const is = (value) => ({ $is: value });
-exports.is = is;
-const isNot = (value) => ({ $isNot: value });
-exports.isNot = isNot;
-const contains = (value) => ({ $contains: value });
-exports.contains = contains;
-// TODO: these can only be applied to columns of type "multiple"
-const includes = (value) => ({ $includes: value });
-exports.includes = includes;
-const includesSubstring = (value) => ({ $includesSubstring: value });
-exports.includesSubstring = includesSubstring;
-const includesPattern = (value) => ({ $includesPattern: value });
-exports.includesPattern = includesPattern;
-const includesAll = (value) => ({ $includesAll: value });
-exports.includesAll = includesAll;
-class Page {
-    constructor(query, meta, records = []) {
-        this.query = query;
-        this.meta = meta;
-        this.records = records;
-    }
-    nextPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.query.getPaginated({ page: { size, offset, after: this.meta.page.cursor } });
-        });
-    }
-    previousPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.query.getPaginated({ page: { size, offset, before: this.meta.page.cursor } });
-        });
-    }
-    firstPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.query.getPaginated({ page: { size, offset, first: this.meta.page.cursor } });
-        });
-    }
-    lastPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.query.getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
-        });
-    }
-    // TODO: We need to add something on the backend if we want a hasPreviousPage
-    hasNextPage() {
-        return this.meta.page.more;
-    }
-}
-class Query {
-    constructor(repository, table, data, parent) {
-        // Cursor pagination
-        this.query = this;
-        this.meta = { page: { cursor: 'start', more: true } };
-        this.records = [];
-        if (repository) {
-            this.repository = repository;
-        }
-        else {
-            this.repository = this;
-        }
-        this.table = table;
-        // For some reason Object.assign(this, parent) didn't work in this case
-        // so doing all this manually:
-        this.$any = parent === null || parent === void 0 ? void 0 : parent.$any;
-        this.$all = parent === null || parent === void 0 ? void 0 : parent.$all;
-        this.$not = parent === null || parent === void 0 ? void 0 : parent.$not;
-        this.$none = parent === null || parent === void 0 ? void 0 : parent.$none;
-        this.$sort = parent === null || parent === void 0 ? void 0 : parent.$sort;
-        Object.assign(this, data);
-        // These bindings are used to support deconstructing
-        // const { any, not, filter, sort } = xata.users.query()
-        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 });
-    }
-    any(...queries) {
-        return new Query(this.repository, this.table, {
-            $any: (this.$any || []).concat(queries)
-        }, this);
-    }
-    all(...queries) {
-        return new Query(this.repository, this.table, {
-            $all: (this.$all || []).concat(queries)
-        }, this);
-    }
-    not(...queries) {
-        return new Query(this.repository, this.table, {
-            $not: (this.$not || []).concat(queries)
-        }, this);
-    }
-    none(...queries) {
-        return new Query(this.repository, this.table, {
-            $none: (this.$none || []).concat(queries)
-        }, this);
-    }
-    filter(a, b) {
-        if (arguments.length === 1) {
-            const constraints = a;
-            const queries = [];
-            for (const [column, constraint] of Object.entries(constraints)) {
-                queries.push({ [column]: constraint });
-            }
-            return new Query(this.repository, this.table, {
-                $all: (this.$all || []).concat(queries)
-            }, this);
-        }
-        else {
-            const column = a;
-            const value = b;
-            return new Query(this.repository, this.table, {
-                $all: (this.$all || []).concat({ [column]: value })
-            }, this);
-        }
-    }
-    sort(column, direction) {
-        const sort = Object.assign(Object.assign({}, this.$sort), { [column]: direction });
-        const q = new Query(this.repository, this.table, {
-            $sort: sort
-        }, this);
-        return q;
-    }
-    getPaginated(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.repository._runQuery(this, options);
-        });
-    }
-    [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;
-            }
-        });
-    }
-    getMany(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { records } = yield this.getPaginated(options);
-            return records;
-        });
-    }
-    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;
-        });
-    }
-    deleteAll() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: Return number of affected rows
-            return 0;
-        });
-    }
-    include(columns) {
-        // TODO
-        return this;
-    }
-    nextPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
-    }
-    previousPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
-    }
-    firstPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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' } });
-        });
-    }
-    hasNextPage() {
-        return this.meta.page.more;
-    }
-}
-exports.Query = Query;
-class Repository extends Query {
-    select(...columns) {
-        return new Query(this.repository, this.table, {});
-    }
-}
-exports.Repository = Repository;
-class RestRepository extends Repository {
-    constructor(client, table) {
-        super(null, table, {});
-        this.client = client;
-        const doWeHaveFetch = typeof fetch !== 'undefined';
-        const isInjectedFetchProblematic = !this.client.options.fetch;
-        if (doWeHaveFetch) {
-            this.fetch = fetch;
-        }
-        else if (isInjectedFetchProblematic) {
-            throw new Error(errors_1.errors.falsyFetchImplementation);
-        }
-        else {
-            this.fetch = this.client.options.fetch;
-        }
-        Object.defineProperty(this, 'client', { enumerable: false });
-        Object.defineProperty(this, 'fetch', { enumerable: false });
-        Object.defineProperty(this, 'hostname', { enumerable: false });
-    }
-    request(method, path, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { databaseURL, apiKey } = this.client.options;
-            const branch = yield this.client.getBranch();
-            const resp = yield this.fetch(`${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();
-        });
-    }
-    select(...columns) {
-        return new Query(this.repository, this.table, {});
-    }
-    create(object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const record = transformObjectLinks(object);
-            const response = yield this.request('POST', `/tables/${this.table}/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/${this.table}/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/${this.table}/data/${id}`);
-                if (!response)
-                    return null;
-                return this.client.initObject(this.table, 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/${this.table}/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 this.client.initObject(this.table, response);
-        });
-    }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.request('DELETE', `/tables/${this.table}/data/${id}`);
-        });
-    }
-    _runQuery(query, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const filter = {
-                $any: query.$any,
-                $all: query.$all,
-                $not: query.$not,
-                $none: query.$none
-            };
-            const body = {
-                filter: Object.values(filter).some(Boolean) ? filter : undefined,
-                sort: query.$sort,
-                page: options === null || options === void 0 ? void 0 : options.page
-            };
-            const response = yield this.request('POST', `/tables/${this.table}/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) => this.client.initObject(this.table, record));
-            return new Page(query, meta, records);
-        });
-    }
-}
-exports.RestRepository = RestRepository;
-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_2, _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_2_1) { e_2 = { error: e_2_1 }; }
-            finally {
-                try {
-                    if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) yield _a.call(strategies_1);
-                }
-                finally { if (e_2) throw e_2.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);
@@ -495,15 +22,8 @@ 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("./client"), exports);
+__exportStar(require("./schema"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./util/config"), exports);

package/dist/namespace.d.ts

@@ -0,0 +1,7 @@
+import { FetcherExtraProps } from './api/fetcher';
+export declare abstract class Namespace {
+    abstract build(options: NamespaceBuildOptions): unknown;
+}
+export declare type NamespaceBuildOptions = {
+    getFetchProps: () => Promise<FetcherExtraProps>;
+};

package/dist/namespace.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Namespace = void 0;
+class Namespace {
+}
+exports.Namespace = Namespace;

package/dist/schema/filters.d.ts

@@ -0,0 +1,96 @@
+import { SingleOrArray } from '../util/types';
+import { SelectableColumn, ValueAtColumn } from './selection';
+/**
+ * PropertyMatchFilter
+ * Example:
+{
+  "filter": {
+    "name": "value",
+    "name": {
+       "$is":  "value",
+       "$any": [ "value1", "value2" ],
+    },
+    "settings.plan": {"$any": ["free", "paid"]},
+    "settings.plan": "free",
+    "settings": {
+      "plan": "free"
+    },
+  }
+}
+*/
+declare type PropertyAccessFilter<Record> = {
+    [key in SelectableColumn<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
+};
+export declare type PropertyFilter<T> = T | {
+    $is: T;
+} | {
+    $isNot: T;
+} | {
+    $any: T[];
+} | {
+    $none: T[];
+} | ValueTypeFilters<T>;
+declare type IncludesFilter<T> = PropertyFilter<T> | {
+    [key in '$all' | '$none' | '$any']?: IncludesFilter<T> | Array<IncludesFilter<T> | {
+        $not: IncludesFilter<T>;
+    }>;
+};
+export declare type StringTypeFilter = {
+    [key in '$contains' | '$pattern' | '$startsWith' | '$endsWith']?: string;
+};
+export declare type ComparableType = number | Date;
+export declare type ComparableTypeFilter<T extends ComparableType> = {
+    [key in '$gt' | '$lt' | '$ge' | '$le']?: T;
+};
+export declare type ArrayFilter<T> = {
+    [key in '$includes']?: SingleOrArray<PropertyFilter<T> | ValueTypeFilters<T>> | IncludesFilter<T>;
+} | {
+    [key in '$includesAll' | '$includesNone' | '$includesAny']?: T | Array<PropertyFilter<T> | {
+        $not: PropertyFilter<T>;
+    }>;
+};
+declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T extends number ? ComparableTypeFilter<number> : T extends Date ? ComparableTypeFilter<Date> : T extends Array<infer T> ? ArrayFilter<T> : never;
+/**
+ * AggregatorFilter
+ * Example:
+{
+  "filter": {
+      "$any": {
+        "settings.dark": true,
+        "settings.plan": "free"
+      }
+  },
+}
+{
+  "filter": {
+    "$any": [
+      {
+        "name": "r1",
+      },
+      {
+        "name": "r2",
+      },
+    ],
+}
+*/
+declare type AggregatorFilter<Record> = {
+    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<Record>>;
+};
+/**
+ * Existance filter
+ * Example: { filter: { $exists: "settings" } }
+ */
+export declare type ExistanceFilter<Record> = {
+    [key in '$exists' | '$notExists']?: SelectableColumn<Record>;
+};
+declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
+/**
+ * Nested filter
+ * Injects the Api filters on nested properties
+ * Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
+ */
+declare type NestedApiFilter<T> = T extends Record<string, any> ? {
+    [key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
+} : PropertyFilter<T>;
+export declare type Filter<Record> = BaseApiFilter<Record> | NestedApiFilter<Record>;
+export {};

package/dist/schema/filters.js

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

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

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