@xata.io/client 0.29.1 → 0.29.3

package/dist/index.mjs

@@ -526,7 +526,7 @@ function defaultOnOpen(response) {
   }
 }
 
-const VERSION = "0.29.1";
+const VERSION = "0.29.3";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -619,15 +619,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();
@@ -845,26 +845,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",
@@ -1078,11 +1081,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,
@@ -1096,19 +1113,7 @@ const operationsByTag$2 = {
     removeGitBranchesEntry,
     resolveBranch
   },
-  migrations: {
-    getSchema,
-    getBranchMigrationHistory,
-    getBranchMigrationPlan,
-    executeBranchMigrationPlan,
-    getBranchSchemaHistory,
-    compareBranchWithUserSchema,
-    compareBranchSchemas,
-    updateBranchSchema,
-    previewBranchSchemaEdit,
-    applyBranchSchemaEdit,
-    pushBranchMigrations
-  },
+  database: { getDatabaseSettings, updateDatabaseSettings },
   migrationRequests: {
     queryMigrationRequests,
     createMigrationRequest,
@@ -1250,6 +1255,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({
@@ -1315,6 +1322,8 @@ const operationsByTag$1 = {
     getWorkspace,
     updateWorkspace,
     deleteWorkspace,
+    getWorkspaceSettings,
+    updateWorkspaceSettings,
     getWorkspaceMembersList,
     updateWorkspaceMemberRole,
     removeWorkspaceMember
@@ -1750,7 +1759,7 @@ class BranchApi {
     database,
     branch
   }) {
-    return operationsByTag.branch.pgRollMigrationHistory({
+    return operationsByTag.migrations.getMigrationHistory({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       ...this.extraProps
     });
@@ -1762,7 +1771,7 @@ class BranchApi {
     branch,
     migration
   }) {
-    return operationsByTag.branch.applyMigration({
+    return operationsByTag.migrations.applyMigration({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
       body: migration,
       ...this.extraProps
@@ -4582,26 +4591,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) {
@@ -4610,6 +4626,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) {
@@ -4661,7 +4704,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);
@@ -4690,7 +4734,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);
@@ -4844,5 +4888,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, FetcherError, FilesPlugin, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, PageRecordArray, Query, RecordArray, RecordColumnTypes, Repository, RestRepository, SQLPlugin, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, TransactionPlugin, XataApiClient, XataApiPlugin, XataError, XataFile, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, pgRollJobStatus, pgRollMigrationHistory, pgRollStatus, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
+export { BaseClient, FetcherError, FilesPlugin, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, PageRecordArray, Query, RecordArray, RecordColumnTypes, Repository, RestRepository, SQLPlugin, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, TransactionPlugin, XataApiClient, XataApiPlugin, XataError, XataFile, XataPlugin, acceptWorkspaceMemberInvite, adaptTable, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, fileUpload, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationJobStatus, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseSettings, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationHistory, getMigrationJobStatus, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspaceSettings, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateDatabaseSettings, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, updateWorkspaceSettings, upsertRecordWithID, vectorSearchTable };
 //# sourceMappingURL=index.mjs.map