@xata.io/client 0.19.0 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @xata.io/client
 
+## 0.20.0
+
+### Minor Changes
+
+- [#737](https://github.com/xataio/client-ts/pull/737) [`6cbeaa0`](https://github.com/xataio/client-ts/commit/6cbeaa00050b5aa99ab7c98052a906487263e026) Thanks [@SferaDev](https://github.com/SferaDev)! - Rename first to start and last to end in pagination
+
+### Patch Changes
+
+- [#732](https://github.com/xataio/client-ts/pull/732) [`a5a9aa5`](https://github.com/xataio/client-ts/commit/a5a9aa59987faa1d3d701d7431b8a96031e01ac7) Thanks [@SferaDev](https://github.com/SferaDev)! - [Experimental] Allow passing fetch options in some queries
+
+- [#735](https://github.com/xataio/client-ts/pull/735) [`c64b2eb`](https://github.com/xataio/client-ts/commit/c64b2eb9add70e75d419d418ab9608caac0dbfa1) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for default values
+
+- [#730](https://github.com/xataio/client-ts/pull/730) [`485b217`](https://github.com/xataio/client-ts/commit/485b217079c4b2091d697e68622c48eddd130ceb) Thanks [@SferaDev](https://github.com/SferaDev)! - Add more summarize functions
+
+- [#730](https://github.com/xataio/client-ts/pull/730) [`4d7499c`](https://github.com/xataio/client-ts/commit/4d7499ccbb135691350334fd8022f7a5da41c5f2) Thanks [@SferaDev](https://github.com/SferaDev)! - Add a check for browser execution
+
+## 0.19.1
+
+### Patch Changes
+
+- [#723](https://github.com/xataio/client-ts/pull/723) [`ad5feeb`](https://github.com/xataio/client-ts/commit/ad5feebad5983f724ea4067b884bfae428447470) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix replace operation not hidden
+
 ## 0.19.0
 
 ### Minor Changes

package/README.md

@@ -187,8 +187,8 @@ page.hasNextPage(); // Boolean
 
 const nextPage = await page.nextPage(); // Page object
 const previousPage = await page.previousPage(); // Page object
-const firstPage = await page.firstPage(); // Page object
-const lastPage = await page.lastPage(); // Page object
+const startPage = await page.startPage(); // Page object
+const endPage = await page.endPage(); // Page object
 ```
 
 If you want to use an iterator, both the Repository and the Query classes implement an `AsyncIterable`. Alternatively you can use `getIterator()` and customize the batch size of the iterator:

package/Usage.md

@@ -329,8 +329,8 @@ It contains:
 - `hasNextPage`: Function that returns a boolean indicating if there is a next page.
 - `nextPage`: Async function that can be used to get the next page.
 - `previousPage`: Async function that can be used to get the previous page.
-- `firstPage`: Async function that can be used to get the first page.
-- `lastPage`: Async function that can be used to get the last page.
+- `startPage`: Async function that can be used to get the start page.
+- `endPage`: Async function that can be used to get the end page.
 - `meta`: Information about the current page and its cursor.
 
 ```ts
@@ -344,14 +344,14 @@ page2.records; // Array of `XataRecord` objects.
 const page1 = await page2.previousPage();
 page1.records; // Array of `XataRecord` objects.
 
-const firstPage = await page1.firstPage();
-firstPage.records; // Array of `XataRecord` objects.
+const startPage = await page1.startPage();
+startPage.records; // Array of `XataRecord` objects.
 ```
 
 The `Repository` class implements the `Query` interface, so you can use it to paginate the records in the table too.
 
 ```ts
-const page = await xata.db.users.firstPage();
+const page = await xata.db.users.startPage();
 page.records; // Array of `XataRecord` objects.
 ```
 

package/dist/index.cjs

@@ -116,6 +116,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;
@@ -186,7 +205,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.19.0";
+const VERSION = "0.20.0";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -276,7 +295,8 @@ async function fetch$1({
   trace,
   signal,
   clientID,
-  sessionID
+  sessionID,
+  fetchOptions = {}
 }) {
   return trace(
     `${method.toUpperCase()} ${path}`,
@@ -289,6 +309,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: {
@@ -338,32 +359,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",
@@ -402,6 +408,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({
@@ -501,7 +508,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,
@@ -526,6 +539,16 @@ const operationsByTag$2 = {
     previewBranchSchemaEdit,
     applyBranchSchemaEdit
   },
+  records: {
+    branchTransaction,
+    insertRecord,
+    getRecord,
+    insertRecordWithID,
+    updateRecordWithID,
+    upsertRecordWithID,
+    deleteRecord,
+    bulkInsertTableRecords
+  },
   migrationRequests: {
     queryMigrationRequests,
     createMigrationRequest,
@@ -548,15 +571,6 @@ const operationsByTag$2 = {
     updateColumn,
     deleteColumn
   },
-  records: {
-    insertRecord,
-    getRecord,
-    insertRecordWithID,
-    updateRecordWithID,
-    upsertRecordWithID,
-    deleteRecord,
-    bulkInsertTableRecords
-  },
   searchAndFilter: { queryTable, searchBranch, searchTable, summarizeTable, aggregateTable }
 };
 
@@ -641,16 +655,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",
@@ -678,11 +697,11 @@ const operationsByTag$1 = {
     resendWorkspaceMemberInvite
   },
   databases: {
-    cPGetDatabaseList,
-    cPCreateDatabase,
-    cPDeleteDatabase,
-    cPGetCPDatabaseMetadata,
-    cPUpdateCPDatabaseMetadata,
+    getDatabaseList,
+    createDatabase,
+    deleteDatabase,
+    getDatabaseMetadata,
+    updateDatabaseMetadata,
     listRegions
   }
 };
@@ -1383,11 +1402,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
     });
   }
@@ -1439,11 +1459,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
     });
   }
@@ -1694,7 +1715,7 @@ class DatabaseApi {
     this.extraProps = extraProps;
   }
   getDatabaseList({ workspace }) {
-    return operationsByTag.databases.cPGetDatabaseList({
+    return operationsByTag.databases.getDatabaseList({
       pathParams: { workspaceId: workspace },
       ...this.extraProps
     });
@@ -1704,7 +1725,7 @@ class DatabaseApi {
     database,
     data
   }) {
-    return operationsByTag.databases.cPCreateDatabase({
+    return operationsByTag.databases.createDatabase({
       pathParams: { workspaceId: workspace, dbName: database },
       body: data,
       ...this.extraProps
@@ -1714,7 +1735,7 @@ class DatabaseApi {
     workspace,
     database
   }) {
-    return operationsByTag.databases.cPDeleteDatabase({
+    return operationsByTag.databases.deleteDatabase({
       pathParams: { workspaceId: workspace, dbName: database },
       ...this.extraProps
     });
@@ -1723,7 +1744,7 @@ class DatabaseApi {
     workspace,
     database
   }) {
-    return operationsByTag.databases.cPGetCPDatabaseMetadata({
+    return operationsByTag.databases.getDatabaseMetadata({
       pathParams: { workspaceId: workspace, dbName: database },
       ...this.extraProps
     });
@@ -1733,7 +1754,7 @@ class DatabaseApi {
     database,
     metadata
   }) {
-    return operationsByTag.databases.cPUpdateCPDatabaseMetadata({
+    return operationsByTag.databases.updateDatabaseMetadata({
       pathParams: { workspaceId: workspace, dbName: database },
       body: metadata,
       ...this.extraProps
@@ -1803,11 +1824,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;
@@ -1819,7 +1840,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) {
@@ -1851,12 +1872,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() {
@@ -1913,6 +1934,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);
@@ -2040,15 +2062,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() {
@@ -2444,6 +2466,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);
@@ -2715,7 +2738,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);
@@ -3102,6 +3125,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();
@@ -3114,7 +3144,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)
@@ -3265,14 +3295,10 @@ exports.addGitBranchesEntry = addGitBranchesEntry;
 exports.addTableColumn = addTableColumn;
 exports.aggregateTable = aggregateTable;
 exports.applyBranchSchemaEdit = applyBranchSchemaEdit;
+exports.branchTransaction = branchTransaction;
 exports.buildClient = buildClient;
 exports.buildWorkerRunner = buildWorkerRunner;
 exports.bulkInsertTableRecords = bulkInsertTableRecords;
-exports.cPCreateDatabase = cPCreateDatabase;
-exports.cPDeleteDatabase = cPDeleteDatabase;
-exports.cPGetCPDatabaseMetadata = cPGetCPDatabaseMetadata;
-exports.cPGetDatabaseList = cPGetDatabaseList;
-exports.cPUpdateCPDatabaseMetadata = cPUpdateCPDatabaseMetadata;
 exports.cancelWorkspaceMemberInvite = cancelWorkspaceMemberInvite;
 exports.compareBranchSchemas = compareBranchSchemas;
 exports.compareBranchWithUserSchema = compareBranchWithUserSchema;
@@ -3284,6 +3310,11 @@ exports.createMigrationRequest = createMigrationRequest;
 exports.createTable = createTable;
 exports.createUserAPIKey = createUserAPIKey;
 exports.createWorkspace = createWorkspace;
+exports.dEPRECATEDcreateDatabase = dEPRECATEDcreateDatabase;
+exports.dEPRECATEDdeleteDatabase = dEPRECATEDdeleteDatabase;
+exports.dEPRECATEDgetDatabaseList = dEPRECATEDgetDatabaseList;
+exports.dEPRECATEDgetDatabaseMetadata = dEPRECATEDgetDatabaseMetadata;
+exports.dEPRECATEDupdateDatabaseMetadata = dEPRECATEDupdateDatabaseMetadata;
 exports.deleteBranch = deleteBranch;
 exports.deleteColumn = deleteColumn;
 exports.deleteDatabase = deleteDatabase;