@xata.io/client 0.0.0-alpha.vf1f4abe → 0.0.0-alpha.vf20a10c

package/.eslintrc.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  ignorePatterns: ["dist"],
+  ignorePatterns: ['dist'],
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module',
@@ -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.21.6 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.21.6 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 1.2s
+
+src/index.ts → dist/index.mjs...
+created dist/index.mjs in 965ms
+
+src/index.ts → dist/index.d.ts...
+created dist/index.d.ts in 6.5s

package/CHANGELOG.md

@@ -1,5 +1,151 @@
 # @xata.io/client
 
+## 0.0.0-alpha.vf20a10c
+
+### 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
+
+- Force canary build
+
+- [#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
+
+- [#828](https://github.com/xataio/client-ts/pull/828) [`039e35bf`](https://github.com/xataio/client-ts/commit/039e35bf9f01149f39bca39e1867908ca3468bb5) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix enableBrowser with Deno
+
+- [#828](https://github.com/xataio/client-ts/pull/828) [`039e35bf`](https://github.com/xataio/client-ts/commit/039e35bf9f01149f39bca39e1867908ca3468bb5) Thanks [@SferaDev](https://github.com/SferaDev)! - Add branded types to serializer
+
+## 0.21.5
+
+### Patch Changes
+
+- [#825](https://github.com/xataio/client-ts/pull/825) [`41c4d29f`](https://github.com/xataio/client-ts/commit/41c4d29f9f9fc7ce87b755e447a2030fe8c10d70) Thanks [@SferaDev](https://github.com/SferaDev)! - Export fetcher error
+
+## 0.21.4
+
+### Patch Changes
+
+- [#816](https://github.com/xataio/client-ts/pull/816) [`a0149435`](https://github.com/xataio/client-ts/commit/a01494358ae3a8dd9d7eba3a276fe6f8b7827a33) Thanks [@SferaDev](https://github.com/SferaDev)! - Improve types for datetime fields accepting strings
+
+## 0.21.3
+
+### Patch Changes
+
+- [#792](https://github.com/xataio/client-ts/pull/792) [`6c96da45`](https://github.com/xataio/client-ts/commit/6c96da4533500ec236547f47310e99461d5457e8) Thanks [@SferaDev](https://github.com/SferaDev)! - Update workers return type helper
+
+## 0.21.2
+
+### Patch Changes
+
+- [#787](https://github.com/xataio/client-ts/pull/787) [`93f5beed`](https://github.com/xataio/client-ts/commit/93f5beed77785b03409c614f5e2c3eca4c69c574) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose consistency options
+
+- [#784](https://github.com/xataio/client-ts/pull/784) [`cbe0609e`](https://github.com/xataio/client-ts/commit/cbe0609ec9d6650030efbda712a1eb243287525d) Thanks [@SferaDev](https://github.com/SferaDev)! - Update resolveBranch behaviour
+
+## 0.21.1
+
+### Patch Changes
+
+- [#781](https://github.com/xataio/client-ts/pull/781) [`fdfa47de`](https://github.com/xataio/client-ts/commit/fdfa47de93ec772170ff00a4341fc14434347df5) Thanks [@SferaDev](https://github.com/SferaDev)! - Send header to disable encoding
+
+## 0.21.0
+
+### Minor Changes
+
+- [#757](https://github.com/xataio/client-ts/pull/757) [`7da604d2`](https://github.com/xataio/client-ts/commit/7da604d27990e20ecadba6122434fca563e6a8c9) Thanks [@SferaDev](https://github.com/SferaDev)! - Add promise pool for retries
+
+### Patch Changes
+
+- [#764](https://github.com/xataio/client-ts/pull/764) [`b131040a`](https://github.com/xataio/client-ts/commit/b131040a2d142c4e71a2e586fbf05cd9295af9a1) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix bun
+
+- [#759](https://github.com/xataio/client-ts/pull/759) [`7ea810dc`](https://github.com/xataio/client-ts/commit/7ea810dc083ec284447e3bd27bd0465f887481e6) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose new transaction API
+
+- [#767](https://github.com/xataio/client-ts/pull/767) [`d124cbfb`](https://github.com/xataio/client-ts/commit/d124cbfb93d3d591e79bbe9e94c4b6304d825e71) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove formatVersion from schema
+
+- [#767](https://github.com/xataio/client-ts/pull/767) [`d124cbfb`](https://github.com/xataio/client-ts/commit/d124cbfb93d3d591e79bbe9e94c4b6304d825e71) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix null value returning on date columns
+
+- [#775](https://github.com/xataio/client-ts/pull/775) [`fb5ccdf9`](https://github.com/xataio/client-ts/commit/fb5ccdf9fa95c37d54fbc5d9c0bb45872c831609) Thanks [@SferaDev](https://github.com/SferaDev)! - Add missing target field to search
+
+- [#760](https://github.com/xataio/client-ts/pull/760) [`4ae00036`](https://github.com/xataio/client-ts/commit/4ae00036b53c6c89e02a1fcfdd992f1a3c22892c) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for filters in boosters
+
+- [#766](https://github.com/xataio/client-ts/pull/766) [`bdae6668`](https://github.com/xataio/client-ts/commit/bdae6668fb571d29f1b1068a54f6866a80d9b174) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove beta for Workers
+
+- [#771](https://github.com/xataio/client-ts/pull/771) [`9486bdcc`](https://github.com/xataio/client-ts/commit/9486bdccc0af567bc5f2e8f91592b0143c539c45) Thanks [@SferaDev](https://github.com/SferaDev)! - Add modifier for numeric booster
+
+- [#771](https://github.com/xataio/client-ts/pull/771) [`9486bdcc`](https://github.com/xataio/client-ts/commit/9486bdccc0af567bc5f2e8f91592b0143c539c45) Thanks [@SferaDev](https://github.com/SferaDev)! - Add pagination to search
+
+## 0.20.2
+
+### Patch Changes
+
+- [#756](https://github.com/xataio/client-ts/pull/756) [`27b73745`](https://github.com/xataio/client-ts/commit/27b737451227cf12774115ccb70649f6bbf76180) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix update method with id in payload
+
+- [#726](https://github.com/xataio/client-ts/pull/726) [`47a1f878`](https://github.com/xataio/client-ts/commit/47a1f87850a7178dad656a16d2584eee6ce68f29) Thanks [@SferaDev](https://github.com/SferaDev)! - Use transactions API internally for bulk operations
+
+- [#726](https://github.com/xataio/client-ts/pull/726) [`adde9b10`](https://github.com/xataio/client-ts/commit/adde9b10708182295dee07c203c7bf737806e49e) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow sending bulk operations of more than the limit
+
+## 0.20.1
+
+### Patch Changes
+
+- [#744](https://github.com/xataio/client-ts/pull/744) [`98298ca`](https://github.com/xataio/client-ts/commit/98298ca1312a2256ee3e9d2700a9f3d3e316abe5) Thanks [@xata-bot](https://github.com/xata-bot)! - Add deno entry point
+
+## 0.20.0
+
+### Minor Changes
+
+- [#737](https://github.com/xataio/client-ts/pull/737) [`6cbeaa0`](https://github.com/xataio/client-ts/commit/6cbeaa00050b5aa99ab7c98052a906487263e026) Thanks [@SferaDev](https://github.com/SferaDev)! - Rename first to start and last to end in pagination
+
+### Patch Changes
+
+- [#732](https://github.com/xataio/client-ts/pull/732) [`a5a9aa5`](https://github.com/xataio/client-ts/commit/a5a9aa59987faa1d3d701d7431b8a96031e01ac7) Thanks [@SferaDev](https://github.com/SferaDev)! - [Experimental] Allow passing fetch options in some queries
+
+- [#735](https://github.com/xataio/client-ts/pull/735) [`c64b2eb`](https://github.com/xataio/client-ts/commit/c64b2eb9add70e75d419d418ab9608caac0dbfa1) Thanks [@SferaDev](https://github.com/SferaDev)! - Add support for default values
+
+- [#730](https://github.com/xataio/client-ts/pull/730) [`485b217`](https://github.com/xataio/client-ts/commit/485b217079c4b2091d697e68622c48eddd130ceb) Thanks [@SferaDev](https://github.com/SferaDev)! - Add more summarize functions
+
+- [#730](https://github.com/xataio/client-ts/pull/730) [`4d7499c`](https://github.com/xataio/client-ts/commit/4d7499ccbb135691350334fd8022f7a5da41c5f2) Thanks [@SferaDev](https://github.com/SferaDev)! - Add a check for browser execution
+
+## 0.19.1
+
+### Patch Changes
+
+- [#723](https://github.com/xataio/client-ts/pull/723) [`ad5feeb`](https://github.com/xataio/client-ts/commit/ad5feebad5983f724ea4067b884bfae428447470) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix replace operation not hidden
+
+## 0.19.0
+
+### Minor Changes
+
+- [#692](https://github.com/xataio/client-ts/pull/692) [`c14f431`](https://github.com/xataio/client-ts/commit/c14f431db020036ab2b059bcc52a5d56b321c8e7) Thanks [@SferaDev](https://github.com/SferaDev)! - Add multi region endpoint support
+
+- [#692](https://github.com/xataio/client-ts/pull/692) [`c8def01`](https://github.com/xataio/client-ts/commit/c8def013e9e2d5b634cdb2850f757a0b3e9e0a6d) Thanks [@SferaDev](https://github.com/SferaDev)! - Update OpenAPI spec methods
+
+### Patch Changes
+
+- [#667](https://github.com/xataio/client-ts/pull/667) [`f80f051`](https://github.com/xataio/client-ts/commit/f80f05118dd0588861b8229114a469f016ef77ac) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow sending page size to summarize endpoint
+
+- [#676](https://github.com/xataio/client-ts/pull/676) [`2e341e5`](https://github.com/xataio/client-ts/commit/2e341e5c6140f9c4ddd74e479049992c26c43ea2) Thanks [@SferaDev](https://github.com/SferaDev)! - Support TS 4.7+
+
+- [#709](https://github.com/xataio/client-ts/pull/709) [`f2f749f`](https://github.com/xataio/client-ts/commit/f2f749f4c64246a303da8d4a617773fc55c1d021) Thanks [@SferaDev](https://github.com/SferaDev)! - Add ifVersion flag to insert/update/upsert operations
+
+- [#709](https://github.com/xataio/client-ts/pull/709) [`f2f749f`](https://github.com/xataio/client-ts/commit/f2f749f4c64246a303da8d4a617773fc55c1d021) Thanks [@SferaDev](https://github.com/SferaDev)! - Add createOrReplace operation to repository
+
+## 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/README.md

@@ -1,6 +1,13 @@
 # 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.
+
+It has zero dependencies and runs in Node.js, V8, Deno and Bun.
+
+## Installation
+
+See our [docs](https://xata.io/docs/sdk/typescript#installation) to get started using the Xata SDK.
+
 
 ## Table of Contents
 
@@ -22,7 +29,7 @@ This SDK has zero dependencies, so it can be used in many JavaScript runtimes in
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Installation
+## Manual Installation
 
 ```bash
 npm install @xata.io/client
@@ -112,18 +119,18 @@ const user = await xata.db.users.create({
 });
 ```
 
-If you want to create a record with a specific ID, you can invoke `insert()`.
+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.insert('user_admin', {
+const user = await xata.db.users.create('user_admin', {
   fullName: 'John Smith'
 });
 ```
 
-And if you want to create or insert a record with a specific ID, you can invoke `updateOrInsert()`.
+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.updateOrInsert('user_admin', {
+const user = await xata.db.users.createOrUpdate('user_admin', {
   fullName: 'John Smith'
 });
 ```
@@ -187,8 +194,8 @@ page.hasNextPage(); // Boolean
 
 const nextPage = await page.nextPage(); // Page object
 const previousPage = await page.previousPage(); // Page object
-const firstPage = await page.firstPage(); // Page object
-const lastPage = await page.lastPage(); // 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:
@@ -247,7 +254,7 @@ Once you have initialized the API client, the operations are organized following
 
 ```ts
 const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
-const { databaseName } = await api.databases.createDatabase(workspace, 'database');
+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');

package/Usage.md

@@ -329,8 +329,8 @@ It contains:
 - `hasNextPage`: Function that returns a boolean indicating if there is a next page.
 - `nextPage`: Async function that can be used to get the next page.
 - `previousPage`: Async function that can be used to get the previous page.
-- `firstPage`: Async function that can be used to get the first page.
-- `lastPage`: Async function that can be used to get the last page.
+- `startPage`: Async function that can be used to get the start page.
+- `endPage`: Async function that can be used to get the end page.
 - `meta`: Information about the current page and its cursor.
 
 ```ts
@@ -344,14 +344,14 @@ page2.records; // Array of `XataRecord` objects.
 const page1 = await page2.previousPage();
 page1.records; // Array of `XataRecord` objects.
 
-const firstPage = await page1.firstPage();
-firstPage.records; // Array of `XataRecord` objects.
+const startPage = await page1.startPage();
+startPage.records; // Array of `XataRecord` objects.
 ```
 
 The `Repository` class implements the `Query` interface, so you can use it to paginate the records in the table too.
 
 ```ts
-const page = await xata.db.users.firstPage();
+const page = await xata.db.users.startPage();
 page.records; // Array of `XataRecord` objects.
 ```