@xata.io/client 0.0.0-alpha.vf9d4e41 → 0.0.0-alpha.vfb4479d

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @xata.io/client
 
+## 0.11.0
+
+### Minor Changes
+
+- [#322](https://github.com/xataio/client-ts/pull/322) [`bc64c28`](https://github.com/xataio/client-ts/commit/bc64c28fbfbb000c7190ac8092e2ef6a261df86f) Thanks [@SferaDev](https://github.com/SferaDev)! - Add filter support for cross-table search operations
+
+### Patch Changes
+
+- [#327](https://github.com/xataio/client-ts/pull/327) [`505257c`](https://github.com/xataio/client-ts/commit/505257c0c42ca0c8beaf5c0f638037c576dcc43c) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow reading multiple uids at the same time
+
+* [#346](https://github.com/xataio/client-ts/pull/346) [`ff7e5c6`](https://github.com/xataio/client-ts/commit/ff7e5c6f211913196d8c28600d7a7675ed261688) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix compat with TS 4.8
+
+- [#345](https://github.com/xataio/client-ts/pull/345) [`bf64cb8`](https://github.com/xataio/client-ts/commit/bf64cb885d55a0271e966314384324f02ded084e) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix bug with nullable record filters inferred as never
+
+* [#334](https://github.com/xataio/client-ts/pull/334) [`ce07601`](https://github.com/xataio/client-ts/commit/ce07601e4ddf9f75e20249d479dc04a63795ca96) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for TS 4.5
+
+- [#325](https://github.com/xataio/client-ts/pull/325) [`12f1ce3`](https://github.com/xataio/client-ts/commit/12f1ce362f6cda27dfdb3afab0800282bddc8b5e) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix offset errors with operations that affect many rows
+
+* [#345](https://github.com/xataio/client-ts/pull/345) [`a73a2a2`](https://github.com/xataio/client-ts/commit/a73a2a2014c44cf88eaef42196ba1dba9d516b4a) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix issue with Filter<T> not narrowing down type on object properties
+
+## 0.10.2
+
+### Patch Changes
+
+- [#312](https://github.com/xataio/client-ts/pull/312) [`0edf1af`](https://github.com/xataio/client-ts/commit/0edf1af2205c4761d53a02c74ddaab3168d69775) Thanks [@SferaDev](https://github.com/SferaDev)! - Add filtering to search by table
+
+* [#312](https://github.com/xataio/client-ts/pull/312) [`66ad7cc`](https://github.com/xataio/client-ts/commit/66ad7cc0365046c5d039c37117feac04428d8373) Thanks [@SferaDev](https://github.com/SferaDev)! - Add new API method for searching in a given table
+
+## 0.10.1
+
+### Patch Changes
+
+- [#271](https://github.com/xataio/client-ts/pull/271) [`0bb17b8`](https://github.com/xataio/client-ts/commit/0bb17b88d49f1c8be32d2d6b0b3a5918890876cb) Thanks [@SferaDev](https://github.com/SferaDev)! - Link and resolve branches from git
+
 ## 0.10.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -11,8 +11,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 {
@@ -74,7 +77,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;
@@ -370,6 +378,11 @@ const queryTable = (variables) => fetch$1({
   method: "post",
   ...variables
 });
+const searchTable = (variables) => fetch$1({
+  url: "/db/{dbBranchName}/tables/{tableName}/search",
+  method: "post",
+  ...variables
+});
 const searchBranch = (variables) => fetch$1({
   url: "/db/{dbBranchName}/search",
   method: "post",
@@ -433,6 +446,7 @@ const operationsByTag = {
     getRecord,
     bulkInsertTableRecords,
     queryTable,
+    searchTable,
     searchBranch
   }
 };
@@ -888,6 +902,13 @@ class RecordsApi {
       ...this.extraProps
     });
   }
+  searchTable(workspace, database, branch, tableName, query) {
+    return operationsByTag.records.searchTable({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName },
+      body: query,
+      ...this.extraProps
+    });
+  }
   searchBranch(workspace, database, branch, query) {
     return operationsByTag.records.searchBranch({
       pathParams: { workspace, dbBranchName: `${database}:${branch}` },
@@ -954,6 +975,9 @@ const PAGINATION_MAX_SIZE = 200;
 const PAGINATION_DEFAULT_SIZE = 200;
 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));
+}
 
 var __accessCheck$5 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -975,7 +999,7 @@ 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: {} });
@@ -987,6 +1011,7 @@ const _Query = class {
     } 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;
@@ -1058,13 +1083,13 @@ 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 = {}) {
@@ -1106,6 +1131,12 @@ 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);
@@ -1188,6 +1219,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;
@@ -1213,27 +1246,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");
       }
@@ -1255,6 +1297,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");
       }
@@ -1276,6 +1320,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");
       }
@@ -1296,9 +1342,14 @@ class RestRepository extends Query {
   }
   async search(query, options = {}) {
     const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
-    const { records } = await searchBranch({
-      pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}" },
-      body: { tables: [__privateGet$4(this, _table)], query, fuzziness: options.fuzziness },
+    const { records } = await searchTable({
+      pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table) },
+      body: {
+        query,
+        fuzziness: options.fuzziness,
+        highlight: options.highlight,
+        filter: options.filter
+      },
       ...fetchProps
     });
     const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
@@ -1699,10 +1750,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;
@@ -1730,30 +1781,39 @@ const envBranchNames = [
   "CF_PAGES_BRANCH",
   "BRANCH"
 ];
-const defaultBranch = "main";
 async function getCurrentBranchName(options) {
   const env = getBranchByEnvVariable();
-  if (env)
-    return env;
-  const branch = await getGitBranch();
-  if (!branch)
-    return defaultBranch;
-  const details = await getDatabaseBranch(branch, options);
-  if (details)
-    return branch;
-  return defaultBranch;
+  if (env) {
+    const details = await getDatabaseBranch(env, options);
+    if (details)
+      return env;
+    console.warn(`Branch ${env} not found in Xata. Ignoring...`);
+  }
+  const gitBranch = await getGitBranch();
+  return resolveXataBranch(gitBranch, options);
 }
 async function getCurrentBranchDetails(options) {
-  const env = getBranchByEnvVariable();
-  if (env)
-    return getDatabaseBranch(env, options);
-  const branch = await getGitBranch();
-  if (!branch)
-    return getDatabaseBranch(defaultBranch, options);
-  const details = await getDatabaseBranch(branch, options);
-  if (details)
-    return details;
-  return getDatabaseBranch(defaultBranch, options);
+  const branch = await getCurrentBranchName(options);
+  return getDatabaseBranch(branch, options);
+}
+async function resolveXataBranch(gitBranch, options) {
+  const databaseURL = options?.databaseURL || getDatabaseURL();
+  const apiKey = options?.apiKey || getAPIKey();
+  if (!databaseURL)
+    throw new Error("A databaseURL was not defined. Either set the XATA_DATABASE_URL env variable or pass the argument explicitely");
+  if (!apiKey)
+    throw new Error("An API key was not defined. Either set the XATA_API_KEY env variable or pass the argument explicitely");
+  const [protocol, , host, , dbName] = databaseURL.split("/");
+  const [workspace] = host.split(".");
+  const { branch } = await resolveBranch({
+    apiKey,
+    apiUrl: databaseURL,
+    fetchImpl: getFetchImplementation(options?.fetchImpl),
+    workspacesApiUrl: `${protocol}//${host}`,
+    pathParams: { dbName, workspace },
+    queryParams: { gitBranch, fallbackBranch: getEnvVariable("XATA_FALLBACK_BRANCH") }
+  });
+  return branch;
 }
 async function getDatabaseBranch(branch, options) {
   const databaseURL = options?.databaseURL || getDatabaseURL();
@@ -1983,6 +2043,7 @@ exports.insertRecord = insertRecord;
 exports.insertRecordWithID = insertRecordWithID;
 exports.inviteWorkspaceMember = inviteWorkspaceMember;
 exports.is = is;
+exports.isCursorPaginationOptions = isCursorPaginationOptions;
 exports.isIdentifiable = isIdentifiable;
 exports.isNot = isNot;
 exports.isXataRecord = isXataRecord;
@@ -1998,6 +2059,7 @@ exports.removeWorkspaceMember = removeWorkspaceMember;
 exports.resendWorkspaceMemberInvite = resendWorkspaceMemberInvite;
 exports.resolveBranch = resolveBranch;
 exports.searchBranch = searchBranch;
+exports.searchTable = searchTable;
 exports.setTableSchema = setTableSchema;
 exports.startsWith = startsWith;
 exports.updateBranchMetadata = updateBranchMetadata;