@xata.io/client 0.0.0-beta.d4fe58e → 0.0.0-beta.d76c443

package/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  ignorePatterns: ["dist"],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    project: 'client/tsconfig.json'
+  },
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/no-floating-promises': 'error',
+  }
+};

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @xata.io/client
 
+## 0.7.1
+
+### Patch Changes
+
+- 01aef78: Fix bundle for browsers
+- 56be1fd: Allow sending updates with link object
+- fc51771: Add includes operator helper methods
+
+## 0.7.0
+
+### Minor Changes
+
+- 6ce5512: Add bulk operations for all methods
+- 2a1fa4f: Introduced automatic branch resolution mechanism
+
+### Patch Changes
+
+- d033f3a: Improve column selection output type with non-nullable columns
+- b1e92db: Include stack trace with errors
+- deed570: Improve sorting with multiple properties
+- 80b5417: Improve filtering types
+
+## 0.6.0
+
+### Minor Changes
+
+- 084f5df: Add type inference for columns
+- bb73c89: Unify create and insert in a single method overload
+
+### Patch Changes
+
+- 716c487: Forward nullable types on links
+- bb66bb2: Fix error handling with createMany
+- 084f5df: Fix circular dependencies on selectable column
+
+## 0.5.1
+
+### Patch Changes
+
+- 12729ab: Make API client fetch implementation optional
+
+## 0.5.0
+
+### Patch Changes
+
+- 14ec7d1: Fix in Selectable type
+
+## 0.4.0
+
+### Patch Changes
+
+- b951331: Add support for new float column
+- d470610: Add new getAll() method
+- eaf92a8: Expose pagination constants (size and offset limits)
+- 57fde77: Reduce subrequests for createMany
+- eaf92a8: Implement schema-less client
+- 97a3caa: Make createBranch from optional with empty branch
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/api/client.d.ts

@@ -4,8 +4,8 @@ import { HostProvider } from './providers';
 import type * as Responses from './responses';
 import type * as Schemas from './schemas';
 export interface XataApiClientOptions {
-    fetch: FetchImpl;
-    apiKey: string;
+    fetch?: FetchImpl;
+    apiKey?: string;
     host?: HostProvider;
 }
 export declare class XataApiClient {

package/dist/api/client.js

@@ -10,49 +10,63 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _XataApiClient_extraProps;
+var _XataApiClient_extraProps, _XataApiClient_namespaces;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XataApiClient = void 0;
+const config_1 = require("../util/config");
+const fetch_1 = require("../util/fetch");
 const components_1 = require("./components");
 const providers_1 = require("./providers");
 class XataApiClient {
     constructor(options) {
-        var _a;
+        var _a, _b;
         _XataApiClient_extraProps.set(this, void 0);
-        const fetchImpl = typeof fetch !== 'undefined' ? fetch : options.fetch;
-        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.`);
-        }
+        _XataApiClient_namespaces.set(this, {});
         const provider = (_a = options.host) !== null && _a !== void 0 ? _a : 'production';
+        const apiKey = (_b = options === null || options === void 0 ? void 0 : options.apiKey) !== null && _b !== void 0 ? _b : (0, config_1.getAPIKey)();
+        if (!apiKey) {
+            throw new Error('Could not resolve a valid apiKey');
+        }
         __classPrivateFieldSet(this, _XataApiClient_extraProps, {
             apiUrl: (0, providers_1.getHostUrl)(provider, 'main'),
             workspacesApiUrl: (0, providers_1.getHostUrl)(provider, 'workspaces'),
-            fetchImpl,
-            apiKey: options.apiKey
+            fetchImpl: (0, fetch_1.getFetchImplementation)(options.fetch),
+            apiKey
         }, "f");
     }
     get user() {
-        return new UserApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user = new UserApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user;
     }
     get workspaces() {
-        return new WorkspaceApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces = new WorkspaceApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces;
     }
     get databases() {
-        return new DatabaseApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases = new DatabaseApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases;
     }
     get branches() {
-        return new BranchApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches = new BranchApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches;
     }
     get tables() {
-        return new TableApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables = new TableApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables;
     }
     get records() {
-        return new RecordsApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records = new RecordsApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records;
     }
 }
 exports.XataApiClient = XataApiClient;
-_XataApiClient_extraProps = new WeakMap();
+_XataApiClient_extraProps = new WeakMap(), _XataApiClient_namespaces = new WeakMap();
 class UserApi {
     constructor(extraProps) {
         this.extraProps = extraProps;
@@ -141,7 +155,7 @@ class BranchApi {
     getBranchDetails(workspace, database, branch) {
         return components_1.operationsByTag.branch.getBranchDetails(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}` } }, this.extraProps));
     }
-    createBranch(workspace, database, branch, from, options = {}) {
+    createBranch(workspace, database, branch, from = '', options = {}) {
         return components_1.operationsByTag.branch.createBranch(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}` }, queryParams: { from }, body: options }, this.extraProps));
     }
     deleteBranch(workspace, database, branch) {
@@ -220,7 +234,9 @@ class RecordsApi {
     deleteRecord(workspace, database, branch, tableName, recordId) {
         return components_1.operationsByTag.records.deleteRecord(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId } }, this.extraProps));
     }
-    getRecord(workspace, database, branch, tableName, recordId, options = {}) {
+    getRecord(workspace, database, branch, tableName, recordId, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options = {}) {
         return components_1.operationsByTag.records.getRecord(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId } }, this.extraProps));
     }
     bulkInsertTableRecords(workspace, database, branch, tableName, records) {

package/dist/api/components.d.ts

@@ -875,7 +875,7 @@ export declare type QueryTableVariables = {
  *   `$none`, etc.
  *
  * All operators start with an `$` to differentiate them from column names
- * (which are not allowed to start with an underscore).
+ * (which are not allowed to start with an dollar sign).
  *
  * #### Exact matching and control operators
  *
@@ -943,27 +943,17 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * If you want to OR together multiple values, you can use an array of values:
+ * If you want to OR together multiple values, you can use the `$any` operator with an array of values:
  *
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": ["free", "paid"]
+ *     "settings.plan": {"$any": ["free", "paid"]}
  *   },
  * }
  * ```
  *
- * Same query with `$is` operator:
- *
- * ```json
- * {
- *   "filter": {
- *     "settings.plan": { "$is": ["free", "paid"]}
- *   },
- * }
- * ```
- *
- * Specifying multiple columns, ANDs them together:
+ * If you specify multiple columns in the same filter, they are logically AND'ed together:
  *
  * ```json
  * {
@@ -974,6 +964,8 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
+ * The above matches if both conditions are met.
+ *
  * To be more explicit about it, you can use `$all` or `$any`:
  *
  * ```json
@@ -981,13 +973,13 @@ export declare type QueryTableVariables = {
  *   "filter": {
  *       "$any": {
  *         "settings.dark": true,
- *         "settings.plan": "free",
+ *         "settings.plan": "free"
  *       }
  *   },
  * }
  * ```
  *
- * `$all` and `$any` can also receive an array of objects, which allows for repeating columns:
+ * The `$all` and `$any` operators can also receive an array of objects, which allows for repeating column names:
  *
  * ```json
  * {
@@ -998,8 +990,9 @@ export declare type QueryTableVariables = {
  *       },
  *       {
  *         "name": "r2",
- *       },
- *     ],
+ *       }
+ *     ]
+ *   }
  * }
  * ```
  *
@@ -1009,7 +1002,7 @@ export declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "$exists": "settings",
- *   },
+ *   }
  * }
  * ```
  *
@@ -1024,19 +1017,19 @@ export declare type QueryTableVariables = {
  *       },
  *       {
  *         "$exists": "name",
- *       },
- *     ],
+ *       }
+ *     ]
  *   }
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
  *   "filter": {
  *     "$notExists": "settings",
- *   },
+ *   }
  * }
  * ```
  *
@@ -1083,7 +1076,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -1098,18 +1091,6 @@ export declare type QueryTableVariables = {
  *
  * The supported operators are `$gt`, `$lt`, `$ge`, `$le`.
  *
- * Date ranges would support the same operators, with the date as string in RFC 3339:
- *
- * ```json
- * {
- *   "filter": {
- *       "<column_name>": {
- *         "$gt": "2019-10-12T07:20:50.52Z",
- *         "$lt": "2021-10-12T07:20:50.52Z"
- *       }
- *   }
- * }
- * ```
  *
  * #### Negations
  *
@@ -1162,7 +1143,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * In addition, we can add specific operators like `$isNot` to simplify expressions:
+ * In addition, you can use operators like `$isNot` or `$notExists` to simplify expressions:
  *
  * ```json
  * {
@@ -1213,6 +1194,22 @@ export declare type QueryTableVariables = {
  * predicate. The `$includes` operator is a synonym for the `$includesAny`
  * operator.
  *
+ * Here is an example of using the `$includesAll` operator:
+ *
+ * ```json
+ * {
+ *   "filter": {
+ *     "settings.labels": {
+ *       "$includesAll": [
+ *         {"$contains": "label"},
+ *       ]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The above matches if all label values contain the string "labels".
+ *
  * ### Sorting
  *
  * Sorting by one element:

package/dist/api/components.js

@@ -458,7 +458,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  *   `$none`, etc.
  *
  * All operators start with an `$` to differentiate them from column names
- * (which are not allowed to start with an underscore).
+ * (which are not allowed to start with an dollar sign).
  *
  * #### Exact matching and control operators
  *
@@ -526,27 +526,17 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * If you want to OR together multiple values, you can use an array of values:
+ * If you want to OR together multiple values, you can use the `$any` operator with an array of values:
  *
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": ["free", "paid"]
+ *     "settings.plan": {"$any": ["free", "paid"]}
  *   },
  * }
  * ```
  *
- * Same query with `$is` operator:
- *
- * ```json
- * {
- *   "filter": {
- *     "settings.plan": { "$is": ["free", "paid"]}
- *   },
- * }
- * ```
- *
- * Specifying multiple columns, ANDs them together:
+ * If you specify multiple columns in the same filter, they are logically AND'ed together:
  *
  * ```json
  * {
@@ -557,6 +547,8 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
+ * The above matches if both conditions are met.
+ *
  * To be more explicit about it, you can use `$all` or `$any`:
  *
  * ```json
@@ -564,13 +556,13 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  *   "filter": {
  *       "$any": {
  *         "settings.dark": true,
- *         "settings.plan": "free",
+ *         "settings.plan": "free"
  *       }
  *   },
  * }
  * ```
  *
- * `$all` and `$any` can also receive an array of objects, which allows for repeating columns:
+ * The `$all` and `$any` operators can also receive an array of objects, which allows for repeating column names:
  *
  * ```json
  * {
@@ -581,8 +573,9 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  *       },
  *       {
  *         "name": "r2",
- *       },
- *     ],
+ *       }
+ *     ]
+ *   }
  * }
  * ```
  *
@@ -592,7 +585,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * {
  *   "filter": {
  *     "$exists": "settings",
- *   },
+ *   }
  * }
  * ```
  *
@@ -607,19 +600,19 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  *       },
  *       {
  *         "$exists": "name",
- *       },
- *     ],
+ *       }
+ *     ]
  *   }
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
  *   "filter": {
  *     "$notExists": "settings",
- *   },
+ *   }
  * }
  * ```
  *
@@ -666,7 +659,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -681,18 +674,6 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  *
  * The supported operators are `$gt`, `$lt`, `$ge`, `$le`.
  *
- * Date ranges would support the same operators, with the date as string in RFC 3339:
- *
- * ```json
- * {
- *   "filter": {
- *       "<column_name>": {
- *         "$gt": "2019-10-12T07:20:50.52Z",
- *         "$lt": "2021-10-12T07:20:50.52Z"
- *       }
- *   }
- * }
- * ```
  *
  * #### Negations
  *
@@ -745,7 +726,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * In addition, we can add specific operators like `$isNot` to simplify expressions:
+ * In addition, you can use operators like `$isNot` or `$notExists` to simplify expressions:
  *
  * ```json
  * {
@@ -796,6 +777,22 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * predicate. The `$includes` operator is a synonym for the `$includesAny`
  * operator.
  *
+ * Here is an example of using the `$includesAll` operator:
+ *
+ * ```json
+ * {
+ *   "filter": {
+ *     "settings.labels": {
+ *       "$includesAll": [
+ *         {"$contains": "label"},
+ *       ]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The above matches if all label values contain the string "labels".
+ *
  * ### Sorting
  *
  * Sorting by one element:

package/dist/api/fetcher.d.ts

@@ -23,3 +23,18 @@ export declare type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> =
     pathParams?: TPathParams;
 };
 export declare function fetch<TData, TBody extends Record<string, unknown> | undefined, THeaders extends Record<string, unknown>, TQueryParams extends Record<string, unknown>, TPathParams extends Record<string, string>>({ url: path, method, body, headers, pathParams, queryParams, fetchImpl, apiKey, apiUrl, workspacesApiUrl }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> & FetcherExtraProps): Promise<TData>;
+export declare class FetcherError extends Error {
+    status: number;
+    errors: Array<{
+        status: number;
+        message?: string;
+    }> | undefined;
+    constructor(data: {
+        message: string;
+        status: number;
+        errors?: Array<{
+            status: number;
+            message?: string;
+        }>;
+    }, parent?: Error);
+}

package/dist/api/fetcher.js

@@ -9,13 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetch = void 0;
+exports.FetcherError = exports.fetch = void 0;
+const lang_1 = require("../util/lang");
 const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
     const query = new URLSearchParams(queryParams).toString();
     const queryString = query.length > 0 ? `?${query}` : '';
     return url.replace(/\{\w*\}/g, (key) => pathParams[key.slice(1, -1)]) + queryString;
 };
-const fallbackError = { message: 'Network response was not ok' };
 function buildBaseUrl({ path, workspacesApiUrl, apiUrl, pathParams }) {
     if (!(pathParams === null || pathParams === void 0 ? void 0 : pathParams.workspace))
         return `${apiUrl}${path}`;
@@ -51,28 +51,29 @@ function fetch({ url: path, method, body, headers, pathParams, queryParams, fetc
             if (response.ok) {
                 return jsonResponse;
             }
-            if (jsonResponse.message) {
-                throw withStatus({ message: jsonResponse.message }, response.status);
-            }
-            else {
-                throw withStatus(fallbackError, response.status);
-            }
+            const { message = 'Unknown error', errors } = jsonResponse;
+            throw new FetcherError({ message, status: response.status, errors });
         }
-        catch (e) {
-            if (e instanceof Error) {
-                const error = {
-                    message: e.message
-                };
-                throw withStatus(error, response.status);
-            }
-            else if (typeof e === 'object' && typeof e.message === 'string') {
-                throw withStatus(e, response.status);
-            }
-            else {
-                throw withStatus(fallbackError, response.status);
-            }
+        catch (error) {
+            const message = hasMessage(error) ? error.message : 'Unknown network error';
+            const parent = error instanceof Error ? error : undefined;
+            throw new FetcherError({ message, status: response.status }, parent);
         }
     });
 }
 exports.fetch = fetch;
-const withStatus = (error, status) => (Object.assign(Object.assign({}, error), { status }));
+const hasMessage = (error) => {
+    return (0, lang_1.isObject)(error) && (0, lang_1.isString)(error.message);
+};
+class FetcherError extends Error {
+    constructor(data, parent) {
+        super(data.message);
+        this.status = data.status;
+        this.errors = data.errors;
+        if (parent) {
+            this.stack = parent.stack;
+            this.cause = parent.cause;
+        }
+    }
+}
+exports.FetcherError = FetcherError;

package/dist/api/providers.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHostUrl = void 0;
+const lang_1 = require("../util/lang");
 function getHostUrl(provider, type) {
     if (isValidAlias(provider)) {
         return providers[provider][type];
@@ -22,8 +23,8 @@ const providers = {
     }
 };
 function isValidAlias(alias) {
-    return typeof alias === 'string' && Object.keys(providers).includes(alias);
+    return (0, lang_1.isString)(alias) && Object.keys(providers).includes(alias);
 }
 function isValidBuilder(builder) {
-    return typeof builder === 'object' && typeof builder.main === 'string' && typeof builder.workspaces === 'string';
+    return (0, lang_1.isObject)(builder) && (0, lang_1.isString)(builder.main) && (0, lang_1.isString)(builder.workspaces);
 }

package/dist/api/responses.d.ts

@@ -19,6 +19,12 @@ export declare type AuthError = {
     id?: string;
     message: string;
 };
+export declare type BulkError = {
+    errors: {
+        message?: string;
+        status?: number;
+    }[];
+};
 export declare type BranchMigrationPlan = {
     version: number;
     migration: Schemas.BranchMigration;

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export declare class XataError extends Error {
 }
 export * from './api';
 export * from './schema';
+export * from './util/config';

package/dist/index.js

@@ -24,3 +24,4 @@ class XataError extends Error {
 exports.XataError = XataError;
 __exportStar(require("./api"), exports);
 __exportStar(require("./schema"), exports);
+__exportStar(require("./util/config"), exports);