@xata.io/client 0.23.5 → 0.24.1

package/dist/index.mjs

@@ -264,7 +264,7 @@ class ApiRequestPool {
     return __privateGet$8(this, _fetch);
   }
   request(url, options) {
-    const start = new Date();
+    const start = /* @__PURE__ */ new Date();
     const fetch2 = this.getFetch();
     const runRequest = async (stalled = false) => {
       const response = await fetch2(url, options);
@@ -274,7 +274,7 @@ class ApiRequestPool {
         return await runRequest(true);
       }
       if (stalled) {
-        const stalledTime = new Date().getTime() - start.getTime();
+        const stalledTime = (/* @__PURE__ */ new Date()).getTime() - start.getTime();
         console.warn(`A request to Xata hit your workspace limits, was retried and stalled for ${stalledTime}ms`);
       }
       return response;
@@ -490,7 +490,7 @@ function defaultOnOpen(response) {
   }
 }
 
-const VERSION = "0.23.5";
+const VERSION = "0.24.1";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -862,6 +862,12 @@ const putFile = (variables, signal) => dataPlaneFetch({
   ...variables,
   signal
 });
+const deleteFile = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file",
+  method: "delete",
+  ...variables,
+  signal
+});
 const getRecord = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}",
   method: "get",
@@ -906,6 +912,12 @@ const askTable = (variables, signal) => dataPlaneFetch({
 });
 const summarizeTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/summarize", method: "post", ...variables, signal });
 const aggregateTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/aggregate", method: "post", ...variables, signal });
+const fileAccess = (variables, signal) => dataPlaneFetch({
+  url: "/file/{fileId}",
+  method: "get",
+  ...variables,
+  signal
+});
 const operationsByTag$2 = {
   branch: {
     getBranchList,
@@ -965,7 +977,7 @@ const operationsByTag$2 = {
     deleteRecord,
     bulkInsertTableRecords
   },
-  files: { getFileItem, putFileItem, deleteFileItem, getFile, putFile },
+  files: { getFileItem, putFileItem, deleteFileItem, getFile, putFile, deleteFile, fileAccess },
   searchAndFilter: {
     queryTable,
     searchBranch,
@@ -1896,6 +1908,7 @@ class FilesApi {
         columnName: column,
         fileId
       },
+      // @ts-ignore
       body: file,
       ...this.extraProps
     });
@@ -1967,6 +1980,43 @@ class FilesApi {
       ...this.extraProps
     });
   }
+  deleteFile({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column
+  }) {
+    return operationsByTag.files.deleteFile({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column
+      },
+      ...this.extraProps
+    });
+  }
+  fileAccess({
+    workspace,
+    region,
+    fileId,
+    verify
+  }) {
+    return operationsByTag.files.fileAccess({
+      pathParams: {
+        workspace,
+        region,
+        fileId
+      },
+      queryParams: { verify },
+      ...this.extraProps
+    });
+  }
 }
 class SearchAndFilterApi {
   constructor(extraProps) {
@@ -2477,18 +2527,46 @@ class Page {
     this.meta = meta;
     this.records = new RecordArray(this, records);
   }
+  /**
+   * Retrieves the next page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The next page or results.
+   */
   async nextPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, after: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the previous page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The previous page or results.
+   */
   async previousPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, before: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the start page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The start page or results.
+   */
   async startPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, start: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the end page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The end page or results.
+   */
   async endPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, end: this.meta.page.cursor } });
   }
+  /**
+   * Shortcut method to check if there will be additional results if the next page of results is retrieved.
+   * @returns Whether or not there will be additional results in the next page of results.
+   */
   hasNextPage() {
     return this.meta.page.more;
   }
@@ -2529,22 +2607,45 @@ const _RecordArray = class extends Array {
   map(callbackfn, thisArg) {
     return this.toArray().map(callbackfn, thisArg);
   }
+  /**
+   * Retrieve next page of records
+   *
+   * @returns A new array of objects
+   */
   async nextPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).nextPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve previous page of records
+   *
+   * @returns A new array of objects
+   */
   async previousPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).previousPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve start page of records
+   *
+   * @returns A new array of objects
+   */
   async startPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).startPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve end page of records
+   *
+   * @returns A new array of objects
+   */
   async endPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).endPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * @returns Boolean indicating if there is a next page
+   */
   hasNextPage() {
     return __privateGet$6(this, _page).meta.page.more;
   }
@@ -2581,6 +2682,7 @@ const _Query = class {
     __privateAdd$5(this, _table$1, void 0);
     __privateAdd$5(this, _repository, void 0);
     __privateAdd$5(this, _data, { filter: {} });
+    // Implements pagination
     this.meta = { page: { cursor: "start", more: true, size: PAGINATION_DEFAULT_SIZE } };
     this.records = new RecordArray(this, []);
     __privateSet$5(this, _table$1, table);
@@ -2618,18 +2720,38 @@ const _Query = class {
     const key = JSON.stringify({ columns, filter, sort, pagination });
     return toBase64(key);
   }
+  /**
+   * Builds a new query object representing a logical OR between the given subqueries.
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   any(...queries) {
     const $any = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $any } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical AND between the given subqueries.
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   all(...queries) {
     const $all = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   not(...queries) {
     const $not = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $not } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   none(...queries) {
     const $none = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $none } }, __privateGet$5(this, _data));
@@ -2652,6 +2774,11 @@ const _Query = class {
     const sort = [...originalSort, { column, direction }];
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { sort }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query specifying the set of columns to be returned in the query response.
+   * @param columns Array of column names to be returned by the query.
+   * @returns A new Query object.
+   */
   select(columns) {
     return new _Query(
       __privateGet$5(this, _repository),
@@ -2664,6 +2791,12 @@ const _Query = class {
     const query = new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), options, __privateGet$5(this, _data));
     return __privateGet$5(this, _repository).query(query);
   }
+  /**
+   * Get results in an iterator
+   *
+   * @async
+   * @returns Async interable of results
+   */
   async *[Symbol.asyncIterator]() {
     for await (const [record] of this.getIterator({ batchSize: 1 })) {
       yield record;
@@ -2724,21 +2857,49 @@ const _Query = class {
     );
     return __privateGet$5(this, _repository).summarizeTable(query, summaries, summariesFilter);
   }
+  /**
+   * Builds a new query object adding a cache TTL in milliseconds.
+   * @param ttl The cache TTL in milliseconds.
+   * @returns A new Query object.
+   */
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
+  /**
+   * Retrieve next page of records
+   *
+   * @returns A new page object.
+   */
   nextPage(size, offset) {
     return this.startPage(size, offset);
   }
+  /**
+   * Retrieve previous page of records
+   *
+   * @returns A new page object
+   */
   previousPage(size, offset) {
     return this.startPage(size, offset);
   }
+  /**
+   * Retrieve start page of records
+   *
+   * @returns A new page object
+   */
   startPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset } });
   }
+  /**
+   * Retrieve last page of records
+   *
+   * @returns A new page object
+   */
   endPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset, before: "end" } });
   }
+  /**
+   * @returns Boolean indicating if there is a next page
+   */
   hasNextPage() {
     return this.meta.page.more;
   }
@@ -3428,7 +3589,7 @@ deleteRecords_fn = async function(recordIds) {
 };
 _setCacheQuery = new WeakSet();
 setCacheQuery_fn = async function(query, meta, records) {
-  await __privateGet$4(this, _cache)?.set(`query_${__privateGet$4(this, _table)}:${query.key()}`, { date: new Date(), meta, records });
+  await __privateGet$4(this, _cache)?.set(`query_${__privateGet$4(this, _table)}:${query.key()}`, { date: /* @__PURE__ */ new Date(), meta, records });
 };
 _getCacheQuery = new WeakSet();
 getCacheQuery_fn = async function(query) {
@@ -3512,6 +3673,8 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
     }
   }
   const record = { ...data };
+  const serializable = { xata, ...transformObjectLinks(data) };
+  const metadata = xata !== void 0 ? { ...xata, createdAt: new Date(xata.createdAt), updatedAt: new Date(xata.updatedAt) } : void 0;
   record.read = function(columns2) {
     return db[table].read(record["id"], columns2);
   };
@@ -3528,14 +3691,15 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
   record.delete = function() {
     return db[table].delete(record["id"]);
   };
+  record.xata = Object.freeze(metadata);
   record.getMetadata = function() {
-    return xata;
+    return record.xata;
   };
   record.toSerializable = function() {
-    return JSON.parse(JSON.stringify(transformObjectLinks(data)));
+    return JSON.parse(JSON.stringify(serializable));
   };
   record.toString = function() {
-    return JSON.stringify(transformObjectLinks(data));
+    return JSON.stringify(transformObjectLinks(serializable));
   };
   for (const prop of ["read", "update", "replace", "delete", "getMetadata", "toSerializable", "toString"]) {
     Object.defineProperty(record, prop, { enumerable: false });
@@ -3754,6 +3918,7 @@ search_fn = async function(query, options, pluginOptions) {
   const { tables, fuzziness, highlight, prefix, page } = options ?? {};
   const { records } = await searchBranch({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", region: "{region}" },
+    // @ts-ignore https://github.com/xataio/client-ts/issues/313
     body: { tables, query, fuzziness, prefix, highlight, page },
     ...pluginOptions
   });
@@ -3908,6 +4073,7 @@ const buildClient = (plugins) => {
       fetch,
       apiKey,
       apiUrl: "",
+      // Instead of using workspace and dbBranch, we inject a probably CNAME'd URL
       workspacesApiUrl: (path, params) => {
         const hasBranch = params.dbBranchName ?? params.branch;
         const newPath = path.replace(/^\/db\/[^/]+/, hasBranch !== void 0 ? `:${branch}` : "");
@@ -4012,5 +4178,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, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, 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, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
+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, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, 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, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
 //# sourceMappingURL=index.mjs.map