@xata.io/client 0.0.0-beta.d4d1df0 → 0.0.0-beta.e5ce1d8

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,28 @@
 # @xata.io/client
 
+## 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,7 +4,7 @@ import { HostProvider } from './providers';
 import type * as Responses from './responses';
 import type * as Schemas from './schemas';
 export interface XataApiClientOptions {
-    fetch: FetchImpl;
+    fetch?: FetchImpl;
     apiKey: string;
     host?: HostProvider;
 }

package/dist/api/client.js

@@ -17,14 +17,15 @@ 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;
+        const globalFetch = typeof fetch !== 'undefined' ? fetch : undefined;
+        const fetchImpl = (_a = options.fetch) !== null && _a !== void 0 ? _a : 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.`);
         }
-        const provider = (_a = options.host) !== null && _a !== void 0 ? _a : 'production';
+        const provider = (_b = options.host) !== null && _b !== void 0 ? _b : 'production';
         __classPrivateFieldSet(this, _XataApiClient_extraProps, {
             apiUrl: (0, providers_1.getHostUrl)(provider, 'main'),
             workspacesApiUrl: (0, providers_1.getHostUrl)(provider, 'workspaces'),
@@ -141,7 +142,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) {

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
  * {
@@ -1030,7 +1022,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
@@ -1083,7 +1075,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -1098,18 +1090,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 +1142,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 +1193,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
  * {
@@ -613,7 +605,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
@@ -666,7 +658,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -681,18 +673,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 +725,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 +776,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.js

@@ -10,12 +10,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetch = void 0;
+/* eslint-disable @typescript-eslint/no-throw-literal */
+/* eslint-disable @typescript-eslint/ban-types */
+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 +53,21 @@ 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 withStatus({ message, errors }, response.status);
         }
         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') {
+            if (isError(e)) {
                 throw withStatus(e, response.status);
             }
             else {
-                throw withStatus(fallbackError, response.status);
+                throw withStatus({ message: 'Network response was not ok' }, response.status);
             }
         }
     });
 }
 exports.fetch = fetch;
-const withStatus = (error, status) => (Object.assign(Object.assign({}, error), { status }));
+const isError = (error) => {
+    return (0, lang_1.isObject)(error) && (0, lang_1.isString)(error.message);
+};
+const withStatus = (error, status) => (0, lang_1.compactObject)(Object.assign(Object.assign({}, error), { status }));

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

@@ -1,12 +1,14 @@
+import { XataRecord } from './record';
+import { SelectableColumn } from './selection';
 export declare type SortDirection = 'asc' | 'desc';
-export declare type SortFilterExtended<T> = {
-    column: keyof T;
+export declare type SortFilterExtended<T extends XataRecord> = {
+    column: SelectableColumn<T>;
     direction?: SortDirection;
 };
-export declare type SortFilter<T> = SortFilterExtended<T> | keyof T;
-export declare function isSortFilterObject<T>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
+export declare type SortFilter<T extends XataRecord> = SelectableColumn<T> | SortFilterExtended<T>;
+export declare function isSortFilterObject<T extends XataRecord>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
 export declare type FilterOperator = '$gt' | '$lt' | '$ge' | '$le' | '$exists' | '$notExists' | '$endsWith' | '$startsWith' | '$pattern' | '$is' | '$isNot' | '$contains' | '$includes' | '$includesSubstring' | '$includesPattern' | '$includesAll';
-export declare function buildSortFilter<T>(filter?: SortFilter<T> | SortFilter<T>[]): {
+export declare function buildSortFilter<T extends XataRecord>(filter?: SortFilter<T> | SortFilter<T>[]): {
     [key: string]: SortDirection;
 } | undefined;
 export declare type Constraint<T> = {

package/dist/schema/filters.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildSortFilter = exports.isSortFilterObject = void 0;
+const lang_1 = require("../util/lang");
 function isSortFilterObject(filter) {
-    return typeof filter === 'object' && filter.column !== undefined;
+    return (0, lang_1.isObject)(filter) && filter.column !== undefined;
 }
 exports.isSortFilterObject = isSortFilterObject;
 function buildSortFilter(filter) {

package/dist/schema/index.d.ts

@@ -1,5 +1,7 @@
 export * from './operators';
-export type { XataRecord } from './record';
-export { Repository, RestRepository, RestRespositoryFactory, BaseClient } from './repository';
-export type { XataClientOptions } from './repository';
+export * from './pagination';
 export { Query } from './query';
+export { isIdentifiable, isXataRecord } from './record';
+export type { Identifiable, XataRecord } from './record';
+export { BaseClient, Repository, RestRepository, RestRespositoryFactory } from './repository';
+export type { XataClientOptions } from './repository';

package/dist/schema/index.js

@@ -14,12 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Query = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
+exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.BaseClient = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
 __exportStar(require("./operators"), exports);
+__exportStar(require("./pagination"), exports);
+var query_1 = require("./query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });
+var record_1 = require("./record");
+Object.defineProperty(exports, "isIdentifiable", { enumerable: true, get: function () { return record_1.isIdentifiable; } });
+Object.defineProperty(exports, "isXataRecord", { enumerable: true, get: function () { return record_1.isXataRecord; } });
 var repository_1 = require("./repository");
+Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
 Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });
 Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_1.RestRepository; } });
 Object.defineProperty(exports, "RestRespositoryFactory", { enumerable: true, get: function () { return repository_1.RestRespositoryFactory; } });
-Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
-var query_1 = require("./query");
-Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });

package/dist/schema/pagination.d.ts

@@ -1,25 +1,25 @@
-import { XataRecord } from '..';
 import { Query } from './query';
+import { XataRecord } from './record';
 export declare type PaginationQueryMeta = {
     page: {
         cursor: string;
         more: boolean;
     };
 };
-export interface Paginable<T extends XataRecord, R extends XataRecord = T> {
+export interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
     meta: PaginationQueryMeta;
-    records: R[];
-    nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    records: Result[];
+    nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     hasNextPage(): boolean;
 }
 /**
  * A Page contains a set of results from a query plus metadata about the retrieved
  * set of values such as the cursor, required to retrieve additional records.
  */
-export declare class Page<T extends XataRecord, R extends XataRecord> implements Paginable<T, R> {
+export declare class Page<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
     #private;
     /**
      * Page metadata, required to retrieve additional records.
@@ -28,36 +28,36 @@ export declare class Page<T extends XataRecord, R extends XataRecord> implements
     /**
      * The set of results for this page.
      */
-    readonly records: R[];
-    constructor(query: Query<T, R>, meta: PaginationQueryMeta, records?: R[]);
+    readonly records: Result[];
+    constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
     /**
      * Retrieves the next page of results.
      * @param size Maximum number of results to be retrieved.
      * @param offset Number of results to skip when retrieving the results.
      * @returns The next page or results.
      */
-    nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     /**
      * Retrieves the previous page of results.
      * @param size Maximum number of results to be retrieved.
      * @param offset Number of results to skip when retrieving the results.
      * @returns The previous page or results.
      */
-    previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     /**
      * Retrieves the first page of results.
      * @param size Maximum number of results to be retrieved.
      * @param offset Number of results to skip when retrieving the results.
      * @returns The first page or results.
      */
-    firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     /**
      * Retrieves the last page of results.
      * @param size Maximum number of results to be retrieved.
      * @param offset Number of results to skip when retrieving the results.
      * @returns The last page or results.
      */
-    lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     /**
      * Shortcut method to check if there will be additional results if the next page of results is retrieved.
      * @returns Whether or not there will be additional results in the next page of results.
@@ -77,3 +77,7 @@ export declare type OffsetNavigationOptions = {
     offset?: number;
 };
 export declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
+export declare const PAGINATION_MAX_SIZE = 200;
+export declare const PAGINATION_DEFAULT_SIZE = 200;
+export declare const PAGINATION_MAX_OFFSET = 800;
+export declare const PAGINATION_DEFAULT_OFFSET = 0;

package/dist/schema/pagination.js

@@ -21,7 +21,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _Page_query;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Page = void 0;
+exports.PAGINATION_DEFAULT_OFFSET = exports.PAGINATION_MAX_OFFSET = exports.PAGINATION_DEFAULT_SIZE = exports.PAGINATION_MAX_SIZE = exports.Page = void 0;
 /**
  * A Page contains a set of results from a query plus metadata about the retrieved
  * set of values such as the cursor, required to retrieve additional records.
@@ -77,7 +77,6 @@ class Page {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
         });
     }
-    // TODO: We need to add something on the backend if we want a hasPreviousPage
     /**
      * Shortcut method to check if there will be additional results if the next page of results is retrieved.
      * @returns Whether or not there will be additional results in the next page of results.
@@ -88,3 +87,7 @@ class Page {
 }
 exports.Page = Page;
 _Page_query = new WeakMap();
+exports.PAGINATION_MAX_SIZE = 200;
+exports.PAGINATION_DEFAULT_SIZE = 200;
+exports.PAGINATION_MAX_OFFSET = 800;
+exports.PAGINATION_DEFAULT_OFFSET = 0;