@xata.io/client 0.2.2 → 0.3.0

package/dist/schema/selection.d.ts

@@ -0,0 +1,13 @@
+import { XataRecord } from '..';
+import { StringKeys, UnionToIntersection, Values } from '../util/types';
+import { Query } from './query';
+declare type Queries<T> = {
+    [key in keyof T as T[key] extends Query<any> ? key : never]: T[key];
+};
+declare type InternalProperties = keyof XataRecord;
+export declare type Selectable<T extends XataRecord> = Omit<T, InternalProperties>;
+export declare type SelectableColumn<O> = '*' | (O extends Array<unknown> ? never : O extends Record<string, any> ? '*' | Values<{
+    [K in StringKeys<O>]: O[K] extends Record<string, any> ? `${K}.${SelectableColumn<O[K]>}` : K;
+}> : '');
+export declare type Select<T, K extends SelectableColumn<T>> = UnionToIntersection<K extends keyof T ? Pick<T, K> : T> & Queries<T> & XataRecord;
+export {};

package/dist/schema/selection.js

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

package/dist/util/lang.d.ts

@@ -0,0 +1,2 @@
+export declare function compact<T>(arr: Array<T | null | undefined>): T[];
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/dist/util/lang.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compact = void 0;
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
+function compact(arr) {
+    return arr.filter(notEmpty);
+}
+exports.compact = compact;

package/dist/util/types.d.ts

@@ -0,0 +1,3 @@
+export declare type StringKeys<O> = Extract<keyof O, string>;
+export declare type Values<O> = O[keyof O];
+export declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;

package/dist/util/types.js

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@xata.io/client",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "prepack": "npm run build"
   },
   "repository": {
@@ -20,5 +20,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "e5103cd1b370d60fd8c8a70841352037d88c816d"
+  "gitHead": "68cefbad5825d10c1f15efd39766280d3b863a87"
 }

package/dist/index.test.d.ts

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

package/dist/index.test.js

@@ -1,304 +0,0 @@
-"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 buildClient = (options = {}) => {
-    const { apiKey = '1234', databaseURL = 'https://my-workspace-5df34do.staging.xatabase.co/db/xata', branch = 'main' } = options;
-    const fetch = jest.fn();
-    const client = new _1.BaseClient({ fetch, apiKey, databaseURL, branch }, {});
-    const users = new _1.RestRepository(client, 'users');
-    return { fetch, client, users };
-};
-describe('client options', () => {
-    test('option parameters are set', () => {
-        const { client } = buildClient({ apiKey: 'apiKey', databaseURL: 'url' });
-        expect(client.options.apiKey).toBe('apiKey');
-        expect(client.options.databaseURL).toBe('url');
-    });
-    test('throws if mandatory options are missing', () => {
-        // @ts-expect-error Options are mandatory in TypeScript
-        expect(() => buildClient({ apiKey: null }, {})).toThrow('Options databaseURL, apiKey and branch are required');
-        // @ts-expect-error Options are mandatory in TypeScript
-        expect(() => buildClient({ databaseURL: null }, {})).toThrow('Options databaseURL, apiKey and branch are required');
-        // @ts-expect-error Options are mandatory in TypeScript
-        expect(() => buildClient({ branch: null }, {})).toThrow('Options databaseURL, apiKey and branch are required');
-    });
-    test('throws if branch cannot be resolved', () => {
-        const { users } = buildClient({ branch: () => null });
-        expect(users.request('GET', '/foo')).rejects.toThrow('Unable to resolve branch value');
-    });
-    test('provide branch as a string', () => __awaiter(void 0, void 0, void 0, function* () {
-        const { fetch, users } = buildClient({ branch: 'branch' });
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield users.request('GET', '/foo');
-        expect(fetch).toHaveBeenCalledTimes(1);
-        expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
-      Array [
-        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:branch/foo",
-        Object {
-          "body": undefined,
-          "headers": Object {
-            "Accept": "*/*",
-            "Authorization": "Bearer 1234",
-            "Content-Type": "application/json",
-          },
-          "method": "GET",
-        },
-      ]
-    `);
-    }));
-    test('provide branch as an array', () => __awaiter(void 0, void 0, void 0, function* () {
-        const { fetch, users } = buildClient({
-            branch: [process.env.NOT_DEFINED_VARIABLE, () => __awaiter(void 0, void 0, void 0, function* () { return null; }), 'branch', 'main']
-        });
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield users.request('GET', '/foo');
-        expect(fetch).toHaveBeenCalledTimes(1);
-        expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
-      Array [
-        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:branch/foo",
-        Object {
-          "body": undefined,
-          "headers": Object {
-            "Accept": "*/*",
-            "Authorization": "Bearer 1234",
-            "Content-Type": "application/json",
-          },
-          "method": "GET",
-        },
-      ]
-    `);
-    }));
-    test('provide branch as a function', () => __awaiter(void 0, void 0, void 0, function* () {
-        const { fetch, users } = buildClient({ branch: () => 'branch' });
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield users.request('GET', '/foo');
-        expect(fetch).toHaveBeenCalledTimes(1);
-        expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
-      Array [
-        "https://my-workspace-5df34do.staging.xatabase.co/db/xata:branch/foo",
-        Object {
-          "body": undefined,
-          "headers": Object {
-            "Accept": "*/*",
-            "Authorization": "Bearer 1234",
-            "Content-Type": "application/json",
-          },
-          "method": "GET",
-        },
-      ]
-    `);
-    }));
-    test('ensure branch resolution is memoized', () => __awaiter(void 0, void 0, void 0, function* () {
-        const branchGetter = jest.fn(() => 'branch');
-        const { fetch, users } = buildClient({ branch: branchGetter });
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield users.request('GET', '/foo');
-        yield users.request('GET', '/foo');
-        expect(branchGetter).toHaveBeenCalledTimes(1);
-    }));
-});
-describe('request', () => {
-    test('builds the right arguments for a GET request', () => __awaiter(void 0, void 0, void 0, function* () {
-        const { fetch, users } = buildClient();
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield 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* () {
-        const { fetch, users } = buildClient();
-        fetch.mockReset().mockImplementation(() => {
-            return {
-                ok: true,
-                json: () => __awaiter(void 0, void 0, void 0, function* () { return ({}); })
-            };
-        });
-        yield 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* () {
-        const { fetch, users } = buildClient();
-        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* () {
-        const { fetch, users } = buildClient();
-        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 { fetch, users } = buildClient();
-        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(users, 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 { users } = buildClient();
-            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
-            expectRequest(users, expected, () => users.getMany(), { records: [] });
-        }));
-        test('query with one filter', () => __awaiter(void 0, void 0, void 0, function* () {
-            const { users } = buildClient();
-            const expected = { method: 'POST', path: '/tables/users/query', body: { filter: { $all: [{ name: 'foo' }] } } };
-            expectRequest(users, expected, () => users.filter('name', 'foo').getMany(), { records: [] });
-        }));
-    });
-    describe('getOne', () => {
-        test('returns a single object', () => __awaiter(void 0, void 0, void 0, function* () {
-            const { users } = buildClient();
-            const result = { records: [{ id: '1234' }] };
-            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
-            expectRequest(users, 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 { users } = buildClient();
-            const result = { records: [] };
-            const expected = { method: 'POST', path: '/tables/users/query', body: {} };
-            expectRequest(users, 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 { users } = buildClient();
-        const id = 'rec_1234';
-        const expected = { method: 'GET', path: `/tables/users/data/${id}`, body: undefined };
-        expectRequest(users, expected, () => users.read(id));
-    }));
-});
-describe('Repository.update', () => {
-    test('updates and object successfully', () => __awaiter(void 0, void 0, void 0, function* () {
-        const { users } = buildClient();
-        const object = { id: 'rec_1234', xata: { version: 1 }, name: 'Ada' };
-        const expected = { method: 'PUT', path: `/tables/users/data/${object.id}`, body: object };
-        expectRequest(users, 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 { users } = buildClient();
-        const id = 'rec_1234';
-        const expected = { method: 'DELETE', path: `/tables/users/data/${id}`, body: undefined };
-        expectRequest(users, 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 { users } = buildClient();
-        const created = { id: 'rec_1234', _version: 0 };
-        const object = { name: 'Ada' };
-        const expected = { method: 'POST', path: '/tables/users/data', body: object };
-        expectRequest(users, expected, () => __awaiter(void 0, void 0, void 0, function* () {
-            const result = yield users.create(object);
-            expect(result.id).toBe(created.id);
-        }), created);
-    }));
-});