@xata.io/client 0.7.0 → 0.8.0

package/dist/util/config.js

@@ -0,0 +1,121 @@
+"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.getAPIKey = exports.getDatabaseURL = exports.getCurrentBranchDetails = exports.getCurrentBranchName = void 0;
+const api_1 = require("../api");
+const environment_1 = require("./environment");
+const fetch_1 = require("./fetch");
+const lang_1 = require("./lang");
+const envBranchNames = [
+    'XATA_BRANCH',
+    'VERCEL_GIT_COMMIT_REF',
+    'CF_PAGES_BRANCH',
+    'BRANCH' // Netlify. Putting it the last one because it is more ambiguous
+];
+const defaultBranch = 'main';
+function getCurrentBranchName(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const env = yield getBranchByEnvVariable();
+        if (env)
+            return env;
+        const branch = yield (0, environment_1.getGitBranch)();
+        if (!branch)
+            return defaultBranch;
+        // TODO: in the future, call /resolve endpoint
+        // For now, call API to see if the branch exists. If not, use a default value.
+        const details = yield getDatabaseBranch(branch, options);
+        if (details)
+            return branch;
+        return defaultBranch;
+    });
+}
+exports.getCurrentBranchName = getCurrentBranchName;
+function getCurrentBranchDetails(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const env = yield getBranchByEnvVariable();
+        if (env)
+            return getDatabaseBranch(env, options);
+        const branch = yield (0, environment_1.getGitBranch)();
+        if (!branch)
+            return getDatabaseBranch(defaultBranch, options);
+        // TODO: in the future, call /resolve endpoint
+        // For now, call API to see if the branch exists. If not, use a default value.
+        const details = yield getDatabaseBranch(branch, options);
+        if (details)
+            return details;
+        return getDatabaseBranch(defaultBranch, options);
+    });
+}
+exports.getCurrentBranchDetails = getCurrentBranchDetails;
+function getDatabaseBranch(branch, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const databaseURL = (options === null || options === void 0 ? void 0 : options.databaseURL) || getDatabaseURL();
+        const apiKey = (options === null || options === void 0 ? void 0 : options.apiKey) || getAPIKey();
+        if (!databaseURL)
+            throw new Error('A databaseURL was not defined. Either set the XATA_DATABASE_URL env variable or pass the argument explicitely');
+        if (!apiKey)
+            throw new Error('An API key was not defined. Either set the XATA_API_KEY env variable or pass the argument explicitely');
+        const [protocol, , host, , database] = databaseURL.split('/');
+        const [workspace] = host.split('.');
+        const dbBranchName = `${database}:${branch}`;
+        try {
+            return yield (0, api_1.getBranchDetails)({
+                apiKey,
+                apiUrl: databaseURL,
+                fetchImpl: (0, fetch_1.getFetchImplementation)(options === null || options === void 0 ? void 0 : options.fetchImpl),
+                workspacesApiUrl: `${protocol}//${host}`,
+                pathParams: {
+                    dbBranchName,
+                    workspace
+                }
+            });
+        }
+        catch (err) {
+            if ((0, lang_1.isObject)(err) && err.status === 404)
+                return null;
+            throw err;
+        }
+    });
+}
+function getBranchByEnvVariable() {
+    for (const name of envBranchNames) {
+        const value = (0, environment_1.getEnvVariable)(name);
+        if (value) {
+            return value;
+        }
+    }
+    try {
+        return XATA_BRANCH;
+    }
+    catch (err) {
+        // Ignore ReferenceError. Only CloudFlare workers set env variables as global variables
+    }
+}
+function getDatabaseURL() {
+    var _a;
+    try {
+        return (_a = (0, environment_1.getEnvVariable)('XATA_DATABASE_URL')) !== null && _a !== void 0 ? _a : XATA_DATABASE_URL;
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.getDatabaseURL = getDatabaseURL;
+function getAPIKey() {
+    var _a;
+    try {
+        return (_a = (0, environment_1.getEnvVariable)('XATA_API_KEY')) !== null && _a !== void 0 ? _a : XATA_API_KEY;
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.getAPIKey = getAPIKey;

package/dist/util/types.d.ts

@@ -12,8 +12,8 @@ export declare type RequiredBy<T, K extends keyof T> = T & {
     [P in K]-?: NonNullable<T[P]>;
 };
 export declare type GetArrayInnerType<T extends readonly any[]> = T[number];
-export declare type NonNullableValues<Obj> = {
-    [K in keyof Obj]: NonNullable<Obj[K]>;
+export declare type AllRequired<T> = {
+    [P in keyof T]-?: T[P];
 };
 export declare type KeysOfUnion<T> = T extends T ? keyof T : never;
 declare type Impossible<K extends keyof any> = {
@@ -21,4 +21,5 @@ declare type Impossible<K extends keyof any> = {
 };
 export declare type Exactly<T, U extends T = T> = U & Impossible<Exclude<keyof U, keyof T>>;
 export declare type SingleOrArray<T> = T | T[];
+export declare type Dictionary<T> = Record<string, T>;
 export {};

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@xata.io/client",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "browser": {
+    "child_process": false
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc -p tsconfig.build.json",
@@ -20,5 +23,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "09bfef88b675f94cf64851e574c4e6cfc65e4b05"
+  "gitHead": "ca9389ac662985428e3714be546cbf9d3bc5c4b6"
 }

package/dist/schema/config.d.ts

@@ -1,4 +0,0 @@
-import { FetcherExtraProps } from '../api/fetcher';
-export declare function getBranch(fetchProps: Omit<FetcherExtraProps, 'workspacesApiUrl'>): Promise<string | undefined>;
-export declare function getDatabaseUrl(): string | undefined;
-export declare function getAPIKey(): string | undefined;

package/dist/schema/config.js

@@ -1,83 +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 });
-exports.getAPIKey = exports.getDatabaseUrl = exports.getBranch = void 0;
-const api_1 = require("../api");
-const environment_1 = require("../util/environment");
-const lang_1 = require("../util/lang");
-const envBranchNames = [
-    'XATA_BRANCH',
-    'VERCEL_GIT_COMMIT_REF',
-    'CF_PAGES_BRANCH',
-    'BRANCH' // Netlify. Putting it the last one because it is more ambiguous
-];
-function getBranch(fetchProps) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const env = getBranchByEnvVariable();
-        if (env)
-            return env;
-        const branch = yield (0, environment_1.getGitBranch)();
-        if (!branch)
-            return undefined;
-        // TODO: in the future, call /resolve endpoint
-        // For now, call API to see if the branch exists. If not, use a default value.
-        const [protocol, , host, , database] = fetchProps.apiUrl.split('/');
-        const [workspace] = host.split('.');
-        const dbBranchName = `${database}:${branch}`;
-        try {
-            yield (0, api_1.getBranchDetails)(Object.assign(Object.assign({}, fetchProps), { workspacesApiUrl: `${protocol}//${host}`, pathParams: {
-                    dbBranchName,
-                    workspace
-                } }));
-        }
-        catch (err) {
-            if ((0, lang_1.isObject)(err) && err.status === 404)
-                return 'main';
-            throw err;
-        }
-        return branch;
-    });
-}
-exports.getBranch = getBranch;
-function getBranchByEnvVariable() {
-    for (const name of envBranchNames) {
-        const value = (0, environment_1.getEnvVariable)(name);
-        if (value) {
-            return value;
-        }
-    }
-    try {
-        return XATA_BRANCH;
-    }
-    catch (err) {
-        // Ignore ReferenceError. Only CloudFlare workers set env variables as global variables
-    }
-}
-function getDatabaseUrl() {
-    var _a;
-    try {
-        return (_a = (0, environment_1.getEnvVariable)('XATA_DATABASE_URL')) !== null && _a !== void 0 ? _a : XATA_DATABASE_URL;
-    }
-    catch (err) {
-        return undefined;
-    }
-}
-exports.getDatabaseUrl = getDatabaseUrl;
-function getAPIKey() {
-    var _a;
-    try {
-        return (_a = (0, environment_1.getEnvVariable)('XATA_API_KEY')) !== null && _a !== void 0 ? _a : XATA_API_KEY;
-    }
-    catch (err) {
-        return undefined;
-    }
-}
-exports.getAPIKey = getAPIKey;