@xata.io/client 0.18.5 → 0.18.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @xata.io/client
 
+## 0.18.6
+
+### Patch Changes
+
+- [#662](https://github.com/xataio/client-ts/pull/662) [`4a41680`](https://github.com/xataio/client-ts/commit/4a416803761a1c944ef9a76b794020ead6c8f477) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove wildcard columns from sorting and filtering
+
+- [#303](https://github.com/xataio/client-ts/pull/303) [`ad0cccb`](https://github.com/xataio/client-ts/commit/ad0cccb11cd4f9bb4bd7e44672d3375821e700fe) Thanks [@gimenete](https://github.com/gimenete)! - Add profiles for host parsing
+
+- [#662](https://github.com/xataio/client-ts/pull/662) [`e1d6add`](https://github.com/xataio/client-ts/commit/e1d6addf84c55648bc0d908887b6bd020b429801) Thanks [@SferaDev](https://github.com/SferaDev)! - Add aggregations support to the SDK
+
+- [#662](https://github.com/xataio/client-ts/pull/662) [`4a41680`](https://github.com/xataio/client-ts/commit/4a416803761a1c944ef9a76b794020ead6c8f477) Thanks [@SferaDev](https://github.com/SferaDev)! - Add summarize endpoints to SDK
+
 ## 0.18.5
 
 ### Patch Changes

package/dist/index.cjs

@@ -172,7 +172,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.18.5";
+const VERSION = "0.18.6";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -234,7 +234,7 @@ function buildBaseUrl({
   apiUrl,
   pathParams
 }) {
-  if (pathParams?.workspace === void 0)
+  if (pathParams?.workspace === void 0 || !path.startsWith("/db"))
     return `${apiUrl}${path}`;
   const url = typeof workspacesApiUrl === "string" ? `${workspacesApiUrl}${path}` : workspacesApiUrl(path, pathParams);
   return url.replace("{workspaceId}", String(pathParams.workspace));
@@ -256,7 +256,9 @@ async function fetch$1({
   apiUrl,
   workspacesApiUrl,
   trace,
-  signal
+  signal,
+  clientID,
+  sessionID
 }) {
   return trace(
     `${method.toUpperCase()} ${path}`,
@@ -274,6 +276,8 @@ async function fetch$1({
         headers: {
           "Content-Type": "application/json",
           "User-Agent": `Xata client-ts/${VERSION}`,
+          "X-Xata-Client-ID": clientID ?? "",
+          "X-Xata-Session-ID": sessionID ?? "",
           ...headers,
           ...hostHeader(fullUrl),
           Authorization: `Bearer ${apiKey}`
@@ -607,6 +611,29 @@ const summarizeTable = (variables, signal) => fetch$1({
   ...variables,
   signal
 });
+const aggregateTable = (variables, signal) => fetch$1({
+  url: "/db/{dbBranchName}/tables/{tableName}/aggregate",
+  method: "post",
+  ...variables,
+  signal
+});
+const cPGetDatabaseList = (variables, signal) => fetch$1({
+  url: "/workspaces/{workspaceId}/dbs",
+  method: "get",
+  ...variables,
+  signal
+});
+const cPCreateDatabase = (variables, signal) => fetch$1({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "put", ...variables, signal });
+const cPDeleteDatabase = (variables, signal) => fetch$1({
+  url: "/workspaces/{workspaceId}/dbs/{dbName}",
+  method: "delete",
+  ...variables,
+  signal
+});
+const cPGetCPDatabaseMetadata = (variables, signal) => fetch$1(
+  { url: "/workspaces/{workspaceId}/dbs/{dbName}/metadata", method: "get", ...variables, signal }
+);
+const cPUpdateCPDatabaseMetadata = (variables, signal) => fetch$1({ url: "/workspaces/{workspaceId}/dbs/{dbName}/metadata", method: "patch", ...variables, signal });
 const operationsByTag = {
   users: { getUser, updateUser, deleteUser, getUserAPIKeys, createUserAPIKey, deleteUserAPIKey },
   workspaces: {
@@ -688,7 +715,15 @@ const operationsByTag = {
     queryTable,
     searchTable,
     searchBranch,
-    summarizeTable
+    summarizeTable,
+    aggregateTable
+  },
+  databases: {
+    cPGetDatabaseList,
+    cPCreateDatabase,
+    cPDeleteDatabase,
+    cPGetCPDatabaseMetadata,
+    cPUpdateCPDatabaseMetadata
   }
 };
 
@@ -716,6 +751,15 @@ function isHostProviderAlias(alias) {
 function isHostProviderBuilder(builder) {
   return isObject(builder) && isString(builder.main) && isString(builder.workspaces);
 }
+function parseProviderString(provider = "production") {
+  if (isHostProviderAlias(provider)) {
+    return provider;
+  }
+  const [main, workspaces] = provider.split(",");
+  if (!main || !workspaces)
+    return null;
+  return { main, workspaces };
+}
 
 var __accessCheck$7 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -1179,6 +1223,13 @@ class RecordsApi {
       ...this.extraProps
     });
   }
+  aggregateTable(workspace, database, branch, tableName, query) {
+    return operationsByTag.records.aggregateTable({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName },
+      body: query,
+      ...this.extraProps
+    });
+  }
 }
 class MigrationRequestsApi {
   constructor(extraProps) {
@@ -1316,6 +1367,20 @@ class XataApiPlugin {
 class XataPlugin {
 }
 
+function generateUUID() {
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function(c) {
+    const r = Math.random() * 16 | 0, v = c == "x" ? r : r & 3 | 8;
+    return v.toString(16);
+  });
+}
+
+function cleanFilter(filter) {
+  if (!filter)
+    return void 0;
+  const values = Object.values(filter).filter(Boolean).filter((value) => Array.isArray(value) ? value.length > 0 : true);
+  return values.length > 0 ? filter : void 0;
+}
+
 var __accessCheck$6 = (obj, member, msg) => {
   if (!member.has(obj))
     throw TypeError("Cannot " + msg);
@@ -1455,7 +1520,7 @@ const _Query = class {
     __privateGet$5(this, _data).filter.$not = data.filter?.$not ?? parent?.filter?.$not;
     __privateGet$5(this, _data).filter.$none = data.filter?.$none ?? parent?.filter?.$none;
     __privateGet$5(this, _data).sort = data.sort ?? parent?.sort;
-    __privateGet$5(this, _data).columns = data.columns ?? parent?.columns ?? ["*"];
+    __privateGet$5(this, _data).columns = data.columns ?? parent?.columns;
     __privateGet$5(this, _data).pagination = data.pagination ?? parent?.pagination;
     __privateGet$5(this, _data).cache = data.cache ?? parent?.cache;
     this.any = this.any.bind(this);
@@ -1571,6 +1636,16 @@ const _Query = class {
       throw new Error("No results found.");
     return records[0];
   }
+  async summarize(params = {}) {
+    const { summaries, summariesFilter, ...options } = params;
+    const query = new _Query(
+      __privateGet$5(this, _repository),
+      __privateGet$5(this, _table$1),
+      options,
+      __privateGet$5(this, _data)
+    );
+    return __privateGet$5(this, _repository).summarizeTable(query, summaries, summariesFilter);
+  }
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
@@ -1692,10 +1767,13 @@ class RestRepository extends Query {
     __privateAdd$4(this, _schemaTables$2, void 0);
     __privateAdd$4(this, _trace, void 0);
     __privateSet$4(this, _table, options.table);
-    __privateSet$4(this, _getFetchProps, options.pluginOptions.getFetchProps);
     __privateSet$4(this, _db, options.db);
     __privateSet$4(this, _cache, options.pluginOptions.cache);
     __privateSet$4(this, _schemaTables$2, options.schemaTables);
+    __privateSet$4(this, _getFetchProps, async () => {
+      const props = await options.pluginOptions.getFetchProps();
+      return { ...props, sessionID: generateUUID() };
+    });
     const trace = options.pluginOptions.trace ?? defaultTrace;
     __privateSet$4(this, _trace, async (name, fn, options2 = {}) => {
       return trace(name, fn, {
@@ -1911,22 +1989,32 @@ class RestRepository extends Query {
       return records.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item, ["*"]));
     });
   }
+  async aggregate(aggs, filter) {
+    return __privateGet$4(this, _trace).call(this, "aggregate", async () => {
+      const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
+      const result = await aggregateTable({
+        pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table) },
+        body: { aggs, filter },
+        ...fetchProps
+      });
+      return result;
+    });
+  }
   async query(query) {
     return __privateGet$4(this, _trace).call(this, "query", async () => {
       const cacheQuery = await __privateMethod$2(this, _getCacheQuery, getCacheQuery_fn).call(this, query);
       if (cacheQuery)
         return new Page(query, cacheQuery.meta, cacheQuery.records);
       const data = query.getQueryOptions();
-      const body = {
-        filter: cleanFilter(data.filter),
-        sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
-        page: data.pagination,
-        columns: data.columns
-      };
       const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
       const { meta, records: objects } = await queryTable({
         pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table) },
-        body,
+        body: {
+          filter: cleanFilter(data.filter),
+          sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
+          page: data.pagination,
+          columns: data.columns ?? ["*"]
+        },
         ...fetchProps
       });
       const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
@@ -1937,6 +2025,24 @@ class RestRepository extends Query {
       return new Page(query, meta, records);
     });
   }
+  async summarizeTable(query, summaries, summariesFilter) {
+    return __privateGet$4(this, _trace).call(this, "summarize", async () => {
+      const data = query.getQueryOptions();
+      const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
+      const result = await summarizeTable({
+        pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table) },
+        body: {
+          filter: cleanFilter(data.filter),
+          sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
+          columns: data.columns,
+          summaries,
+          summariesFilter
+        },
+        ...fetchProps
+      });
+      return result;
+    });
+  }
 }
 _table = new WeakMap();
 _getFetchProps = new WeakMap();
@@ -2158,12 +2264,6 @@ function extractId(value) {
     return value.id;
   return void 0;
 }
-function cleanFilter(filter) {
-  if (!filter)
-    return void 0;
-  const values = Object.values(filter).filter(Boolean).filter((value) => Array.isArray(value) ? value.length > 0 : true);
-  return values.length > 0 ? filter : void 0;
-}
 function isValidColumn(columns, column) {
   if (columns.includes("*"))
     return true;
@@ -2534,8 +2634,15 @@ const buildClient = (plugins) => {
     if (!databaseURL) {
       throw new Error("Option databaseURL is required");
     }
-    return { fetch, databaseURL, apiKey, branch, cache, trace };
-  }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({ fetch, apiKey, databaseURL, branch, trace }) {
+    return { fetch, databaseURL, apiKey, branch, cache, trace, clientID: generateUUID() };
+  }, _getFetchProps = new WeakSet(), getFetchProps_fn = async function({
+    fetch,
+    apiKey,
+    databaseURL,
+    branch,
+    trace,
+    clientID
+  }) {
     const branchValue = await __privateMethod(this, _evaluateBranch, evaluateBranch_fn).call(this, branch);
     if (!branchValue)
       throw new Error("Unable to resolve branch value");
@@ -2548,7 +2655,8 @@ const buildClient = (plugins) => {
         const newPath = path.replace(/^\/db\/[^/]+/, hasBranch !== void 0 ? `:${branchValue}` : "");
         return databaseURL + newPath;
       },
-      trace
+      trace,
+      clientID
     };
   }, _evaluateBranch = new WeakSet(), evaluateBranch_fn = async function(param) {
     if (__privateGet(this, _branch))
@@ -2682,10 +2790,16 @@ exports.XataPlugin = XataPlugin;
 exports.acceptWorkspaceMemberInvite = acceptWorkspaceMemberInvite;
 exports.addGitBranchesEntry = addGitBranchesEntry;
 exports.addTableColumn = addTableColumn;
+exports.aggregateTable = aggregateTable;
 exports.applyBranchSchemaEdit = applyBranchSchemaEdit;
 exports.buildClient = buildClient;
 exports.buildWorkerRunner = buildWorkerRunner;
 exports.bulkInsertTableRecords = bulkInsertTableRecords;
+exports.cPCreateDatabase = cPCreateDatabase;
+exports.cPDeleteDatabase = cPDeleteDatabase;
+exports.cPGetCPDatabaseMetadata = cPGetCPDatabaseMetadata;
+exports.cPGetDatabaseList = cPGetDatabaseList;
+exports.cPUpdateCPDatabaseMetadata = cPUpdateCPDatabaseMetadata;
 exports.cancelWorkspaceMemberInvite = cancelWorkspaceMemberInvite;
 exports.compareBranchSchemas = compareBranchSchemas;
 exports.compareBranchWithUserSchema = compareBranchWithUserSchema;
@@ -2726,6 +2840,7 @@ exports.getDatabaseList = getDatabaseList;
 exports.getDatabaseMetadata = getDatabaseMetadata;
 exports.getDatabaseURL = getDatabaseURL;
 exports.getGitBranchesMapping = getGitBranchesMapping;
+exports.getHostUrl = getHostUrl;
 exports.getMigrationRequest = getMigrationRequest;
 exports.getMigrationRequestIsMerged = getMigrationRequestIsMerged;
 exports.getRecord = getRecord;
@@ -2750,6 +2865,8 @@ exports.insertRecordWithID = insertRecordWithID;
 exports.inviteWorkspaceMember = inviteWorkspaceMember;
 exports.is = is;
 exports.isCursorPaginationOptions = isCursorPaginationOptions;
+exports.isHostProviderAlias = isHostProviderAlias;
+exports.isHostProviderBuilder = isHostProviderBuilder;
 exports.isIdentifiable = isIdentifiable;
 exports.isNot = isNot;
 exports.isXataRecord = isXataRecord;
@@ -2763,6 +2880,7 @@ exports.lte = lte;
 exports.mergeMigrationRequest = mergeMigrationRequest;
 exports.notExists = notExists;
 exports.operationsByTag = operationsByTag;
+exports.parseProviderString = parseProviderString;
 exports.pattern = pattern;
 exports.previewBranchSchemaEdit = previewBranchSchemaEdit;
 exports.queryMigrationRequests = queryMigrationRequests;