@xata.io/client 0.0.0-beta.bdce130 → 0.0.0-beta.c21e40a

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

@@ -0,0 +1,49 @@
+# @xata.io/client
+
+## 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
+
+- 1c0a454: Add API Client and internally use it
+
+### Patch Changes
+
+- 122321c: Fix client in CF workers and Deno
+- a2671b5: Allow cancel or resend workspace invites
+- e73d470: Split insert and create

package/dist/api/client.d.ts

@@ -4,12 +4,12 @@ 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;
 }
 export declare class XataApiClient {
-    private extraProps;
+    #private;
     constructor(options: XataApiClientOptions);
     get user(): UserApi;
     get workspaces(): WorkspaceApi;
@@ -40,6 +40,8 @@ declare class WorkspaceApi {
     updateWorkspaceMemberRole(workspaceId: Schemas.WorkspaceID, userId: Schemas.UserID, role: Schemas.Role): Promise<void>;
     removeWorkspaceMember(workspaceId: Schemas.WorkspaceID, userId: Schemas.UserID): Promise<void>;
     inviteWorkspaceMember(workspaceId: Schemas.WorkspaceID, email: string, role: Schemas.Role): Promise<Schemas.WorkspaceInvite>;
+    cancelWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteId: Schemas.InviteID): Promise<void>;
+    resendWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteId: Schemas.InviteID): Promise<void>;
     acceptWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteKey: Schemas.InviteKey): Promise<void>;
 }
 declare class DatabaseApi {
@@ -81,10 +83,13 @@ declare class RecordsApi {
     private extraProps;
     constructor(extraProps: FetcherExtraProps);
     insertRecord(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, record: Record<string, any>): Promise<Types.InsertRecordResponse>;
-    insertRecordWithID(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID, record: Record<string, any>, options?: Types.InsertRecordWithIDQueryParams): Promise<Types.InsertRecordWithIDResponse>;
+    insertRecordWithID(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID, record: Record<string, any>, options?: Types.InsertRecordWithIDQueryParams): Promise<Responses.RecordUpdateResponse>;
+    updateRecordWithID(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID, record: Record<string, any>, options?: Types.UpdateRecordWithIDQueryParams): Promise<Responses.RecordUpdateResponse>;
+    upsertRecordWithID(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID, record: Record<string, any>, options?: Types.UpsertRecordWithIDQueryParams): Promise<Responses.RecordUpdateResponse>;
     deleteRecord(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID): Promise<void>;
     getRecord(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, recordId: Schemas.RecordID, options?: Types.GetRecordRequestBody): Promise<Schemas.XataRecord>;
     bulkInsertTableRecords(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, records: Record<string, any>[]): Promise<Types.BulkInsertTableRecordsResponse>;
     queryTable(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, tableName: Schemas.TableName, query: Types.QueryTableRequestBody): Promise<Responses.QueryResponse>;
+    searchBranch(workspace: Schemas.WorkspaceID, database: Schemas.DBName, branch: Schemas.BranchName, query: Types.SearchBranchRequestBody): Promise<Responses.SearchResponse>;
 }
 export {};

package/dist/api/client.js

@@ -1,44 +1,59 @@
 "use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XataApiClient = void 0;
 const components_1 = require("./components");
 const providers_1 = require("./providers");
 class XataApiClient {
     constructor(options) {
-        var _a;
-        const fetchImpl = typeof fetch !== 'undefined' ? fetch : options.fetch;
+        var _a, _b;
+        _XataApiClient_extraProps.set(this, void 0);
+        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';
-        this.extraProps = {
+        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'),
             fetchImpl,
             apiKey: options.apiKey
-        };
+        }, "f");
     }
     get user() {
-        return new UserApi(this.extraProps);
+        return new UserApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
     get workspaces() {
-        return new WorkspaceApi(this.extraProps);
+        return new WorkspaceApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
     get databases() {
-        return new DatabaseApi(this.extraProps);
+        return new DatabaseApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
     get branches() {
-        return new BranchApi(this.extraProps);
+        return new BranchApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
     get tables() {
-        return new TableApi(this.extraProps);
+        return new TableApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
     get records() {
-        return new RecordsApi(this.extraProps);
+        return new RecordsApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
     }
 }
 exports.XataApiClient = XataApiClient;
+_XataApiClient_extraProps = new WeakMap();
 class UserApi {
     constructor(extraProps) {
         this.extraProps = extraProps;
@@ -93,6 +108,12 @@ class WorkspaceApi {
     inviteWorkspaceMember(workspaceId, email, role) {
         return components_1.operationsByTag.workspaces.inviteWorkspaceMember(Object.assign({ pathParams: { workspaceId }, body: { email, role } }, this.extraProps));
     }
+    cancelWorkspaceMemberInvite(workspaceId, inviteId) {
+        return components_1.operationsByTag.workspaces.cancelWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteId } }, this.extraProps));
+    }
+    resendWorkspaceMemberInvite(workspaceId, inviteId) {
+        return components_1.operationsByTag.workspaces.resendWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteId } }, this.extraProps));
+    }
     acceptWorkspaceMemberInvite(workspaceId, inviteKey) {
         return components_1.operationsByTag.workspaces.acceptWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteKey } }, this.extraProps));
     }
@@ -121,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) {
@@ -191,6 +212,12 @@ class RecordsApi {
     insertRecordWithID(workspace, database, branch, tableName, recordId, record, options = {}) {
         return components_1.operationsByTag.records.insertRecordWithID(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId }, queryParams: options, body: record }, this.extraProps));
     }
+    updateRecordWithID(workspace, database, branch, tableName, recordId, record, options = {}) {
+        return components_1.operationsByTag.records.updateRecordWithID(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId }, queryParams: options, body: record }, this.extraProps));
+    }
+    upsertRecordWithID(workspace, database, branch, tableName, recordId, record, options = {}) {
+        return components_1.operationsByTag.records.upsertRecordWithID(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId }, queryParams: options, body: record }, this.extraProps));
+    }
     deleteRecord(workspace, database, branch, tableName, recordId) {
         return components_1.operationsByTag.records.deleteRecord(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName, recordId } }, this.extraProps));
     }
@@ -203,4 +230,7 @@ class RecordsApi {
     queryTable(workspace, database, branch, tableName, query) {
         return components_1.operationsByTag.records.queryTable(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName }, body: query }, this.extraProps));
     }
+    searchBranch(workspace, database, branch, query) {
+        return components_1.operationsByTag.records.searchBranch(Object.assign({ pathParams: { workspace, dbBranchName: `${database}:${branch}` }, body: query }, this.extraProps));
+    }
 }

package/dist/api/components.d.ts

@@ -161,22 +161,6 @@ export declare type InviteWorkspaceMemberVariables = {
  * Invite some user to join the workspace with the given role
  */
 export declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<Schemas.WorkspaceInvite>;
-export declare type UpdateWorkspaceMemberInvitePathParams = {
-    workspaceId: Schemas.WorkspaceID;
-    inviteId: Schemas.InviteID;
-};
-export declare type UpdateWorkspaceMemberInviteRequestBody = {
-    role: Schemas.Role;
-};
-export declare type UpdateWorkspaceMemberInviteVariables = {
-    body: UpdateWorkspaceMemberInviteRequestBody;
-    pathParams: UpdateWorkspaceMemberInvitePathParams;
-} & FetcherExtraProps;
-/**
- * This operation provides a way to update an invite.
- * The role can be updated while the email cannot.
- */
-export declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<Schemas.WorkspaceInvite>;
 export declare type CancelWorkspaceMemberInvitePathParams = {
     workspaceId: Schemas.WorkspaceID;
     inviteId: Schemas.InviteID;
@@ -566,12 +550,6 @@ export declare type InsertRecordWithIDQueryParams = {
     createOnly?: boolean;
     ifVersion?: number;
 };
-export declare type InsertRecordWithIDResponse = {
-    id: string;
-    xata: {
-        version: number;
-    };
-};
 export declare type InsertRecordWithIDVariables = {
     body?: Record<string, any>;
     pathParams: InsertRecordWithIDPathParams;
@@ -580,7 +558,37 @@ export declare type InsertRecordWithIDVariables = {
 /**
  * By default, IDs are auto-generated when data is insterted into Xata. Sending a request to this endpoint allows us to insert a record with a pre-existing ID, bypassing the default automatic ID generation.
  */
-export declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<InsertRecordWithIDResponse>;
+export declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
+export declare type UpdateRecordWithIDPathParams = {
+    dbBranchName: Schemas.DBBranchName;
+    tableName: Schemas.TableName;
+    recordId: Schemas.RecordID;
+    workspace: string;
+};
+export declare type UpdateRecordWithIDQueryParams = {
+    ifVersion?: number;
+};
+export declare type UpdateRecordWithIDVariables = {
+    body?: Record<string, any>;
+    pathParams: UpdateRecordWithIDPathParams;
+    queryParams?: UpdateRecordWithIDQueryParams;
+} & FetcherExtraProps;
+export declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
+export declare type UpsertRecordWithIDPathParams = {
+    dbBranchName: Schemas.DBBranchName;
+    tableName: Schemas.TableName;
+    recordId: Schemas.RecordID;
+    workspace: string;
+};
+export declare type UpsertRecordWithIDQueryParams = {
+    ifVersion?: number;
+};
+export declare type UpsertRecordWithIDVariables = {
+    body?: Record<string, any>;
+    pathParams: UpsertRecordWithIDPathParams;
+    queryParams?: UpsertRecordWithIDQueryParams;
+} & FetcherExtraProps;
+export declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
 export declare type DeleteRecordPathParams = {
     dbBranchName: Schemas.DBBranchName;
     tableName: Schemas.TableName;
@@ -867,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
  *
@@ -935,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
  * {
@@ -966,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
@@ -973,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
  * {
@@ -1022,7 +1022,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
@@ -1075,7 +1075,7 @@ export declare type QueryTableVariables = {
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -1090,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
  *
@@ -1154,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
  * {
@@ -1205,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:
@@ -1356,13 +1360,14 @@ export declare type SearchBranchPathParams = {
 export declare type SearchBranchRequestBody = {
     tables?: string[];
     query: string;
+    fuzziness?: number;
 };
 export declare type SearchBranchVariables = {
     body: SearchBranchRequestBody;
     pathParams: SearchBranchPathParams;
 } & FetcherExtraProps;
 /**
- * Run a free text search operation across the Database.
+ * Run a free text search operation across the database branch.
  */
 export declare const searchBranch: (variables: SearchBranchVariables) => Promise<Responses.SearchResponse>;
 export declare const operationsByTag: {
@@ -1384,7 +1389,6 @@ export declare const operationsByTag: {
         updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
         removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
         inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<Schemas.WorkspaceInvite>;
-        updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<Schemas.WorkspaceInvite>;
         cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
         resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
         acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
@@ -1420,7 +1424,9 @@ export declare const operationsByTag: {
     };
     records: {
         insertRecord: (variables: InsertRecordVariables) => Promise<InsertRecordResponse>;
-        insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<InsertRecordWithIDResponse>;
+        insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
+        updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
+        upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<Responses.RecordUpdateResponse>;
         deleteRecord: (variables: DeleteRecordVariables) => Promise<undefined>;
         getRecord: (variables: GetRecordVariables) => Promise<Schemas.XataRecord>;
         bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertTableRecordsResponse>;

package/dist/api/components.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.operationsByTag = exports.searchBranch = exports.queryTable = exports.bulkInsertTableRecords = exports.getRecord = exports.deleteRecord = exports.insertRecordWithID = exports.insertRecord = exports.updateColumn = exports.deleteColumn = exports.getColumn = exports.addTableColumn = exports.getTableColumns = exports.setTableSchema = exports.getTableSchema = exports.updateTable = exports.deleteTable = exports.createTable = exports.getBranchStats = exports.getBranchMigrationPlan = exports.executeBranchMigrationPlan = exports.getBranchMigrationHistory = exports.getBranchMetadata = exports.updateBranchMetadata = exports.deleteBranch = exports.createBranch = exports.getBranchDetails = exports.deleteDatabase = exports.createDatabase = exports.getBranchList = exports.getDatabaseList = exports.acceptWorkspaceMemberInvite = exports.resendWorkspaceMemberInvite = exports.cancelWorkspaceMemberInvite = exports.updateWorkspaceMemberInvite = exports.inviteWorkspaceMember = exports.removeWorkspaceMember = exports.updateWorkspaceMemberRole = exports.getWorkspaceMembersList = exports.deleteWorkspace = exports.updateWorkspace = exports.getWorkspace = exports.getWorkspacesList = exports.createWorkspace = exports.deleteUserAPIKey = exports.createUserAPIKey = exports.getUserAPIKeys = exports.deleteUser = exports.updateUser = exports.getUser = void 0;
+exports.searchBranch = exports.queryTable = exports.bulkInsertTableRecords = exports.getRecord = exports.deleteRecord = exports.upsertRecordWithID = exports.updateRecordWithID = exports.insertRecordWithID = exports.insertRecord = exports.updateColumn = exports.deleteColumn = exports.getColumn = exports.addTableColumn = exports.getTableColumns = exports.setTableSchema = exports.getTableSchema = exports.updateTable = exports.deleteTable = exports.createTable = exports.getBranchStats = exports.getBranchMigrationPlan = exports.executeBranchMigrationPlan = exports.getBranchMigrationHistory = exports.getBranchMetadata = exports.updateBranchMetadata = exports.deleteBranch = exports.createBranch = exports.getBranchDetails = exports.deleteDatabase = exports.createDatabase = exports.getBranchList = exports.getDatabaseList = exports.acceptWorkspaceMemberInvite = exports.resendWorkspaceMemberInvite = exports.cancelWorkspaceMemberInvite = exports.inviteWorkspaceMember = exports.removeWorkspaceMember = exports.updateWorkspaceMemberRole = exports.getWorkspaceMembersList = exports.deleteWorkspace = exports.updateWorkspace = exports.getWorkspace = exports.getWorkspacesList = exports.createWorkspace = exports.deleteUserAPIKey = exports.createUserAPIKey = exports.getUserAPIKeys = exports.deleteUser = exports.updateUser = exports.getUser = void 0;
+exports.operationsByTag = void 0;
 /**
  * Generated by @openapi-codegen
  *
@@ -82,12 +83,6 @@ exports.removeWorkspaceMember = removeWorkspaceMember;
  */
 const inviteWorkspaceMember = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/workspaces/{workspaceId}/invites', method: 'post' }, variables));
 exports.inviteWorkspaceMember = inviteWorkspaceMember;
-/**
- * This operation provides a way to update an invite.
- * The role can be updated while the email cannot.
- */
-const updateWorkspaceMemberInvite = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/workspaces/{workspaceId}/invites/{inviteId}', method: 'patch' }, variables));
-exports.updateWorkspaceMemberInvite = updateWorkspaceMemberInvite;
 /**
  * This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
  */
@@ -222,6 +217,10 @@ exports.insertRecord = insertRecord;
  */
 const insertRecordWithID = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/tables/{tableName}/data/{recordId}', method: 'put' }, variables));
 exports.insertRecordWithID = insertRecordWithID;
+const updateRecordWithID = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/tables/{tableName}/data/{recordId}', method: 'patch' }, variables));
+exports.updateRecordWithID = updateRecordWithID;
+const upsertRecordWithID = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/tables/{tableName}/data/{recordId}', method: 'post' }, variables));
+exports.upsertRecordWithID = upsertRecordWithID;
 const deleteRecord = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/tables/{tableName}/data/{recordId}', method: 'delete' }, variables));
 exports.deleteRecord = deleteRecord;
 /**
@@ -459,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
  *
@@ -527,27 +526,17 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * If you want to OR together multiple values, you can use an array of values:
- *
- * ```json
- * {
- *   "filter": {
- *     "settings.plan": ["free", "paid"]
- *   },
- * }
- * ```
- *
- * Same query with `$is` operator:
+ * If you want to OR together multiple values, you can use the `$any` operator with an array of values:
  *
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": { "$is": ["free", "paid"]}
+ *     "settings.plan": {"$any": ["free", "paid"]}
  *   },
  * }
  * ```
  *
- * Specifying multiple columns, ANDs them together:
+ * If you specify multiple columns in the same filter, they are logically AND'ed together:
  *
  * ```json
  * {
@@ -558,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
@@ -565,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
  * {
@@ -614,7 +605,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * We can also make the negation version, `$notExists` :
+ * Or you can use the inverse operator `$notExists`:
  *
  * ```json
  * {
@@ -667,7 +658,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
  * }
  * ```
  *
- * #### Numeric/date ranges
+ * #### Numeric ranges
  *
  * ```json
  * {
@@ -682,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
  *
@@ -746,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
  * {
@@ -797,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:
@@ -943,7 +938,7 @@ exports.bulkInsertTableRecords = bulkInsertTableRecords;
 const queryTable = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/tables/{tableName}/query', method: 'post' }, variables));
 exports.queryTable = queryTable;
 /**
- * Run a free text search operation across the Database.
+ * Run a free text search operation across the database branch.
  */
 const searchBranch = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/db/{dbBranchName}/search', method: 'post' }, variables));
 exports.searchBranch = searchBranch;
@@ -959,7 +954,6 @@ exports.operationsByTag = {
         updateWorkspaceMemberRole: exports.updateWorkspaceMemberRole,
         removeWorkspaceMember: exports.removeWorkspaceMember,
         inviteWorkspaceMember: exports.inviteWorkspaceMember,
-        updateWorkspaceMemberInvite: exports.updateWorkspaceMemberInvite,
         cancelWorkspaceMemberInvite: exports.cancelWorkspaceMemberInvite,
         resendWorkspaceMemberInvite: exports.resendWorkspaceMemberInvite,
         acceptWorkspaceMemberInvite: exports.acceptWorkspaceMemberInvite
@@ -992,6 +986,8 @@ exports.operationsByTag = {
     records: {
         insertRecord: exports.insertRecord,
         insertRecordWithID: exports.insertRecordWithID,
+        updateRecordWithID: exports.updateRecordWithID,
+        upsertRecordWithID: exports.upsertRecordWithID,
         deleteRecord: exports.deleteRecord,
         getRecord: exports.getRecord,
         bulkInsertTableRecords: exports.bulkInsertTableRecords,

package/dist/api/fetcher.d.ts

@@ -7,9 +7,10 @@ export declare type FetchImpl = (url: string, init?: {
     status: number;
     json(): Promise<any>;
 }>;
+export declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
 export declare type FetcherExtraProps = {
     apiUrl: string;
-    workspacesApiUrl: string;
+    workspacesApiUrl: string | WorkspaceApiUrlBuilder;
     fetchImpl: FetchImpl;
     apiKey: string;
 };
@@ -21,4 +22,4 @@ export declare type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> =
     queryParams?: TQueryParams;
     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, method, body, headers, pathParams, queryParams, fetchImpl, apiKey, apiUrl, workspacesApiUrl }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> & FetcherExtraProps): Promise<TData>;
+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>;