@xata.io/client 0.29.1 → 0.29.2

package/.turbo/turbo-add-version.log

@@ -1,4 +1,4 @@
 
-> @xata.io/client@0.29.1 add-version /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.29.2 add-version /home/runner/work/client-ts/client-ts/packages/client
 > node ../../scripts/add-version-file.mjs
 

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @xata.io/client@0.29.1 build /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.29.2 build /home/runner/work/client-ts/client-ts/packages/client
 > rimraf dist && rollup -c
 
 
@@ -7,7 +7,7 @@
 created dist/index.cjs in 1.1s
 
 src/index.ts → dist/index.mjs...
-created dist/index.mjs in 807ms
+created dist/index.mjs in 698ms
 
 src/index.ts → dist/index.d.ts...
-created dist/index.d.ts in 5.2s
+created dist/index.d.ts in 5.1s

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xata.io/client
 
+## 0.29.2
+
+### Patch Changes
+
+- [#1380](https://github.com/xataio/client-ts/pull/1380) [`e8db1cd`](https://github.com/xataio/client-ts/commit/e8db1cd394ccbed32403548bf9d09a5c3973d850) Thanks [@richardgill](https://github.com/richardgill)! - Link to our docs to explain how to resolve the 'api key in browser' error message
+
 ## 0.29.1
 
 ### Patch Changes

package/dist/index.cjs

@@ -528,7 +528,7 @@ function defaultOnOpen(response) {
   }
 }
 
-const VERSION = "0.29.1";
+const VERSION = "0.29.2";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -847,26 +847,29 @@ function parseUrl(url) {
 
 const dataPlaneFetch = async (options) => fetch$1({ ...options, endpoint: "dataPlane" });
 
-const applyMigration = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/pgroll/apply", method: "post", ...variables, signal });
-const pgRollStatus = (variables, signal) => dataPlaneFetch({
-  url: "/db/{dbBranchName}/pgroll/status",
-  method: "get",
+const applyMigration = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/apply", method: "post", ...variables, signal });
+const adaptTable = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/migrations/adapt/{tableName}",
+  method: "post",
   ...variables,
   signal
 });
-const pgRollJobStatus = (variables, signal) => dataPlaneFetch({
-  url: "/db/{dbBranchName}/pgroll/jobs/{jobId}",
+const getBranchMigrationJobStatus = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/status", method: "get", ...variables, signal });
+const getMigrationJobStatus = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/jobs/{jobId}", method: "get", ...variables, signal });
+const getMigrationHistory = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/migrations/history", method: "get", ...variables, signal });
+const getBranchList = (variables, signal) => dataPlaneFetch({
+  url: "/dbs/{dbName}",
   method: "get",
   ...variables,
   signal
 });
-const pgRollMigrationHistory = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/pgroll/migrations", method: "get", ...variables, signal });
-const getBranchList = (variables, signal) => dataPlaneFetch({
-  url: "/dbs/{dbName}",
+const getDatabaseSettings = (variables, signal) => dataPlaneFetch({
+  url: "/dbs/{dbName}/settings",
   method: "get",
   ...variables,
   signal
 });
+const updateDatabaseSettings = (variables, signal) => dataPlaneFetch({ url: "/dbs/{dbName}/settings", method: "patch", ...variables, signal });
 const getBranchDetails = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}",
   method: "get",
@@ -1080,11 +1083,25 @@ const sqlQuery = (variables, signal) => dataPlaneFetch({
   signal
 });
 const operationsByTag$2 = {
-  branch: {
+  migrations: {
     applyMigration,
-    pgRollStatus,
-    pgRollJobStatus,
-    pgRollMigrationHistory,
+    adaptTable,
+    getBranchMigrationJobStatus,
+    getMigrationJobStatus,
+    getMigrationHistory,
+    getSchema,
+    getBranchMigrationHistory,
+    getBranchMigrationPlan,
+    executeBranchMigrationPlan,
+    getBranchSchemaHistory,
+    compareBranchWithUserSchema,
+    compareBranchSchemas,
+    updateBranchSchema,
+    previewBranchSchemaEdit,
+    applyBranchSchemaEdit,
+    pushBranchMigrations
+  },
+  branch: {
     getBranchList,
     getBranchDetails,
     createBranch,
@@ -1098,19 +1115,7 @@ const operationsByTag$2 = {
     removeGitBranchesEntry,
     resolveBranch
   },
-  migrations: {
-    getSchema,
-    getBranchMigrationHistory,
-    getBranchMigrationPlan,
-    executeBranchMigrationPlan,
-    getBranchSchemaHistory,
-    compareBranchWithUserSchema,
-    compareBranchSchemas,
-    updateBranchSchema,
-    previewBranchSchemaEdit,
-    applyBranchSchemaEdit,
-    pushBranchMigrations
-  },
+  database: { getDatabaseSettings, updateDatabaseSettings },
   migrationRequests: {
     queryMigrationRequests,
     createMigrationRequest,
@@ -1752,7 +1757,7 @@ class BranchApi {
     database,
     branch
   }) {
-    return operationsByTag.branch.pgRollMigrationHistory({
+    return operationsByTag.migrations.getMigrationHistory({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       ...this.extraProps
     });
@@ -1764,7 +1769,7 @@ class BranchApi {
     branch,
     migration
   }) {
-    return operationsByTag.branch.applyMigration({
+    return operationsByTag.migrations.applyMigration({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       body: migration,
       ...this.extraProps
@@ -4597,12 +4602,17 @@ class SQLPlugin extends XataPlugin {
         throw new Error("Invalid usage of `xata.sql`. Please use it as a tagged template or with an object.");
       }
       const { statement, params, consistency } = prepareParams(query, parameters);
-      const { records, warning, columns } = await sqlQuery({
+      const {
+        records,
+        rows,
+        warning,
+        columns = []
+      } = await sqlQuery({
         pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", region: "{region}" },
         body: { statement, params, consistency },
         ...pluginOptions
       });
-      return { records, warning, columns };
+      return { records, rows, warning, columns };
     };
   }
 }
@@ -4692,7 +4702,7 @@ const buildClient = (plugins) => {
     const isBrowser = typeof window !== "undefined" && typeof Deno === "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."
+        "You are trying to use Xata from the browser, which is potentially a non-secure environment. How to fix: https://xata.io/docs/messages/api-key-browser-error"
       );
     }
     const fetch = getFetchImplementation(options?.fetch);
@@ -4873,6 +4883,7 @@ exports.XataError = XataError;
 exports.XataFile = XataFile;
 exports.XataPlugin = XataPlugin;
 exports.acceptWorkspaceMemberInvite = acceptWorkspaceMemberInvite;
+exports.adaptTable = adaptTable;
 exports.addGitBranchesEntry = addGitBranchesEntry;
 exports.addTableColumn = addTableColumn;
 exports.aggregateTable = aggregateTable;
@@ -4926,6 +4937,7 @@ exports.getBranchDetails = getBranchDetails;
 exports.getBranchList = getBranchList;
 exports.getBranchMetadata = getBranchMetadata;
 exports.getBranchMigrationHistory = getBranchMigrationHistory;
+exports.getBranchMigrationJobStatus = getBranchMigrationJobStatus;
 exports.getBranchMigrationPlan = getBranchMigrationPlan;
 exports.getBranchSchemaHistory = getBranchSchemaHistory;
 exports.getBranchStats = getBranchStats;
@@ -4934,11 +4946,14 @@ exports.getColumn = getColumn;
 exports.getDatabaseGithubSettings = getDatabaseGithubSettings;
 exports.getDatabaseList = getDatabaseList;
 exports.getDatabaseMetadata = getDatabaseMetadata;
+exports.getDatabaseSettings = getDatabaseSettings;
 exports.getDatabaseURL = getDatabaseURL;
 exports.getFile = getFile;
 exports.getFileItem = getFileItem;
 exports.getGitBranchesMapping = getGitBranchesMapping;
 exports.getHostUrl = getHostUrl;
+exports.getMigrationHistory = getMigrationHistory;
+exports.getMigrationJobStatus = getMigrationJobStatus;
 exports.getMigrationRequest = getMigrationRequest;
 exports.getMigrationRequestIsMerged = getMigrationRequestIsMerged;
 exports.getPreviewBranch = getPreviewBranch;
@@ -4992,9 +5007,6 @@ exports.operationsByTag = operationsByTag;
 exports.parseProviderString = parseProviderString;
 exports.parseWorkspacesUrlParts = parseWorkspacesUrlParts;
 exports.pattern = pattern;
-exports.pgRollJobStatus = pgRollJobStatus;
-exports.pgRollMigrationHistory = pgRollMigrationHistory;
-exports.pgRollStatus = pgRollStatus;
 exports.previewBranchSchemaEdit = previewBranchSchemaEdit;
 exports.pushBranchMigrations = pushBranchMigrations;
 exports.putFile = putFile;
@@ -5020,6 +5032,7 @@ exports.updateCluster = updateCluster;
 exports.updateColumn = updateColumn;
 exports.updateDatabaseGithubSettings = updateDatabaseGithubSettings;
 exports.updateDatabaseMetadata = updateDatabaseMetadata;
+exports.updateDatabaseSettings = updateDatabaseSettings;
 exports.updateMigrationRequest = updateMigrationRequest;
 exports.updateOAuthAccessToken = updateOAuthAccessToken;
 exports.updateRecordWithID = updateRecordWithID;