@xata.io/client 0.1.5 → 0.2.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -109,18 +109,25 @@ interface RepositoryFactory {
 export declare class RestRespositoryFactory implements RepositoryFactory {
     createRepository<T>(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?: unknown;
     databaseURL: string;
+    branch: BranchStrategyOption;
     apiKey: string;
     repositoryFactory?: RepositoryFactory;
 };
 export declare class BaseClient<D extends Record<string, Repository<any>>> {
     options: XataClientOptions;
     private links;
+    private branch;
     db: D;
     constructor(options: XataClientOptions, links: Links);
     initObject<T>(table: string, object: object): T;
+    getBranch(): Promise<string>;
 }
 export declare class XataError extends Error {
     readonly status: number;

package/dist/index.js

@@ -8,6 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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); }
+};
 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 gt = (value) => ({ $gt: value });
@@ -184,13 +191,14 @@ class RestRepository extends Repository {
     }
     request(method, path, body) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { databaseURL } = this.client.options;
-            const resp = yield this.fetch(`${databaseURL}${path}`, {
+            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 ${this.client.options.apiKey}`
+                    Authorization: `Bearer ${apiKey}`
                 },
                 body: JSON.stringify(body)
             });
@@ -281,6 +289,9 @@ class RestRespositoryFactory {
 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;
     }
@@ -323,6 +334,36 @@ class BaseClient {
         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;
 class XataError extends Error {
@@ -332,3 +373,6 @@ class XataError extends Error {
     }
 }
 exports.XataError = XataError;
+const isBranchStrategyBuilder = (strategy) => {
+    return typeof strategy === 'function';
+};

package/dist/index.test.js

@@ -10,22 +10,132 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const _1 = require("./");
-const fetch = jest.fn();
-const client = new _1.BaseClient({
-    fetch,
-    apiKey: '1234',
-    databaseURL: 'https://my-workspace-5df34do.staging.xatabase.co/db/xata:main'
-}, {});
-const users = new _1.RestRepository(client, 'users');
+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 ({}); })
             };
         });
-        users.request('GET', '/foo');
+        yield users.request('GET', '/foo');
         expect(fetch).toHaveBeenCalledTimes(1);
         expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
       Array [
@@ -43,13 +153,14 @@ describe('request', () => {
     `);
     }));
     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 ({}); })
             };
         });
-        users.request('POST', '/foo', { a: 1 });
+        yield users.request('POST', '/foo', { a: 1 });
         expect(fetch).toHaveBeenCalledTimes(1);
         expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
       Array [
@@ -67,6 +178,7 @@ describe('request', () => {
     `);
     }));
     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,
@@ -77,6 +189,7 @@ describe('request', () => {
         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,
@@ -88,6 +201,7 @@ describe('request', () => {
         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 {
@@ -99,7 +213,7 @@ describe('request', () => {
         expect(result).toEqual(json);
     }));
 });
-function expectRequest(expectedRequest, callback, response) {
+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;
@@ -115,27 +229,31 @@ function expectRequest(expectedRequest, callback, response) {
 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(expected, () => users.getMany(), { records: [] });
+            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(expected, () => users.filter('name', 'foo').getMany(), { records: [] });
+            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(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+            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(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+            expectRequest(users, expected, () => __awaiter(void 0, void 0, void 0, function* () {
                 const first = yield users.getOne();
                 expect(first).toBeNull();
             }), result);
@@ -144,16 +262,18 @@ describe('query', () => {
 });
 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(expected, () => users.read(id));
+        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(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+        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 });
@@ -161,9 +281,10 @@ describe('Repository.update', () => {
 });
 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(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+        expectRequest(users, expected, () => __awaiter(void 0, void 0, void 0, function* () {
             const result = yield users.delete(id);
             expect(result).toBe(undefined);
         }));
@@ -171,10 +292,11 @@ describe('Repository.delete', () => {
 });
 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(expected, () => __awaiter(void 0, void 0, void 0, function* () {
+        expectRequest(users, 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

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.1.5",
+  "version": "0.2.2",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -19,5 +19,6 @@
   "bugs": {
     "url": "https://github.com/xataio/client-ts/issues"
   },
-  "homepage": "https://github.com/xataio/client-ts#readme"
+  "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
+  "gitHead": "e5103cd1b370d60fd8c8a70841352037d88c816d"
 }

package/src/index.test.ts

@@ -1,23 +1,159 @@
-import { BaseClient, RestRepository, XataError, XataRecord } from './';
-
-const fetch = jest.fn();
-const client = new BaseClient(
-  {
-    fetch,
-    apiKey: '1234',
-    databaseURL: 'https://my-workspace-5df34do.staging.xatabase.co/db/xata:main'
-  },
-  {}
-);
+import { BaseClient, RestRepository, XataClientOptions, XataError, XataRecord } from './';
 
 interface User extends XataRecord {
   name: string;
 }
 
-const users = new RestRepository<User>(client, 'users');
+const buildClient = (options: Partial<XataClientOptions> = {}) => {
+  const {
+    apiKey = '1234',
+    databaseURL = 'https://my-workspace-5df34do.staging.xatabase.co/db/xata',
+    branch = 'main'
+  } = options;
+
+  const fetch = jest.fn();
+  const client = new BaseClient({ fetch, apiKey, databaseURL, branch }, {});
+  const users = new RestRepository<User>(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', async () => {
+    const { fetch, users } = buildClient({ branch: 'branch' });
+
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    await 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', async () => {
+    const { fetch, users } = buildClient({
+      branch: [process.env.NOT_DEFINED_VARIABLE, async () => null, 'branch', 'main']
+    });
+
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    await 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', async () => {
+    const { fetch, users } = buildClient({ branch: () => 'branch' });
+
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    await 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', async () => {
+    const branchGetter = jest.fn(() => 'branch');
+
+    const { fetch, users } = buildClient({ branch: branchGetter });
+
+    fetch.mockReset().mockImplementation(() => {
+      return {
+        ok: true,
+        json: async () => ({})
+      };
+    });
+
+    await users.request('GET', '/foo');
+    await users.request('GET', '/foo');
+
+    expect(branchGetter).toHaveBeenCalledTimes(1);
+  });
+});
 
 describe('request', () => {
   test('builds the right arguments for a GET request', async () => {
+    const { fetch, users } = buildClient();
+
     fetch.mockReset().mockImplementation(() => {
       return {
         ok: true,
@@ -25,7 +161,7 @@ describe('request', () => {
       };
     });
 
-    users.request('GET', '/foo');
+    await users.request('GET', '/foo');
 
     expect(fetch).toHaveBeenCalledTimes(1);
     expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
@@ -45,6 +181,8 @@ describe('request', () => {
   });
 
   test('builds the right arguments for a POST request', async () => {
+    const { fetch, users } = buildClient();
+
     fetch.mockReset().mockImplementation(() => {
       return {
         ok: true,
@@ -52,7 +190,7 @@ describe('request', () => {
       };
     });
 
-    users.request('POST', '/foo', { a: 1 });
+    await users.request('POST', '/foo', { a: 1 });
 
     expect(fetch).toHaveBeenCalledTimes(1);
     expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
@@ -72,6 +210,8 @@ describe('request', () => {
   });
 
   test('throws if the response is not ok', async () => {
+    const { fetch, users } = buildClient();
+
     fetch.mockImplementation(() => {
       return {
         ok: false,
@@ -84,6 +224,8 @@ describe('request', () => {
   });
 
   test('throws with the error from the server if the response is not ok', async () => {
+    const { fetch, users } = buildClient();
+
     fetch.mockImplementation(() => {
       return {
         ok: false,
@@ -97,6 +239,8 @@ describe('request', () => {
   });
 
   test('returns the json body if the response is ok', async () => {
+    const { fetch, users } = buildClient();
+
     const json = { a: 1 };
     fetch.mockImplementation(() => {
       return {
@@ -116,7 +260,12 @@ type ExpectedRequest = {
   body: unknown;
 };
 
-async function expectRequest(expectedRequest: ExpectedRequest, callback: () => void, response?: unknown) {
+async function expectRequest(
+  users: RestRepository<User>,
+  expectedRequest: ExpectedRequest,
+  callback: () => void,
+  response?: unknown
+) {
   const request = jest.fn(async () => response);
   users.request = request;
 
@@ -133,21 +282,28 @@ async function expectRequest(expectedRequest: ExpectedRequest, callback: () => v
 describe('query', () => {
   describe('getMany', () => {
     test('simple query', async () => {
+      const { users } = buildClient();
+
       const expected = { method: 'POST', path: '/tables/users/query', body: {} };
-      expectRequest(expected, () => users.getMany(), { records: [] });
+      expectRequest(users, expected, () => users.getMany(), { records: [] });
     });
 
     test('query with one filter', async () => {
+      const { users } = buildClient();
+
       const expected = { method: 'POST', path: '/tables/users/query', body: { filter: { $all: [{ name: 'foo' }] } } };
-      expectRequest(expected, () => users.filter('name', 'foo').getMany(), { records: [] });
+      expectRequest(users, expected, () => users.filter('name', 'foo').getMany(), { records: [] });
     });
   });
 
   describe('getOne', () => {
     test('returns a single object', async () => {
+      const { users } = buildClient();
+
       const result = { records: [{ id: '1234' }] };
       const expected = { method: 'POST', path: '/tables/users/query', body: {} };
       expectRequest(
+        users,
         expected,
         async () => {
           const first = await users.select().getOne();
@@ -158,9 +314,12 @@ describe('query', () => {
     });
 
     test('returns null if no objects are returned', async () => {
+      const { users } = buildClient();
+
       const result = { records: [] };
       const expected = { method: 'POST', path: '/tables/users/query', body: {} };
       expectRequest(
+        users,
         expected,
         async () => {
           const first = await users.getOne();
@@ -174,17 +333,22 @@ describe('query', () => {
 
 describe('read', () => {
   test('reads an object by id successfully', async () => {
+    const { users } = buildClient();
+
     const id = 'rec_1234';
     const expected = { method: 'GET', path: `/tables/users/data/${id}`, body: undefined };
-    expectRequest(expected, () => users.read(id));
+    expectRequest(users, expected, () => users.read(id));
   });
 });
 
 describe('Repository.update', () => {
   test('updates and object successfully', async () => {
+    const { users } = buildClient();
+
     const object = { id: 'rec_1234', xata: { version: 1 }, name: 'Ada' } as User;
     const expected = { method: 'PUT', path: `/tables/users/data/${object.id}`, body: object };
     expectRequest(
+      users,
       expected,
       async () => {
         const result = await users.update(object.id, object);
@@ -194,11 +358,14 @@ describe('Repository.update', () => {
     );
   });
 });
+
 describe('Repository.delete', () => {
   test('deletes a record by id successfully', async () => {
+    const { users } = buildClient();
+
     const id = 'rec_1234';
     const expected = { method: 'DELETE', path: `/tables/users/data/${id}`, body: undefined };
-    expectRequest(expected, async () => {
+    expectRequest(users, expected, async () => {
       const result = await users.delete(id);
       expect(result).toBe(undefined);
     });
@@ -207,10 +374,13 @@ describe('Repository.delete', () => {
 
 describe('create', () => {
   test('successful', async () => {
+    const { users } = buildClient();
+
     const created = { id: 'rec_1234', _version: 0 };
     const object = { name: 'Ada' } as User;
     const expected = { method: 'POST', path: '/tables/users/data', body: object };
     expectRequest(
+      users,
       expected,
       async () => {
         const result = await users.create(object);

package/src/index.ts

@@ -304,13 +304,15 @@ export class RestRepository<T> extends Repository<T> {
   }
 
   async request(method: string, path: string, body?: unknown) {
-    const { databaseURL } = this.client.options;
-    const resp: Response = await this.fetch(`${databaseURL}${path}`, {
+    const { databaseURL, apiKey } = this.client.options;
+    const branch = await this.client.getBranch();
+
+    const resp: Response = await this.fetch(`${databaseURL}:${branch}${path}`, {
       method,
       headers: {
         Accept: '*/*',
         'Content-Type': 'application/json',
-        Authorization: `Bearer ${this.client.options.apiKey}`
+        Authorization: `Bearer ${apiKey}`
       },
       body: JSON.stringify(body)
     });
@@ -393,9 +395,15 @@ export class RestRespositoryFactory implements RepositoryFactory {
   }
 }
 
+type BranchStrategyValue = string | undefined | null;
+type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
+type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
+type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
+
 export type XataClientOptions = {
   fetch?: unknown;
   databaseURL: string;
+  branch: BranchStrategyOption;
   apiKey: string;
   repositoryFactory?: RepositoryFactory;
 };
@@ -403,9 +411,14 @@ export type XataClientOptions = {
 export class BaseClient<D extends Record<string, Repository<any>>> {
   options: XataClientOptions;
   private links: Links;
+  private branch: BranchStrategyValue;
   db!: D;
 
   constructor(options: XataClientOptions, links: Links) {
+    if (!options.databaseURL || !options.apiKey || !options.branch) {
+      throw new Error('Options databaseURL, apiKey and branch are required');
+    }
+
     this.options = options;
     this.links = links;
   }
@@ -454,6 +467,27 @@ export class BaseClient<D extends Record<string, Repository<any>>> {
     Object.freeze(o);
     return o as T;
   }
+
+  public async getBranch(): Promise<string> {
+    if (this.branch) return this.branch;
+
+    const { branch: param } = this.options;
+    const strategies = Array.isArray(param) ? [...param] : [param];
+
+    const evaluateBranch = async (strategy: BranchStrategy) => {
+      return isBranchStrategyBuilder(strategy) ? await strategy() : strategy;
+    };
+
+    for await (const strategy of strategies) {
+      const branch = await evaluateBranch(strategy);
+      if (branch) {
+        this.branch = branch;
+        return branch;
+      }
+    }
+
+    throw new Error('Unable to resolve branch value');
+  }
 }
 
 export class XataError extends Error {
@@ -466,3 +500,7 @@ export class XataError extends Error {
 }
 
 export type Links = Record<string, Array<string[]>>;
+
+const isBranchStrategyBuilder = (strategy: BranchStrategy): strategy is BranchStrategyBuilder => {
+  return typeof strategy === 'function';
+};