@xata.io/client 0.0.0-alpha.vf603f80 → 0.0.0-alpha.vf61048f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.cjs +3 -2
- package/.turbo/turbo-add-version.log +4 -0
- package/.turbo/turbo-build.log +13 -0
- package/CHANGELOG.md +268 -0
- package/README.md +41 -32
- package/Usage.md +67 -11
- package/dist/index.cjs +2152 -805
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +5227 -1486
- package/dist/index.mjs +2121 -788
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -9
- package/rollup.config.mjs +44 -0
- package/rollup.config.js +0 -29
package/.eslintrc.cjs
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
module.exports = {
|
2
|
-
ignorePatterns: [
|
2
|
+
ignorePatterns: ['dist'],
|
3
3
|
parserOptions: {
|
4
4
|
ecmaVersion: 2020,
|
5
5
|
sourceType: 'module',
|
@@ -7,6 +7,7 @@ module.exports = {
|
|
7
7
|
},
|
8
8
|
rules: {
|
9
9
|
'@typescript-eslint/no-floating-promises': 'error',
|
10
|
-
|
10
|
+
'@typescript-eslint/strict-boolean-expressions': ['error', { allowNullableString: true, allowNullableObject: true }],
|
11
|
+
"@typescript-eslint/ban-types": "off",
|
11
12
|
}
|
12
13
|
};
|
@@ -0,0 +1,13 @@
|
|
1
|
+
|
2
|
+
> @xata.io/client@0.21.6 build /home/runner/work/client-ts/client-ts/packages/client
|
3
|
+
> rimraf dist && rollup -c
|
4
|
+
|
5
|
+
[36m
|
6
|
+
[1msrc/index.ts[22m → [1mdist/index.cjs[22m...[39m
|
7
|
+
[32mcreated [1mdist/index.cjs[22m in [1m1s[22m[39m
|
8
|
+
[36m
|
9
|
+
[1msrc/index.ts[22m → [1mdist/index.mjs[22m...[39m
|
10
|
+
[32mcreated [1mdist/index.mjs[22m in [1m853ms[22m[39m
|
11
|
+
[36m
|
12
|
+
[1msrc/index.ts[22m → [1mdist/index.d.ts[22m...[39m
|
13
|
+
[32mcreated [1mdist/index.d.ts[22m in [1m6.3s[22m[39m
|
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,273 @@
|
|
1
1
|
# @xata.io/client
|
2
2
|
|
3
|
+
## 0.0.0-alpha.vf61048f
|
4
|
+
|
5
|
+
### Minor Changes
|
6
|
+
|
7
|
+
- [#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
|
8
|
+
|
9
|
+
### Patch Changes
|
10
|
+
|
11
|
+
- Force canary build
|
12
|
+
|
13
|
+
- [#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`
|
14
|
+
|
15
|
+
## 0.21.6
|
16
|
+
|
17
|
+
### Patch Changes
|
18
|
+
|
19
|
+
- [#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
|
20
|
+
|
21
|
+
- [#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
|
22
|
+
|
23
|
+
## 0.21.5
|
24
|
+
|
25
|
+
### Patch Changes
|
26
|
+
|
27
|
+
- [#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
|
28
|
+
|
29
|
+
## 0.21.4
|
30
|
+
|
31
|
+
### Patch Changes
|
32
|
+
|
33
|
+
- [#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
|
34
|
+
|
35
|
+
## 0.21.3
|
36
|
+
|
37
|
+
### Patch Changes
|
38
|
+
|
39
|
+
- [#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
|
40
|
+
|
41
|
+
## 0.21.2
|
42
|
+
|
43
|
+
### Patch Changes
|
44
|
+
|
45
|
+
- [#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
|
46
|
+
|
47
|
+
- [#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
|
48
|
+
|
49
|
+
## 0.21.1
|
50
|
+
|
51
|
+
### Patch Changes
|
52
|
+
|
53
|
+
- [#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
|
54
|
+
|
55
|
+
## 0.21.0
|
56
|
+
|
57
|
+
### Minor Changes
|
58
|
+
|
59
|
+
- [#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
|
60
|
+
|
61
|
+
### Patch Changes
|
62
|
+
|
63
|
+
- [#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
|
64
|
+
|
65
|
+
- [#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
|
66
|
+
|
67
|
+
- [#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
|
68
|
+
|
69
|
+
- [#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
|
70
|
+
|
71
|
+
- [#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
|
72
|
+
|
73
|
+
- [#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
|
74
|
+
|
75
|
+
- [#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
|
76
|
+
|
77
|
+
- [#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
|
78
|
+
|
79
|
+
- [#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
|
80
|
+
|
81
|
+
## 0.20.2
|
82
|
+
|
83
|
+
### Patch Changes
|
84
|
+
|
85
|
+
- [#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
|
86
|
+
|
87
|
+
- [#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
|
88
|
+
|
89
|
+
- [#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
|
90
|
+
|
91
|
+
## 0.20.1
|
92
|
+
|
93
|
+
### Patch Changes
|
94
|
+
|
95
|
+
- [#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
|
96
|
+
|
97
|
+
## 0.20.0
|
98
|
+
|
99
|
+
### Minor Changes
|
100
|
+
|
101
|
+
- [#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
|
102
|
+
|
103
|
+
### Patch Changes
|
104
|
+
|
105
|
+
- [#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
|
106
|
+
|
107
|
+
- [#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
|
108
|
+
|
109
|
+
- [#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
|
110
|
+
|
111
|
+
- [#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
|
112
|
+
|
113
|
+
## 0.19.1
|
114
|
+
|
115
|
+
### Patch Changes
|
116
|
+
|
117
|
+
- [#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
|
118
|
+
|
119
|
+
## 0.19.0
|
120
|
+
|
121
|
+
### Minor Changes
|
122
|
+
|
123
|
+
- [#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
|
124
|
+
|
125
|
+
- [#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
|
126
|
+
|
127
|
+
### Patch Changes
|
128
|
+
|
129
|
+
- [#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
|
130
|
+
|
131
|
+
- [#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+
|
132
|
+
|
133
|
+
- [#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
|
134
|
+
|
135
|
+
- [#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
|
136
|
+
|
137
|
+
## 0.18.6
|
138
|
+
|
139
|
+
### Patch Changes
|
140
|
+
|
141
|
+
- [#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
|
142
|
+
|
143
|
+
- [#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
|
144
|
+
|
145
|
+
- [#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
|
146
|
+
|
147
|
+
- [#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
|
148
|
+
|
149
|
+
## 0.18.5
|
150
|
+
|
151
|
+
### Patch Changes
|
152
|
+
|
153
|
+
- [#656](https://github.com/xataio/client-ts/pull/656) [`2dc2f5a`](https://github.com/xataio/client-ts/commit/2dc2f5a45529b2ace9127d963fb30214298da2e0) Thanks [@SferaDev](https://github.com/SferaDev)! - Broaden type for AbortSignal
|
154
|
+
|
155
|
+
## 0.18.4
|
156
|
+
|
157
|
+
### Patch Changes
|
158
|
+
|
159
|
+
- [#650](https://github.com/xataio/client-ts/pull/650) [`b8d441f`](https://github.com/xataio/client-ts/commit/b8d441f80867322f41989d52c94bba230632782b) Thanks [@xata-bot](https://github.com/xata-bot)! - API: Rename listMigrationRequests to queryMigrationRequests
|
160
|
+
|
161
|
+
## 0.18.3
|
162
|
+
|
163
|
+
### Patch Changes
|
164
|
+
|
165
|
+
- [#639](https://github.com/xataio/client-ts/pull/639) [`50fb3c0`](https://github.com/xataio/client-ts/commit/50fb3c0a1cffd03a16cc8b1b21454ea816f2edbb) Thanks [@SferaDev](https://github.com/SferaDev)! - Do not return null for columns not selected
|
166
|
+
|
167
|
+
## 0.18.2
|
168
|
+
|
169
|
+
### Patch Changes
|
170
|
+
|
171
|
+
- [#635](https://github.com/xataio/client-ts/pull/635) [`713f9b2`](https://github.com/xataio/client-ts/commit/713f9b2773be99c17d3fcb663e24fe096fa3da48) Thanks [@SferaDev](https://github.com/SferaDev)! - [Search] Add target columns
|
172
|
+
|
173
|
+
## 0.18.1
|
174
|
+
|
175
|
+
### Patch Changes
|
176
|
+
|
177
|
+
- [#627](https://github.com/xataio/client-ts/pull/627) [`ad0a5b4`](https://github.com/xataio/client-ts/commit/ad0a5b4bc87b82fdc10008a8ea324a8ca783e678) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix some cases where filters on link and multiple column types are not working
|
178
|
+
|
179
|
+
## 0.18.0
|
180
|
+
|
181
|
+
### Minor Changes
|
182
|
+
|
183
|
+
- [#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
|
184
|
+
|
185
|
+
### Patch Changes
|
186
|
+
|
187
|
+
- [#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
|
188
|
+
|
189
|
+
- [#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
|
190
|
+
|
191
|
+
- [#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
|
192
|
+
|
193
|
+
- [#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
|
194
|
+
|
195
|
+
- [#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.
|
196
|
+
|
197
|
+
- [#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
|
198
|
+
|
199
|
+
- [#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
|
200
|
+
|
201
|
+
## 0.17.1
|
202
|
+
|
203
|
+
### Patch Changes
|
204
|
+
|
205
|
+
- [#584](https://github.com/xataio/client-ts/pull/584) [`a305072`](https://github.com/xataio/client-ts/commit/a3050726517632b4975f2a2ed5f771dd247e51d5) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix issues with multiple filters
|
206
|
+
|
207
|
+
* [#249](https://github.com/xataio/client-ts/pull/249) [`7812a41`](https://github.com/xataio/client-ts/commit/7812a414b7d99e9515c0ce48a61ad7a8b84d65d0) Thanks [@xata-bot](https://github.com/xata-bot)! - API: Add first endpoints for migration requests and schema compare
|
208
|
+
|
209
|
+
- [#585](https://github.com/xataio/client-ts/pull/585) [`d4a8ced`](https://github.com/xataio/client-ts/commit/d4a8ced9c257058ed7f660e01ee5fd1da154c391) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix problem with some special characters not being URI encoded
|
210
|
+
|
211
|
+
* [#574](https://github.com/xataio/client-ts/pull/574) [`cf85b13`](https://github.com/xataio/client-ts/commit/cf85b13e1ca69e79100fd02f58d79d556012395d) Thanks [@SferaDev](https://github.com/SferaDev)! - Do not allow unknown tables on codegen output
|
212
|
+
|
213
|
+
- [#576](https://github.com/xataio/client-ts/pull/576) [`2350739`](https://github.com/xataio/client-ts/commit/2350739d3f0a176b0f1fc77b0f4f597321349726) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow sending empty, undefined or conditional filters
|
214
|
+
|
215
|
+
* [#581](https://github.com/xataio/client-ts/pull/581) [`a336e61`](https://github.com/xataio/client-ts/commit/a336e6161be04a652e6f0f0a4c2edac10d50c99e) Thanks [@SferaDev](https://github.com/SferaDev)! - Update error codes in tracing
|
216
|
+
|
217
|
+
## 0.17.0
|
218
|
+
|
219
|
+
### Minor Changes
|
220
|
+
|
221
|
+
- [#563](https://github.com/xataio/client-ts/pull/563) [`26e91d1`](https://github.com/xataio/client-ts/commit/26e91d1d84df082dedd7159271fc7c27ec87fefe) Thanks [@SferaDev](https://github.com/SferaDev)! - Return nulls on operations that can fail
|
222
|
+
|
223
|
+
* [#563](https://github.com/xataio/client-ts/pull/563) [`3332d43`](https://github.com/xataio/client-ts/commit/3332d43121367f61c8d87dfb7da2af65bd1c278f) Thanks [@SferaDev](https://github.com/SferaDev)! - Return object on delete operation
|
224
|
+
|
225
|
+
## 0.16.2
|
226
|
+
|
227
|
+
### Patch Changes
|
228
|
+
|
229
|
+
- [#541](https://github.com/xataio/client-ts/pull/541) [`c74467c`](https://github.com/xataio/client-ts/commit/c74467caeff4e3d60d0981a173b462e970c6c1fc) Thanks [@SferaDev](https://github.com/SferaDev)! - Add tracing with open telemetry
|
230
|
+
|
231
|
+
* [#551](https://github.com/xataio/client-ts/pull/551) [`ee72bfe`](https://github.com/xataio/client-ts/commit/ee72bfef34765374ec66c7edaa6b5508c3f8e8dc) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix filter operators and dates
|
232
|
+
|
233
|
+
- [#552](https://github.com/xataio/client-ts/pull/552) [`e88effa`](https://github.com/xataio/client-ts/commit/e88effa00f8c2c0e24ec8cd60fb21859ac236191) Thanks [@SferaDev](https://github.com/SferaDev)! - Update error message for required settings
|
234
|
+
|
235
|
+
* [#551](https://github.com/xataio/client-ts/pull/551) [`33293b3`](https://github.com/xataio/client-ts/commit/33293b3509d984bb9b1af457c96260d43f398efe) Thanks [@SferaDev](https://github.com/SferaDev)! - Add aliases for some operators
|
236
|
+
|
237
|
+
- [#534](https://github.com/xataio/client-ts/pull/534) [`efc09b4`](https://github.com/xataio/client-ts/commit/efc09b420a25253b428662c2eec40ff3bc36ce79) Thanks [@SferaDev](https://github.com/SferaDev)! - Make sort direction optional
|
238
|
+
|
239
|
+
## 0.16.1
|
240
|
+
|
241
|
+
### Patch Changes
|
242
|
+
|
243
|
+
- [#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
|
244
|
+
|
245
|
+
* [#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
|
246
|
+
|
247
|
+
- [#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
|
248
|
+
|
249
|
+
## 0.16.0
|
250
|
+
|
251
|
+
### Minor Changes
|
252
|
+
|
253
|
+
- [#485](https://github.com/xataio/client-ts/pull/485) [`a9cbb26`](https://github.com/xataio/client-ts/commit/a9cbb263fbca47cb91a827db252d95a5bb4079a6) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow selecting columns with record operations
|
254
|
+
|
255
|
+
* [#485](https://github.com/xataio/client-ts/pull/485) [`7e04a3d`](https://github.com/xataio/client-ts/commit/7e04a3d1c51958a44f687a0036ead8bb3f5a2dfb) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove record cache
|
256
|
+
|
257
|
+
### Patch Changes
|
258
|
+
|
259
|
+
- [#503](https://github.com/xataio/client-ts/pull/503) [`6a96ea5`](https://github.com/xataio/client-ts/commit/6a96ea5da4c5b7ca9a99b57ebbce8d6766b5d4d8) Thanks [@xata-bot](https://github.com/xata-bot)! - Update API response types for create of tables and branches
|
260
|
+
|
261
|
+
* [#421](https://github.com/xataio/client-ts/pull/421) [`43f2560`](https://github.com/xataio/client-ts/commit/43f25605ddd0d2fd514a1542a14389d28955c500) Thanks [@SferaDev](https://github.com/SferaDev)! - Add search boosters and allow prefix search
|
262
|
+
|
263
|
+
## 0.15.0
|
264
|
+
|
265
|
+
### Patch Changes
|
266
|
+
|
267
|
+
- [#496](https://github.com/xataio/client-ts/pull/496) [`e923d11`](https://github.com/xataio/client-ts/commit/e923d11fe357519dc4ca3ae722670e6e70ccd1c6) Thanks [@gimenete](https://github.com/gimenete)! - Ignore git output in Xata client
|
268
|
+
|
269
|
+
* [#481](https://github.com/xataio/client-ts/pull/481) [`599b52c`](https://github.com/xataio/client-ts/commit/599b52c3090222eedef85d1ad1e907874cd3e801) Thanks [@xata-bot](https://github.com/xata-bot)! - Add updateWorkspaceMemberInvite API method
|
270
|
+
|
3
271
|
## 0.14.0
|
4
272
|
|
5
273
|
### Minor Changes
|
package/README.md
CHANGED
@@ -1,6 +1,13 @@
|
|
1
1
|
# Xata SDK for TypeScript and JavaScript
|
2
2
|
|
3
|
-
|
3
|
+
The Xata SDK supports typescript definitions for your Xata database schema. It also works with JavaScript.
|
4
|
+
|
5
|
+
It has zero dependencies and runs in Node.js, V8, Deno and Bun.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
See our [docs](https://xata.io/docs/sdk/typescript#installation) to get started using the Xata SDK.
|
10
|
+
|
4
11
|
|
5
12
|
## Table of Contents
|
6
13
|
|
@@ -12,17 +19,17 @@ This SDK has zero dependencies, so it can be used in many JavaScript runtimes in
|
|
12
19
|
- [Schema-generated Client](#schema-generated-client)
|
13
20
|
- [Schema-less Client](#schema-less-client)
|
14
21
|
- [API Design](#api-design)
|
15
|
-
- [Creating
|
16
|
-
- [Query a Single
|
17
|
-
- [Querying Multiple
|
18
|
-
- [Updating
|
19
|
-
- [Deleting
|
22
|
+
- [Creating Records](#creating-records)
|
23
|
+
- [Query a Single Record by its ID](#query-a-single-record-by-its-id)
|
24
|
+
- [Querying Multiple Records](#querying-multiple-records)
|
25
|
+
- [Updating Records](#updating-records)
|
26
|
+
- [Deleting Records](#deleting-records)
|
20
27
|
- [API Client](#api-client)
|
21
28
|
- [Deno support](#deno-support)
|
22
29
|
|
23
30
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
24
31
|
|
25
|
-
## Installation
|
32
|
+
## Manual Installation
|
26
33
|
|
27
34
|
```bash
|
28
35
|
npm install @xata.io/client
|
@@ -102,7 +109,7 @@ The Xata SDK to create/read/update/delete records follows the [repository patter
|
|
102
109
|
|
103
110
|
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.
|
104
111
|
|
105
|
-
#### Creating
|
112
|
+
#### Creating Records
|
106
113
|
|
107
114
|
Invoke the `create()` method in the repository. Example:
|
108
115
|
|
@@ -112,33 +119,33 @@ const user = await xata.db.users.create({
|
|
112
119
|
});
|
113
120
|
```
|
114
121
|
|
115
|
-
If you want to create a record with a specific ID, you can
|
122
|
+
If you want to create a record with a specific ID, you can provide the id as parameter to the `create()` method.
|
116
123
|
|
117
124
|
```ts
|
118
|
-
const user = await xata.db.users.
|
125
|
+
const user = await xata.db.users.create('user_admin', {
|
119
126
|
fullName: 'John Smith'
|
120
127
|
});
|
121
128
|
```
|
122
129
|
|
123
|
-
And if you want to create or
|
130
|
+
And if you want to create or update a record with a specific ID, you can invoke `createOrUpdate()` with an id parameter.
|
124
131
|
|
125
132
|
```ts
|
126
|
-
const user = await
|
133
|
+
const user = await xata.db.users.createOrUpdate('user_admin', {
|
127
134
|
fullName: 'John Smith'
|
128
135
|
});
|
129
136
|
```
|
130
137
|
|
131
|
-
#### Query a Single
|
138
|
+
#### Query a Single Record by its ID
|
132
139
|
|
133
140
|
```ts
|
134
|
-
// `user` will be null if the
|
141
|
+
// `user` will be null if the record cannot be found
|
135
142
|
const user = await xata.db.users.read('rec_1234abcdef');
|
136
143
|
```
|
137
144
|
|
138
|
-
#### Querying Multiple
|
145
|
+
#### Querying Multiple Records
|
139
146
|
|
140
147
|
```ts
|
141
|
-
// Query
|
148
|
+
// Query records selecting all fields.
|
142
149
|
const page = await xata.db.users.select().getPaginated();
|
143
150
|
const user = await xata.db.users.select().getFirst();
|
144
151
|
|
@@ -146,7 +153,7 @@ const user = await xata.db.users.select().getFirst();
|
|
146
153
|
const page = await xata.db.users.getPaginated();
|
147
154
|
const user = await xata.db.users.getFirst();
|
148
155
|
|
149
|
-
// Query
|
156
|
+
// Query records selecting just one or more fields
|
150
157
|
const page = await xata.db.users.select('email', 'profile').getPaginated();
|
151
158
|
|
152
159
|
// Apply constraints
|
@@ -158,6 +165,8 @@ const page = await xata.db.users.sort('full_name', 'asc').getPaginated();
|
|
158
165
|
|
159
166
|
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()`.
|
160
167
|
|
168
|
+
To learn the differences between these methods, see the [reference](https://docs.xata.io/sdk/reference#query).
|
169
|
+
|
161
170
|
```ts
|
162
171
|
// Operators that combine multiple conditions can be deconstructed
|
163
172
|
const { filter, any, all, not, sort } = xata.db.users;
|
@@ -185,8 +194,8 @@ page.hasNextPage(); // Boolean
|
|
185
194
|
|
186
195
|
const nextPage = await page.nextPage(); // Page object
|
187
196
|
const previousPage = await page.previousPage(); // Page object
|
188
|
-
const
|
189
|
-
const
|
197
|
+
const startPage = await page.startPage(); // Page object
|
198
|
+
const endPage = await page.endPage(); // Page object
|
190
199
|
```
|
191
200
|
|
192
201
|
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:
|
@@ -205,9 +214,9 @@ for await (const records of xata.db.users.getIterator({ batchSize: 100 })) {
|
|
205
214
|
}
|
206
215
|
```
|
207
216
|
|
208
|
-
#### Updating
|
217
|
+
#### Updating Records
|
209
218
|
|
210
|
-
Updating
|
219
|
+
Updating a record leaves the existing object unchanged, but returns a new object with the updated values.
|
211
220
|
|
212
221
|
```ts
|
213
222
|
// Using an existing object
|
@@ -215,19 +224,19 @@ const updatedUser = await user.update({
|
|
215
224
|
fullName: 'John Smith Jr.'
|
216
225
|
});
|
217
226
|
|
218
|
-
// Using
|
227
|
+
// Using a record id
|
219
228
|
const updatedUser = await xata.db.users.update('rec_1234abcdef', {
|
220
229
|
fullName: 'John Smith Jr.'
|
221
230
|
});
|
222
231
|
```
|
223
232
|
|
224
|
-
#### Deleting
|
233
|
+
#### Deleting Records
|
225
234
|
|
226
235
|
```ts
|
227
236
|
// Using an existing object
|
228
237
|
await user.delete();
|
229
238
|
|
230
|
-
// Using
|
239
|
+
// Using a record id
|
231
240
|
await xata.db.users.delete('rec_1234abcdef');
|
232
241
|
```
|
233
242
|
|
@@ -244,22 +253,22 @@ const api = new XataApiClient({ apiKey: process.env.XATA_API_KEY });
|
|
244
253
|
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`...).
|
245
254
|
|
246
255
|
```ts
|
247
|
-
const { id: workspace } = await
|
248
|
-
const { databaseName } = await
|
256
|
+
const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
|
257
|
+
const { databaseName } = await api.database.createDatabase(workspace, 'database', { region: 'eu-west-1' });
|
249
258
|
|
250
|
-
await
|
251
|
-
await
|
252
|
-
await
|
259
|
+
await api.branches.createBranch(workspace, databaseName, 'branch');
|
260
|
+
await api.tables.createTable(workspace, databaseName, 'branch', 'table');
|
261
|
+
await api.tables.setTableSchema(workspace, databaseName, 'branch', 'table', {
|
253
262
|
columns: [{ name: 'email', type: 'string' }]
|
254
263
|
});
|
255
264
|
|
256
|
-
const { id: recordId } = await
|
265
|
+
const { id: recordId } = await api.records.insertRecord(workspace, databaseName, 'branch', 'table', {
|
257
266
|
email: 'example@foo.bar'
|
258
267
|
});
|
259
268
|
|
260
|
-
const record = await
|
269
|
+
const record = await api.records.getRecord(workspace, databaseName, 'branch', 'table', recordId);
|
261
270
|
|
262
|
-
await
|
271
|
+
await api.workspaces.deleteWorkspace(workspace);
|
263
272
|
```
|
264
273
|
|
265
274
|
## Deno support
|
package/Usage.md
CHANGED
@@ -38,8 +38,31 @@ To get a collection of records, you can use the `Query` object. It provides the
|
|
38
38
|
|
39
39
|
- `getFirst()`: returns the first record in the query results.
|
40
40
|
- `getPaginated()`: returns a page of records in the query results.
|
41
|
-
- `getAll()`: returns all the records in the query results.
|
42
|
-
- `getMany()`: returns an array of
|
41
|
+
- `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.
|
42
|
+
- `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).
|
43
|
+
|
44
|
+
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.
|
45
|
+
|
46
|
+
All these methods allow customising its filters, column selection, column ordering, pagination or cache TTL. For example:
|
47
|
+
|
48
|
+
```ts
|
49
|
+
// First item sorting by name
|
50
|
+
const user = await xata.db.users.getFirst({ sort: 'name' });
|
51
|
+
|
52
|
+
// Get first 50 items but ignore the first one
|
53
|
+
const users = await xata.db.users.getMany({ pagination: { size: 50, offset: 1 } });
|
54
|
+
|
55
|
+
// Get page of 100 items where name contains "foo"
|
56
|
+
const page = await xata.db.users.getPaginated({ filter: { name: { $contains: 'foo' } }, pagination: { size: 100 } });
|
57
|
+
|
58
|
+
// Get all admin users and cache the result for 5 minutes
|
59
|
+
const user = await xata.db.users.filter('role', 'admin').getAll({ cache: 5 * 60 * 1000 });
|
60
|
+
|
61
|
+
// Overwrite values set in a query
|
62
|
+
const query = xata.db.users.filter('role', 'admin').select(['name']);
|
63
|
+
const adminUsers = await query.getAll();
|
64
|
+
const firstAdminUserWithEmail = await query.getFirst({ columns: ['name', 'email'] });
|
65
|
+
```
|
43
66
|
|
44
67
|
Since the [`Repository`](#repository) class implements the `Query` interface, you can use it to query and paginate the records in the table too.
|
45
68
|
|
@@ -155,6 +178,13 @@ const user = await xata.db.users.read(object1);
|
|
155
178
|
const users = await xata.db.users.read([object1, object2]);
|
156
179
|
```
|
157
180
|
|
181
|
+
By default an object with the first level properties is returned. If you want to reduce or expand its columns, you can pass an array of columns to the `read()` method.
|
182
|
+
|
183
|
+
```ts
|
184
|
+
const user = await xata.db.users.read('rec_1234abcdef', ['fullName', 'team.name']);
|
185
|
+
const users = await xata.db.users.read(['rec_1234abcdef', 'rec_5678defgh'], ['fullName', 'team.name']);
|
186
|
+
```
|
187
|
+
|
158
188
|
### Creating Records
|
159
189
|
|
160
190
|
Both the `create()` and `createOrUpdate()` methods can be used to create a new record.
|
@@ -202,6 +232,19 @@ const users = await xata.db.users.createOrUpdate([
|
|
202
232
|
]);
|
203
233
|
```
|
204
234
|
|
235
|
+
By default, the `create` and `createOrUpdate` methods will return the created record with the first level properties. If you want to reduce or expand its columns, you can pass an array of columns to the `create` or `createOrUpdate` method.
|
236
|
+
|
237
|
+
```ts
|
238
|
+
const user = await xata.db.users.create('user_admin', { fullName: 'John Smith' }, ['fullName', 'team.name']);
|
239
|
+
const users = await xata.db.users.createOrUpdate(
|
240
|
+
[
|
241
|
+
{ id: 'user_admin', fullName: 'John Smith' },
|
242
|
+
{ id: 'user_manager', fullName: 'Jane Doe' }
|
243
|
+
],
|
244
|
+
['fullName', 'team.name']
|
245
|
+
);
|
246
|
+
```
|
247
|
+
|
205
248
|
### Updating records
|
206
249
|
|
207
250
|
The `update()` method can be used to update an existing record. It will throw an `Error` if the record cannot be found.
|
@@ -225,6 +268,12 @@ const users = await xata.db.users.update([
|
|
225
268
|
]);
|
226
269
|
```
|
227
270
|
|
271
|
+
By default, the `update` method will return the updated record with the first level properties. If you want to reduce or expand its columns, you can pass an array of columns to the `update` method.
|
272
|
+
|
273
|
+
```ts
|
274
|
+
const user = await xata.db.users.update('rec_1234abcdef', { fullName: 'John Smith' }, ['fullName', 'team.name']);
|
275
|
+
```
|
276
|
+
|
228
277
|
### Deleting Records
|
229
278
|
|
230
279
|
The `delete()` method can be used to delete an existing record. It will throw an `Error` if the record cannot be found.
|
@@ -280,8 +329,8 @@ It contains:
|
|
280
329
|
- `hasNextPage`: Function that returns a boolean indicating if there is a next page.
|
281
330
|
- `nextPage`: Async function that can be used to get the next page.
|
282
331
|
- `previousPage`: Async function that can be used to get the previous page.
|
283
|
-
- `
|
284
|
-
- `
|
332
|
+
- `startPage`: Async function that can be used to get the start page.
|
333
|
+
- `endPage`: Async function that can be used to get the end page.
|
285
334
|
- `meta`: Information about the current page and its cursor.
|
286
335
|
|
287
336
|
```ts
|
@@ -295,14 +344,14 @@ page2.records; // Array of `XataRecord` objects.
|
|
295
344
|
const page1 = await page2.previousPage();
|
296
345
|
page1.records; // Array of `XataRecord` objects.
|
297
346
|
|
298
|
-
const
|
299
|
-
|
347
|
+
const startPage = await page1.startPage();
|
348
|
+
startPage.records; // Array of `XataRecord` objects.
|
300
349
|
```
|
301
350
|
|
302
351
|
The `Repository` class implements the `Query` interface, so you can use it to paginate the records in the table too.
|
303
352
|
|
304
353
|
```ts
|
305
|
-
const page = await xata.db.users.
|
354
|
+
const page = await xata.db.users.startPage();
|
306
355
|
page.records; // Array of `XataRecord` objects.
|
307
356
|
```
|
308
357
|
|
@@ -349,10 +398,10 @@ for await (const users of xata.db.users.getIterator({ batchSize: 50 })) {
|
|
349
398
|
|
350
399
|
We expose some helper variables of the API limits when paginating:
|
351
400
|
|
352
|
-
- `PAGINATION_MAX_SIZE`: Maximum page size.
|
353
|
-
- `PAGINATION_DEFAULT_SIZE`: Default page size.
|
354
|
-
- `PAGINATION_MAX_OFFSET`: Maximum offset.
|
355
|
-
- `PAGINATION_DEFAULT_OFFSET`: Default offset.
|
401
|
+
- `PAGINATION_MAX_SIZE`: Maximum page size (200).
|
402
|
+
- `PAGINATION_DEFAULT_SIZE`: Default page size (20).
|
403
|
+
- `PAGINATION_MAX_OFFSET`: Maximum offset (800).
|
404
|
+
- `PAGINATION_DEFAULT_OFFSET`: Default offset (0).
|
356
405
|
|
357
406
|
You can use these variables if you implement your own pagination mechanism, as they will be updated when our API limits are updated.
|
358
407
|
|
@@ -373,6 +422,13 @@ user?.update({ fullName: 'John Doe' }); // Partially updates the record
|
|
373
422
|
user?.delete(); // Deletes the record
|
374
423
|
```
|
375
424
|
|
425
|
+
The `read` and `update` methods return the updated record with the first level properties. If you want to reduce or expand its columns, you can pass an array of columns to the `read` and `update` methods.
|
426
|
+
|
427
|
+
```ts
|
428
|
+
const user = await xata.db.users.read('rec_1234abcdef');
|
429
|
+
user?.read(['fullName', 'team.name']); // Reads the record again with the `fullName` and `team.name` columns
|
430
|
+
```
|
431
|
+
|
376
432
|
If the table contains a link property, it will be represented as a `Link` object containing its `id` property and methods to read again or update the linked record.
|
377
433
|
|
378
434
|
```ts
|