@xata.io/client 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+export interface XataRecord {
+    _id: string;
+    _version: number;
+    read(): Promise<this>;
+    update(data: Selectable<this>): Promise<this>;
+    delete(): Promise<void>;
+}
+export declare type Queries<T> = {
+    [key in keyof T as T[key] extends Query<infer A, infer B> ? key : never]: T[key];
+};
+export declare type OmitQueries<T> = {
+    [key in keyof T as T[key] extends Query<infer A, infer B> ? never : key]: T[key];
+};
+export declare type OmitLinks<T> = {
+    [key in keyof T as T[key] extends XataRecord ? never : key]: T[key];
+};
+export declare type OmitMethods<T> = {
+    [key in keyof T as T[key] extends Function ? never : key]: T[key];
+};
+export declare type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, '_id' | '_version'>;
+export declare type Select<T, K extends keyof T> = Pick<T, K> & Queries<T> & XataRecord;
+export declare type Include<T> = {
+    [key in keyof T as T[key] extends XataRecord ? key : never]?: boolean | Array<keyof Selectable<T[key]>>;
+};
+declare type SortDirection = 'asc' | 'desc';
+declare type Operator = '_gt' | '_lt' | '_gte' | '_lte' | '_exists' | '_notExists' | '_endsWith' | '_startsWith' | '_pattern' | '_isNot' | '_includes' | '_includesSubstring' | '_includesPattern' | '_includesAll';
+declare type Constraint<T> = Partial<Record<Operator, T>>;
+declare type ComparableType = number | Date;
+export declare const gt: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
+export declare const gte: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
+export declare const lt: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
+export declare const lte: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
+export declare const exists: (column: string) => Constraint<string>;
+export declare const notExists: (column: string) => Constraint<string>;
+export declare const startsWith: (value: string) => Constraint<string>;
+export declare const endsWith: (value: string) => Constraint<string>;
+export declare const pattern: (value: string) => Constraint<string>;
+export declare const isNot: <T>(value: T) => Partial<Record<Operator, T>>;
+export declare const includes: (value: string) => Constraint<string>;
+export declare const includesSubstring: (value: string) => Constraint<string>;
+export declare const includesPattern: (value: string) => Constraint<string>;
+export declare const includesAll: (value: string) => Constraint<string>;
+declare type FilterConstraints<T> = {
+    [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | Constraint<T[key]>;
+};
+declare type BulkQueryOptions<T> = {
+    filter?: FilterConstraints<T>;
+    sort?: {
+        column: keyof T;
+        direction?: SortDirection;
+    } | keyof T;
+};
+declare type QueryOrConstraint<T, R> = Query<T, R> | Constraint<T>;
+export declare class Query<T, R = T> {
+    table: string;
+    repository: Repository<T>;
+    readonly _any?: QueryOrConstraint<T, R>[];
+    readonly _all?: QueryOrConstraint<T, R>[];
+    readonly _not?: QueryOrConstraint<T, R>[];
+    readonly _none?: QueryOrConstraint<T, R>[];
+    readonly _sort?: Record<string, SortDirection>;
+    constructor(repository: Repository<T> | null, table: string, data: Partial<Query<T, R>>, parent?: Query<T, R>);
+    any(...queries: Query<T, R>[]): Query<T, R>;
+    all(...queries: Query<T, R>[]): Query<T, R>;
+    not(...queries: Query<T, R>[]): Query<T, R>;
+    none(...queries: Query<T, R>[]): Query<T, R>;
+    filter(constraints: FilterConstraints<T>): Query<T, R>;
+    filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | Constraint<T[F]>): Query<T, R>;
+    sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
+    getMany(options?: BulkQueryOptions<T>): Promise<R[]>;
+    getOne(options?: BulkQueryOptions<T>): Promise<R | null>;
+    deleteAll(): Promise<number>;
+    include(columns: Include<T>): this;
+    toJSON(): {
+        _filter: {
+            _any: QueryOrConstraint<T, R>[] | undefined;
+            _all: QueryOrConstraint<T, R>[] | undefined;
+            _not: QueryOrConstraint<T, R>[] | undefined;
+            _none: QueryOrConstraint<T, R>[] | undefined;
+        } | undefined;
+        _sort: Record<string, SortDirection> | undefined;
+    };
+}
+export declare abstract class Repository<T> extends Query<T, Selectable<T>> {
+    select<K extends keyof Selectable<T>>(...columns: K[]): Query<T, Select<T, K>>;
+    abstract create(object: Selectable<T>): Promise<T>;
+    abstract read(id: string): Promise<T | null>;
+    abstract update(id: string, object: Partial<T>): Promise<T>;
+    abstract delete(id: string): void;
+    abstract query<R>(query: Query<T, R>): Promise<R[]>;
+}
+export declare class RestRepository<T> extends Repository<T> {
+    client: BaseClient<any>;
+    fetch: any;
+    constructor(client: BaseClient<any>, table: string);
+    request(method: string, path: string, body?: unknown): Promise<any>;
+    select<K extends keyof T>(...columns: K[]): Query<T, Select<T, K>>;
+    create(object: T): Promise<T>;
+    read(id: string): Promise<T | null>;
+    update(id: string, object: Partial<T>): Promise<T>;
+    delete(id: string): Promise<void>;
+    query<R>(query: Query<T, R>): Promise<R[]>;
+}
+interface RepositoryFactory {
+    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
+}
+export declare class RestRespositoryFactory implements RepositoryFactory {
+    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
+}
+export declare type XataClientOptions = {
+    fetch?: unknown;
+    url: string;
+    token: string;
+    repositoryFactory?: RepositoryFactory;
+};
+export declare class BaseClient<D extends Record<string, Repository<any>>> {
+    options: XataClientOptions;
+    private links;
+    db: D;
+    constructor(options: XataClientOptions, links: Links);
+    initObject<T>(table: string, object: object): T;
+}
+export declare class XataError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+export declare type Links = Record<string, Array<string[]>>;
+export {};

package/dist/index.js

@@ -0,0 +1,319 @@
+"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());
+    });
+};
+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.isNot = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.lte = exports.lt = exports.gte = exports.gt = void 0;
+const gt = (value) => ({ _gt: value });
+exports.gt = gt;
+const gte = (value) => ({ _gte: value });
+exports.gte = gte;
+const lt = (value) => ({ _lt: value });
+exports.lt = lt;
+const lte = (value) => ({ _lte: value });
+exports.lte = lte;
+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 isNot = (value) => ({ _isNot: value });
+exports.isNot = isNot;
+// 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 Query {
+    constructor(repository, table, data, parent) {
+        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);
+    }
+    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, {
+                _any: (this._any || []).concat(queries)
+            }, this);
+        }
+        else {
+            const column = a;
+            const value = b;
+            return new Query(this.repository, this.table, {
+                _any: (this._any || []).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;
+    }
+    // TODO: pagination. Maybe implement different methods for different type of paginations
+    // and one to simply get the first records returned by the query with no pagination.
+    getMany(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: use options
+            return this.repository.query(this);
+        });
+    }
+    getOne(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: use options
+            const arr = yield this.getMany(); // TODO, limit to 1
+            return arr[0] || null;
+        });
+    }
+    deleteAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Return number of affected rows
+            return 0;
+        });
+    }
+    include(columns) {
+        // TODO
+        return this;
+    }
+    toJSON() {
+        const _filter = {
+            _any: this._any,
+            _all: this._all,
+            _not: this._not,
+            _none: this._none
+        };
+        return {
+            _filter: Object.values(_filter).some(Boolean) ? _filter : undefined,
+            _sort: this._sort
+        };
+    }
+}
+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 { fetch } = client.options;
+        if (fetch) {
+            this.fetch = fetch;
+        }
+        else if (typeof window === 'object') {
+            this.fetch = window.fetch;
+        }
+        else if (typeof require === 'function') {
+            try {
+                this.fetch = require('node-fetch');
+            }
+            catch (err) {
+                try {
+                    this.fetch = require('cross-fetch');
+                }
+                catch (err) {
+                    throw new Error('No fetch implementation found. Please provide one in the constructor');
+                }
+            }
+        }
+        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 { url: xatabaseURL } = this.client.options;
+            const resp = yield this.fetch(`${xatabaseURL}${path}`, {
+                method,
+                headers: {
+                    Accept: '*/*',
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${this.client.options.token}`
+                },
+                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;
+            return resp.json();
+        });
+    }
+    select(...columns) {
+        return new Query(this.repository, this.table, {});
+    }
+    create(object) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const obj = yield this.request('POST', `/tables/${this.table}/data`, object);
+            return this.client.initObject(this.table, obj);
+        });
+    }
+    read(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const obj = yield this.request('GET', `/tables/${this.table}/data/${id}`);
+                return this.client.initObject(this.table, obj);
+            }
+            catch (err) {
+                if (err.status === 404)
+                    return null;
+                throw err;
+            }
+        });
+    }
+    update(id, object) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const obj = yield this.request('PUT', `/tables/${this.table}/data/${id}`, object);
+            return this.client.initObject(this.table, obj);
+        });
+    }
+    delete(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.request('DELETE', `/tables/${this.table}/data/${id}`);
+        });
+    }
+    query(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request('POST', `/tables/${this.table}/query`, query);
+            return result.records.map((record) => this.client.initObject(this.table, record));
+        });
+    }
+}
+exports.RestRepository = RestRepository;
+class RestRespositoryFactory {
+    createRepository(client, table) {
+        return new RestRepository(client, table);
+    }
+}
+exports.RestRespositoryFactory = RestRespositoryFactory;
+class BaseClient {
+    constructor(options, links) {
+        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.startsWith('_'))) {
+                    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;
+    }
+}
+exports.BaseClient = BaseClient;
+class XataError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.status = status;
+    }
+}
+exports.XataError = XataError;

package/dist/index.test.d.ts

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

package/dist/index.test.js

@@ -0,0 +1,182 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+const fetch = jest.fn();
+const client = new _1.BaseClient({
+    fetch,
+    token: '1234',
+    url: 'https://my-workspace-5df34do.staging.xatabase.co/db/xata:main'
+}, {});
+const users = new _1.RestRepository(client, 'users');
+describe('request', () => {
+    test('builds the right arguments for a GET request', () => __awaiter(void 0, void 0, void 0, function* () {
+        fetch.mockReset().mockImplementation(() => {
+            return {
+                ok: true,
+                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
+            };
+        });
+        users.request('GET', '/foo');
+        expect(fetch).toHaveBeenCalledTimes(1);
+        expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:main/foo",
+        Object {
+          "body": undefined,
+          "headers": Object {
+            "Accept": "*/*",
+            "Authorization": "Bearer 1234",
+            "Content-Type": "application/json",
+          },
+          "method": "GET",
+        },
+      ]
+    `);
+    }));
+    test('builds the right arguments for a POST request', () => __awaiter(void 0, void 0, void 0, function* () {
+        fetch.mockReset().mockImplementation(() => {
+            return {
+                ok: true,
+                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
+            };
+        });
+        users.request('POST', '/foo', { a: 1 });
+        expect(fetch).toHaveBeenCalledTimes(1);
+        expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:main/foo",
+        Object {
+          "body": "{\\"a\\":1}",
+          "headers": Object {
+            "Accept": "*/*",
+            "Authorization": "Bearer 1234",
+            "Content-Type": "application/json",
+          },
+          "method": "POST",
+        },
+      ]
+    `);
+    }));
+    test('throws if the response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        fetch.mockImplementation(() => {
+            return {
+                ok: false,
+                status: 404,
+                statusText: 'Not Found'
+            };
+        });
+        expect(users.request('GET', '/foo')).rejects.toThrow(new _1.XataError('Not Found', 404));
+    }));
+    test('throws with the error from the server if the response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        fetch.mockImplementation(() => {
+            return {
+                ok: false,
+                status: 404,
+                statusText: 'Not Found',
+                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({ message: 'Resource not found' }); })
+            };
+        });
+        expect(users.request('GET', '/foo')).rejects.toThrow(new _1.XataError('Resource not found', 404));
+    }));
+    test('returns the json body if the response is ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        const json = { a: 1 };
+        fetch.mockImplementation(() => {
+            return {
+                ok: true,
+                json: () => __awaiter(void 0, void 0, void 0, function* () { return json; })
+            };
+        });
+        const result = yield users.request('GET', '/foo');
+        expect(result).toEqual(json);
+    }));
+});
+function expectRequest(expectedRequest, callback, response) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const request = jest.fn(() => __awaiter(this, void 0, void 0, function* () { return response; }));
+        users.request = request;
+        yield callback();
+        const { calls } = request.mock;
+        expect(calls.length).toBe(1);
+        const [method, path, body] = calls[0];
+        expect(method).toBe(expectedRequest.method);
+        expect(path).toBe(expectedRequest.path);
+        expect(JSON.stringify(body)).toBe(JSON.stringify(expectedRequest.body));
+    });
+}
+describe('query', () => {
+    describe('getMany', () => {
+        test('simple query', () => __awaiter(void 0, void 0, void 0, function* () {
+            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+            expectRequest(expected, () => users.getMany(), { records: [] });
+        }));
+        test('query with one filter', () => __awaiter(void 0, void 0, void 0, function* () {
+            const expected = { method: 'POST', path: '/tables/users/query', body: { _filter: { _any: [{ name: 'foo' }] } } };
+            expectRequest(expected, () => users.filter('name', 'foo').getMany(), { records: [] });
+        }));
+    });
+    describe('getOne', () => {
+        test('returns a single object', () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = { records: [{ _id: '1234' }] };
+            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+            expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+                const first = yield users.select().getOne();
+                expect(first === null || first === void 0 ? void 0 : first._id).toBe(result.records[0]._id);
+            }), result);
+        }));
+        test('returns null if no objects are returned', () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = { records: [] };
+            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+            expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+                const first = yield users.getOne();
+                expect(first).toBeNull();
+            }), result);
+        }));
+    });
+});
+describe('read', () => {
+    test('reads an object by id successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+        const id = 'rec_1234';
+        const expected = { method: 'GET', path: `/tables/users/data/${id}`, body: undefined };
+        expectRequest(expected, () => users.read(id));
+    }));
+});
+describe('Repository.update', () => {
+    test('updates and object successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+        const object = { _id: 'rec_1234', _version: 1, name: 'Ada' };
+        const expected = { method: 'PUT', path: `/tables/users/data/${object._id}`, body: object };
+        expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield users.update(object._id, object);
+            expect(result._id).toBe(object._id);
+        }), { _id: object._id });
+    }));
+});
+describe('Repository.delete', () => {
+    test('deletes a record by id successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+        const id = 'rec_1234';
+        const expected = { method: 'DELETE', path: `/tables/users/data/${id}`, body: undefined };
+        expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield users.delete(id);
+            expect(result).toBe(undefined);
+        }));
+    }));
+});
+describe('create', () => {
+    test('successful', () => __awaiter(void 0, void 0, void 0, function* () {
+        const created = { _id: 'rec_1234', _version: 0 };
+        const object = { name: 'Ada' };
+        const expected = { method: 'POST', path: '/tables/users/data', body: object };
+        expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield users.create(object);
+            expect(result._id).toBe(created._id);
+        }), created);
+    }));
+});

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@xata.io/client",
+  "version": "0.1.0",
+  "description": "Xata.io SDK for TypesScript and JavaScript",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xataio/client-ts.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/xataio/client-ts/issues"
+  },
+  "homepage": "https://github.com/xataio/client-ts#readme"
+}

package/src/index.test.ts

@@ -0,0 +1,222 @@
+import { BaseClient, RestRepository, XataError, XataRecord } from './';
+
+const fetch = jest.fn();
+const client = new BaseClient(
+  {
+    fetch,
+    token: '1234',
+    url: 'https://my-workspace-5df34do.staging.xatabase.co/db/xata:main'
+  },
+  {}
+);
+
+interface User extends XataRecord {
+  name: string;
+}
+
+const users = new RestRepository<User>(client, 'users');
+
+describe('request', () => {
+  test('builds the right arguments for a GET request', async () => {
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    users.request('GET', '/foo');
+
+    expect(fetch).toHaveBeenCalledTimes(1);
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:main/foo",
+        Object {
+          "body": undefined,
+          "headers": Object {
+            "Accept": "*/*",
+            "Authorization": "Bearer 1234",
+            "Content-Type": "application/json",
+          },
+          "method": "GET",
+        },
+      ]
+    `);
+  });
+
+  test('builds the right arguments for a POST request', async () => {
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    users.request('POST', '/foo', { a: 1 });
+
+    expect(fetch).toHaveBeenCalledTimes(1);
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:main/foo",
+        Object {
+          "body": "{\\"a\\":1}",
+          "headers": Object {
+            "Accept": "*/*",
+            "Authorization": "Bearer 1234",
+            "Content-Type": "application/json",
+          },
+          "method": "POST",
+        },
+      ]
+    `);
+  });
+
+  test('throws if the response is not ok', async () => {
+    fetch.mockImplementation(() => {
+      return {
+        ok: false,
+        status: 404,
+        statusText: 'Not Found'
+      };
+    });
+
+    expect(users.request('GET', '/foo')).rejects.toThrow(new XataError('Not Found', 404));
+  });
+
+  test('throws with the error from the server if the response is not ok', async () => {
+    fetch.mockImplementation(() => {
+      return {
+        ok: false,
+        status: 404,
+        statusText: 'Not Found',
+        json: async () => ({ message: 'Resource not found' })
+      };
+    });
+
+    expect(users.request('GET', '/foo')).rejects.toThrow(new XataError('Resource not found', 404));
+  });
+
+  test('returns the json body if the response is ok', async () => {
+    const json = { a: 1 };
+    fetch.mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => json
+      };
+    });
+
+    const result = await users.request('GET', '/foo');
+    expect(result).toEqual(json);
+  });
+});
+
+type ExpectedRequest = {
+  method: string;
+  path: string;
+  body: unknown;
+};
+
+async function expectRequest(expectedRequest: ExpectedRequest, callback: () => void, response?: unknown) {
+  const request = jest.fn(async () => response);
+  users.request = request;
+
+  await callback();
+
+  const { calls } = request.mock;
+  expect(calls.length).toBe(1);
+  const [method, path, body] = calls[0] as any;
+  expect(method).toBe(expectedRequest.method);
+  expect(path).toBe(expectedRequest.path);
+  expect(JSON.stringify(body)).toBe(JSON.stringify(expectedRequest.body));
+}
+
+describe('query', () => {
+  describe('getMany', () => {
+    test('simple query', async () => {
+      const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+      expectRequest(expected, () => users.getMany(), { records: [] });
+    });
+
+    test('query with one filter', async () => {
+      const expected = { method: 'POST', path: '/tables/users/query', body: { _filter: { _any: [{ name: 'foo' }] } } };
+      expectRequest(expected, () => users.filter('name', 'foo').getMany(), { records: [] });
+    });
+  });
+
+  describe('getOne', () => {
+    test('returns a single object', async () => {
+      const result = { records: [{ _id: '1234' }] };
+      const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+      expectRequest(
+        expected,
+        async () => {
+          const first = await users.select().getOne();
+          expect(first?._id).toBe(result.records[0]._id);
+        },
+        result
+      );
+    });
+
+    test('returns null if no objects are returned', async () => {
+      const result = { records: [] };
+      const expected = { method: 'POST', path: '/tables/users/query', body: {} };
+      expectRequest(
+        expected,
+        async () => {
+          const first = await users.getOne();
+          expect(first).toBeNull();
+        },
+        result
+      );
+    });
+  });
+});
+
+describe('read', () => {
+  test('reads an object by id successfully', async () => {
+    const id = 'rec_1234';
+    const expected = { method: 'GET', path: `/tables/users/data/${id}`, body: undefined };
+    expectRequest(expected, () => users.read(id));
+  });
+});
+
+describe('Repository.update', () => {
+  test('updates and object successfully', async () => {
+    const object = { _id: 'rec_1234', _version: 1, name: 'Ada' } as User;
+    const expected = { method: 'PUT', path: `/tables/users/data/${object._id}`, body: object };
+    expectRequest(
+      expected,
+      async () => {
+        const result = await users.update(object._id, object);
+        expect(result._id).toBe(object._id);
+      },
+      { _id: object._id }
+    );
+  });
+});
+describe('Repository.delete', () => {
+  test('deletes a record by id successfully', async () => {
+    const id = 'rec_1234';
+    const expected = { method: 'DELETE', path: `/tables/users/data/${id}`, body: undefined };
+    expectRequest(expected, async () => {
+      const result = await users.delete(id);
+      expect(result).toBe(undefined);
+    });
+  });
+});
+
+describe('create', () => {
+  test('successful', async () => {
+    const created = { _id: 'rec_1234', _version: 0 };
+    const object = { name: 'Ada' } as User;
+    const expected = { method: 'POST', path: '/tables/users/data', body: object };
+    expectRequest(
+      expected,
+      async () => {
+        const result = await users.create(object);
+        expect(result._id).toBe(created._id);
+      },
+      created
+    );
+  });
+});

package/src/index.ts

@@ -0,0 +1,447 @@
+export interface XataRecord {
+  _id: string;
+  _version: number;
+  read(): Promise<this>;
+  update(data: Selectable<this>): Promise<this>;
+  delete(): Promise<void>;
+}
+
+export type Queries<T> = {
+  [key in keyof T as T[key] extends Query<infer A, infer B> ? key : never]: T[key];
+};
+
+export type OmitQueries<T> = {
+  [key in keyof T as T[key] extends Query<infer A, infer B> ? never : key]: T[key];
+};
+
+export type OmitLinks<T> = {
+  [key in keyof T as T[key] extends XataRecord ? never : key]: T[key];
+};
+
+export type OmitMethods<T> = {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  [key in keyof T as T[key] extends Function ? never : key]: T[key];
+};
+
+export type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, '_id' | '_version'>;
+
+export type Select<T, K extends keyof T> = Pick<T, K> & Queries<T> & XataRecord;
+
+export type Include<T> = {
+  [key in keyof T as T[key] extends XataRecord ? key : never]?: boolean | Array<keyof Selectable<T[key]>>;
+};
+
+type SortDirection = 'asc' | 'desc';
+
+type Operator =
+  | '_gt'
+  | '_lt'
+  | '_gte'
+  | '_lte'
+  | '_exists'
+  | '_notExists'
+  | '_endsWith'
+  | '_startsWith'
+  | '_pattern'
+  | '_isNot'
+  | '_includes'
+  | '_includesSubstring'
+  | '_includesPattern'
+  | '_includesAll';
+
+// TODO: restrict constraints depending on type?
+// E.g. startsWith cannot be used with numbers
+type Constraint<T> = Partial<Record<Operator, T>>;
+
+type ComparableType = number | Date;
+
+export const gt = <T extends ComparableType>(value: T): Constraint<T> => ({ _gt: value });
+export const gte = <T extends ComparableType>(value: T): Constraint<T> => ({ _gte: value });
+export const lt = <T extends ComparableType>(value: T): Constraint<T> => ({ _lt: value });
+export const lte = <T extends ComparableType>(value: T): Constraint<T> => ({ _lte: value });
+export const exists = (column: string): Constraint<string> => ({ _exists: column });
+export const notExists = (column: string): Constraint<string> => ({ _notExists: column });
+export const startsWith = (value: string): Constraint<string> => ({ _startsWith: value });
+export const endsWith = (value: string): Constraint<string> => ({ _endsWith: value });
+export const pattern = (value: string): Constraint<string> => ({ _pattern: value });
+export const isNot = <T>(value: T): Constraint<T> => ({ _isNot: value });
+
+// TODO: these can only be applied to columns of type "multiple"
+export const includes = (value: string): Constraint<string> => ({ _includes: value });
+export const includesSubstring = (value: string): Constraint<string> => ({ _includesSubstring: value });
+export const includesPattern = (value: string): Constraint<string> => ({ _includesPattern: value });
+export const includesAll = (value: string): Constraint<string> => ({ _includesAll: value });
+
+type FilterConstraints<T> = {
+  [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | Constraint<T[key]>;
+};
+
+type BulkQueryOptions<T> = {
+  filter?: FilterConstraints<T>;
+  sort?:
+    | {
+        column: keyof T;
+        direction?: SortDirection;
+      }
+    | keyof T;
+};
+
+type QueryOrConstraint<T, R> = Query<T, R> | Constraint<T>;
+
+export class Query<T, R = T> {
+  table: string;
+  repository: Repository<T>;
+
+  readonly _any?: QueryOrConstraint<T, R>[];
+  readonly _all?: QueryOrConstraint<T, R>[];
+  readonly _not?: QueryOrConstraint<T, R>[];
+  readonly _none?: QueryOrConstraint<T, R>[];
+  readonly _sort?: Record<string, SortDirection>;
+
+  constructor(repository: Repository<T> | null, table: string, data: Partial<Query<T, R>>, parent?: Query<T, R>) {
+    if (repository) {
+      this.repository = repository;
+    } else {
+      this.repository = this as any;
+    }
+    this.table = table;
+
+    // For some reason Object.assign(this, parent) didn't work in this case
+    // so doing all this manually:
+    this._any = parent?._any;
+    this._all = parent?._all;
+    this._not = parent?._not;
+    this._none = parent?._none;
+    this._sort = 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);
+  }
+
+  any(...queries: Query<T, R>[]): Query<T, R> {
+    return new Query<T, R>(
+      this.repository,
+      this.table,
+      {
+        _any: (this._any || []).concat(queries)
+      },
+      this
+    );
+  }
+
+  all(...queries: Query<T, R>[]): Query<T, R> {
+    return new Query<T, R>(
+      this.repository,
+      this.table,
+      {
+        _all: (this._all || []).concat(queries)
+      },
+      this
+    );
+  }
+
+  not(...queries: Query<T, R>[]): Query<T, R> {
+    return new Query<T, R>(
+      this.repository,
+      this.table,
+      {
+        _not: (this._not || []).concat(queries)
+      },
+      this
+    );
+  }
+
+  none(...queries: Query<T, R>[]): Query<T, R> {
+    return new Query<T, R>(
+      this.repository,
+      this.table,
+      {
+        _none: (this._none || []).concat(queries)
+      },
+      this
+    );
+  }
+
+  filter(constraints: FilterConstraints<T>): Query<T, R>;
+  filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | Constraint<T[F]>): Query<T, R>;
+  filter(a: any, b?: any): Query<T, R> {
+    if (arguments.length === 1) {
+      const constraints = a as FilterConstraints<T>;
+      const queries: QueryOrConstraint<T, R>[] = [];
+      for (const [column, constraint] of Object.entries(constraints)) {
+        queries.push({ [column]: constraint });
+      }
+      return new Query<T, R>(
+        this.repository,
+        this.table,
+        {
+          _any: (this._any || []).concat(queries)
+        },
+        this
+      );
+    } else {
+      const column = a as keyof T;
+      const value = b as Partial<T[keyof T]> | Constraint<T[keyof T]>;
+      return new Query<T, R>(
+        this.repository,
+        this.table,
+        {
+          _any: (this._any || []).concat({ [column]: value })
+        },
+        this
+      );
+    }
+  }
+
+  sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R> {
+    const sort = { ...this._sort, [column]: direction };
+    const q = new Query<T, R>(
+      this.repository,
+      this.table,
+      {
+        _sort: sort
+      },
+      this
+    );
+
+    return q;
+  }
+
+  // TODO: pagination. Maybe implement different methods for different type of paginations
+  // and one to simply get the first records returned by the query with no pagination.
+  async getMany(options?: BulkQueryOptions<T>): Promise<R[]> {
+    // TODO: use options
+    return this.repository.query(this);
+  }
+
+  async getOne(options?: BulkQueryOptions<T>): Promise<R | null> {
+    // TODO: use options
+    const arr = await this.getMany(); // TODO, limit to 1
+    return arr[0] || null;
+  }
+
+  async deleteAll(): Promise<number> {
+    // Return number of affected rows
+    return 0;
+  }
+
+  include(columns: Include<T>) {
+    // TODO
+    return this;
+  }
+
+  toJSON() {
+    const _filter = {
+      _any: this._any,
+      _all: this._all,
+      _not: this._not,
+      _none: this._none
+    };
+    return {
+      _filter: Object.values(_filter).some(Boolean) ? _filter : undefined,
+      _sort: this._sort
+    };
+  }
+}
+
+export abstract class Repository<T> extends Query<T, Selectable<T>> {
+  select<K extends keyof Selectable<T>>(...columns: K[]) {
+    return new Query<T, Select<T, K>>(this.repository, this.table, {});
+  }
+
+  abstract create(object: Selectable<T>): Promise<T>;
+
+  abstract read(id: string): Promise<T | null>;
+
+  abstract update(id: string, object: Partial<T>): Promise<T>;
+
+  abstract delete(id: string): void;
+
+  // Used by the Query object internally
+  abstract query<R>(query: Query<T, R>): Promise<R[]>;
+}
+
+export class RestRepository<T> extends Repository<T> {
+  client: BaseClient<any>;
+  fetch: any;
+
+  constructor(client: BaseClient<any>, table: string) {
+    super(null, table, {});
+    this.client = client;
+
+    const { fetch } = client.options;
+
+    if (fetch) {
+      this.fetch = fetch;
+    } else if (typeof window === 'object') {
+      this.fetch = window.fetch;
+    } else if (typeof require === 'function') {
+      try {
+        this.fetch = require('node-fetch');
+      } catch (err) {
+        try {
+          this.fetch = require('cross-fetch');
+        } catch (err) {
+          throw new Error('No fetch implementation found. Please provide one in the constructor');
+        }
+      }
+    }
+
+    Object.defineProperty(this, 'client', { enumerable: false });
+    Object.defineProperty(this, 'fetch', { enumerable: false });
+    Object.defineProperty(this, 'hostname', { enumerable: false });
+  }
+
+  async request(method: string, path: string, body?: unknown) {
+    const { url: xatabaseURL } = this.client.options;
+    const resp: Response = await this.fetch(`${xatabaseURL}${path}`, {
+      method,
+      headers: {
+        Accept: '*/*',
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${this.client.options.token}`
+      },
+      body: JSON.stringify(body)
+    });
+    if (!resp.ok) {
+      try {
+        const json = await 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;
+    return resp.json();
+  }
+
+  select<K extends keyof T>(...columns: K[]) {
+    return new Query<T, Select<T, K>>(this.repository, this.table, {});
+  }
+
+  async create(object: T): Promise<T> {
+    const obj = await this.request('POST', `/tables/${this.table}/data`, object);
+    return this.client.initObject(this.table, obj);
+  }
+
+  async read(id: string): Promise<T | null> {
+    try {
+      const obj = await this.request('GET', `/tables/${this.table}/data/${id}`);
+      return this.client.initObject(this.table, obj);
+    } catch (err) {
+      if ((err as XataError).status === 404) return null;
+      throw err;
+    }
+  }
+
+  async update(id: string, object: Partial<T>): Promise<T> {
+    const obj = await this.request('PUT', `/tables/${this.table}/data/${id}`, object);
+    return this.client.initObject(this.table, obj);
+  }
+
+  async delete(id: string) {
+    await this.request('DELETE', `/tables/${this.table}/data/${id}`);
+  }
+
+  async query<R>(query: Query<T, R>): Promise<R[]> {
+    const result = await this.request('POST', `/tables/${this.table}/query`, query);
+    return result.records.map((record: object) => this.client.initObject(this.table, record));
+  }
+}
+
+interface RepositoryFactory {
+  createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
+}
+
+export class RestRespositoryFactory implements RepositoryFactory {
+  createRepository<T>(client: BaseClient<any>, table: string): Repository<T> {
+    return new RestRepository<T>(client, table);
+  }
+}
+
+export type XataClientOptions = {
+  fetch?: unknown;
+  url: string;
+  token: string;
+  repositoryFactory?: RepositoryFactory;
+};
+
+export class BaseClient<D extends Record<string, Repository<any>>> {
+  options: XataClientOptions;
+  private links: Links;
+  db!: D;
+
+  constructor(options: XataClientOptions, links: Links) {
+    this.options = options;
+    this.links = links;
+  }
+
+  public initObject<T>(table: string, object: object) {
+    const o: Record<string, unknown> = {};
+    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 as any;
+        if (Object.keys(value).find((col) => !col.startsWith('_'))) {
+          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'] as string);
+    };
+    o.update = function (data: any) {
+      return db[table].update(o['_id'] as string, data);
+    };
+    o.delete = function () {
+      return db[table].delete(o['_id'] as string);
+    };
+
+    for (const prop of ['read', 'update', 'delete']) {
+      Object.defineProperty(o, prop, { enumerable: false });
+    }
+
+    // TODO: links and rev links
+
+    Object.freeze(o);
+    return o as T;
+  }
+}
+
+export class XataError extends Error {
+  readonly status: number;
+
+  constructor(message: string, status: number) {
+    super(message);
+    this.status = status;
+  }
+}
+
+export type Links = Record<string, Array<string[]>>;

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "lib": ["dom", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": ["src"]
+}