@xata.io/client 0.10.0 → 0.10.1

package/dist/index.d.ts

@@ -1151,14 +1151,15 @@ declare type ResolveBranchVariables = {
 } & FetcherExtraProps;
 /**
  * In order to resolve the database branch, the following algorithm is used:
- * * if the `gitBranch` is found in the [git branches mapping](), the associated Xata branch is returned
+ * * if the `gitBranch` was provided and is found in the [git branches mapping](/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
  * * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
- * * else, return the default branch of the DB (currently `main` or the first branch)
+ * * else, if `fallbackBranch` is provided and a branch with that name exists, return it
+ * * else, return the default branch of the DB (`main` or the first branch)
  *
  * Example call:
  *
  * ```json
- * // GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test?fallbackBranch=tsg
+ * // GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test&fallbackBranch=tsg
  * ```
  *
  * Example response:
@@ -1458,8 +1459,9 @@ declare type UpdateTableVariables = {
  *
  * In the example below, we rename a table from “users” to “people”:
  *
- * ```jsx
- * PATCH /db/test:main/tables/users
+ * ```json
+ * // PATCH /db/test:main/tables/users
+ *
  * {
  *   "name": "people"
  * }
@@ -1867,7 +1869,7 @@ declare type QueryTableVariables = {
  * {
  *   "columns": [...],
  *   "filter": {
- *     "$all": [...]
+ *     "$all": [...],
  *     "$any": [...]
  *     ...
  *   },
@@ -2005,7 +2007,7 @@ declare type QueryTableVariables = {
  * {
  *   "name": "Kilian",
  *   "address": {
- *     "street": "New street",
+ *     "street": "New street"
  *   }
  * }
  * ```
@@ -2014,10 +2016,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.name"
- *   ]
+ *   "columns": ["*", "team.name"]
  * }
  * ```
  *
@@ -2035,7 +2034,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team"
  *   }
@@ -2046,10 +2045,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.*"
- *   ]
+ *   "columns": ["*", "team.*"]
  * }
  * ```
  *
@@ -2067,7 +2063,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team",
  *     "code": "A1",
@@ -2117,7 +2113,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "name": "r2",
+ *     "name": "r2"
  *   }
  * }
  * ```
@@ -2139,7 +2135,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.plan": "free",
+ *     "settings.plan": "free"
  *   }
  * }
  * ```
@@ -2149,8 +2145,8 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "settings": {
  *       "plan": "free"
- *     },
- *   },
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2159,8 +2155,8 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": {"$any": ["free", "paid"]}
- *   },
+ *     "settings.plan": { "$any": ["free", "paid"] }
+ *   }
  * }
  * ```
  *
@@ -2169,9 +2165,9 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.dark": true,
- *       "settings.plan": "free",
- *   },
+ *     "settings.dark": true,
+ *     "settings.plan": "free"
+ *   }
  * }
  * ```
  *
@@ -2182,11 +2178,11 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "$any": {
- *         "settings.dark": true,
- *         "settings.plan": "free"
- *       }
- *   },
+ *     "$any": {
+ *       "settings.dark": true,
+ *       "settings.plan": "free"
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2197,10 +2193,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$any": [
  *       {
- *         "name": "r1",
+ *         "name": "r1"
  *       },
  *       {
- *         "name": "r2",
+ *         "name": "r2"
  *       }
  *     ]
  *   }
@@ -2212,7 +2208,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$exists": "settings",
+ *     "$exists": "settings"
  *   }
  * }
  * ```
@@ -2224,10 +2220,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$all": [
  *       {
- *         "$exists": "settings",
+ *         "$exists": "settings"
  *       },
  *       {
- *         "$exists": "name",
+ *         "$exists": "name"
  *       }
  *     ]
  *   }
@@ -2239,7 +2235,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$notExists": "settings",
+ *     "$notExists": "settings"
  *   }
  * }
  * ```
@@ -2266,7 +2262,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$pattern": "v*alue*"
+ *       "$pattern": "v*alue*"
  *     }
  *   }
  * }
@@ -2278,10 +2274,10 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$endsWith": ".gz"
+ *       "$endsWith": ".gz"
  *     },
  *     "<column_name>": {
- *         "$startsWith": "tmp-"
+ *       "$startsWith": "tmp-"
  *     }
  *   }
  * }
@@ -2292,10 +2288,10 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "<column_name>": {
- *         "$ge": 0,
- *         "$lt": 100
- *       }
+ *     "<column_name>": {
+ *       "$ge": 0,
+ *       "$lt": 100
+ *     }
  *   }
  * }
  * ```
@@ -2313,7 +2309,6 @@ declare type QueryTableVariables = {
  * ```
  * The supported operators are `$gt`, `$lt`, `$ge`, `$le`.
  *
- *
  * #### Negations
  *
  * A general `$not` operator can inverse any operation.
@@ -2338,15 +2333,21 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "$not": {
- *       "$any": [{
- *         "<column_name1>": "value1"
- *       }, {
- *         "$all": [{
- *           "<column_name2>": "value2"
- *         }, {
- *           "<column_name3>": "value3"
- *         }]
- *       }]
+ *       "$any": [
+ *         {
+ *           "<column_name1>": "value1"
+ *         },
+ *         {
+ *           "$all": [
+ *             {
+ *               "<column_name2>": "value2"
+ *             },
+ *             {
+ *               "<column_name3>": "value3"
+ *             }
+ *           ]
+ *         }
+ *       ]
  *     }
  *   }
  * }
@@ -2401,8 +2402,8 @@ declare type QueryTableVariables = {
  *     "<array name>": {
  *       "$includes": {
  *         "$all": [
- *           {"$contains": "label"},
- *           {"$not": {"$endsWith": "-debug"}}
+ *           { "$contains": "label" },
+ *           { "$not": { "$endsWith": "-debug" } }
  *         ]
  *       }
  *     }
@@ -2422,9 +2423,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "settings.labels": {
- *       "$includesAll": [
- *         {"$contains": "label"},
- *       ]
+ *       "$includesAll": [{ "$contains": "label" }]
  *     }
  *   }
  * }
@@ -2472,7 +2471,6 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- *
  * ### Pagination
  *
  * We offer cursor pagination and offset pagination. The offset pagination is limited
@@ -2538,8 +2536,8 @@ declare type QueryTableVariables = {
  * can be queried by update `page.after` to the returned cursor while keeping the
  * `page.before` cursor from the first range query.
  *
- * The `filter` , `columns`,  `sort` , and `page.size` configuration will be
- * encoded with the cursor.  The pagination request will be invalid if
+ * The `filter` , `columns`, `sort` , and `page.size` configuration will be
+ * encoded with the cursor. The pagination request will be invalid if
  * `filter` or `sort` is set. The columns returned and page size can be changed
  * anytime by passing the `columns` or `page.size` settings to the next query.
  *

package/dist/index.mjs

@@ -1077,7 +1077,7 @@ const _Query = class {
   }
   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));
@@ -1307,7 +1307,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
     };
@@ -1497,7 +1497,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;
@@ -1623,7 +1623,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];
@@ -1726,30 +1726,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();
@@ -1838,7 +1847,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) {
@@ -1855,7 +1864,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");
     }
@@ -1882,7 +1891,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) => {