@xata.io/client 0.10.2 → 0.13.0

package/dist/index.mjs

@@ -7,8 +7,11 @@ function compact(arr) {
 function isObject(value) {
   return Boolean(value) && typeof value === "object" && !Array.isArray(value);
 }
+function isDefined(value) {
+  return value !== null && value !== void 0;
+}
 function isString(value) {
-  return value !== void 0 && value !== null && typeof value === "string";
+  return isDefined(value) && typeof value === "string";
 }
 function toBase64(value) {
   try {
@@ -70,7 +73,12 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-class FetcherError extends Error {
+class ErrorWithCause extends Error {
+  constructor(message, options) {
+    super(message, options);
+  }
+}
+class FetcherError extends ErrorWithCause {
   constructor(status, data) {
     super(getMessage(data));
     this.status = status;
@@ -934,13 +942,13 @@ var __privateSet$5 = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _query;
+var _query, _page;
 class Page {
   constructor(query, meta, records = []) {
     __privateAdd$6(this, _query, void 0);
     __privateSet$5(this, _query, query);
     this.meta = meta;
-    this.records = records;
+    this.records = new RecordArray(this, records);
   }
   async nextPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, after: this.meta.page.cursor } });
@@ -960,9 +968,40 @@ class Page {
 }
 _query = new WeakMap();
 const PAGINATION_MAX_SIZE = 200;
-const PAGINATION_DEFAULT_SIZE = 200;
+const PAGINATION_DEFAULT_SIZE = 20;
 const PAGINATION_MAX_OFFSET = 800;
 const PAGINATION_DEFAULT_OFFSET = 0;
+function isCursorPaginationOptions(options) {
+  return isDefined(options) && (isDefined(options.first) || isDefined(options.last) || isDefined(options.after) || isDefined(options.before));
+}
+const _RecordArray = class extends Array {
+  constructor(page, overrideRecords) {
+    super(...overrideRecords ?? page.records);
+    __privateAdd$6(this, _page, void 0);
+    __privateSet$5(this, _page, page);
+  }
+  async nextPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).nextPage(size, offset);
+    return new _RecordArray(newPage);
+  }
+  async previousPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).previousPage(size, offset);
+    return new _RecordArray(newPage);
+  }
+  async firstPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).firstPage(size, offset);
+    return new _RecordArray(newPage);
+  }
+  async lastPage(size, offset) {
+    const newPage = await __privateGet$6(this, _page).lastPage(size, offset);
+    return new _RecordArray(newPage);
+  }
+  hasNextPage() {
+    return __privateGet$6(this, _page).meta.page.more;
+  }
+};
+let RecordArray = _RecordArray;
+_page = new WeakMap();
 
 var __accessCheck$5 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -984,18 +1023,19 @@ var __privateSet$4 = (obj, member, value, setter) => {
 };
 var _table$1, _repository, _data;
 const _Query = class {
-  constructor(repository, table, data, parent) {
+  constructor(repository, table, data, rawParent) {
     __privateAdd$5(this, _table$1, void 0);
     __privateAdd$5(this, _repository, void 0);
     __privateAdd$5(this, _data, { filter: {} });
     this.meta = { page: { cursor: "start", more: true } };
-    this.records = [];
+    this.records = new RecordArray(this, []);
     __privateSet$4(this, _table$1, table);
     if (repository) {
       __privateSet$4(this, _repository, repository);
     } else {
       __privateSet$4(this, _repository, this);
     }
+    const parent = cleanParent(data, rawParent);
     __privateGet$5(this, _data).filter = data.filter ?? parent?.filter ?? {};
     __privateGet$5(this, _data).filter.$any = data.filter?.$any ?? parent?.filter?.$any;
     __privateGet$5(this, _data).filter.$all = data.filter?.$all ?? parent?.filter?.$all;
@@ -1067,18 +1107,21 @@ const _Query = class {
   }
   async *getIterator(options = {}) {
     const { batchSize = 1 } = options;
-    let offset = 0;
-    let end = false;
-    while (!end) {
-      const { records, meta } = await this.getPaginated({ ...options, pagination: { size: batchSize, offset } });
-      yield records;
-      offset += batchSize;
-      end = !meta.page.more;
+    let page = await this.getPaginated({ ...options, pagination: { size: batchSize, offset: 0 } });
+    let more = page.hasNextPage();
+    yield page.records;
+    while (more) {
+      page = await page.nextPage();
+      more = page.hasNextPage();
+      yield page.records;
     }
   }
   async getMany(options = {}) {
-    const { records } = await this.getPaginated(options);
-    return records;
+    const page = await this.getPaginated(options);
+    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;
   }
   async getAll(options = {}) {
     const { batchSize = PAGINATION_MAX_SIZE, ...rest } = options;
@@ -1115,12 +1158,20 @@ let Query = _Query;
 _table$1 = new WeakMap();
 _repository = new WeakMap();
 _data = new WeakMap();
+function cleanParent(data, parent) {
+  if (isCursorPaginationOptions(data.pagination)) {
+    return { ...parent, sorting: void 0, filter: void 0 };
+  }
+  return parent;
+}
 
 function isIdentifiable(x) {
   return isObject(x) && isString(x?.id);
 }
 function isXataRecord(x) {
-  return isIdentifiable(x) && typeof x?.xata === "object" && typeof x?.xata?.version === "number";
+  const record = x;
+  const metadata = record?.getMetadata();
+  return isIdentifiable(x) && isObject(metadata) && typeof metadata.version === "number";
 }
 
 function isSortFilterString(value) {
@@ -1197,6 +1248,8 @@ class RestRepository extends Query {
   }
   async create(a, b) {
     if (Array.isArray(a)) {
+      if (a.length === 0)
+        return [];
       const records = await __privateMethod$2(this, _bulkInsertTableRecords, bulkInsertTableRecords_fn).call(this, a);
       await Promise.all(records.map((record) => __privateMethod$2(this, _setCacheRecord, setCacheRecord_fn).call(this, record)));
       return records;
@@ -1222,27 +1275,36 @@ class RestRepository extends Query {
     }
     throw new Error("Invalid arguments for create method");
   }
-  async read(recordId) {
-    const cacheRecord = await __privateMethod$2(this, _getCacheRecord, getCacheRecord_fn).call(this, recordId);
-    if (cacheRecord)
-      return cacheRecord;
-    const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
-    try {
-      const response = await getRecord({
-        pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table), recordId },
-        ...fetchProps
-      });
-      const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
-      return initObject(this.db, schema, __privateGet$4(this, _table), response);
-    } catch (e) {
-      if (isObject(e) && e.status === 404) {
-        return null;
+  async read(a) {
+    if (Array.isArray(a)) {
+      if (a.length === 0)
+        return [];
+      return this.getAll({ filter: { id: { $any: a } } });
+    }
+    if (isString(a)) {
+      const cacheRecord = await __privateMethod$2(this, _getCacheRecord, getCacheRecord_fn).call(this, a);
+      if (cacheRecord)
+        return cacheRecord;
+      const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
+      try {
+        const response = await getRecord({
+          pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table), recordId: a },
+          ...fetchProps
+        });
+        const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
+        return initObject(this.db, schema, __privateGet$4(this, _table), response);
+      } catch (e) {
+        if (isObject(e) && e.status === 404) {
+          return null;
+        }
+        throw e;
       }
-      throw e;
     }
   }
   async update(a, b) {
     if (Array.isArray(a)) {
+      if (a.length === 0)
+        return [];
       if (a.length > 100) {
         console.warn("Bulk update operation is not optimized in the Xata API yet, this request might be slow");
       }
@@ -1264,6 +1326,8 @@ class RestRepository extends Query {
   }
   async createOrUpdate(a, b) {
     if (Array.isArray(a)) {
+      if (a.length === 0)
+        return [];
       if (a.length > 100) {
         console.warn("Bulk update operation is not optimized in the Xata API yet, this request might be slow");
       }
@@ -1285,6 +1349,8 @@ class RestRepository extends Query {
   }
   async delete(a) {
     if (Array.isArray(a)) {
+      if (a.length === 0)
+        return;
       if (a.length > 100) {
         console.warn("Bulk delete operation is not optimized in the Xata API yet, this request might be slow");
       }
@@ -1310,6 +1376,7 @@ class RestRepository extends Query {
       body: {
         query,
         fuzziness: options.fuzziness,
+        highlight: options.highlight,
         filter: options.filter
       },
       ...fetchProps
@@ -1494,7 +1561,8 @@ const transformObjectLinks = (object) => {
 };
 const initObject = (db, schema, table, object) => {
   const result = {};
-  Object.assign(result, object);
+  const { xata, ...rest } = object ?? {};
+  Object.assign(result, rest);
   const { columns } = schema.tables.find(({ name }) => name === table) ?? {};
   if (!columns)
     console.error(`Table ${table} not found in schema`);
@@ -1502,10 +1570,10 @@ const initObject = (db, schema, table, object) => {
     const value = result[column.name];
     switch (column.type) {
       case "datetime": {
-        const date = new Date(value);
-        if (isNaN(date.getTime())) {
+        const date = value !== void 0 ? new Date(value) : void 0;
+        if (date && isNaN(date.getTime())) {
           console.error(`Failed to parse date ${value} for field ${column.name}`);
-        } else {
+        } else if (date) {
           result[column.name] = date;
         }
         break;
@@ -1530,7 +1598,10 @@ const initObject = (db, schema, table, object) => {
   result.delete = function() {
     return db[table].delete(result["id"]);
   };
-  for (const prop of ["read", "update", "delete"]) {
+  result.getMetadata = function() {
+    return xata;
+  };
+  for (const prop of ["read", "update", "delete", "getMetadata"]) {
     Object.defineProperty(result, prop, { enumerable: false });
   }
   Object.freeze(result);
@@ -1712,10 +1783,10 @@ _schema = new WeakMap();
 _search = new WeakSet();
 search_fn = async function(query, options, getFetchProps) {
   const fetchProps = await getFetchProps();
-  const { tables, fuzziness } = options ?? {};
+  const { tables, fuzziness, highlight } = options ?? {};
   const { records } = await searchBranch({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}" },
-    body: { tables, query, fuzziness },
+    body: { tables, query, fuzziness, highlight },
     ...fetchProps
   });
   return records;
@@ -1933,5 +2004,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, Repository, RestRepository, SchemaPlugin, SearchPlugin, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, 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, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
 //# sourceMappingURL=index.mjs.map