@xata.io/client 0.0.0-alpha.vfe9bed6 → 0.0.0-alpha.vfecc463

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.
@@ -0,0 +1,4 @@
1
+
2
+ > @xata.io/client@0.24.3 add-version /home/runner/work/client-ts/client-ts/packages/client
3
+ > node ../../scripts/add-version-file.mjs
4
+
@@ -0,0 +1,18 @@
1
+
2
+ > @xata.io/client@0.24.3 build /home/runner/work/client-ts/client-ts/packages/client
3
+ > rimraf dist && rollup -c
4
+
5
+ 
6
+ src/index.ts → dist/index.cjs...
7
+ created dist/index.cjs in 942ms
8
+ 
9
+ src/index.ts → dist/index.mjs...
10
+ created dist/index.mjs in 620ms
11
+ 
12
+ src/index.ts → dist/index.d.ts...
13
+ (!) Circular dependencies
14
+ src/api/index.ts -> src/plugins.ts -> src/api/index.ts
15
+ src/api/index.ts -> src/api/client.ts -> src/api/components.ts -> src/api/controlPlaneComponents.ts -> src/api/controlPlaneFetcher.ts -> src/api/errors.ts -> src/api/index.ts
16
+ src/schema/record.ts -> src/schema/selection.ts -> src/schema/record.ts
17
+ ...and 6 more
18
+ created dist/index.d.ts in 5s
package/CHANGELOG.md CHANGED
@@ -1,5 +1,295 @@
1
1
  # @xata.io/client
2
2
 
3
+ ## 0.0.0-alpha.vfecc463
4
+
5
+ ### Patch Changes
6
+
7
+ - Force canary build
8
+
9
+ - [#1067](https://github.com/xataio/client-ts/pull/1067) [`c1f2d264`](https://github.com/xataio/client-ts/commit/c1f2d2649e077cdffae97c90b9d2b1c75d6858fb) Thanks [@SferaDev](https://github.com/SferaDev)! - Fix error 400 with partial filters
10
+
11
+ - [#1071](https://github.com/xataio/client-ts/pull/1071) [`ac799dc7`](https://github.com/xataio/client-ts/commit/ac799dc71c8b2a0dbc3b71f2fed2b42bf94867bb) Thanks [@SferaDev](https://github.com/SferaDev)! - Add request timeout
12
+
13
+ ## 0.24.3
14
+
15
+ ### Patch Changes
16
+
17
+ - [#1033](https://github.com/xataio/client-ts/pull/1033) [`f01d1580`](https://github.com/xataio/client-ts/commit/f01d1580fc450cbf06eb8af85d68cf052fbe83a1) Thanks [@xata-bot](https://github.com/xata-bot)! - [OpenAPI] Spec updates for column selection
18
+
19
+ - [#1044](https://github.com/xataio/client-ts/pull/1044) [`52290feb`](https://github.com/xataio/client-ts/commit/52290feb5bba57384cdc14e7722fb5d9883dc581) Thanks [@SferaDev](https://github.com/SferaDev)! - Allow undefined with createOrUpdate/createOrReplace
20
+
21
+ ## 0.24.2
22
+
23
+ ### Patch Changes
24
+
25
+ - [#1038](https://github.com/xataio/client-ts/pull/1038) [`51561b52`](https://github.com/xataio/client-ts/commit/51561b52b56ad5ed9101d8faf12929891419cb2c) Thanks [@SferaDev](https://github.com/SferaDev)! - Show internal columns in filters
26
+
27
+ ## 0.24.1
28
+
29
+ ### Patch Changes
30
+
31
+ - [#1030](https://github.com/xataio/client-ts/pull/1030) [`eaa774f5`](https://github.com/xataio/client-ts/commit/eaa774f542185ef92448155bcdff331686c4da9f) Thanks [@SferaDev](https://github.com/SferaDev)! - Make `xata` property enumerable
32
+
33
+ ## 0.24.0
34
+
35
+ ### Minor Changes
36
+
37
+ - [#1009](https://github.com/xataio/client-ts/pull/1009) [`45aa2207`](https://github.com/xataio/client-ts/commit/45aa220728e98dd716a55a9a307474732a9b2bc1) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `createdAt` and `updatedAt` properties
38
+
39
+ ### Patch Changes
40
+
41
+ - [#1008](https://github.com/xataio/client-ts/pull/1008) [`f28080f0`](https://github.com/xataio/client-ts/commit/f28080f034f02704fe00d64b8f42e1127bde30c7) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `failIfMissing` to delete transactions
42
+
43
+ - [#994](https://github.com/xataio/client-ts/pull/994) [`ac9c0604`](https://github.com/xataio/client-ts/commit/ac9c06042bb85105d9a38624676ce6ea5a27d488) Thanks [@xata-bot](https://github.com/xata-bot)! - Update internal endpoints
44
+
45
+ - [#1015](https://github.com/xataio/client-ts/pull/1015) [`c163b365`](https://github.com/xataio/client-ts/commit/c163b3658f23fb2eaad6243ebebc92624754099a) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `factor` to date boosters
46
+
47
+ ## 0.23.5
48
+
49
+ ### Patch Changes
50
+
51
+ - [#970](https://github.com/xataio/client-ts/pull/970) [`20cc8c43`](https://github.com/xataio/client-ts/commit/20cc8c43e1659bf112ae2642948c84bfcf46a6ba) Thanks [@xata-bot](https://github.com/xata-bot)! - Add delete file endpoint
52
+
53
+ - [#976](https://github.com/xataio/client-ts/pull/976) [`5099cbbd`](https://github.com/xataio/client-ts/commit/5099cbbd3065a60dcee2f1699afa1ee8ed5edb1c) Thanks [@SferaDev](https://github.com/SferaDev)! - Re-export JSONData helper type
54
+
55
+ - [#972](https://github.com/xataio/client-ts/pull/972) [`89375e76`](https://github.com/xataio/client-ts/commit/89375e76b790fed7e6a26bf3ac4ea9eaed1aecae) Thanks [@SferaDev](https://github.com/SferaDev)! - Add types to exports
56
+
57
+ - [#979](https://github.com/xataio/client-ts/pull/979) [`5eaee932`](https://github.com/xataio/client-ts/commit/5eaee932b828907ae352d7c0d0584e860845434b) Thanks [@SferaDev](https://github.com/SferaDev)! - Add `size` to pagination meta
58
+
59
+ - [#974](https://github.com/xataio/client-ts/pull/974) [`109b8790`](https://github.com/xataio/client-ts/commit/109b8790849532d9c442e7c03c67792aeafebd88) Thanks [@xata-bot](https://github.com/xata-bot)! - Make checksum mandatory
60
+
61
+ ## 0.23.4
62
+
63
+ ### Patch Changes
64
+
65
+ - [#951](https://github.com/xataio/client-ts/pull/951) [`470cc71f`](https://github.com/xataio/client-ts/commit/470cc71f7c5c8b9fd50f789e157d2b2eecd0b3e8) Thanks [@SferaDev](https://github.com/SferaDev)! - Add random sorting
66
+
67
+ ## 0.23.3
68
+
69
+ ### Patch Changes
70
+
71
+ - [#947](https://github.com/xataio/client-ts/pull/947) [`344b0d68`](https://github.com/xataio/client-ts/commit/344b0d687962d569872d1e90d59818d28df7579c) Thanks [@SferaDev](https://github.com/SferaDev)! - Add numeric operators
72
+
73
+ ## 0.23.2
74
+
75
+ ### Patch Changes
76
+
77
+ - [#939](https://github.com/xataio/client-ts/pull/939) [`c477c177`](https://github.com/xataio/client-ts/commit/c477c17795c01cbf945be413217944a5a38655a5) Thanks [@SferaDev](https://github.com/SferaDev)! - Add deploy preview branch env variable loading
78
+
79
+ - [#945](https://github.com/xataio/client-ts/pull/945) [`ecdc6553`](https://github.com/xataio/client-ts/commit/ecdc6553d4628289e88953ab6296b80f60e8f757) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new types
80
+
81
+ ## 0.23.1
82
+
83
+ ### Patch Changes
84
+
85
+ - [#941](https://github.com/xataio/client-ts/pull/941) [`3026d708`](https://github.com/xataio/client-ts/commit/3026d70847830fd0f2024413d823380ff323806c) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose records in ask SSE
86
+
87
+ ## 0.23.0
88
+
89
+ ### Minor Changes
90
+
91
+ - [#867](https://github.com/xataio/client-ts/pull/867) [`5838113f`](https://github.com/xataio/client-ts/commit/5838113fca042163b44d7cc7cc1686d5ef89b302) Thanks [@SferaDev](https://github.com/SferaDev)! - [Workflow] Remove fallback branch
92
+
93
+ ## 0.22.4
94
+
95
+ ### Patch Changes
96
+
97
+ - [#927](https://github.com/xataio/client-ts/pull/927) [`22e7dd29`](https://github.com/xataio/client-ts/commit/22e7dd29f7a51dccc087d5fd7fff32084c7733af) Thanks [@SferaDev](https://github.com/SferaDev)! - Expose `ask` endpoint in the SDK
98
+
99
+ - [#921](https://github.com/xataio/client-ts/pull/921) [`07fc879d`](https://github.com/xataio/client-ts/commit/07fc879d3f778536e39588e66d7a18b5a9d52ebe) Thanks [@SferaDev](https://github.com/SferaDev)! - Remove git branch resolution
100
+
101
+ - [#925](https://github.com/xataio/client-ts/pull/925) [`58a1c24e`](https://github.com/xataio/client-ts/commit/58a1c24e5d30025dce243eecce44f09d4f65ed66) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new methods to API client
102
+
103
+ - [#932](https://github.com/xataio/client-ts/pull/932) [`c2c6e244`](https://github.com/xataio/client-ts/commit/c2c6e24459b1acc07f0414066258071fbcf7dde9) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new experimental copy branch endpoint
104
+
105
+ ## 0.22.3
106
+
107
+ ### Patch Changes
108
+
109
+ - [#917](https://github.com/xataio/client-ts/pull/917) [`4210b8c3`](https://github.com/xataio/client-ts/commit/4210b8c3c4169ba781a56deed7ba09c99788db1f) Thanks [@xata-bot](https://github.com/xata-bot)! - [OpenAPI] Spec updates to add better types to Record input
110
+
111
+ ## 0.22.2
112
+
113
+ ### Patch Changes
114
+
115
+ - [#898](https://github.com/xataio/client-ts/pull/898) [`72e13bf9`](https://github.com/xataio/client-ts/commit/72e13bf99d0ebefef91c984a995a28b0e8ca2a8f) Thanks [@SferaDev](https://github.com/SferaDev)! - Add methods for vector type
116
+
117
+ ## 0.22.1
118
+
119
+ ### Patch Changes
120
+
121
+ - [#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
122
+
123
+ - [#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
124
+
125
+ ## 0.22.0
126
+
127
+ ### Minor Changes
128
+
129
+ - [#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
130
+
131
+ ### Patch Changes
132
+
133
+ - [#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`
134
+
135
+ ## 0.21.6
136
+
137
+ ### Patch Changes
138
+
139
+ - [#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
140
+
141
+ - [#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
142
+
143
+ ## 0.21.5
144
+
145
+ ### Patch Changes
146
+
147
+ - [#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
148
+
149
+ ## 0.21.4
150
+
151
+ ### Patch Changes
152
+
153
+ - [#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
154
+
155
+ ## 0.21.3
156
+
157
+ ### Patch Changes
158
+
159
+ - [#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
160
+
161
+ ## 0.21.2
162
+
163
+ ### Patch Changes
164
+
165
+ - [#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
166
+
167
+ - [#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
168
+
169
+ ## 0.21.1
170
+
171
+ ### Patch Changes
172
+
173
+ - [#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
174
+
175
+ ## 0.21.0
176
+
177
+ ### Minor Changes
178
+
179
+ - [#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
180
+
181
+ ### Patch Changes
182
+
183
+ - [#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
184
+
185
+ - [#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
186
+
187
+ - [#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
188
+
189
+ - [#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
190
+
191
+ - [#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
192
+
193
+ - [#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
194
+
195
+ - [#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
196
+
197
+ - [#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
198
+
199
+ - [#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
200
+
201
+ ## 0.20.2
202
+
203
+ ### Patch Changes
204
+
205
+ - [#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
206
+
207
+ - [#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
208
+
209
+ - [#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
210
+
211
+ ## 0.20.1
212
+
213
+ ### Patch Changes
214
+
215
+ - [#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
216
+
217
+ ## 0.20.0
218
+
219
+ ### Minor Changes
220
+
221
+ - [#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
222
+
223
+ ### Patch Changes
224
+
225
+ - [#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
226
+
227
+ - [#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
228
+
229
+ - [#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
230
+
231
+ - [#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
232
+
233
+ ## 0.19.1
234
+
235
+ ### Patch Changes
236
+
237
+ - [#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
238
+
239
+ ## 0.19.0
240
+
241
+ ### Minor Changes
242
+
243
+ - [#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
244
+
245
+ - [#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
246
+
247
+ ### Patch Changes
248
+
249
+ - [#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
250
+
251
+ - [#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+
252
+
253
+ - [#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
254
+
255
+ - [#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
256
+
257
+ ## 0.18.6
258
+
259
+ ### Patch Changes
260
+
261
+ - [#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
262
+
263
+ - [#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
264
+
265
+ - [#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
266
+
267
+ - [#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
268
+
269
+ ## 0.18.5
270
+
271
+ ### Patch Changes
272
+
273
+ - [#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
274
+
275
+ ## 0.18.4
276
+
277
+ ### Patch Changes
278
+
279
+ - [#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
280
+
281
+ ## 0.18.3
282
+
283
+ ### Patch Changes
284
+
285
+ - [#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
286
+
287
+ ## 0.18.2
288
+
289
+ ### Patch Changes
290
+
291
+ - [#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
292
+
3
293
  ## 0.18.1
4
294
 
5
295
  ### Patch Changes
package/README.md CHANGED
@@ -1,273 +1,7 @@
1
1
  # Xata SDK for TypeScript and JavaScript
2
2
 
3
- 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.
3
+ The Xata SDK supports typescript definitions for your Xata database schema. It also works with JavaScript.
4
4
 
5
- ## Table of Contents
5
+ It has zero dependencies and runs in Node.js, V8, Deno and Bun.
6
6
 
7
- <!-- START doctoc generated TOC please keep comment here to allow auto update -->
8
- <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
9
-
10
- - [Installation](#installation)
11
- - [Usage](#usage)
12
- - [Schema-generated Client](#schema-generated-client)
13
- - [Schema-less Client](#schema-less-client)
14
- - [API Design](#api-design)
15
- - [Creating Records](#creating-records)
16
- - [Query a Single Record by its ID](#query-a-single-record-by-its-id)
17
- - [Querying Multiple Records](#querying-multiple-records)
18
- - [Updating Records](#updating-records)
19
- - [Deleting Records](#deleting-records)
20
- - [API Client](#api-client)
21
- - [Deno support](#deno-support)
22
-
23
- <!-- END doctoc generated TOC please keep comment here to allow auto update -->
24
-
25
- ## Installation
26
-
27
- ```bash
28
- npm install @xata.io/client
29
- ```
30
-
31
- ## Usage
32
-
33
- There are three ways to use the SDK:
34
-
35
- - **Schema-generated Client**: SDK to create/read/update/delete records in a given database following a schema file (with type-safety).
36
- - **Schema-less Client**: SDK to create/read/update/delete records in any database without schema validation (with partial type-safety).
37
- - **API Client**: SDK to interact with the whole Xata API and all its endpoints.
38
-
39
- ### Schema-generated Client
40
-
41
- 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).
42
-
43
- To run it (and assuming you have configured the project with `xata init`):
44
-
45
- ```bash
46
- xata codegen
47
- ```
48
-
49
- In a TypeScript file, start using the generated code like this:
50
-
51
- ```ts
52
- import { XataClient } from './xata'; // or wherever you chose to generate the client
53
-
54
- const xata = new XataClient();
55
- ```
56
-
57
- The import above will differ if you chose to generate the code in a different location.
58
-
59
- 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.
60
-
61
- 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).
62
-
63
- ```ts
64
- interface User extends Identifiable {
65
- email?: string | null;
66
- }
67
-
68
- type UserRecord = User & XataRecord;
69
-
70
- async function initializeDatabase(admin: User): Promise<UserRecord> {
71
- return xata.db.users.create(admin);
72
- }
73
-
74
- const admin = await initializeDatabase({ email: 'admin@example.com' });
75
- await admin.update({ email: 'admin@foo.bar' });
76
- await admin.delete();
77
- ```
78
-
79
- You will learn more about the available operations below, under the [`API Design`](#api-design) section.
80
-
81
- ### Schema-less Client
82
-
83
- 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.
84
-
85
- ```ts
86
- import { BaseClient } from '@xata.io/client';
87
-
88
- const xata = new BaseClient({
89
- branch: 'branchname',
90
- apiKey: 'xau_1234abcdef',
91
- fetch: fetchImplementation // Required if your runtime doesn't provide a global `fetch` function.
92
- });
93
- ```
94
-
95
- It works the same way as the code-generated `XataClient` but doesn't provide type-safety for your model.
96
-
97
- You can read more on the methods available below, in the next section.
98
-
99
- ### API Design
100
-
101
- 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]`.
102
-
103
- 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
-
105
- #### Creating Records
106
-
107
- Invoke the `create()` method in the repository. Example:
108
-
109
- ```ts
110
- const user = await xata.db.users.create({
111
- fullName: 'John Smith'
112
- });
113
- ```
114
-
115
- If you want to create a record with a specific ID, you can invoke `insert()`.
116
-
117
- ```ts
118
- const user = await xata.db.users.insert('user_admin', {
119
- fullName: 'John Smith'
120
- });
121
- ```
122
-
123
- And if you want to create or insert a record with a specific ID, you can invoke `updateOrInsert()`.
124
-
125
- ```ts
126
- const user = await xata.db.users.updateOrInsert('user_admin', {
127
- fullName: 'John Smith'
128
- });
129
- ```
130
-
131
- #### Query a Single Record by its ID
132
-
133
- ```ts
134
- // `user` will be null if the record cannot be found
135
- const user = await xata.db.users.read('rec_1234abcdef');
136
- ```
137
-
138
- #### Querying Multiple Records
139
-
140
- ```ts
141
- // Query records selecting all fields.
142
- const page = await xata.db.users.select().getPaginated();
143
- const user = await xata.db.users.select().getFirst();
144
-
145
- // You can also use `xata.db.users` directly, since it's an immutable Query too!
146
- const page = await xata.db.users.getPaginated();
147
- const user = await xata.db.users.getFirst();
148
-
149
- // Query records selecting just one or more fields
150
- const page = await xata.db.users.select('email', 'profile').getPaginated();
151
-
152
- // Apply constraints
153
- const page = await xata.db.users.filter('email', 'foo@example.com').getPaginated();
154
-
155
- // Sorting
156
- const page = await xata.db.users.sort('full_name', 'asc').getPaginated();
157
- ```
158
-
159
- 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
-
161
- To learn the differences between these methods, see the [reference](https://docs.xata.io/sdk/reference#query).
162
-
163
- ```ts
164
- // Operators that combine multiple conditions can be deconstructed
165
- const { filter, any, all, not, sort } = xata.db.users;
166
- const query = filter('email', 'foo@example.com');
167
-
168
- // Single-column operators are imported directly from the package
169
- import { gt, includes, startsWith } from '@xata.io/client';
170
- filter('email', startsWith('username')).not(filter('created_at', gt(somePastDate)));
171
-
172
- // Queries are immutable objects. This is useful to derive queries from other queries
173
- const admins = filter('admin', true);
174
- const spaniardsAdmins = admins.filter('country', 'Spain');
175
- await admins.getAll(); // still returns all admins
176
-
177
- // Finally fetch the results of the query
178
- const users = await query.getAll();
179
- const firstUser = await query.getFirst();
180
- ```
181
-
182
- The `getPaginated()` method will return a `Page` object. It's a wrapper that internally uses cursor based pagination.
183
-
184
- ```ts
185
- page.records; // Array of records
186
- page.hasNextPage(); // Boolean
187
-
188
- const nextPage = await page.nextPage(); // Page object
189
- const previousPage = await page.previousPage(); // Page object
190
- const firstPage = await page.firstPage(); // Page object
191
- const lastPage = await page.lastPage(); // Page object
192
- ```
193
-
194
- 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:
195
-
196
- ```ts
197
- for await (const record of xata.db.users) {
198
- console.log(record);
199
- }
200
-
201
- for await (const record of xata.db.users.filter('team.id', teamId)) {
202
- console.log(record);
203
- }
204
-
205
- for await (const records of xata.db.users.getIterator({ batchSize: 100 })) {
206
- console.log(records);
207
- }
208
- ```
209
-
210
- #### Updating Records
211
-
212
- Updating a record leaves the existing object unchanged, but returns a new object with the updated values.
213
-
214
- ```ts
215
- // Using an existing object
216
- const updatedUser = await user.update({
217
- fullName: 'John Smith Jr.'
218
- });
219
-
220
- // Using a record id
221
- const updatedUser = await xata.db.users.update('rec_1234abcdef', {
222
- fullName: 'John Smith Jr.'
223
- });
224
- ```
225
-
226
- #### Deleting Records
227
-
228
- ```ts
229
- // Using an existing object
230
- await user.delete();
231
-
232
- // Using a record id
233
- await xata.db.users.delete('rec_1234abcdef');
234
- ```
235
-
236
- ### API Client
237
-
238
- 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...
239
-
240
- To communicate with the SDK we provide a constructor called `XataApiClient` that accepts an API token and an optional fetch implementation method.
241
-
242
- ```ts
243
- const api = new XataApiClient({ apiKey: process.env.XATA_API_KEY });
244
- ```
245
-
246
- 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`...).
247
-
248
- ```ts
249
- const { id: workspace } = await api.workspaces.createWorkspace({ name: 'example' });
250
- const { databaseName } = await api.databases.createDatabase(workspace, 'database');
251
-
252
- await api.branches.createBranch(workspace, databaseName, 'branch');
253
- await api.tables.createTable(workspace, databaseName, 'branch', 'table');
254
- await api.tables.setTableSchema(workspace, databaseName, 'branch', 'table', {
255
- columns: [{ name: 'email', type: 'string' }]
256
- });
257
-
258
- const { id: recordId } = await api.records.insertRecord(workspace, databaseName, 'branch', 'table', {
259
- email: 'example@foo.bar'
260
- });
261
-
262
- const record = await api.records.getRecord(workspace, databaseName, 'branch', 'table', recordId);
263
-
264
- await api.workspaces.deleteWorkspace(workspace);
265
- ```
266
-
267
- ## Deno support
268
-
269
- 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:
270
-
271
- ```ts
272
- import { buildClient, BaseClientOptions, XataRecord } from 'https://deno.land/x/xata/mod.ts';
273
- ```
7
+ You can find the SDK documentation [here](https://xata.io/docs/typescript-client/overview).