@xata.io/client 0.0.0-alpha.vecada6d → 0.0.0-alpha.ved669cc

package/dist/index.mjs

@@ -7,30 +7,78 @@ 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 {
     return btoa(value);
   } catch (err) {
-    return Buffer.from(value).toString("base64");
+    const buf = Buffer;
+    return buf.from(value).toString("base64");
   }
 }
 
-function getEnvVariable(name) {
+function getEnvironment() {
   try {
-    if (isObject(process) && isString(process?.env?.[name])) {
-      return process.env[name];
+    if (isObject(process) && isObject(process.env)) {
+      return {
+        apiKey: process.env.XATA_API_KEY ?? getGlobalApiKey(),
+        databaseURL: process.env.XATA_DATABASE_URL ?? getGlobalDatabaseURL(),
+        branch: process.env.XATA_BRANCH ?? process.env.VERCEL_GIT_COMMIT_REF ?? process.env.CF_PAGES_BRANCH ?? process.env.BRANCH ?? getGlobalBranch(),
+        fallbackBranch: process.env.XATA_FALLBACK_BRANCH ?? getGlobalFallbackBranch()
+      };
     }
   } catch (err) {
   }
   try {
-    if (isObject(Deno) && isString(Deno?.env?.get(name))) {
-      return Deno.env.get(name);
+    if (isObject(Deno) && isObject(Deno.env)) {
+      return {
+        apiKey: Deno.env.get("XATA_API_KEY") ?? getGlobalApiKey(),
+        databaseURL: Deno.env.get("XATA_DATABASE_URL") ?? getGlobalDatabaseURL(),
+        branch: Deno.env.get("XATA_BRANCH") ?? Deno.env.get("VERCEL_GIT_COMMIT_REF") ?? Deno.env.get("CF_PAGES_BRANCH") ?? Deno.env.get("BRANCH") ?? getGlobalBranch(),
+        fallbackBranch: Deno.env.get("XATA_FALLBACK_BRANCH") ?? getGlobalFallbackBranch()
+      };
     }
   } catch (err) {
   }
+  return {
+    apiKey: getGlobalApiKey(),
+    databaseURL: getGlobalDatabaseURL(),
+    branch: getGlobalBranch(),
+    fallbackBranch: getGlobalFallbackBranch()
+  };
+}
+function getGlobalApiKey() {
+  try {
+    return XATA_API_KEY;
+  } catch (err) {
+    return void 0;
+  }
+}
+function getGlobalDatabaseURL() {
+  try {
+    return XATA_DATABASE_URL;
+  } catch (err) {
+    return void 0;
+  }
+}
+function getGlobalBranch() {
+  try {
+    return XATA_BRANCH;
+  } catch (err) {
+    return void 0;
+  }
+}
+function getGlobalFallbackBranch() {
+  try {
+    return XATA_FALLBACK_BRANCH;
+  } catch (err) {
+    return void 0;
+  }
 }
 async function getGitBranch() {
   try {
@@ -55,7 +103,8 @@ async function getGitBranch() {
 
 function getAPIKey() {
   try {
-    return getEnvVariable("XATA_API_KEY") ?? XATA_API_KEY;
+    const { apiKey } = getEnvironment();
+    return apiKey;
   } catch (err) {
     return void 0;
   }
@@ -70,16 +119,28 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-class FetcherError extends Error {
-  constructor(status, data) {
+const VERSION = "0.0.0-alpha.ved669cc";
+
+class ErrorWithCause extends Error {
+  constructor(message, options) {
+    super(message, options);
+  }
+}
+class FetcherError extends ErrorWithCause {
+  constructor(status, data, requestId) {
     super(getMessage(data));
     this.status = status;
     this.errors = isBulkError(data) ? data.errors : void 0;
+    this.requestId = requestId;
     if (data instanceof Error) {
       this.stack = data.stack;
       this.cause = data.cause;
     }
   }
+  toString() {
+    const error = super.toString();
+    return `[${this.status}] (${this.requestId ?? "Unknown"}): ${error}`;
+  }
 }
 function isBulkError(error) {
   return isObject(error) && Array.isArray(error.errors);
@@ -102,7 +163,12 @@ function getMessage(data) {
 }
 
 const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
-  const query = new URLSearchParams(queryParams).toString();
+  const cleanQueryParams = Object.entries(queryParams).reduce((acc, [key, value]) => {
+    if (value === void 0 || value === null)
+      return acc;
+    return { ...acc, [key]: value };
+  }, {});
+  const query = new URLSearchParams(cleanQueryParams).toString();
   const queryString = query.length > 0 ? `?${query}` : "";
   return url.replace(/\{\w*\}/g, (key) => pathParams[key.slice(1, -1)]) + queryString;
 };
@@ -142,6 +208,7 @@ async function fetch$1({
     body: body ? JSON.stringify(body) : void 0,
     headers: {
       "Content-Type": "application/json",
+      "User-Agent": `Xata client-ts/${VERSION}`,
       ...headers,
       ...hostHeader(fullUrl),
       Authorization: `Bearer ${apiKey}`
@@ -150,14 +217,15 @@ async function fetch$1({
   if (response.status === 204) {
     return {};
   }
+  const requestId = response.headers?.get("x-request-id") ?? void 0;
   try {
     const jsonResponse = await response.json();
     if (response.ok) {
       return jsonResponse;
     }
-    throw new FetcherError(response.status, jsonResponse);
+    throw new FetcherError(response.status, jsonResponse, requestId);
   } catch (error) {
-    throw new FetcherError(response.status, error);
+    throw new FetcherError(response.status, error, requestId);
   }
 }
 
@@ -477,7 +545,7 @@ var __privateAdd$7 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$6 = (obj, member, value, setter) => {
+var __privateSet$7 = (obj, member, value, setter) => {
   __accessCheck$7(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
@@ -492,7 +560,7 @@ class XataApiClient {
     if (!apiKey) {
       throw new Error("Could not resolve a valid apiKey");
     }
-    __privateSet$6(this, _extraProps, {
+    __privateSet$7(this, _extraProps, {
       apiUrl: getHostUrl(provider, "main"),
       workspacesApiUrl: getHostUrl(provider, "workspaces"),
       fetchImpl: getFetchImplementation(options.fetch),
@@ -681,10 +749,10 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
-  resolveBranch(workspace, dbName, gitBranch) {
+  resolveBranch(workspace, dbName, gitBranch, fallbackBranch) {
     return operationsByTag.database.resolveBranch({
       pathParams: { workspace, dbName },
-      queryParams: { gitBranch },
+      queryParams: { gitBranch, fallbackBranch },
       ...this.extraProps
     });
   }
@@ -929,18 +997,18 @@ var __privateAdd$6 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$5 = (obj, member, value, setter) => {
+var __privateSet$6 = (obj, member, value, setter) => {
   __accessCheck$6(obj, member, "write to private field");
   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);
+    __privateSet$6(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 +1028,50 @@ 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(..._RecordArray.parseConstructorParams(page, overrideRecords));
+    __privateAdd$6(this, _page, void 0);
+    __privateSet$6(this, _page, page);
+  }
+  static parseConstructorParams(...args) {
+    if (args.length === 1 && typeof args[0] === "number") {
+      return new Array(args[0]);
+    }
+    if (args.length <= 2 && isObject(args[0]?.meta) && Array.isArray(args[1] ?? [])) {
+      const result = args[1] ?? args[0].records ?? [];
+      return new Array(...result);
+    }
+    return new Array(...args);
+  }
+  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))
@@ -977,25 +1086,26 @@ var __privateAdd$5 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$4 = (obj, member, value, setter) => {
+var __privateSet$5 = (obj, member, value, setter) => {
   __accessCheck$5(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
 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 = [];
-    __privateSet$4(this, _table$1, table);
+    this.records = new RecordArray(this, []);
+    __privateSet$5(this, _table$1, table);
     if (repository) {
-      __privateSet$4(this, _repository, repository);
+      __privateSet$5(this, _repository, repository);
     } else {
-      __privateSet$4(this, _repository, this);
+      __privateSet$5(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 +1177,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 +1228,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) {
@@ -1159,7 +1280,7 @@ var __privateAdd$4 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$3 = (obj, member, value, setter) => {
+var __privateSet$4 = (obj, member, value, setter) => {
   __accessCheck$4(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
@@ -1168,7 +1289,7 @@ var __privateMethod$2 = (obj, member, method) => {
   __accessCheck$4(obj, member, "access private method");
   return method;
 };
-var _table, _getFetchProps, _cache, _schema$1, _insertRecordWithoutId, insertRecordWithoutId_fn, _insertRecordWithId, insertRecordWithId_fn, _bulkInsertTableRecords, bulkInsertTableRecords_fn, _updateRecordWithID, updateRecordWithID_fn, _upsertRecordWithID, upsertRecordWithID_fn, _deleteRecord, deleteRecord_fn, _invalidateCache, invalidateCache_fn, _setCacheRecord, setCacheRecord_fn, _getCacheRecord, getCacheRecord_fn, _setCacheQuery, setCacheQuery_fn, _getCacheQuery, getCacheQuery_fn, _getSchema$1, getSchema_fn$1;
+var _table, _getFetchProps, _cache, _schemaTables$2, _insertRecordWithoutId, insertRecordWithoutId_fn, _insertRecordWithId, insertRecordWithId_fn, _bulkInsertTableRecords, bulkInsertTableRecords_fn, _updateRecordWithID, updateRecordWithID_fn, _upsertRecordWithID, upsertRecordWithID_fn, _deleteRecord, deleteRecord_fn, _invalidateCache, invalidateCache_fn, _setCacheRecord, setCacheRecord_fn, _getCacheRecord, getCacheRecord_fn, _setCacheQuery, setCacheQuery_fn, _getCacheQuery, getCacheQuery_fn, _getSchemaTables$1, getSchemaTables_fn$1;
 class Repository extends Query {
 }
 class RestRepository extends Query {
@@ -1185,18 +1306,21 @@ class RestRepository extends Query {
     __privateAdd$4(this, _getCacheRecord);
     __privateAdd$4(this, _setCacheQuery);
     __privateAdd$4(this, _getCacheQuery);
-    __privateAdd$4(this, _getSchema$1);
+    __privateAdd$4(this, _getSchemaTables$1);
     __privateAdd$4(this, _table, void 0);
     __privateAdd$4(this, _getFetchProps, void 0);
     __privateAdd$4(this, _cache, void 0);
-    __privateAdd$4(this, _schema$1, void 0);
-    __privateSet$3(this, _table, options.table);
-    __privateSet$3(this, _getFetchProps, options.pluginOptions.getFetchProps);
+    __privateAdd$4(this, _schemaTables$2, void 0);
+    __privateSet$4(this, _table, options.table);
+    __privateSet$4(this, _getFetchProps, options.pluginOptions.getFetchProps);
     this.db = options.db;
-    __privateSet$3(this, _cache, options.pluginOptions.cache);
+    __privateSet$4(this, _cache, options.pluginOptions.cache);
+    __privateSet$4(this, _schemaTables$2, options.schemaTables);
   }
   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 +1346,38 @@ 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 [];
+      const ids = a.map((item) => isString(item) ? item : item.id).filter((id2) => isString(id2));
+      return this.getAll({ filter: { id: { $any: ids } } });
+    }
+    const id = isString(a) ? a : a.id;
+    if (isString(id)) {
+      const cacheRecord = await __privateMethod$2(this, _getCacheRecord, getCacheRecord_fn).call(this, id);
+      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: id },
+          ...fetchProps
+        });
+        const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
+        return initObject(this.db, schemaTables, __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 +1399,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 +1422,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,12 +1449,13 @@ class RestRepository extends Query {
       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);
-    return records.map((item) => initObject(this.db, schema, __privateGet$4(this, _table), item));
+    const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
+    return records.map((item) => initObject(this.db, schemaTables, __privateGet$4(this, _table), item));
   }
   async query(query) {
     const cacheQuery = await __privateMethod$2(this, _getCacheQuery, getCacheQuery_fn).call(this, query);
@@ -1334,8 +1474,8 @@ class RestRepository extends Query {
       body,
       ...fetchProps
     });
-    const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
-    const records = objects.map((record) => initObject(this.db, schema, __privateGet$4(this, _table), record));
+    const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
+    const records = objects.map((record) => initObject(this.db, schemaTables, __privateGet$4(this, _table), record));
     await __privateMethod$2(this, _setCacheQuery, setCacheQuery_fn).call(this, query, meta, records);
     return new Page(query, meta, records);
   }
@@ -1343,7 +1483,7 @@ class RestRepository extends Query {
 _table = new WeakMap();
 _getFetchProps = new WeakMap();
 _cache = new WeakMap();
-_schema$1 = new WeakMap();
+_schemaTables$2 = new WeakMap();
 _insertRecordWithoutId = new WeakSet();
 insertRecordWithoutId_fn = async function(object) {
   const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
@@ -1388,16 +1528,20 @@ _bulkInsertTableRecords = new WeakSet();
 bulkInsertTableRecords_fn = async function(objects) {
   const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
   const records = objects.map((object) => transformObjectLinks(object));
-  const response = await bulkInsertTableRecords({
+  const { recordIDs } = await bulkInsertTableRecords({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table) },
     body: { records },
     ...fetchProps
   });
-  const finalObjects = await this.any(...response.recordIDs.map((id) => this.filter("id", id))).getAll();
+  const finalObjects = await this.read(recordIDs);
   if (finalObjects.length !== objects.length) {
     throw new Error("The server failed to save some records");
   }
-  return finalObjects;
+  const dictionary = finalObjects.reduce((acc, object) => {
+    acc[object.id] = object;
+    return acc;
+  }, {});
+  return recordIDs.map((id) => dictionary[id]);
 };
 _updateRecordWithID = new WeakSet();
 updateRecordWithID_fn = async function(recordId, object) {
@@ -1473,17 +1617,17 @@ getCacheQuery_fn = async function(query) {
   const hasExpired = result.date.getTime() + ttl < Date.now();
   return hasExpired ? null : result;
 };
-_getSchema$1 = new WeakSet();
-getSchema_fn$1 = async function() {
-  if (__privateGet$4(this, _schema$1))
-    return __privateGet$4(this, _schema$1);
+_getSchemaTables$1 = new WeakSet();
+getSchemaTables_fn$1 = async function() {
+  if (__privateGet$4(this, _schemaTables$2))
+    return __privateGet$4(this, _schemaTables$2);
   const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
   const { schema } = await getBranchDetails({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}" },
     ...fetchProps
   });
-  __privateSet$3(this, _schema$1, schema);
-  return schema;
+  __privateSet$4(this, _schemaTables$2, schema.tables);
+  return schema.tables;
 };
 const transformObjectLinks = (object) => {
   return Object.entries(object).reduce((acc, [key, value]) => {
@@ -1492,20 +1636,21 @@ const transformObjectLinks = (object) => {
     return { ...acc, [key]: isIdentifiable(value) ? value.id : value };
   }, {});
 };
-const initObject = (db, schema, table, object) => {
+const initObject = (db, schemaTables, table, object) => {
   const result = {};
-  Object.assign(result, object);
-  const { columns } = schema.tables.find(({ name }) => name === table) ?? {};
+  const { xata, ...rest } = object ?? {};
+  Object.assign(result, rest);
+  const { columns } = schemaTables.find(({ name }) => name === table) ?? {};
   if (!columns)
     console.error(`Table ${table} not found in schema`);
   for (const column of columns ?? []) {
     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;
@@ -1515,7 +1660,7 @@ const initObject = (db, schema, table, object) => {
         if (!linkTable) {
           console.error(`Failed to parse link for field ${column.name}`);
         } else if (isObject(value)) {
-          result[column.name] = initObject(db, schema, linkTable, value);
+          result[column.name] = initObject(db, schemaTables, linkTable, value);
         }
         break;
       }
@@ -1530,7 +1675,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);
@@ -1559,7 +1707,7 @@ var __privateAdd$3 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$2 = (obj, member, value, setter) => {
+var __privateSet$3 = (obj, member, value, setter) => {
   __accessCheck$3(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
@@ -1568,7 +1716,7 @@ var _map;
 class SimpleCache {
   constructor(options = {}) {
     __privateAdd$3(this, _map, void 0);
-    __privateSet$2(this, _map, /* @__PURE__ */ new Map());
+    __privateSet$3(this, _map, /* @__PURE__ */ new Map());
     this.capacity = options.max ?? 500;
     this.cacheRecords = options.cacheRecords ?? true;
     this.defaultQueryTTL = options.defaultQueryTTL ?? 60 * 1e3;
@@ -1628,12 +1776,18 @@ var __privateAdd$2 = (obj, member, value) => {
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var _tables;
+var __privateSet$2 = (obj, member, value, setter) => {
+  __accessCheck$2(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var _tables, _schemaTables$1;
 class SchemaPlugin extends XataPlugin {
-  constructor(tableNames) {
+  constructor(schemaTables) {
     super();
-    this.tableNames = tableNames;
     __privateAdd$2(this, _tables, {});
+    __privateAdd$2(this, _schemaTables$1, void 0);
+    __privateSet$2(this, _schemaTables$1, schemaTables);
   }
   build(pluginOptions) {
     const db = new Proxy({}, {
@@ -1646,13 +1800,15 @@ class SchemaPlugin extends XataPlugin {
         return __privateGet$2(this, _tables)[table];
       }
     });
-    for (const table of this.tableNames ?? []) {
-      db[table] = new RestRepository({ db, pluginOptions, table });
+    const tableNames = __privateGet$2(this, _schemaTables$1)?.map(({ name }) => name) ?? [];
+    for (const table of tableNames) {
+      db[table] = new RestRepository({ db, pluginOptions, table, schemaTables: __privateGet$2(this, _schemaTables$1) });
     }
     return db;
   }
 }
 _tables = new WeakMap();
+_schemaTables$1 = new WeakMap();
 
 var __accessCheck$1 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -1676,80 +1832,75 @@ var __privateMethod$1 = (obj, member, method) => {
   __accessCheck$1(obj, member, "access private method");
   return method;
 };
-var _schema, _search, search_fn, _getSchema, getSchema_fn;
+var _schemaTables, _search, search_fn, _getSchemaTables, getSchemaTables_fn;
 class SearchPlugin extends XataPlugin {
-  constructor(db) {
+  constructor(db, schemaTables) {
     super();
     this.db = db;
     __privateAdd$1(this, _search);
-    __privateAdd$1(this, _getSchema);
-    __privateAdd$1(this, _schema, void 0);
+    __privateAdd$1(this, _getSchemaTables);
+    __privateAdd$1(this, _schemaTables, void 0);
+    __privateSet$1(this, _schemaTables, schemaTables);
   }
   build({ getFetchProps }) {
     return {
       all: async (query, options = {}) => {
         const records = await __privateMethod$1(this, _search, search_fn).call(this, query, options, getFetchProps);
-        const schema = await __privateMethod$1(this, _getSchema, getSchema_fn).call(this, getFetchProps);
+        const schemaTables = await __privateMethod$1(this, _getSchemaTables, getSchemaTables_fn).call(this, getFetchProps);
         return records.map((record) => {
           const { table = "orphan" } = record.xata;
-          return { table, record: initObject(this.db, schema, table, record) };
+          return { table, record: initObject(this.db, schemaTables, table, record) };
         });
       },
       byTable: async (query, options = {}) => {
         const records = await __privateMethod$1(this, _search, search_fn).call(this, query, options, getFetchProps);
-        const schema = await __privateMethod$1(this, _getSchema, getSchema_fn).call(this, getFetchProps);
+        const schemaTables = await __privateMethod$1(this, _getSchemaTables, getSchemaTables_fn).call(this, getFetchProps);
         return records.reduce((acc, record) => {
           const { table = "orphan" } = record.xata;
           const items = acc[table] ?? [];
-          const item = initObject(this.db, schema, table, record);
+          const item = initObject(this.db, schemaTables, table, record);
           return { ...acc, [table]: [...items, item] };
         }, {});
       }
     };
   }
 }
-_schema = new WeakMap();
+_schemaTables = 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;
 };
-_getSchema = new WeakSet();
-getSchema_fn = async function(getFetchProps) {
-  if (__privateGet$1(this, _schema))
-    return __privateGet$1(this, _schema);
+_getSchemaTables = new WeakSet();
+getSchemaTables_fn = async function(getFetchProps) {
+  if (__privateGet$1(this, _schemaTables))
+    return __privateGet$1(this, _schemaTables);
   const fetchProps = await getFetchProps();
   const { schema } = await getBranchDetails({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}" },
     ...fetchProps
   });
-  __privateSet$1(this, _schema, schema);
-  return schema;
+  __privateSet$1(this, _schemaTables, schema.tables);
+  return schema.tables;
 };
 
 const isBranchStrategyBuilder = (strategy) => {
   return typeof strategy === "function";
 };
 
-const envBranchNames = [
-  "XATA_BRANCH",
-  "VERCEL_GIT_COMMIT_REF",
-  "CF_PAGES_BRANCH",
-  "BRANCH"
-];
 async function getCurrentBranchName(options) {
-  const env = getBranchByEnvVariable();
-  if (env) {
-    const details = await getDatabaseBranch(env, options);
+  const { branch } = getEnvironment();
+  if (branch) {
+    const details = await getDatabaseBranch(branch, options);
     if (details)
-      return env;
-    console.warn(`Branch ${env} not found in Xata. Ignoring...`);
+      return branch;
+    console.warn(`Branch ${branch} not found in Xata. Ignoring...`);
   }
   const gitBranch = await getGitBranch();
   return resolveXataBranch(gitBranch, options);
@@ -1767,13 +1918,14 @@ async function resolveXataBranch(gitBranch, options) {
     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 { fallbackBranch } = getEnvironment();
   const { branch } = await resolveBranch({
     apiKey,
     apiUrl: databaseURL,
     fetchImpl: getFetchImplementation(options?.fetchImpl),
     workspacesApiUrl: `${protocol}//${host}`,
     pathParams: { dbName, workspace },
-    queryParams: { gitBranch, fallbackBranch: getEnvVariable("XATA_FALLBACK_BRANCH") }
+    queryParams: { gitBranch, fallbackBranch }
   });
   return branch;
 }
@@ -1793,10 +1945,7 @@ async function getDatabaseBranch(branch, options) {
       apiUrl: databaseURL,
       fetchImpl: getFetchImplementation(options?.fetchImpl),
       workspacesApiUrl: `${protocol}//${host}`,
-      pathParams: {
-        dbBranchName,
-        workspace
-      }
+      pathParams: { dbBranchName, workspace }
     });
   } catch (err) {
     if (isObject(err) && err.status === 404)
@@ -1804,21 +1953,10 @@ async function getDatabaseBranch(branch, options) {
     throw err;
   }
 }
-function getBranchByEnvVariable() {
-  for (const name of envBranchNames) {
-    const value = getEnvVariable(name);
-    if (value) {
-      return value;
-    }
-  }
-  try {
-    return XATA_BRANCH;
-  } catch (err) {
-  }
-}
 function getDatabaseURL() {
   try {
-    return getEnvVariable("XATA_DATABASE_URL") ?? XATA_DATABASE_URL;
+    const { databaseURL } = getEnvironment();
+    return databaseURL;
   } catch (err) {
     return void 0;
   }
@@ -1849,7 +1987,7 @@ var __privateMethod = (obj, member, method) => {
 const buildClient = (plugins) => {
   var _branch, _parseOptions, parseOptions_fn, _getFetchProps, getFetchProps_fn, _evaluateBranch, evaluateBranch_fn, _a;
   return _a = class {
-    constructor(options = {}, tables) {
+    constructor(options = {}, schemaTables) {
       __privateAdd(this, _parseOptions);
       __privateAdd(this, _getFetchProps);
       __privateAdd(this, _evaluateBranch);
@@ -1859,8 +1997,8 @@ const buildClient = (plugins) => {
         getFetchProps: () => __privateMethod(this, _getFetchProps, getFetchProps_fn).call(this, safeOptions),
         cache: safeOptions.cache
       };
-      const db = new SchemaPlugin(tables).build(pluginOptions);
-      const search = new SearchPlugin(db).build(pluginOptions);
+      const db = new SchemaPlugin(schemaTables).build(pluginOptions);
+      const search = new SearchPlugin(db, schemaTables).build(pluginOptions);
       this.db = db;
       this.search = search;
       for (const [key, namespace] of Object.entries(plugins ?? {})) {
@@ -1933,5 +2071,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