@xata.io/client 0.21.6 → 0.22.1

package/dist/index.mjs

@@ -299,7 +299,7 @@ function generateUUID() {
   });
 }
 
-const VERSION = "0.21.6";
+const VERSION = "0.22.1";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -393,12 +393,13 @@ async function fetch$1({
   clientID,
   sessionID,
   clientName,
+  xataAgentExtra,
   fetchOptions = {}
 }) {
   pool.setFetch(fetchImpl);
   return await trace(
     `${method.toUpperCase()} ${path}`,
-    async ({ name, setAttributes }) => {
+    async ({ setAttributes }) => {
       const baseUrl = buildBaseUrl({ endpoint, path, workspacesApiUrl, pathParams, apiUrl });
       const fullUrl = resolveUrl(baseUrl, queryParams, pathParams);
       const url = fullUrl.includes("localhost") ? fullUrl.replace(/^[^.]+\./, "http://") : fullUrl;
@@ -409,7 +410,8 @@ async function fetch$1({
       const xataAgent = compact([
         ["client", "TS_SDK"],
         ["version", VERSION],
-        isDefined(clientName) ? ["service", clientName] : void 0
+        isDefined(clientName) ? ["service", clientName] : void 0,
+        ...Object.entries(xataAgentExtra ?? {})
       ]).map(([key, value]) => `${key}=${value}`).join("; ");
       const headers = {
         "Accept-Encoding": "identity",
@@ -511,7 +513,6 @@ 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({
@@ -578,6 +579,7 @@ const deleteColumn = (variables, signal) => dataPlaneFetch({
   ...variables,
   signal
 });
+const branchTransaction = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/transaction", method: "post", ...variables, signal });
 const insertRecord = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/data", method: "post", ...variables, signal });
 const getRecord = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}",
@@ -635,16 +637,6 @@ const operationsByTag$2 = {
     previewBranchSchemaEdit,
     applyBranchSchemaEdit
   },
-  records: {
-    branchTransaction,
-    insertRecord,
-    getRecord,
-    insertRecordWithID,
-    updateRecordWithID,
-    upsertRecordWithID,
-    deleteRecord,
-    bulkInsertTableRecords
-  },
   migrationRequests: {
     queryMigrationRequests,
     createMigrationRequest,
@@ -667,6 +659,16 @@ const operationsByTag$2 = {
     updateColumn,
     deleteColumn
   },
+  records: {
+    branchTransaction,
+    insertRecord,
+    getRecord,
+    insertRecordWithID,
+    updateRecordWithID,
+    upsertRecordWithID,
+    deleteRecord,
+    bulkInsertTableRecords
+  },
   searchAndFilter: { queryTable, searchBranch, searchTable, summarizeTable, aggregateTable }
 };
 
@@ -766,6 +768,9 @@ const deleteDatabase = (variables, signal) => controlPlaneFetch({
 });
 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 getDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "get", ...variables, signal });
+const updateDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "put", ...variables, signal });
+const deleteDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "delete", ...variables, signal });
 const listRegions = (variables, signal) => controlPlaneFetch({
   url: "/workspaces/{workspaceId}/regions",
   method: "get",
@@ -798,6 +803,9 @@ const operationsByTag$1 = {
     deleteDatabase,
     getDatabaseMetadata,
     updateDatabaseMetadata,
+    getDatabaseGithubSettings,
+    updateDatabaseGithubSettings,
+    deleteDatabaseGithubSettings,
     listRegions
   }
 };
@@ -842,7 +850,8 @@ function parseWorkspacesUrlParts(url) {
     return null;
   const regex = /(?:https:\/\/)?([^.]+)(?:\.([^.]+))\.xata\.sh.*/;
   const regexStaging = /(?:https:\/\/)?([^.]+)\.staging(?:\.([^.]+))\.xatabase\.co.*/;
-  const match = url.match(regex) || url.match(regexStaging);
+  const regexDev = /(?:https:\/\/)?([^.]+)\.staging(?:\.([^.]+))\.xata\.tech.*/;
+  const match = url.match(regex) || url.match(regexStaging) || url.match(regexDev);
   if (!match)
     return null;
   return { workspace: match[1], region: match[2] };
@@ -885,6 +894,7 @@ class XataApiClient {
       apiKey,
       trace,
       clientName: options.clientName,
+      xataAgentExtra: options.xataAgentExtra,
       clientID
     });
   }
@@ -1760,11 +1770,13 @@ class MigrationsApi {
     region,
     database,
     branch,
-    schema
+    schema,
+    schemaOperations,
+    branchOperations
   }) {
     return operationsByTag.migrations.compareBranchWithUserSchema({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
-      body: { schema },
+      body: { schema, schemaOperations, branchOperations },
       ...this.extraProps
     });
   }
@@ -1774,11 +1786,12 @@ class MigrationsApi {
     database,
     branch,
     compare,
-    schema
+    sourceBranchOperations,
+    targetBranchOperations
   }) {
     return operationsByTag.migrations.compareBranchSchemas({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}`, branchName: compare },
-      body: { schema },
+      body: { sourceBranchOperations, targetBranchOperations },
       ...this.extraProps
     });
   }
@@ -1872,6 +1885,35 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
+  getDatabaseGithubSettings({
+    workspace,
+    database
+  }) {
+    return operationsByTag.databases.getDatabaseGithubSettings({
+      pathParams: { workspaceId: workspace, dbName: database },
+      ...this.extraProps
+    });
+  }
+  updateDatabaseGithubSettings({
+    workspace,
+    database,
+    settings
+  }) {
+    return operationsByTag.databases.updateDatabaseGithubSettings({
+      pathParams: { workspaceId: workspace, dbName: database },
+      body: settings,
+      ...this.extraProps
+    });
+  }
+  deleteDatabaseGithubSettings({
+    workspace,
+    database
+  }) {
+    return operationsByTag.databases.deleteDatabaseGithubSettings({
+      pathParams: { workspaceId: workspace, dbName: database },
+      ...this.extraProps
+    });
+  }
   listRegions({ workspace }) {
     return operationsByTag.databases.listRegions({
       pathParams: { workspaceId: workspace },
@@ -1966,6 +2008,12 @@ const _RecordArray = class extends Array {
   toArray() {
     return new Array(...this);
   }
+  toSerializable() {
+    return JSON.parse(this.toString());
+  }
+  toString() {
+    return JSON.stringify(this.toArray());
+  }
   map(callbackfn, thisArg) {
     return this.toArray().map(callbackfn, thisArg);
   }
@@ -2933,7 +2981,13 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
   record.getMetadata = function() {
     return xata;
   };
-  for (const prop of ["read", "update", "replace", "delete", "getMetadata"]) {
+  record.toSerializable = function() {
+    return JSON.parse(JSON.stringify(transformObjectLinks(data)));
+  };
+  record.toString = function() {
+    return JSON.stringify(transformObjectLinks(data));
+  };
+  for (const prop of ["read", "update", "replace", "delete", "getMetadata", "toSerializable", "toString"]) {
     Object.defineProperty(record, prop, { enumerable: false });
   }
   Object.freeze(record);
@@ -3225,7 +3279,8 @@ async function resolveXataBranch(gitBranch, options) {
     pathParams: { dbName, workspace, region },
     queryParams: { gitBranch, fallbackBranch },
     trace: defaultTrace,
-    clientName: options?.clientName
+    clientName: options?.clientName,
+    xataAgentExtra: options?.xataAgentExtra
   });
   return branch;
 }
@@ -3345,11 +3400,13 @@ const buildClient = (plugins) => {
     const cache = options?.cache ?? new SimpleCache({ defaultQueryTTL: 0 });
     const trace = options?.trace ?? defaultTrace;
     const clientName = options?.clientName;
+    const xataAgentExtra = options?.xataAgentExtra;
     const branch = async () => options?.branch !== void 0 ? await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, options.branch) : await getCurrentBranchName({
       apiKey,
       databaseURL,
       fetchImpl: options?.fetch,
-      clientName: options?.clientName
+      clientName,
+      xataAgentExtra
     });
     if (!apiKey) {
       throw new Error("Option apiKey is required");
@@ -3357,7 +3414,18 @@ const buildClient = (plugins) => {
     if (!databaseURL) {
       throw new Error("Option databaseURL is required");
     }
-    return { fetch, databaseURL, apiKey, branch, cache, trace, clientID: generateUUID(), enableBrowser, clientName };
+    return {
+      fetch,
+      databaseURL,
+      apiKey,
+      branch,
+      cache,
+      trace,
+      clientID: generateUUID(),
+      enableBrowser,
+      clientName,
+      xataAgentExtra
+    };
   }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({
     fetch,
     apiKey,
@@ -3365,7 +3433,8 @@ const buildClient = (plugins) => {
     branch,
     trace,
     clientID,
-    clientName
+    clientName,
+    xataAgentExtra
   }) {
     const branchValue = await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, branch);
     if (!branchValue)
@@ -3381,7 +3450,8 @@ const buildClient = (plugins) => {
       },
       trace,
       clientID,
-      clientName
+      clientName,
+      xataAgentExtra
     };
   }, _evaluateBranch = new WeakSet(), evaluateBranch_fn = async function(param) {
     if (__privateGet(this, _branch))
@@ -3493,5 +3563,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, FetcherError, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
+export { BaseClient, FetcherError, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
 //# sourceMappingURL=index.mjs.map