@xata.io/client 0.17.1 → 0.18.1

package/dist/index.mjs

@@ -150,7 +150,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.17.1";
+const VERSION = "0.18.1";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -386,6 +386,7 @@ const getDatabaseMetadata = (variables) => fetch$1({
   method: "get",
   ...variables
 });
+const updateDatabaseMetadata = (variables) => fetch$1({ url: "/dbs/{dbName}/metadata", method: "patch", ...variables });
 const getGitBranchesMapping = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "get", ...variables });
 const addGitBranchesEntry = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "post", ...variables });
 const removeGitBranchesEntry = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "delete", ...variables });
@@ -529,6 +530,11 @@ const searchBranch = (variables) => fetch$1({
   method: "post",
   ...variables
 });
+const summarizeTable = (variables) => fetch$1({
+  url: "/db/{dbBranchName}/tables/{tableName}/summarize",
+  method: "post",
+  ...variables
+});
 const operationsByTag = {
   users: { getUser, updateUser, deleteUser, getUserAPIKeys, createUserAPIKey, deleteUserAPIKey },
   workspaces: {
@@ -551,6 +557,7 @@ const operationsByTag = {
     createDatabase,
     deleteDatabase,
     getDatabaseMetadata,
+    updateDatabaseMetadata,
     getGitBranchesMapping,
     addGitBranchesEntry,
     removeGitBranchesEntry,
@@ -608,7 +615,8 @@ const operationsByTag = {
     bulkInsertTableRecords,
     queryTable,
     searchTable,
-    searchBranch
+    searchBranch,
+    summarizeTable
   }
 };
 
@@ -859,6 +867,13 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
+  updateDatabaseMetadata(workspace, dbName, options = {}) {
+    return operationsByTag.database.updateDatabaseMetadata({
+      pathParams: { workspace, dbName },
+      body: options,
+      ...this.extraProps
+    });
+  }
   getGitBranchesMapping(workspace, dbName) {
     return operationsByTag.database.getGitBranchesMapping({
       pathParams: { workspace, dbName },
@@ -1085,6 +1100,13 @@ class RecordsApi {
       ...this.extraProps
     });
   }
+  summarizeTable(workspace, database, branch, tableName, query) {
+    return operationsByTag.records.summarizeTable({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName },
+      body: query,
+      ...this.extraProps
+    });
+  }
 }
 class MigrationRequestsApi {
   constructor(extraProps) {
@@ -1335,9 +1357,14 @@ var __privateSet$5 = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _table$1, _repository, _data;
+var __privateMethod$3 = (obj, member, method) => {
+  __accessCheck$5(obj, member, "access private method");
+  return method;
+};
+var _table$1, _repository, _data, _cleanFilterConstraint, cleanFilterConstraint_fn;
 const _Query = class {
   constructor(repository, table, data, rawParent) {
+    __privateAdd$5(this, _cleanFilterConstraint);
     __privateAdd$5(this, _table$1, void 0);
     __privateAdd$5(this, _repository, void 0);
     __privateAdd$5(this, _data, { filter: {} });
@@ -1394,22 +1421,17 @@ const _Query = class {
   }
   filter(a, b) {
     if (arguments.length === 1) {
-      const constraints = Object.entries(a ?? {}).map(([column, constraint]) => ({ [column]: constraint }));
+      const constraints = Object.entries(a ?? {}).map(([column, constraint]) => ({
+        [column]: __privateMethod$3(this, _cleanFilterConstraint, cleanFilterConstraint_fn).call(this, column, constraint)
+      }));
       const $all = compact([__privateGet$5(this, _data).filter?.$all].flat().concat(constraints));
       return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
     } else {
-      const constraints = isDefined(a) && isDefined(b) ? [{ [a]: this.defaultFilter(a, b) }] : void 0;
+      const constraints = isDefined(a) && isDefined(b) ? [{ [a]: __privateMethod$3(this, _cleanFilterConstraint, cleanFilterConstraint_fn).call(this, a, b) }] : void 0;
       const $all = compact([__privateGet$5(this, _data).filter?.$all].flat().concat(constraints));
       return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
     }
   }
-  defaultFilter(column, value) {
-    const columnType = __privateGet$5(this, _table$1).schema?.columns.find(({ name }) => name === column)?.type;
-    if (columnType === "multiple" && (isString(value) || isStringArray(value))) {
-      return { $includes: value };
-    }
-    return value;
-  }
   sort(column, direction = "asc") {
     const originalSort = [__privateGet$5(this, _data).sort ?? []].flat();
     const sort = [...originalSort, { column, direction }];
@@ -1444,11 +1466,20 @@ const _Query = class {
     }
   }
   async getMany(options = {}) {
-    const page = await this.getPaginated(options);
+    const { pagination = {}, ...rest } = options;
+    const { size = PAGINATION_DEFAULT_SIZE, offset } = pagination;
+    const batchSize = size <= PAGINATION_MAX_SIZE ? size : PAGINATION_MAX_SIZE;
+    let page = await this.getPaginated({ ...rest, pagination: { size: batchSize, offset } });
+    const results = [...page.records];
+    while (page.hasNextPage() && results.length < size) {
+      page = await page.nextPage();
+      results.push(...page.records);
+    }
     if (page.hasNextPage() && options.pagination?.size === void 0) {
       console.trace("Calling getMany does not return all results. Paginate to get all results or call getAll.");
     }
-    return page.records;
+    const array = new RecordArray(page, results.slice(0, size));
+    return array;
   }
   async getAll(options = {}) {
     const { batchSize = PAGINATION_MAX_SIZE, ...rest } = options;
@@ -1462,6 +1493,12 @@ const _Query = class {
     const records = await this.getMany({ ...options, pagination: { size: 1 } });
     return records[0] ?? null;
   }
+  async getFirstOrThrow(options = {}) {
+    const records = await this.getMany({ ...options, pagination: { size: 1 } });
+    if (records[0] === void 0)
+      throw new Error("No results found.");
+    return records[0];
+  }
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
@@ -1485,6 +1522,17 @@ let Query = _Query;
 _table$1 = new WeakMap();
 _repository = new WeakMap();
 _data = new WeakMap();
+_cleanFilterConstraint = new WeakSet();
+cleanFilterConstraint_fn = function(column, value) {
+  const columnType = __privateGet$5(this, _table$1).schema?.columns.find(({ name }) => name === column)?.type;
+  if (columnType === "multiple" && (isString(value) || isStringArray(value))) {
+    return { $includes: value };
+  }
+  if (columnType === "link" && isObject(value) && isString(value.id)) {
+    return value.id;
+  }
+  return value;
+};
 function cleanParent(data, parent) {
   if (isCursorPaginationOptions(data.pagination)) {
     return { ...parent, sorting: void 0, filter: void 0 };
@@ -1653,6 +1701,25 @@ class RestRepository extends Query {
       return null;
     });
   }
+  async readOrThrow(a, b) {
+    return __privateGet$4(this, _trace).call(this, "readOrThrow", async () => {
+      const result = await this.read(a, b);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      }
+      if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async update(a, b, c) {
     return __privateGet$4(this, _trace).call(this, "update", async () => {
       if (Array.isArray(a)) {
@@ -1675,6 +1742,25 @@ class RestRepository extends Query {
       throw new Error("Invalid arguments for update method");
     });
   }
+  async updateOrThrow(a, b, c) {
+    return __privateGet$4(this, _trace).call(this, "updateOrThrow", async () => {
+      const result = await this.update(a, b, c);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      }
+      if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async createOrUpdate(a, b, c) {
     return __privateGet$4(this, _trace).call(this, "createOrUpdate", async () => {
       if (Array.isArray(a)) {
@@ -1716,6 +1802,24 @@ class RestRepository extends Query {
       throw new Error("Invalid arguments for delete method");
     });
   }
+  async deleteOrThrow(a, b) {
+    return __privateGet$4(this, _trace).call(this, "deleteOrThrow", async () => {
+      const result = await this.delete(a, b);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      } else if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async search(query, options = {}) {
     return __privateGet$4(this, _trace).call(this, "search", async () => {
       const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
@@ -1927,9 +2031,17 @@ const initObject = (db, schemaTables, table, object) => {
           console.error(`Failed to parse link for field ${column.name}`);
         } else if (isObject(value)) {
           result[column.name] = initObject(db, schemaTables, linkTable, value);
+        } else {
+          result[column.name] = null;
         }
         break;
       }
+      default:
+        result[column.name] = value ?? null;
+        if (column.notNull === true && value === null) {
+          console.error(`Parse error, column ${column.name} is non nullable and value resolves null`);
+        }
+        break;
     }
   }
   result.read = function(columns2) {
@@ -2453,5 +2565,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, 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, applyBranchSchemaEdit, 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, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateBranchSchema, updateColumn, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
+export { BaseClient, 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, applyBranchSchemaEdit, 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, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
 //# sourceMappingURL=index.mjs.map