@xata.io/client 0.16.0 → 0.16.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @xata.io/client
 
+## 0.16.1
+
+### Patch Changes
+
+- [#531](https://github.com/xataio/client-ts/pull/531) [`e33d8fb`](https://github.com/xataio/client-ts/commit/e33d8fbca264d3ab1597ed698d5e79484dcba8a3) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new method to list database metadata in the API client
+
+* [#524](https://github.com/xataio/client-ts/pull/524) [`a3b1044`](https://github.com/xataio/client-ts/commit/a3b1044038c4ae73b4aacaa112818e69b7d380e1) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose internal config information
+
+- [#525](https://github.com/xataio/client-ts/pull/525) [`5f0f2c2`](https://github.com/xataio/client-ts/commit/5f0f2c2bb42da360e810f0a61ce360f8f8b07a04) Thanks [@xata-bot](https://github.com/xata-bot)! - Update dependencies
+
 ## 0.16.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -143,12 +143,14 @@ function getFetchImplementation(userFetch) {
   const globalFetch = typeof fetch !== "undefined" ? fetch : void 0;
   const fetchImpl = userFetch ?? globalFetch;
   if (!fetchImpl) {
-    throw new Error(`The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.`);
+    throw new Error(
+      `The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.`
+    );
   }
   return fetchImpl;
 }
 
-const VERSION = "0.16.0";
+const VERSION = "0.16.1";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -349,6 +351,11 @@ const deleteDatabase = (variables) => fetch$1({
   method: "delete",
   ...variables
 });
+const getDatabaseMetadata = (variables) => fetch$1({
+  url: "/dbs/{dbName}/metadata",
+  method: "get",
+  ...variables
+});
 const getGitBranchesMapping = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "get", ...variables });
 const addGitBranchesEntry = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "post", ...variables });
 const removeGitBranchesEntry = (variables) => fetch$1({ url: "/dbs/{dbName}/gitBranches", method: "delete", ...variables });
@@ -487,6 +494,7 @@ const operationsByTag = {
     getDatabaseList,
     createDatabase,
     deleteDatabase,
+    getDatabaseMetadata,
     getGitBranchesMapping,
     addGitBranchesEntry,
     removeGitBranchesEntry,
@@ -759,6 +767,12 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
+  getDatabaseMetadata(workspace, dbName) {
+    return operationsByTag.database.getDatabaseMetadata({
+      pathParams: { workspace, dbName },
+      ...this.extraProps
+    });
+  }
   getGitBranchesMapping(workspace, dbName) {
     return operationsByTag.database.getGitBranchesMapping({
       pathParams: { workspace, dbName },
@@ -1204,7 +1218,12 @@ const _Query = class {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { sort }, __privateGet$5(this, _data));
   }
   select(columns) {
-    return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { columns }, __privateGet$5(this, _data));
+    return new _Query(
+      __privateGet$5(this, _repository),
+      __privateGet$5(this, _table$1),
+      { columns },
+      __privateGet$5(this, _data)
+    );
   }
   getPaginated(options = {}) {
     const query = new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), options, __privateGet$5(this, _data));
@@ -1329,7 +1348,7 @@ var __privateMethod$2 = (obj, member, method) => {
   __accessCheck$4(obj, member, "access private method");
   return method;
 };
-var _table, _getFetchProps, _cache, _schemaTables$2, _insertRecordWithoutId, insertRecordWithoutId_fn, _insertRecordWithId, insertRecordWithId_fn, _bulkInsertTableRecords, bulkInsertTableRecords_fn, _updateRecordWithID, updateRecordWithID_fn, _upsertRecordWithID, upsertRecordWithID_fn, _deleteRecord, deleteRecord_fn, _setCacheQuery, setCacheQuery_fn, _getCacheQuery, getCacheQuery_fn, _getSchemaTables$1, getSchemaTables_fn$1;
+var _table, _getFetchProps, _db, _cache, _schemaTables$2, _insertRecordWithoutId, insertRecordWithoutId_fn, _insertRecordWithId, insertRecordWithId_fn, _bulkInsertTableRecords, bulkInsertTableRecords_fn, _updateRecordWithID, updateRecordWithID_fn, _upsertRecordWithID, upsertRecordWithID_fn, _deleteRecord, deleteRecord_fn, _setCacheQuery, setCacheQuery_fn, _getCacheQuery, getCacheQuery_fn, _getSchemaTables$1, getSchemaTables_fn$1;
 class Repository extends Query {
 }
 class RestRepository extends Query {
@@ -1346,11 +1365,12 @@ class RestRepository extends Query {
     __privateAdd$4(this, _getSchemaTables$1);
     __privateAdd$4(this, _table, void 0);
     __privateAdd$4(this, _getFetchProps, void 0);
+    __privateAdd$4(this, _db, void 0);
     __privateAdd$4(this, _cache, void 0);
     __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$4(this, _db, options.db);
     __privateSet$4(this, _cache, options.pluginOptions.cache);
     __privateSet$4(this, _schemaTables$2, options.schemaTables);
   }
@@ -1402,7 +1422,7 @@ class RestRepository extends Query {
           ...fetchProps
         });
         const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-        return initObject(this.db, schemaTables, __privateGet$4(this, _table), response);
+        return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
       } catch (e) {
         if (isObject(e) && e.status === 404) {
           return null;
@@ -1487,7 +1507,7 @@ class RestRepository extends Query {
       ...fetchProps
     });
     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));
+    return records.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item));
   }
   async query(query) {
     const cacheQuery = await __privateMethod$2(this, _getCacheQuery, getCacheQuery_fn).call(this, query);
@@ -1507,13 +1527,14 @@ class RestRepository extends Query {
       ...fetchProps
     });
     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));
+    const records = objects.map((record) => initObject(__privateGet$4(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);
   }
 }
 _table = new WeakMap();
 _getFetchProps = new WeakMap();
+_db = new WeakMap();
 _cache = new WeakMap();
 _schemaTables$2 = new WeakMap();
 _insertRecordWithoutId = new WeakSet();
@@ -1531,7 +1552,7 @@ insertRecordWithoutId_fn = async function(object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(this.db, schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
 };
 _insertRecordWithId = new WeakSet();
 insertRecordWithId_fn = async function(recordId, object, columns = ["*"]) {
@@ -1549,7 +1570,7 @@ insertRecordWithId_fn = async function(recordId, object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(this.db, schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
 };
 _bulkInsertTableRecords = new WeakSet();
 bulkInsertTableRecords_fn = async function(objects, columns = ["*"]) {
@@ -1565,7 +1586,7 @@ bulkInsertTableRecords_fn = async function(objects, columns = ["*"]) {
     throw new Error("Request included columns but server didn't include them");
   }
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return response.records?.map((item) => initObject(this.db, schemaTables, __privateGet$4(this, _table), item));
+  return response.records?.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item));
 };
 _updateRecordWithID = new WeakSet();
 updateRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
@@ -1578,7 +1599,7 @@ updateRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(this.db, schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
 };
 _upsertRecordWithID = new WeakSet();
 upsertRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
@@ -1590,7 +1611,7 @@ upsertRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(this.db, schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
 };
 _deleteRecord = new WeakSet();
 deleteRecord_fn = async function(recordId) {
@@ -1782,16 +1803,19 @@ class SchemaPlugin extends XataPlugin {
     __privateSet$2(this, _schemaTables$1, schemaTables);
   }
   build(pluginOptions) {
-    const db = new Proxy({}, {
-      get: (_target, table) => {
-        if (!isString(table))
-          throw new Error("Invalid table name");
-        if (__privateGet$2(this, _tables)[table] === void 0) {
-          __privateGet$2(this, _tables)[table] = new RestRepository({ db, pluginOptions, table, schemaTables: __privateGet$2(this, _schemaTables$1) });
+    const db = new Proxy(
+      {},
+      {
+        get: (_target, table) => {
+          if (!isString(table))
+            throw new Error("Invalid table name");
+          if (__privateGet$2(this, _tables)[table] === void 0) {
+            __privateGet$2(this, _tables)[table] = new RestRepository({ db, pluginOptions, table, schemaTables: __privateGet$2(this, _schemaTables$1) });
+          }
+          return __privateGet$2(this, _tables)[table];
         }
-        return __privateGet$2(this, _tables)[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) });
@@ -1905,9 +1929,13 @@ 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");
+    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");
+    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();
@@ -1925,9 +1953,13 @@ async function getDatabaseBranch(branch, 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");
+    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");
+    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, , database] = databaseURL.split("/");
   const [workspace] = host.split(".");
   const dbBranchName = `${database}:${branch}`;
@@ -1977,14 +2009,16 @@ var __privateMethod = (obj, member, method) => {
   return method;
 };
 const buildClient = (plugins) => {
-  var _branch, _parseOptions, parseOptions_fn, _getFetchProps, getFetchProps_fn, _evaluateBranch, evaluateBranch_fn, _a;
+  var _branch, _options, _parseOptions, parseOptions_fn, _getFetchProps, getFetchProps_fn, _evaluateBranch, evaluateBranch_fn, _a;
   return _a = class {
     constructor(options = {}, schemaTables) {
       __privateAdd(this, _parseOptions);
       __privateAdd(this, _getFetchProps);
       __privateAdd(this, _evaluateBranch);
       __privateAdd(this, _branch, void 0);
+      __privateAdd(this, _options, void 0);
       const safeOptions = __privateMethod(this, _parseOptions, parseOptions_fn).call(this, options);
+      __privateSet(this, _options, safeOptions);
       const pluginOptions = {
         getFetchProps: () => __privateMethod(this, _getFetchProps, getFetchProps_fn).call(this, safeOptions),
         cache: safeOptions.cache
@@ -2006,7 +2040,12 @@ const buildClient = (plugins) => {
         }
       }
     }
-  }, _branch = new WeakMap(), _parseOptions = new WeakSet(), parseOptions_fn = function(options) {
+    async getConfig() {
+      const databaseURL = __privateGet(this, _options).databaseURL;
+      const branch = await __privateGet(this, _options).branch();
+      return { databaseURL, branch };
+    }
+  }, _branch = new WeakMap(), _options = new WeakMap(), _parseOptions = new WeakSet(), parseOptions_fn = function(options) {
     const fetch = getFetchImplementation(options?.fetch);
     const databaseURL = options?.databaseURL || getDatabaseURL();
     const apiKey = options?.apiKey || getAPIKey();
@@ -2016,12 +2055,7 @@ const buildClient = (plugins) => {
       throw new Error("Options databaseURL and apiKey are required");
     }
     return { fetch, databaseURL, apiKey, branch, cache };
-  }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({
-    fetch,
-    apiKey,
-    databaseURL,
-    branch
-  }) {
+  }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({ fetch, apiKey, databaseURL, branch }) {
     const branchValue = await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, branch);
     if (!branchValue)
       throw new Error("Unable to resolve branch value");
@@ -2056,6 +2090,88 @@ const buildClient = (plugins) => {
 class BaseClient extends buildClient() {
 }
 
+const META = "__";
+const VALUE = "___";
+class Serializer {
+  constructor() {
+    this.classes = {};
+  }
+  add(clazz) {
+    this.classes[clazz.name] = clazz;
+  }
+  toJSON(data) {
+    function visit(obj) {
+      if (Array.isArray(obj))
+        return obj.map(visit);
+      const type = typeof obj;
+      if (type === "undefined")
+        return { [META]: "undefined" };
+      if (type === "bigint")
+        return { [META]: "bigint", [VALUE]: obj.toString() };
+      if (obj === null || type !== "object")
+        return obj;
+      const constructor = obj.constructor;
+      const o = { [META]: constructor.name };
+      for (const [key, value] of Object.entries(obj)) {
+        o[key] = visit(value);
+      }
+      if (constructor === Date)
+        o[VALUE] = obj.toISOString();
+      if (constructor === Map)
+        o[VALUE] = Object.fromEntries(obj);
+      if (constructor === Set)
+        o[VALUE] = [...obj];
+      return o;
+    }
+    return JSON.stringify(visit(data));
+  }
+  fromJSON(json) {
+    return JSON.parse(json, (key, value) => {
+      if (value && typeof value === "object" && !Array.isArray(value)) {
+        const { [META]: clazz, [VALUE]: val, ...rest } = value;
+        const constructor = this.classes[clazz];
+        if (constructor) {
+          return Object.assign(Object.create(constructor.prototype), rest);
+        }
+        if (clazz === "Date")
+          return new Date(val);
+        if (clazz === "Set")
+          return new Set(val);
+        if (clazz === "Map")
+          return new Map(Object.entries(val));
+        if (clazz === "bigint")
+          return BigInt(val);
+        if (clazz === "undefined")
+          return void 0;
+        return rest;
+      }
+      return value;
+    });
+  }
+}
+const defaultSerializer = new Serializer();
+const serialize = (data) => {
+  return defaultSerializer.toJSON(data);
+};
+const deserialize = (json) => {
+  return defaultSerializer.fromJSON(json);
+};
+
+function buildWorkerRunner(config) {
+  return function xataWorker(name, _worker) {
+    return async (...args) => {
+      const url = process.env.NODE_ENV === "development" ? `http://localhost:64749/${name}` : `https://dispatcher.xata.workers.dev/${config.workspace}/${config.worker}/${name}`;
+      const result = await fetch(url, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: serialize({ args })
+      });
+      const text = await result.text();
+      return deserialize(text);
+    };
+  };
+}
+
 class XataError extends Error {
   constructor(message, status) {
     super(message);
@@ -2076,6 +2192,7 @@ exports.Repository = Repository;
 exports.RestRepository = RestRepository;
 exports.SchemaPlugin = SchemaPlugin;
 exports.SearchPlugin = SearchPlugin;
+exports.Serializer = Serializer;
 exports.SimpleCache = SimpleCache;
 exports.XataApiClient = XataApiClient;
 exports.XataApiPlugin = XataApiPlugin;
@@ -2085,6 +2202,7 @@ exports.acceptWorkspaceMemberInvite = acceptWorkspaceMemberInvite;
 exports.addGitBranchesEntry = addGitBranchesEntry;
 exports.addTableColumn = addTableColumn;
 exports.buildClient = buildClient;
+exports.buildWorkerRunner = buildWorkerRunner;
 exports.bulkInsertTableRecords = bulkInsertTableRecords;
 exports.cancelWorkspaceMemberInvite = cancelWorkspaceMemberInvite;
 exports.contains = contains;
@@ -2101,6 +2219,7 @@ exports.deleteTable = deleteTable;
 exports.deleteUser = deleteUser;
 exports.deleteUserAPIKey = deleteUserAPIKey;
 exports.deleteWorkspace = deleteWorkspace;
+exports.deserialize = deserialize;
 exports.endsWith = endsWith;
 exports.executeBranchMigrationPlan = executeBranchMigrationPlan;
 exports.exists = exists;
@@ -2116,6 +2235,7 @@ exports.getColumn = getColumn;
 exports.getCurrentBranchDetails = getCurrentBranchDetails;
 exports.getCurrentBranchName = getCurrentBranchName;
 exports.getDatabaseList = getDatabaseList;
+exports.getDatabaseMetadata = getDatabaseMetadata;
 exports.getDatabaseURL = getDatabaseURL;
 exports.getGitBranchesMapping = getGitBranchesMapping;
 exports.getRecord = getRecord;
@@ -2153,6 +2273,7 @@ exports.resendWorkspaceMemberInvite = resendWorkspaceMemberInvite;
 exports.resolveBranch = resolveBranch;
 exports.searchBranch = searchBranch;
 exports.searchTable = searchTable;
+exports.serialize = serialize;
 exports.setTableSchema = setTableSchema;
 exports.startsWith = startsWith;
 exports.updateBranchMetadata = updateBranchMetadata;