@xata.io/client 0.19.0 → 0.20.0

package/dist/index.mjs

@@ -94,6 +94,25 @@ function getEnvironment() {
     fallbackBranch: getGlobalFallbackBranch()
   };
 }
+function getEnableBrowserVariable() {
+  try {
+    if (isObject(process) && isObject(process.env) && process.env.XATA_ENABLE_BROWSER !== void 0) {
+      return process.env.XATA_ENABLE_BROWSER === "true";
+    }
+  } catch (err) {
+  }
+  try {
+    if (isObject(Deno) && isObject(Deno.env) && Deno.env.get("XATA_ENABLE_BROWSER") !== void 0) {
+      return Deno.env.get("XATA_ENABLE_BROWSER") === "true";
+    }
+  } catch (err) {
+  }
+  try {
+    return XATA_ENABLE_BROWSER === true || XATA_ENABLE_BROWSER === "true";
+  } catch (err) {
+    return void 0;
+  }
+}
 function getGlobalApiKey() {
   try {
     return XATA_API_KEY;
@@ -164,7 +183,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.19.0";
+const VERSION = "0.20.0";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -254,7 +273,8 @@ async function fetch$1({
   trace,
   signal,
   clientID,
-  sessionID
+  sessionID,
+  fetchOptions = {}
 }) {
   return trace(
     `${method.toUpperCase()} ${path}`,
@@ -267,6 +287,7 @@ async function fetch$1({
         [TraceAttributes.HTTP_TARGET]: resolveUrl(path, queryParams, pathParams)
       });
       const response = await fetchImpl(url, {
+        ...fetchOptions,
         method: method.toUpperCase(),
         body: body ? JSON.stringify(body) : void 0,
         headers: {
@@ -316,32 +337,17 @@ function parseUrl(url) {
 
 const dataPlaneFetch = async (options) => fetch$1({ ...options, endpoint: "dataPlane" });
 
-const getDatabaseList = (variables, signal) => dataPlaneFetch({
-  url: "/dbs",
-  method: "get",
-  ...variables,
-  signal
-});
+const dEPRECATEDgetDatabaseList = (variables, signal) => dataPlaneFetch({ url: "/dbs", method: "get", ...variables, signal });
 const getBranchList = (variables, signal) => dataPlaneFetch({
   url: "/dbs/{dbName}",
   method: "get",
   ...variables,
   signal
 });
-const createDatabase = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}", method: "put", ...variables, signal });
-const deleteDatabase = (variables, signal) => dataPlaneFetch({
-  url: "/dbs/{dbName}",
-  method: "delete",
-  ...variables,
-  signal
-});
-const getDatabaseMetadata = (variables, signal) => dataPlaneFetch({
-  url: "/dbs/{dbName}/metadata",
-  method: "get",
-  ...variables,
-  signal
-});
-const updateDatabaseMetadata = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/metadata", method: "patch", ...variables, signal });
+const dEPRECATEDcreateDatabase = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}", method: "put", ...variables, signal });
+const dEPRECATEDdeleteDatabase = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}", method: "delete", ...variables, signal });
+const dEPRECATEDgetDatabaseMetadata = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/metadata", method: "get", ...variables, signal });
+const dEPRECATEDupdateDatabaseMetadata = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/metadata", method: "patch", ...variables, signal });
 const getBranchDetails = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}",
   method: "get",
@@ -380,6 +386,7 @@ const resolveBranch = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName
 const getBranchMigrationHistory = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations", method: "get", ...variables, signal });
 const getBranchMigrationPlan = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/plan", method: "post", ...variables, signal });
 const executeBranchMigrationPlan = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/execute", method: "post", ...variables, signal });
+const branchTransaction = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/transaction", method: "post", ...variables, signal });
 const queryMigrationRequests = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/migrations/query", method: "post", ...variables, signal });
 const createMigrationRequest = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/migrations", method: "post", ...variables, signal });
 const getMigrationRequest = (variables, signal) => dataPlaneFetch({
@@ -479,7 +486,13 @@ const searchTable = (variables, signal) => dataPlaneFetch({
 const summarizeTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/summarize", method: "post", ...variables, signal });
 const aggregateTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/aggregate", method: "post", ...variables, signal });
 const operationsByTag$2 = {
-  database: { getDatabaseList, createDatabase, deleteDatabase, getDatabaseMetadata, updateDatabaseMetadata },
+  database: {
+    dEPRECATEDgetDatabaseList,
+    dEPRECATEDcreateDatabase,
+    dEPRECATEDdeleteDatabase,
+    dEPRECATEDgetDatabaseMetadata,
+    dEPRECATEDupdateDatabaseMetadata
+  },
   branch: {
     getBranchList,
     getBranchDetails,
@@ -504,6 +517,16 @@ const operationsByTag$2 = {
     previewBranchSchemaEdit,
     applyBranchSchemaEdit
   },
+  records: {
+    branchTransaction,
+    insertRecord,
+    getRecord,
+    insertRecordWithID,
+    updateRecordWithID,
+    upsertRecordWithID,
+    deleteRecord,
+    bulkInsertTableRecords
+  },
   migrationRequests: {
     queryMigrationRequests,
     createMigrationRequest,
@@ -526,15 +549,6 @@ const operationsByTag$2 = {
     updateColumn,
     deleteColumn
   },
-  records: {
-    insertRecord,
-    getRecord,
-    insertRecordWithID,
-    updateRecordWithID,
-    upsertRecordWithID,
-    deleteRecord,
-    bulkInsertTableRecords
-  },
   searchAndFilter: { queryTable, searchBranch, searchTable, summarizeTable, aggregateTable }
 };
 
@@ -619,16 +633,21 @@ const updateWorkspaceMemberInvite = (variables, signal) => controlPlaneFetch({ u
 const cancelWorkspaceMemberInvite = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/invites/{inviteId}", method: "delete", ...variables, signal });
 const acceptWorkspaceMemberInvite = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/invites/{inviteKey}/accept", method: "post", ...variables, signal });
 const resendWorkspaceMemberInvite = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/invites/{inviteId}/resend", method: "post", ...variables, signal });
-const cPGetDatabaseList = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs", method: "get", ...variables, signal });
-const cPCreateDatabase = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "put", ...variables, signal });
-const cPDeleteDatabase = (variables, signal) => controlPlaneFetch({
+const getDatabaseList = (variables, signal) => controlPlaneFetch({
+  url: "/workspaces/{workspaceId}/dbs",
+  method: "get",
+  ...variables,
+  signal
+});
+const createDatabase = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "put", ...variables, signal });
+const deleteDatabase = (variables, signal) => controlPlaneFetch({
   url: "/workspaces/{workspaceId}/dbs/{dbName}",
   method: "delete",
   ...variables,
   signal
 });
-const cPGetCPDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "get", ...variables, signal });
-const cPUpdateCPDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "patch", ...variables, signal });
+const getDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "get", ...variables, signal });
+const updateDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "patch", ...variables, signal });
 const listRegions = (variables, signal) => controlPlaneFetch({
   url: "/workspaces/{workspaceId}/regions",
   method: "get",
@@ -656,11 +675,11 @@ const operationsByTag$1 = {
     resendWorkspaceMemberInvite
   },
   databases: {
-    cPGetDatabaseList,
-    cPCreateDatabase,
-    cPDeleteDatabase,
-    cPGetCPDatabaseMetadata,
-    cPUpdateCPDatabaseMetadata,
+    getDatabaseList,
+    createDatabase,
+    deleteDatabase,
+    getDatabaseMetadata,
+    updateDatabaseMetadata,
     listRegions
   }
 };
@@ -1361,11 +1380,12 @@ class SearchAndFilterApi {
     filter,
     sort,
     page,
-    columns
+    columns,
+    consistency
   }) {
     return operationsByTag.searchAndFilter.queryTable({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}`, tableName: table },
-      body: { filter, sort, page, columns },
+      body: { filter, sort, page, columns, consistency },
       ...this.extraProps
     });
   }
@@ -1417,11 +1437,12 @@ class SearchAndFilterApi {
     summaries,
     sort,
     summariesFilter,
-    page
+    page,
+    consistency
   }) {
     return operationsByTag.searchAndFilter.summarizeTable({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}`, tableName: table },
-      body: { filter, columns, summaries, sort, summariesFilter, page },
+      body: { filter, columns, summaries, sort, summariesFilter, page, consistency },
       ...this.extraProps
     });
   }
@@ -1672,7 +1693,7 @@ class DatabaseApi {
     this.extraProps = extraProps;
   }
   getDatabaseList({ workspace }) {
-    return operationsByTag.databases.cPGetDatabaseList({
+    return operationsByTag.databases.getDatabaseList({
       pathParams: { workspaceId: workspace },
       ...this.extraProps
     });
@@ -1682,7 +1703,7 @@ class DatabaseApi {
     database,
     data
   }) {
-    return operationsByTag.databases.cPCreateDatabase({
+    return operationsByTag.databases.createDatabase({
       pathParams: { workspaceId: workspace, dbName: database },
       body: data,
       ...this.extraProps
@@ -1692,7 +1713,7 @@ class DatabaseApi {
     workspace,
     database
   }) {
-    return operationsByTag.databases.cPDeleteDatabase({
+    return operationsByTag.databases.deleteDatabase({
       pathParams: { workspaceId: workspace, dbName: database },
       ...this.extraProps
     });
@@ -1701,7 +1722,7 @@ class DatabaseApi {
     workspace,
     database
   }) {
-    return operationsByTag.databases.cPGetCPDatabaseMetadata({
+    return operationsByTag.databases.getDatabaseMetadata({
       pathParams: { workspaceId: workspace, dbName: database },
       ...this.extraProps
     });
@@ -1711,7 +1732,7 @@ class DatabaseApi {
     database,
     metadata
   }) {
-    return operationsByTag.databases.cPUpdateCPDatabaseMetadata({
+    return operationsByTag.databases.updateDatabaseMetadata({
       pathParams: { workspaceId: workspace, dbName: database },
       body: metadata,
       ...this.extraProps
@@ -1781,11 +1802,11 @@ class Page {
   async previousPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, before: this.meta.page.cursor } });
   }
-  async firstPage(size, offset) {
-    return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, first: this.meta.page.cursor } });
+  async startPage(size, offset) {
+    return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, start: this.meta.page.cursor } });
   }
-  async lastPage(size, offset) {
-    return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, last: this.meta.page.cursor } });
+  async endPage(size, offset) {
+    return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, end: this.meta.page.cursor } });
   }
   hasNextPage() {
     return this.meta.page.more;
@@ -1797,7 +1818,7 @@ const PAGINATION_DEFAULT_SIZE = 20;
 const PAGINATION_MAX_OFFSET = 800;
 const PAGINATION_DEFAULT_OFFSET = 0;
 function isCursorPaginationOptions(options) {
-  return isDefined(options) && (isDefined(options.first) || isDefined(options.last) || isDefined(options.after) || isDefined(options.before));
+  return isDefined(options) && (isDefined(options.start) || isDefined(options.end) || isDefined(options.after) || isDefined(options.before));
 }
 const _RecordArray = class extends Array {
   constructor(...args) {
@@ -1829,12 +1850,12 @@ const _RecordArray = class extends Array {
     const newPage = await __privateGet$6(this, _page).previousPage(size, offset);
     return new _RecordArray(newPage);
   }
-  async firstPage(size, offset) {
-    const newPage = await __privateGet$6(this, _page).firstPage(size, offset);
+  async startPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).startPage(size, offset);
     return new _RecordArray(newPage);
   }
-  async lastPage(size, offset) {
-    const newPage = await __privateGet$6(this, _page).lastPage(size, offset);
+  async endPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).endPage(size, offset);
     return new _RecordArray(newPage);
   }
   hasNextPage() {
@@ -1891,6 +1912,7 @@ const _Query = class {
     __privateGet$5(this, _data).columns = data.columns ?? parent?.columns;
     __privateGet$5(this, _data).pagination = data.pagination ?? parent?.pagination;
     __privateGet$5(this, _data).cache = data.cache ?? parent?.cache;
+    __privateGet$5(this, _data).fetchOptions = data.fetchOptions ?? parent?.fetchOptions;
     this.any = this.any.bind(this);
     this.all = this.all.bind(this);
     this.not = this.not.bind(this);
@@ -2018,15 +2040,15 @@ const _Query = class {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
   nextPage(size, offset) {
-    return this.firstPage(size, offset);
+    return this.startPage(size, offset);
   }
   previousPage(size, offset) {
-    return this.firstPage(size, offset);
+    return this.startPage(size, offset);
   }
-  firstPage(size, offset) {
+  startPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset } });
   }
-  lastPage(size, offset) {
+  endPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset, before: "end" } });
   }
   hasNextPage() {
@@ -2422,6 +2444,7 @@ class RestRepository extends Query {
           page: data.pagination,
           columns: data.columns ?? ["*"]
         },
+        fetchOptions: data.fetchOptions,
         ...fetchProps
       });
       const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
@@ -2693,7 +2716,7 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
   result.getMetadata = function() {
     return xata;
   };
-  for (const prop of ["read", "update", "delete", "getMetadata"]) {
+  for (const prop of ["read", "update", "replace", "delete", "getMetadata"]) {
     Object.defineProperty(result, prop, { enumerable: false });
   }
   Object.freeze(result);
@@ -3080,6 +3103,13 @@ const buildClient = (plugins) => {
       return { databaseURL, branch };
     }
   }, _branch = new WeakMap(), _options = new WeakMap(), _parseOptions = new WeakSet(), parseOptions_fn = function(options) {
+    const enableBrowser = options?.enableBrowser ?? getEnableBrowserVariable() ?? false;
+    const isBrowser = typeof window !== "undefined";
+    if (isBrowser && !enableBrowser) {
+      throw new Error(
+        "You are trying to use Xata from the browser, which is potentially a non-secure environment. If you understand the security concerns, such as leaking your credentials, pass `enableBrowser: true` to the client options to remove this error."
+      );
+    }
     const fetch = getFetchImplementation(options?.fetch);
     const databaseURL = options?.databaseURL || getDatabaseURL();
     const apiKey = options?.apiKey || getAPIKey();
@@ -3092,7 +3122,7 @@ const buildClient = (plugins) => {
     if (!databaseURL) {
       throw new Error("Option databaseURL is required");
     }
-    return { fetch, databaseURL, apiKey, branch, cache, trace, clientID: generateUUID() };
+    return { fetch, databaseURL, apiKey, branch, cache, trace, clientID: generateUUID(), enableBrowser };
   }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({ fetch, apiKey, databaseURL, branch, trace, clientID }) {
     const branchValue = await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, branch);
     if (!branchValue)
@@ -3219,5 +3249,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cPCreateDatabase, cPDeleteDatabase, cPGetCPDatabaseMetadata, cPGetDatabaseList, cPUpdateCPDatabaseMetadata, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
+export { BaseClient, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, dEPRECATEDcreateDatabase, dEPRECATEDdeleteDatabase, dEPRECATEDgetDatabaseList, dEPRECATEDgetDatabaseMetadata, dEPRECATEDupdateDatabaseMetadata, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
 //# sourceMappingURL=index.mjs.map