@xata.io/client 0.17.1 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @xata.io/client
 
+## 0.18.0
+
+### Minor Changes
+
+- [#562](https://github.com/xataio/client-ts/pull/562) [`699beb4`](https://github.com/xataio/client-ts/commit/699beb4bbf21cffa001d3f88a03246980e30250b) Thanks [@SferaDev](https://github.com/SferaDev)! - Return null on nullable columns
+
+### Patch Changes
+
+- [#583](https://github.com/xataio/client-ts/pull/583) [`330b076`](https://github.com/xataio/client-ts/commit/330b076a0781e3576c82afab76e3fb2a64f2e041) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for unique columns
+
+- [#598](https://github.com/xataio/client-ts/pull/598) [`c3dfb4b`](https://github.com/xataio/client-ts/commit/c3dfb4babc990634b9e9747616ed93223178a2e7) Thanks [@SferaDev](https://github.com/SferaDev)! - API: Add patch database metadata endpoint
+
+- [#602](https://github.com/xataio/client-ts/pull/602) [`74b17aa`](https://github.com/xataio/client-ts/commit/74b17aaedc0dbdd79bfdcb182b2e70b61f98f5a5) Thanks [@gimenete](https://github.com/gimenete)! - API: Make workspace slug optional on create
+
+- [#615](https://github.com/xataio/client-ts/pull/615) [`83f20cd`](https://github.com/xataio/client-ts/commit/83f20cdbe53706c16016c4db3f318e679b24ec86) Thanks [@SferaDev](https://github.com/SferaDev)! - Make `getMany` return more items than max pagination size
+
+- [#562](https://github.com/xataio/client-ts/pull/562) [`addfcc6`](https://github.com/xataio/client-ts/commit/addfcc67fca663defdd340111ea09c9188bad3ab) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `orThrows` methods that instead of returning null, throw an exception.
+
+- [#583](https://github.com/xataio/client-ts/pull/583) [`eb7ba59`](https://github.com/xataio/client-ts/commit/eb7ba594be2a1f0ab90956836bbeb912e188a46d) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for non nullable columns
+
+- [#612](https://github.com/xataio/client-ts/pull/612) [`f1a0742`](https://github.com/xataio/client-ts/commit/f1a0742a04e1aefab14f46371a04a41069faec01) Thanks [@xata-bot](https://github.com/xata-bot)! - API: Add summarize table endpoint
+
 ## 0.17.1
 
 ### Patch Changes

package/README.md

@@ -246,7 +246,7 @@ const api = new XataApiClient({ apiKey: process.env.XATA_API_KEY });
 Once you have initialized the API client, the operations are organized following the same hiearchy as in the [official documentation](https://docs.xata.io). You have different namespaces for each entity (ie. `workspaces`, `databases`, `tables`, `branches`, `users`, `records`...).
 
 ```ts
-const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example', slug: 'example' });
+const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
 const { databaseName } = await api.databases.createDatabase(workspace, 'database');
 
 await api.branches.createBranch(workspace, databaseName, 'branch');

package/Usage.md

@@ -41,6 +41,8 @@ To get a collection of records, you can use the `Query` object. It provides the
 - `getAll()`: returns all the records in the query results by making multiple requests to iterate over all the pages which exist. If the query is not filtered and the table is a large dataset, this operation can affect the performance.
 - `getMany()`: returns an array with a subset of the first results in the query. The default [pagination](#page) size (20) is used and can be customised by passing a different `{ pagination: { size: number } }` in its options. To learn more about default values, see [helper variables](#helper-variables).
 
+Both the `getAll()` and `getMany()` will produce multiple requests to the server if the query should return more than the maximum page size. We perform the minimum number of requests to get the desired number of records.
+
 All these methods allow customising its filters, column selection, column ordering, pagination or cache TTL. For example:
 
 ```ts

package/dist/index.cjs

@@ -172,7 +172,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.17.1";
+const VERSION = "0.18.0";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -408,6 +408,7 @@ const getDatabaseMetadata = (variables) => fetch$1({
   method: "get",
   ...variables
 });
+const updateDatabaseMetadata = (variables) => fetch$1({ url: "/dbs/{dbName}/metadata", method: "patch", ...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 });
@@ -551,6 +552,11 @@ const searchBranch = (variables) => fetch$1({
   method: "post",
   ...variables
 });
+const summarizeTable = (variables) => fetch$1({
+  url: "/db/{dbBranchName}/tables/{tableName}/summarize",
+  method: "post",
+  ...variables
+});
 const operationsByTag = {
   users: { getUser, updateUser, deleteUser, getUserAPIKeys, createUserAPIKey, deleteUserAPIKey },
   workspaces: {
@@ -573,6 +579,7 @@ const operationsByTag = {
     createDatabase,
     deleteDatabase,
     getDatabaseMetadata,
+    updateDatabaseMetadata,
     getGitBranchesMapping,
     addGitBranchesEntry,
     removeGitBranchesEntry,
@@ -630,7 +637,8 @@ const operationsByTag = {
     bulkInsertTableRecords,
     queryTable,
     searchTable,
-    searchBranch
+    searchBranch,
+    summarizeTable
   }
 };
 
@@ -881,6 +889,13 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
+  updateDatabaseMetadata(workspace, dbName, options = {}) {
+    return operationsByTag.database.updateDatabaseMetadata({
+      pathParams: { workspace, dbName },
+      body: options,
+      ...this.extraProps
+    });
+  }
   getGitBranchesMapping(workspace, dbName) {
     return operationsByTag.database.getGitBranchesMapping({
       pathParams: { workspace, dbName },
@@ -1107,6 +1122,13 @@ class RecordsApi {
       ...this.extraProps
     });
   }
+  summarizeTable(workspace, database, branch, tableName, query) {
+    return operationsByTag.records.summarizeTable({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}`, tableName },
+      body: query,
+      ...this.extraProps
+    });
+  }
 }
 class MigrationRequestsApi {
   constructor(extraProps) {
@@ -1466,11 +1488,20 @@ const _Query = class {
     }
   }
   async getMany(options = {}) {
-    const page = await this.getPaginated(options);
+    const { pagination = {}, ...rest } = options;
+    const { size = PAGINATION_DEFAULT_SIZE, offset } = pagination;
+    const batchSize = size <= PAGINATION_MAX_SIZE ? size : PAGINATION_MAX_SIZE;
+    let page = await this.getPaginated({ ...rest, pagination: { size: batchSize, offset } });
+    const results = [...page.records];
+    while (page.hasNextPage() && results.length < size) {
+      page = await page.nextPage();
+      results.push(...page.records);
+    }
     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;
+    const array = new RecordArray(page, results.slice(0, size));
+    return array;
   }
   async getAll(options = {}) {
     const { batchSize = PAGINATION_MAX_SIZE, ...rest } = options;
@@ -1484,6 +1515,12 @@ const _Query = class {
     const records = await this.getMany({ ...options, pagination: { size: 1 } });
     return records[0] ?? null;
   }
+  async getFirstOrThrow(options = {}) {
+    const records = await this.getMany({ ...options, pagination: { size: 1 } });
+    if (records[0] === void 0)
+      throw new Error("No results found.");
+    return records[0];
+  }
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
@@ -1675,6 +1712,25 @@ class RestRepository extends Query {
       return null;
     });
   }
+  async readOrThrow(a, b) {
+    return __privateGet$4(this, _trace).call(this, "readOrThrow", async () => {
+      const result = await this.read(a, b);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      }
+      if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async update(a, b, c) {
     return __privateGet$4(this, _trace).call(this, "update", async () => {
       if (Array.isArray(a)) {
@@ -1697,6 +1753,25 @@ class RestRepository extends Query {
       throw new Error("Invalid arguments for update method");
     });
   }
+  async updateOrThrow(a, b, c) {
+    return __privateGet$4(this, _trace).call(this, "updateOrThrow", async () => {
+      const result = await this.update(a, b, c);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      }
+      if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async createOrUpdate(a, b, c) {
     return __privateGet$4(this, _trace).call(this, "createOrUpdate", async () => {
       if (Array.isArray(a)) {
@@ -1738,6 +1813,24 @@ class RestRepository extends Query {
       throw new Error("Invalid arguments for delete method");
     });
   }
+  async deleteOrThrow(a, b) {
+    return __privateGet$4(this, _trace).call(this, "deleteOrThrow", async () => {
+      const result = await this.delete(a, b);
+      if (Array.isArray(result)) {
+        const missingIds = compact(
+          a.filter((_item, index) => result[index] === null).map((item) => extractId(item))
+        );
+        if (missingIds.length > 0) {
+          throw new Error(`Could not find records with ids: ${missingIds.join(", ")}`);
+        }
+        return result;
+      } else if (result === null) {
+        const id = extractId(a) ?? "unknown";
+        throw new Error(`Record with id ${id} not found`);
+      }
+      return result;
+    });
+  }
   async search(query, options = {}) {
     return __privateGet$4(this, _trace).call(this, "search", async () => {
       const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
@@ -1949,9 +2042,17 @@ const initObject = (db, schemaTables, table, object) => {
           console.error(`Failed to parse link for field ${column.name}`);
         } else if (isObject(value)) {
           result[column.name] = initObject(db, schemaTables, linkTable, value);
+        } else {
+          result[column.name] = null;
         }
         break;
       }
+      default:
+        result[column.name] = value ?? null;
+        if (column.notNull === true && value === null) {
+          console.error(`Parse error, column ${column.name} is non nullable and value resolves null`);
+        }
+        break;
     }
   }
   result.read = function(columns2) {
@@ -2591,9 +2692,11 @@ exports.searchTable = searchTable;
 exports.serialize = serialize;
 exports.setTableSchema = setTableSchema;
 exports.startsWith = startsWith;
+exports.summarizeTable = summarizeTable;
 exports.updateBranchMetadata = updateBranchMetadata;
 exports.updateBranchSchema = updateBranchSchema;
 exports.updateColumn = updateColumn;
+exports.updateDatabaseMetadata = updateDatabaseMetadata;
 exports.updateMigrationRequest = updateMigrationRequest;
 exports.updateRecordWithID = updateRecordWithID;
 exports.updateTable = updateTable;