@xata.io/client 0.0.0-next.vdcc7247ab6c54a023e791b576c247bc20533009e → 0.0.0-next.vdf3a7b8c70c130a3e9c73decc8494a3f8c8febcb

package/.turbo/turbo-build.log

@@ -4,10 +4,10 @@
 
 
 src/index.ts → dist/index.cjs...
-created dist/index.cjs in 891ms
+created dist/index.cjs in 977ms
 
 src/index.ts → dist/index.mjs...
-created dist/index.mjs in 671ms
+created dist/index.mjs in 626ms
 
 src/index.ts → dist/index.d.ts...
-created dist/index.d.ts in 4.2s
+created dist/index.d.ts in 4.4s

package/CHANGELOG.md

@@ -1,12 +1,16 @@
 # @xata.io/client
 
-## 0.0.0-next.vdcc7247ab6c54a023e791b576c247bc20533009e
+## 0.0.0-next.vdf3a7b8c70c130a3e9c73decc8494a3f8c8febcb
 
 ### Major Changes
 
-- [`03882fe`](https://github.com/xataio/client-ts/commit/03882fed962b51028571bc65c82a4ecb9ed40ae6) Thanks [@SferaDev](https://github.com/SferaDev)! - Make XataApiClient to use ES Proxies
+- [`eb10b5a`](https://github.com/xataio/client-ts/commit/eb10b5a5ca2167991be014273648706e223e7ec3) Thanks [@SferaDev](https://github.com/SferaDev)! - Make XataApiClient to use ES Proxies
 
-- [`b173601`](https://github.com/xataio/client-ts/commit/b1736015ba325ed13c7444699e454228c987a391) Thanks [@SferaDev](https://github.com/SferaDev)! - Version 1.0
+- [`9d9b6fd`](https://github.com/xataio/client-ts/commit/9d9b6fd483e00f625b7f5d34bb8616b2a11e0cf1) Thanks [@SferaDev](https://github.com/SferaDev)! - Version 1.0
+
+### 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
 
 ## 0.29.2
 

package/dist/index.cjs

@@ -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();
@@ -1259,6 +1259,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({
@@ -1324,6 +1326,8 @@ const operationsByTag$1 = {
     getWorkspace,
     updateWorkspace,
     deleteWorkspace,
+    getWorkspaceSettings,
+    updateWorkspaceSettings,
     getWorkspaceMembersList,
     updateWorkspaceMemberRole,
     removeWorkspaceMember
@@ -3203,7 +3207,7 @@ function prepareParams(param1, param2) {
 
 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.");
       }
@@ -3220,6 +3224,8 @@ class SQLPlugin extends XataPlugin {
       });
       return { records, rows, warning, columns };
     };
+    sqlFunction.connectionString = buildConnectionString(pluginOptions);
+    return sqlFunction;
   }
 }
 function isTemplateStringsArray(strings) {
@@ -3228,6 +3234,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) {
@@ -3278,7 +3311,8 @@ const buildClient = (plugins) => {
       const pluginOptions = {
         ...__privateMethod(this, _getFetchProps, getFetchProps_fn).call(this, safeOptions),
         host: safeOptions.host,
-        tables
+        tables,
+        branch: safeOptions.branch
       };
       const db = new SchemaPlugin().build(pluginOptions);
       const search = new SearchPlugin(db).build(pluginOptions);
@@ -3569,6 +3603,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;
@@ -3642,6 +3677,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