@xata.io/client 0.5.1 → 0.7.1

package/dist/schema/selection.spec.js

@@ -0,0 +1,203 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-floating-promises */
+Object.defineProperty(exports, "__esModule", { value: true });
+//                              SelectableColumn<O>                            //
+// --------------------------------------------------------------------------- //
+const validTeamColumns = [
+    '*',
+    'id',
+    'name',
+    'owner.*',
+    'owner.address.*',
+    'owner.address',
+    'owner.address.street'
+];
+// @ts-expect-error
+const invalidFullNameTeamColumn = 'full_name';
+// @ts-expect-error
+const invalidPartialTeamColumn = 'owner.address.';
+// @ts-expect-error
+const invalidDeleteTeamColumn = 'owner.delete';
+// @ts-expect-error
+const invalidReadTeamColumn = 'owner.read.*';
+//                              ValueAtColumn<O, P>                            //
+// --------------------------------------------------------------------------- //
+const labelsValue = ['foo'];
+// @ts-expect-error
+const invalidLabelsValue = [1];
+//                            SelectedRecordPick<O, Key>                        //
+// ---------------------------------------------------------------------------- //
+function test1(user) {
+    var _a, _b, _c, _d;
+    user.id;
+    user.read();
+    user.full_name;
+    (_a = user.address) === null || _a === void 0 ? void 0 : _a.street;
+    // @ts-expect-error
+    user.team.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.id;
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.read();
+    // @ts-expect-error
+    (_d = user.team) === null || _d === void 0 ? void 0 : _d.name;
+    user.partner.id;
+    user.partner.read();
+    // @ts-expect-error
+    user.partner.full_name;
+    user.team = null;
+    // @ts-expect-error
+    user.partner = null;
+}
+function test2(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    user.id;
+    user.read();
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner;
+    (_f = (_e = user.team) === null || _e === void 0 ? void 0 : _e.owner) === null || _f === void 0 ? void 0 : _f.id;
+    (_h = (_g = user.team) === null || _g === void 0 ? void 0 : _g.owner) === null || _h === void 0 ? void 0 : _h.read();
+    // @ts-expect-error
+    (_k = (_j = user.team) === null || _j === void 0 ? void 0 : _j.owner) === null || _k === void 0 ? void 0 : _k.full_name;
+    // @ts-expect-error
+    user.full_name = null;
+    user.email = null;
+    user.email = '';
+    // @ts-expect-error
+    user.email = 2;
+    if (user.team) {
+        // @ts-expect-error
+        user.team.name = null;
+        user.team.labels = null;
+        user.team.labels = ['foo'];
+        // @ts-expect-error
+        user.team.labels = [1];
+    }
+}
+function test3(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = user.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    (_j = (_h = user.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+}
+function test4(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    (_c = user.team) === null || _c === void 0 ? void 0 : _c.name;
+    (_e = (_d = user.team) === null || _d === void 0 ? void 0 : _d.owner) === null || _e === void 0 ? void 0 : _e.id;
+    (_g = (_f = user.team) === null || _f === void 0 ? void 0 : _f.owner) === null || _g === void 0 ? void 0 : _g.read();
+    // @ts-expect-error
+    (_j = (_h = user.team) === null || _h === void 0 ? void 0 : _h.owner) === null || _j === void 0 ? void 0 : _j.full_name;
+    (_l = (_k = user.team) === null || _k === void 0 ? void 0 : _k.owner) === null || _l === void 0 ? void 0 : _l.address;
+    (_p = (_o = (_m = user.team) === null || _m === void 0 ? void 0 : _m.owner) === null || _o === void 0 ? void 0 : _o.address) === null || _p === void 0 ? void 0 : _p.street;
+    (_s = (_r = (_q = user.team) === null || _q === void 0 ? void 0 : _q.owner) === null || _r === void 0 ? void 0 : _r.address) === null || _s === void 0 ? void 0 : _s.zipcode;
+}
+function test5(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    user.settings;
+    (_a = user.settings) === null || _a === void 0 ? void 0 : _a.theme;
+    (_b = user.settings) === null || _b === void 0 ? void 0 : _b.language;
+    (_c = user.settings) === null || _c === void 0 ? void 0 : _c.signin;
+    (_e = (_d = user.settings) === null || _d === void 0 ? void 0 : _d.signin) === null || _e === void 0 ? void 0 : _e.email;
+    (_g = (_f = user.settings) === null || _f === void 0 ? void 0 : _f.signin) === null || _g === void 0 ? void 0 : _g.github;
+    // @ts-expect-error
+    (_h = user.settings) === null || _h === void 0 ? void 0 : _h.id;
+    // @ts-expect-error
+    (_j = user.settings) === null || _j === void 0 ? void 0 : _j.read();
+    // @ts-expect-error
+    (_l = (_k = user.settings) === null || _k === void 0 ? void 0 : _k.signin) === null || _l === void 0 ? void 0 : _l.id;
+    user.settings = null;
+    user.nonNullable.nested.value = 2;
+    // @ts-expect-error
+    user.nonNullable = null;
+    // @ts-expect-error
+    user.nonNullable.nested.value = null;
+}
+function test6(user) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    user.id;
+    user.read();
+    // @ts-expect-error
+    user.full_name;
+    user.settings;
+    (_a = user.settings) === null || _a === void 0 ? void 0 : _a.theme;
+    (_b = user.settings) === null || _b === void 0 ? void 0 : _b.language;
+    (_c = user.settings) === null || _c === void 0 ? void 0 : _c.signin;
+    (_e = (_d = user.settings) === null || _d === void 0 ? void 0 : _d.signin) === null || _e === void 0 ? void 0 : _e.email;
+    (_g = (_f = user.settings) === null || _f === void 0 ? void 0 : _f.signin) === null || _g === void 0 ? void 0 : _g.github;
+    // @ts-expect-error
+    (_h = user.settings) === null || _h === void 0 ? void 0 : _h.id;
+    // @ts-expect-error
+    (_j = user.settings) === null || _j === void 0 ? void 0 : _j.read();
+    // @ts-expect-error
+    (_l = (_k = user.settings) === null || _k === void 0 ? void 0 : _k.signin) === null || _l === void 0 ? void 0 : _l.id;
+    user.nonNullable.nested.value = 2;
+    user.nonNullable.nested.deep.depths.of.numbers = [1, 2, 3];
+    // @ts-expect-error
+    user.nonNullable.nested.deep.depths.of.numbers = 'invalid-string';
+    user.settings = null;
+    // @ts-expect-error
+    user.nonNullable = null;
+    // @ts-expect-error
+    user.nonNullable.nested.value = null;
+}
+function test7(user) {
+    var _a, _b;
+    user.partner;
+    user.partner.id;
+    user.partner.read();
+    user.partner.full_name;
+    // @ts-expect-error
+    user.partner.full_name = null;
+    user.partner.address;
+    // @ts-expect-error
+    user.team.id;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    // @ts-expect-error
+    user.team.read();
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    user.partner = null;
+    user.team = null;
+}
+function test8(user) {
+    var _a, _b;
+    user.partner;
+    user.partner.id;
+    user.partner.read();
+    user.partner.full_name;
+    // @ts-expect-error
+    user.partner.full_name = null;
+    user.partner.address;
+    // @ts-expect-error
+    user.team.id;
+    (_a = user.team) === null || _a === void 0 ? void 0 : _a.id;
+    // @ts-expect-error
+    user.team.read();
+    (_b = user.team) === null || _b === void 0 ? void 0 : _b.read();
+    // @ts-expect-error
+    user.partner = null;
+    user.team = null;
+}
+test('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

package/dist/schema/sorting.d.ts

@@ -0,0 +1,17 @@
+import { SingleOrArray, Values } from '../util/types';
+import { XataRecord } from './record';
+import { SelectableColumn } from './selection';
+export declare type SortDirection = 'asc' | 'desc';
+export declare type SortFilterExtended<T extends XataRecord> = {
+    column: SelectableColumn<T>;
+    direction?: SortDirection;
+};
+export declare type SortFilter<T extends XataRecord> = SelectableColumn<T> | SortFilterExtended<T>;
+export declare type ApiSortFilter<T extends XataRecord> = SingleOrArray<Values<{
+    [key in SelectableColumn<T>]: {
+        [K in key]: SortDirection;
+    };
+}>>;
+export declare function isSortFilterString<T extends XataRecord>(value: any): value is SelectableColumn<T>;
+export declare function isSortFilterObject<T extends XataRecord>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
+export declare function buildSortFilter<T extends XataRecord>(filter: SingleOrArray<SortFilter<T>>): ApiSortFilter<T>;

package/dist/schema/sorting.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSortFilter = exports.isSortFilterObject = exports.isSortFilterString = void 0;
+const lang_1 = require("../util/lang");
+function isSortFilterString(value) {
+    return (0, lang_1.isString)(value);
+}
+exports.isSortFilterString = isSortFilterString;
+function isSortFilterObject(filter) {
+    return (0, lang_1.isObject)(filter) && filter.column !== undefined;
+}
+exports.isSortFilterObject = isSortFilterObject;
+function buildSortFilter(filter) {
+    var _a;
+    if (isSortFilterString(filter)) {
+        return { [filter]: 'asc' };
+    }
+    else if (Array.isArray(filter)) {
+        return filter.map((item) => buildSortFilter(item));
+    }
+    else if (isSortFilterObject(filter)) {
+        return { [filter.column]: (_a = filter.direction) !== null && _a !== void 0 ? _a : 'asc' };
+    }
+    else {
+        throw new Error(`Invalid sort filter: ${filter}`);
+    }
+}
+exports.buildSortFilter = buildSortFilter;

package/dist/schema/sorting.spec.d.ts

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

package/dist/schema/sorting.spec.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Simple sorting
+const simpleSorting = { name: 'asc' };
+// Array of simple sorting
+const arrayOfSimpleSorting = [{ name: 'asc' }, { age: 'desc' }];
+test('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

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

@@ -1,2 +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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compact = void 0;
+exports.isString = exports.isObject = exports.compactObject = exports.compact = void 0;
 function notEmpty(value) {
     return value !== null && value !== undefined;
 }
@@ -8,3 +8,15 @@ 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

@@ -1,3 +1,24 @@
 export declare type StringKeys<O> = Extract<keyof O, string>;
-export declare type Values<O> = O[keyof O];
+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 NonNullableValues<Obj> = {
+    [K in keyof Obj]: NonNullable<Obj[K]>;
+};
+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 {};

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@xata.io/client",
-  "version": "0.5.1",
+  "version": "0.7.1",
   "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": "09892c40a01ece59c802844310aac17aba7a281c"
+  "gitHead": "c817835c55f287286f4d30863e7bcfac0215f8f7"
 }