@xata.io/client 0.29.1 → 0.29.3

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.3 add-version /home/runner/work/client-ts/client-ts/packages/client
 > node ../../scripts/add-version-file.mjs
 

package/.turbo/turbo-build.log

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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @xata.io/client
 
+## 0.29.3
+
+### Patch Changes
+
+- [#1399](https://github.com/xataio/client-ts/pull/1399) [`02053fb`](https://github.com/xataio/client-ts/commit/02053fbb10479b8e9453691f957d3235762555aa) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose `xata.sql.connectionString` helper
+
+- [#1398](https://github.com/xataio/client-ts/pull/1398) [`e27cb74`](https://github.com/xataio/client-ts/commit/e27cb74143aa9b6c654713878e5d3776858e5290) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for array response type
+
+## 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.3";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -621,15 +621,15 @@ function parseWorkspacesUrlParts(url) {
   if (!isString(url))
     return null;
   const matches = {
-    production: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.xata\.sh.*/),
-    staging: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.staging-xata\.dev.*/),
-    dev: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.dev-xata\.dev.*/),
-    local: url.match(/(?:https?:\/\/)?([^.]+)(?:\.([^.]+))\.localhost:(\d+)/)
+    production: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.xata\.sh\/db\/([^:]+):?(.*)?/),
+    staging: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.staging-xata\.dev\/db\/([^:]+):?(.*)?/),
+    dev: url.match(/(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.dev-xata\.dev\/db\/([^:]+):?(.*)?/),
+    local: url.match(/(?:https?:\/\/)?([^.]+)(?:\.([^.]+))\.localhost:([^:]+):?(.*)?/)
   };
   const [host, match] = Object.entries(matches).find(([, match2]) => match2 !== null) ?? [];
   if (!isHostProviderAlias(host) || !match)
     return null;
-  return { workspace: match[1], region: match[2], host };
+  return { workspace: match[1], region: match[2], database: match[3], branch: match[4], host };
 }
 
 const pool = new ApiRequestPool();
@@ -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,
@@ -1252,6 +1257,8 @@ const deleteWorkspace = (variables, signal) => controlPlaneFetch({
   ...variables,
   signal
 });
+const getWorkspaceSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/settings", method: "get", ...variables, signal });
+const updateWorkspaceSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/settings", method: "patch", ...variables, signal });
 const getWorkspaceMembersList = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/members", method: "get", ...variables, signal });
 const updateWorkspaceMemberRole = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/members/{userId}", method: "put", ...variables, signal });
 const removeWorkspaceMember = (variables, signal) => controlPlaneFetch({
@@ -1317,6 +1324,8 @@ const operationsByTag$1 = {
     getWorkspace,
     updateWorkspace,
     deleteWorkspace,
+    getWorkspaceSettings,
+    updateWorkspaceSettings,
     getWorkspaceMembersList,
     updateWorkspaceMemberRole,
     removeWorkspaceMember
@@ -1752,7 +1761,7 @@ class BranchApi {
     database,
     branch
   }) {
-    return operationsByTag.branch.pgRollMigrationHistory({
+    return operationsByTag.migrations.getMigrationHistory({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       ...this.extraProps
     });
@@ -1764,7 +1773,7 @@ class BranchApi {
     branch,
     migration
   }) {
-    return operationsByTag.branch.applyMigration({
+    return operationsByTag.migrations.applyMigration({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       body: migration,
       ...this.extraProps
@@ -4584,26 +4593,33 @@ function prepareParams(param1, param2) {
     return { statement, params: param2?.map((value) => prepareValue(value)) };
   }
   if (isObject(param1)) {
-    const { statement, params, consistency } = param1;
-    return { statement, params: params?.map((value) => prepareValue(value)), consistency };
+    const { statement, params, consistency, responseType } = param1;
+    return { statement, params: params?.map((value) => prepareValue(value)), consistency, responseType };
   }
   throw new Error("Invalid query");
 }
 
 class SQLPlugin extends XataPlugin {
   build(pluginOptions) {
-    return async (query, ...parameters) => {
+    const sqlFunction = async (query, ...parameters) => {
       if (!isParamsObject(query) && (!isTemplateStringsArray(query) || !Array.isArray(parameters))) {
         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 { statement, params, consistency, responseType } = prepareParams(query, parameters);
+      const {
+        records,
+        rows,
+        warning,
+        columns = []
+      } = await sqlQuery({
         pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", region: "{region}" },
-        body: { statement, params, consistency },
+        body: { statement, params, consistency, responseType },
         ...pluginOptions
       });
-      return { records, warning, columns };
+      return { records, rows, warning, columns };
     };
+    sqlFunction.connectionString = buildConnectionString(pluginOptions);
+    return sqlFunction;
   }
 }
 function isTemplateStringsArray(strings) {
@@ -4612,6 +4628,33 @@ function isTemplateStringsArray(strings) {
 function isParamsObject(params) {
   return isObject(params) && "statement" in params;
 }
+function buildDomain(host, region) {
+  switch (host) {
+    case "production":
+      return `${region}.sql.xata.sh`;
+    case "staging":
+      return `${region}.sql.staging-xata.dev`;
+    case "dev":
+      return `${region}.sql.dev-xata.dev`;
+    case "local":
+      return "localhost:7654";
+    default:
+      throw new Error("Invalid host provider");
+  }
+}
+function buildConnectionString({ apiKey, workspacesApiUrl, branch }) {
+  const url = isString(workspacesApiUrl) ? workspacesApiUrl : workspacesApiUrl("", {});
+  const parts = parseWorkspacesUrlParts(url);
+  if (!parts)
+    throw new Error("Invalid workspaces URL");
+  const { workspace: workspaceSlug, region, database, host } = parts;
+  const domain = buildDomain(host, region);
+  const workspace = workspaceSlug.split("-").pop();
+  if (!workspace || !region || !database || !apiKey || !branch) {
+    throw new Error("Unable to build xata connection string");
+  }
+  return `postgresql://${workspace}:${apiKey}@${domain}/${database}:${branch}?sslmode=require`;
+}
 
 class TransactionPlugin extends XataPlugin {
   build(pluginOptions) {
@@ -4663,7 +4706,8 @@ const buildClient = (plugins) => {
         ...__privateMethod(this, _getFetchProps, getFetchProps_fn).call(this, safeOptions),
         cache: safeOptions.cache,
         host: safeOptions.host,
-        tables
+        tables,
+        branch: safeOptions.branch
       };
       const db = new SchemaPlugin().build(pluginOptions);
       const search = new SearchPlugin(db).build(pluginOptions);
@@ -4692,7 +4736,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 +4917,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 +4971,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 +4980,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;
@@ -4952,6 +5001,7 @@ exports.getUserOAuthAccessTokens = getUserOAuthAccessTokens;
 exports.getUserOAuthClients = getUserOAuthClients;
 exports.getWorkspace = getWorkspace;
 exports.getWorkspaceMembersList = getWorkspaceMembersList;
+exports.getWorkspaceSettings = getWorkspaceSettings;
 exports.getWorkspacesList = getWorkspacesList;
 exports.grantAuthorizationCode = grantAuthorizationCode;
 exports.greaterEquals = greaterEquals;
@@ -4992,9 +5042,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 +5067,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;
@@ -5028,6 +5076,7 @@ exports.updateUser = updateUser;
 exports.updateWorkspace = updateWorkspace;
 exports.updateWorkspaceMemberInvite = updateWorkspaceMemberInvite;
 exports.updateWorkspaceMemberRole = updateWorkspaceMemberRole;
+exports.updateWorkspaceSettings = updateWorkspaceSettings;
 exports.upsertRecordWithID = upsertRecordWithID;
 exports.vectorSearchTable = vectorSearchTable;
 //# sourceMappingURL=index.cjs.map