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

package/dist/util/config.d.ts

@@ -0,0 +1,11 @@
+import { FetchImpl } from '../api/fetcher';
+declare type BranchResolutionOptions = {
+    databaseURL?: string;
+    apiKey?: string;
+    fetchImpl?: FetchImpl;
+};
+export declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string | undefined>;
+export declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<import("../api/schemas").DBBranch | null>;
+export declare function getDatabaseURL(): string | undefined;
+export declare function getAPIKey(): string | undefined;
+export {};

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/environment.d.ts

@@ -0,0 +1,5 @@
+/// <reference path="../../src/types/global-node.d.ts" />
+/// <reference path="../../src/types/global-variables.d.ts" />
+/// <reference path="../../src/types/global-deno.d.ts" />
+export declare function getEnvVariable(name: string): string | undefined;
+export declare function getGitBranch(): Promise<string | undefined>;

package/dist/util/environment.js

@@ -0,0 +1,68 @@
+"use strict";
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+///<reference path="../types/global-node.d.ts"/>
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+///<reference path="../types/global-variables.d.ts"/>
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+///<reference path="../types/global-deno.d.ts"/>
+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.getGitBranch = exports.getEnvVariable = void 0;
+const lang_1 = require("./lang");
+function getEnvVariable(name) {
+    var _a, _b;
+    // Node.js: process.env
+    try {
+        if ((0, lang_1.isObject)(process) && (0, lang_1.isString)((_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a[name])) {
+            return process.env[name];
+        }
+    }
+    catch (err) {
+        // Ignore: Should never happen
+    }
+    try {
+        // Deno: Deno.env.get
+        if ((0, lang_1.isObject)(Deno) && (0, lang_1.isString)((_b = Deno === null || Deno === void 0 ? void 0 : Deno.env) === null || _b === void 0 ? void 0 : _b.get(name))) {
+            return Deno.env.get(name);
+        }
+    }
+    catch (err) {
+        // Ignore: Will fail if not using --allow-env
+    }
+}
+exports.getEnvVariable = getEnvVariable;
+function getGitBranch() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Node.js: child_process.execSync
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            return require('child_process').execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
+        }
+        catch (err) {
+            // Ignore
+        }
+        // Deno: Deno.run
+        try {
+            if ((0, lang_1.isObject)(Deno)) {
+                const process = Deno.run({
+                    cmd: ['git', 'branch', '--show-current'],
+                    stdout: 'piped',
+                    stderr: 'piped'
+                });
+                return new TextDecoder().decode(yield process.output()).trim();
+            }
+        }
+        catch (err) {
+            // Ignore: Will fail if not using --allow-run
+        }
+    });
+}
+exports.getGitBranch = getGitBranch;

package/dist/util/fetch.d.ts

@@ -0,0 +1,2 @@
+import { FetchImpl } from '../api/fetcher';
+export declare function getFetchImplementation(userFetch?: FetchImpl): FetchImpl | typeof fetch;

package/dist/util/fetch.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetchImplementation = void 0;
+function getFetchImplementation(userFetch) {
+    const globalFetch = typeof fetch !== 'undefined' ? fetch : undefined;
+    const fetchImpl = userFetch !== null && userFetch !== void 0 ? userFetch : globalFetch;
+    if (!fetchImpl) {
+        /** @todo add a link after docs exist */
+        throw new Error(`The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.`);
+    }
+    return fetchImpl;
+}
+exports.getFetchImplementation = getFetchImplementation;

package/dist/util/lang.d.ts

@@ -0,0 +1,5 @@
+export declare function compact<T>(arr: Array<T | null | undefined>): T[];
+export declare function compactObject<T>(obj: Record<string, T | null | undefined>): Record<string, T>;
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export declare function isObject(value: any): value is Record<string, unknown>;
+export declare function isString(value: any): value is string;

package/dist/util/lang.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = exports.isObject = exports.compactObject = exports.compact = void 0;
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
+function compact(arr) {
+    return arr.filter(notEmpty);
+}
+exports.compact = compact;
+function compactObject(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(([, value]) => notEmpty(value)));
+}
+exports.compactObject = compactObject;
+function isObject(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+exports.isObject = isObject;
+function isString(value) {
+    return value !== undefined && value !== null && typeof value === 'string';
+}
+exports.isString = isString;

package/dist/util/types.d.ts

@@ -0,0 +1,25 @@
+export declare type StringKeys<O> = Extract<keyof O, string>;
+export declare type NumberKeys<O> = Extract<keyof O, number>;
+export declare type Values<O> = O[StringKeys<O>];
+export declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
+export declare type If<Condition, Then, Else> = Condition extends true ? Then : Else;
+export declare type IsObject<T> = T extends Record<string, any> ? true : false;
+export declare type IsArray<T> = T extends Array<any> ? true : false;
+export declare type NonEmptyArray<T> = T[] & {
+    0: T;
+};
+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 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> = {
+    [P in K]: never;
+};
+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/dist/util/types.js

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

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.c9e08d0",
+  "version": "0.0.0-beta.ca9389a",
   "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": "c9e08d07e1a7e7b07d118b2b459b9843edb341c3"
+  "gitHead": "ca9389ac662985428e3714be546cbf9d3bc5c4b6"
 }

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"]
+}

package/dist/util/errors.d.ts

@@ -1,3 +0,0 @@
-export declare const errors: {
-    falsyFetchImplementation: string; /** @todo add a link after docs exist */
-};

package/dist/util/errors.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errors = void 0;
-exports.errors = {
-    falsyFetchImplementation: `The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.
-  
-More in the docs: 
-` /** @todo add a link after docs exist */
-};