@xata.io/client 0.0.0-alpha.vf7b5320 → 0.0.0-alpha.vf957886

package/.eslintrc.cjs

@@ -6,8 +6,7 @@ module.exports = {
     project: 'packages/client/tsconfig.json'
   },
   rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-types': 'off',
     '@typescript-eslint/no-floating-promises': 'error',
+    "@typescript-eslint/strict-boolean-expressions": ["error", { allowNullableString: true, allowNullableObject: true }],
   }
 };

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @xata.io/client
 
+## 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
+
+- [#272](https://github.com/xataio/client-ts/pull/272) [`6d76275`](https://github.com/xataio/client-ts/commit/6d7627555a404a4c2da42f4187df6f8300f9a46f) Thanks [@SferaDev](https://github.com/SferaDev)! - Rename page options to pagination
+
+* [#270](https://github.com/xataio/client-ts/pull/270) [`1864742`](https://github.com/xataio/client-ts/commit/18647428d8608841de514c3784fb711c39dccc6d) Thanks [@SferaDev](https://github.com/SferaDev)! - Move chunk to options object
+
+### Patch Changes
+
+- [#281](https://github.com/xataio/client-ts/pull/281) [`d1ec0df`](https://github.com/xataio/client-ts/commit/d1ec0df14834088a816919bfc68216f3f9b2d9ef) Thanks [@SferaDev](https://github.com/SferaDev)! - Do not send from param on undefined
+
+* [#282](https://github.com/xataio/client-ts/pull/282) [`1af6f1a`](https://github.com/xataio/client-ts/commit/1af6f1aaa1123e77a895961581c87f06a88db698) Thanks [@SferaDev](https://github.com/SferaDev)! - Do not allow filter/sort with cursor navigation
+
+- [#284](https://github.com/xataio/client-ts/pull/284) [`be4eda8`](https://github.com/xataio/client-ts/commit/be4eda8f73037d97fef7de28b56d7471dd867875) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix cache ttl with 0 value
+
+* [#265](https://github.com/xataio/client-ts/pull/265) [`99be734`](https://github.com/xataio/client-ts/commit/99be734827576d888aa12a579ed1983a0a8a8e83) Thanks [@SferaDev](https://github.com/SferaDev)! - Add datetime field type support
+
 ## 0.9.1
 
 ### Patch 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
   }
 };
@@ -703,10 +717,10 @@ class BranchApi {
       ...this.extraProps
     });
   }
-  createBranch(workspace, database, branch, from = "", options = {}) {
+  createBranch(workspace, database, branch, from, options = {}) {
     return operationsByTag.branch.createBranch({
       pathParams: { workspace, dbBranchName: `${database}:${branch}` },
-      queryParams: { from },
+      queryParams: isString(from) ? { from } : void 0,
       body: options,
       ...this.extraProps
     });
@@ -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;
@@ -1052,34 +1077,36 @@ const _Query = class {
     return __privateGet$5(this, _repository).query(query);
   }
   async *[Symbol.asyncIterator]() {
-    for await (const [record] of this.getIterator(1)) {
+    for await (const [record] of this.getIterator({ batchSize: 1 })) {
       yield record;
     }
   }
-  async *getIterator(chunk, options = {}) {
-    let offset = 0;
-    let end = false;
-    while (!end) {
-      const { records, meta } = await this.getPaginated({ ...options, pagination: { size: chunk, offset } });
-      yield records;
-      offset += chunk;
-      end = !meta.page.more;
+  async *getIterator(options = {}) {
+    const { batchSize = 1 } = options;
+    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;
   }
-  async getAll(chunk = PAGINATION_MAX_SIZE, options = {}) {
+  async getAll(options = {}) {
+    const { batchSize = PAGINATION_MAX_SIZE, ...rest } = options;
     const results = [];
-    for await (const page of this.getIterator(chunk, options)) {
+    for await (const page of this.getIterator({ ...rest, batchSize })) {
       results.push(...page);
     }
     return results;
   }
   async getFirst(options = {}) {
     const records = await this.getMany({ ...options, pagination: { size: 1 } });
-    return records[0] || null;
+    return records[0] ?? null;
   }
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
@@ -1104,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);
@@ -1294,9 +1327,13 @@ 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,
+        filter: options.filter
+      },
       ...fetchProps
     });
     const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
@@ -1309,7 +1346,7 @@ class RestRepository extends Query {
     const data = query.getQueryOptions();
     const body = {
       filter: Object.values(data.filter ?? {}).some(Boolean) ? data.filter : void 0,
-      sort: data.sort ? buildSortFilter(data.sort) : void 0,
+      sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
       page: data.pagination,
       columns: data.columns
     };
@@ -1453,8 +1490,8 @@ getCacheQuery_fn = async function(query) {
   if (!result)
     return null;
   const { cache: ttl = __privateGet$4(this, _cache).defaultQueryTTL } = query.getQueryOptions();
-  if (!ttl || ttl < 0)
-    return result;
+  if (ttl < 0)
+    return null;
   const hasExpired = result.date.getTime() + ttl < Date.now();
   return hasExpired ? null : result;
 };
@@ -1499,7 +1536,7 @@ const initObject = (db, schema, table, object) => {
         const linkTable = column.link?.table;
         if (!linkTable) {
           console.error(`Failed to parse link for field ${column.name}`);
-        } else if (value && isObject(value)) {
+        } else if (isObject(value)) {
           result[column.name] = initObject(db, schema, linkTable, value);
         }
         break;
@@ -1625,7 +1662,7 @@ class SchemaPlugin extends XataPlugin {
       get: (_target, table) => {
         if (!isString(table))
           throw new Error("Invalid table name");
-        if (!__privateGet$2(this, _tables)[table]) {
+        if (__privateGet$2(this, _tables)[table] === void 0) {
           __privateGet$2(this, _tables)[table] = new RestRepository({ db, pluginOptions, table });
         }
         return __privateGet$2(this, _tables)[table];
@@ -1728,30 +1765,39 @@ const envBranchNames = [
   "CF_PAGES_BRANCH",
   "BRANCH"
 ];
-const defaultBranch = "main";
 async function getCurrentBranchName(options) {
-  const env = await 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;
+  const env = getBranchByEnvVariable();
+  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 = await 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();
@@ -1840,7 +1886,7 @@ const buildClient = (plugins) => {
       this.db = db;
       this.search = search;
       for (const [key, namespace] of Object.entries(plugins ?? {})) {
-        if (!namespace)
+        if (namespace === void 0)
           continue;
         const result = namespace.build(pluginOptions);
         if (result instanceof Promise) {
@@ -1857,7 +1903,7 @@ const buildClient = (plugins) => {
     const databaseURL = options?.databaseURL || getDatabaseURL();
     const apiKey = options?.apiKey || getAPIKey();
     const cache = options?.cache ?? new SimpleCache({ cacheRecords: false, defaultQueryTTL: 0 });
-    const branch = async () => options?.branch ? await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, options.branch) : await getCurrentBranchName({ apiKey, databaseURL, fetchImpl: options?.fetch });
+    const branch = async () => options?.branch !== void 0 ? await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, options.branch) : await getCurrentBranchName({ apiKey, databaseURL, fetchImpl: options?.fetch });
     if (!databaseURL || !apiKey) {
       throw new Error("Options databaseURL and apiKey are required");
     }
@@ -1884,7 +1930,7 @@ const buildClient = (plugins) => {
   }, _evaluateBranch = new WeakSet(), evaluateBranch_fn = async function(param) {
     if (__privateGet(this, _branch))
       return __privateGet(this, _branch);
-    if (!param)
+    if (param === void 0)
       return void 0;
     const strategies = Array.isArray(param) ? [...param] : [param];
     const evaluateBranch = async (strategy) => {
@@ -1981,6 +2027,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;
@@ -1996,6 +2043,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;