@xata.io/client 0.21.6 → 0.22.1

package/.eslintrc.cjs

@@ -7,6 +7,7 @@ module.exports = {
   },
   rules: {
     '@typescript-eslint/no-floating-promises': 'error',
-    '@typescript-eslint/strict-boolean-expressions': ['error', { allowNullableString: true, allowNullableObject: true }]
+    '@typescript-eslint/strict-boolean-expressions': ['error', { allowNullableString: true, allowNullableObject: true }],
+    "@typescript-eslint/ban-types": "off",
   }
 };

package/.turbo/turbo-add-version.log

@@ -0,0 +1,4 @@
+
+> @xata.io/client@0.22.1 add-version /home/runner/work/client-ts/client-ts/packages/client
+> node ../../scripts/add-version-file.mjs
+

package/.turbo/turbo-build.log

@@ -0,0 +1,13 @@
+
+> @xata.io/client@0.22.1 build /home/runner/work/client-ts/client-ts/packages/client
+> rimraf dist && rollup -c
+
+
+src/index.ts → dist/index.cjs...
+created dist/index.cjs in 1s
+
+src/index.ts → dist/index.mjs...
+created dist/index.mjs in 947ms
+
+src/index.ts → dist/index.d.ts...
+created dist/index.d.ts in 6.6s

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @xata.io/client
 
+## 0.22.1
+
+### Patch Changes
+
+- [#885](https://github.com/xataio/client-ts/pull/885) [`4cafde72`](https://github.com/xataio/client-ts/commit/4cafde728e4e9e5e83812d475d9980397ae78362) Thanks [@SferaDev](https://github.com/SferaDev)! - Update body of compareBranchSchemas
+
+- [#890](https://github.com/xataio/client-ts/pull/890) [`639710a5`](https://github.com/xataio/client-ts/commit/639710a52132f260bf3a26560a21ae2193abb71d) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose consistency settings in summarize
+
+## 0.22.0
+
+### Minor Changes
+
+- [#852](https://github.com/xataio/client-ts/pull/852) [`b2a4def4`](https://github.com/xataio/client-ts/commit/b2a4def4baf3eb18cd323895635e0bccb7f876f4) Thanks [@SferaDev](https://github.com/SferaDev)! - [BREAKING CHANGE] Reduce column selection depth
+
+### Patch Changes
+
+- [#835](https://github.com/xataio/client-ts/pull/835) [`379e6144`](https://github.com/xataio/client-ts/commit/379e61446b21e7cbadd7fc59267736c6845ec566) Thanks [@SferaDev](https://github.com/SferaDev)! - Add helper methods `toSerializable` and `toString`
+
 ## 0.21.6
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,273 +1,7 @@
 # Xata SDK for TypeScript and JavaScript
 
-This SDK has zero dependencies, so it can be used in many JavaScript runtimes including Node.js, Cloudflare workers, Deno, Electron, etc. It also works in browsers for the same reason. But this is strongly discouraged because you can easily leak your API keys from browsers.
+The Xata SDK supports typescript definitions for your Xata database schema. It also works with JavaScript.
 
-## Table of Contents
+It has zero dependencies and runs in Node.js, V8, Deno and Bun.
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Schema-generated Client](#schema-generated-client)
-  - [Schema-less Client](#schema-less-client)
-  - [API Design](#api-design)
-    - [Creating Records](#creating-records)
-    - [Query a Single Record by its ID](#query-a-single-record-by-its-id)
-    - [Querying Multiple Records](#querying-multiple-records)
-    - [Updating Records](#updating-records)
-    - [Deleting Records](#deleting-records)
-  - [API Client](#api-client)
-- [Deno support](#deno-support)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Installation
-
-```bash
-npm install @xata.io/client
-```
-
-## Usage
-
-There are three ways to use the SDK:
-
-- **Schema-generated Client**: SDK to create/read/update/delete records in a given database following a schema file (with type-safety).
-- **Schema-less Client**: SDK to create/read/update/delete records in any database without schema validation (with partial type-safety).
-- **API Client**: SDK to interact with the whole Xata API and all its endpoints.
-
-### Schema-generated Client
-
-To use the schema-generated client, you need to run the code generator utility that comes with [our CLI](https://docs.xata.io/cli/getting-started).
-
-To run it (and assuming you have configured the project with `xata init`):
-
-```bash
-xata codegen
-```
-
-In a TypeScript file, start using the generated code like this:
-
-```ts
-import { XataClient } from './xata'; // or wherever you chose to generate the client
-
-const xata = new XataClient();
-```
-
-The import above will differ if you chose to generate the code in a different location.
-
-The `XataClient` constructor accepts an object with configuration options, like the `fetch` parameter, which is required only if your runtime doesn't provide a global `fetch` function. There's also a `databaseURL` argument that by default will contain a URL pointing to your database (e.g. `https://myworkspace-123abc.xata.sh/db/databasename`). It can be specified in the constructor to overwrite that value if for whatever reason you need to connect to a different workspace or database.
-
-The code generator will create two TypeScript types for each schema entity. The base one will be an `Identifiable` entity with the internal properties your entity has and the `Record` one will extend it with a set of operations (update, delete, etc...) and some schema metadata (xata version).
-
-```ts
-interface User extends Identifiable {
-  email?: string | null;
-}
-
-type UserRecord = User & XataRecord;
-
-async function initializeDatabase(admin: User): Promise<UserRecord> {
-  return xata.db.users.create(admin);
-}
-
-const admin = await initializeDatabase({ email: 'admin@example.com' });
-await admin.update({ email: 'admin@foo.bar' });
-await admin.delete();
-```
-
-You will learn more about the available operations below, under the [`API Design`](#api-design) section.
-
-### Schema-less Client
-
-If you don't have a schema file, or you are building a generic way to interact with Xata, you can use the `BaseClient` class without schema validation.
-
-```ts
-import { BaseClient } from '@xata.io/client';
-
-const xata = new BaseClient({
-  branch: 'branchname',
-  apiKey: 'xau_1234abcdef',
-  fetch: fetchImplementation // Required if your runtime doesn't provide a global `fetch` function.
-});
-```
-
-It works the same way as the code-generated `XataClient` but doesn't provide type-safety for your model.
-
-You can read more on the methods available below, in the next section.
-
-### API Design
-
-The Xata SDK to create/read/update/delete records follows the [repository pattern](https://lyz-code.github.io/blue-book/architecture/repository_pattern/). Each table will have a repository object available at `xata.db.[table-name]`.
-
-For example if you have a `users` table, there'll be a repository at `xata.db.users`. If you're using the schema-less client, you can also use the `xata.db.[table-name]` syntax to access the repository but without TypeScript auto-completion.
-
-#### Creating Records
-
-Invoke the `create()` method in the repository. Example:
-
-```ts
-const user = await xata.db.users.create({
-  fullName: 'John Smith'
-});
-```
-
-If you want to create a record with a specific ID, you can provide the id as parameter to the `create()` method.
-
-```ts
-const user = await xata.db.users.create('user_admin', {
-  fullName: 'John Smith'
-});
-```
-
-And if you want to create or update a record with a specific ID, you can invoke `createOrUpdate()` with an id parameter.
-
-```ts
-const user = await xata.db.users.createOrUpdate('user_admin', {
-  fullName: 'John Smith'
-});
-```
-
-#### Query a Single Record by its ID
-
-```ts
-// `user` will be null if the record cannot be found
-const user = await xata.db.users.read('rec_1234abcdef');
-```
-
-#### Querying Multiple Records
-
-```ts
-// Query records selecting all fields.
-const page = await xata.db.users.select().getPaginated();
-const user = await xata.db.users.select().getFirst();
-
-// You can also use `xata.db.users` directly, since it's an immutable Query too!
-const page = await xata.db.users.getPaginated();
-const user = await xata.db.users.getFirst();
-
-// Query records selecting just one or more fields
-const page = await xata.db.users.select('email', 'profile').getPaginated();
-
-// Apply constraints
-const page = await xata.db.users.filter('email', 'foo@example.com').getPaginated();
-
-// Sorting
-const page = await xata.db.users.sort('full_name', 'asc').getPaginated();
-```
-
-Query operations (`select()`, `filter()`, `sort()`) return a `Query` object. These objects are immutable. You can add additional constraints, `sort`, etc. by calling their methods, and a new query will be returned. In order to finally make a query to the database you'll invoke `getPaginated()`, `getMany()`, `getAll()`, or `getFirst()`.
-
-To learn the differences between these methods, see the [reference](https://docs.xata.io/sdk/reference#query).
-
-```ts
-// Operators that combine multiple conditions can be deconstructed
-const { filter, any, all, not, sort } = xata.db.users;
-const query = filter('email', 'foo@example.com');
-
-// Single-column operators are imported directly from the package
-import { gt, includes, startsWith } from '@xata.io/client';
-filter('email', startsWith('username')).not(filter('created_at', gt(somePastDate)));
-
-// Queries are immutable objects. This is useful to derive queries from other queries
-const admins = filter('admin', true);
-const spaniardsAdmins = admins.filter('country', 'Spain');
-await admins.getAll(); // still returns all admins
-
-// Finally fetch the results of the query
-const users = await query.getAll();
-const firstUser = await query.getFirst();
-```
-
-The `getPaginated()` method will return a `Page` object. It's a wrapper that internally uses cursor based pagination.
-
-```ts
-page.records; // Array of records
-page.hasNextPage(); // Boolean
-
-const nextPage = await page.nextPage(); // Page object
-const previousPage = await page.previousPage(); // Page object
-const startPage = await page.startPage(); // Page object
-const endPage = await page.endPage(); // Page object
-```
-
-If you want to use an iterator, both the Repository and the Query classes implement an `AsyncIterable`. Alternatively you can use `getIterator()` and customize the batch size of the iterator:
-
-```ts
-for await (const record of xata.db.users) {
-  console.log(record);
-}
-
-for await (const record of xata.db.users.filter('team.id', teamId)) {
-  console.log(record);
-}
-
-for await (const records of xata.db.users.getIterator({ batchSize: 100 })) {
-  console.log(records);
-}
-```
-
-#### Updating Records
-
-Updating a record leaves the existing object unchanged, but returns a new object with the updated values.
-
-```ts
-// Using an existing object
-const updatedUser = await user.update({
-  fullName: 'John Smith Jr.'
-});
-
-// Using a record id
-const updatedUser = await xata.db.users.update('rec_1234abcdef', {
-  fullName: 'John Smith Jr.'
-});
-```
-
-#### Deleting Records
-
-```ts
-// Using an existing object
-await user.delete();
-
-// Using a record id
-await xata.db.users.delete('rec_1234abcdef');
-```
-
-### API Client
-
-One of the main features of the SDK is the ability to interact with the whole Xata API and perform administrative operations such as creating/reading/updating/deleting [workspaces](https://docs.xata.io/concepts/workspaces), databases, tables, branches...
-
-To communicate with the SDK we provide a constructor called `XataApiClient` that accepts an API token and an optional fetch implementation method.
-
-```ts
-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' });
-const { databaseName } = await api.database.createDatabase(workspace, 'database', { region: 'eu-west-1' });
-
-await api.branches.createBranch(workspace, databaseName, 'branch');
-await api.tables.createTable(workspace, databaseName, 'branch', 'table');
-await api.tables.setTableSchema(workspace, databaseName, 'branch', 'table', {
-  columns: [{ name: 'email', type: 'string' }]
-});
-
-const { id: recordId } = await api.records.insertRecord(workspace, databaseName, 'branch', 'table', {
-  email: 'example@foo.bar'
-});
-
-const record = await api.records.getRecord(workspace, databaseName, 'branch', 'table', recordId);
-
-await api.workspaces.deleteWorkspace(workspace);
-```
-
-## Deno support
-
-We publish the client on [deno.land](https://deno.land/x/xata). You can use it by changing the import in the auto-generated `xata.ts` file:
-
-```ts
-import { buildClient, BaseClientOptions, XataRecord } from 'https://deno.land/x/xata/mod.ts';
-```
+You can find the SDK documentation [here](https://xata.io/docs/typescript-client/overview).