tinybase 6.3.0 → 6.3.1

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.
Files changed (27) hide show
  1. package/@types/mergeable-store/index.d.ts +1 -0
  2. package/@types/mergeable-store/with-schemas/index.d.ts +1 -0
  3. package/@types/persisters/index.d.ts +1 -0
  4. package/@types/persisters/persister-browser/index.d.ts +2 -0
  5. package/@types/persisters/persister-browser/with-schemas/index.d.ts +2 -0
  6. package/@types/persisters/persister-durable-object-sql-storage/index.d.ts +1 -0
  7. package/@types/persisters/persister-durable-object-sql-storage/with-schemas/index.d.ts +1 -0
  8. package/@types/persisters/persister-pglite/index.d.ts +1 -0
  9. package/@types/persisters/persister-pglite/with-schemas/index.d.ts +1 -0
  10. package/@types/persisters/persister-sqlite-wasm/index.d.ts +1 -0
  11. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.ts +1 -0
  12. package/@types/persisters/with-schemas/index.d.ts +1 -0
  13. package/@types/store/index.d.ts +13 -0
  14. package/@types/store/with-schemas/index.d.ts +13 -0
  15. package/@types/synchronizers/index.d.ts +1 -0
  16. package/@types/synchronizers/synchronizer-ws-client/index.d.ts +1 -0
  17. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts +1 -0
  18. package/@types/synchronizers/synchronizer-ws-server-durable-object/index.d.ts +1 -0
  19. package/@types/synchronizers/synchronizer-ws-server-durable-object/with-schemas/index.d.ts +1 -0
  20. package/@types/synchronizers/with-schemas/index.d.ts +1 -0
  21. package/@types/ui-react/index.d.ts +5 -0
  22. package/@types/ui-react/with-schemas/index.d.ts +5 -0
  23. package/@types/ui-react-inspector/index.d.ts +1 -0
  24. package/@types/ui-react-inspector/with-schemas/index.d.ts +1 -0
  25. package/package.json +6 -6
  26. package/readme.md +8 -8
  27. package/releases.md +50 -25
@@ -1115,6 +1115,7 @@ export interface MergeableStore extends Store {
1115
1115
  * ];
1116
1116
  * ```
1117
1117
  * @category Creation
1118
+ * @essential Creating stores
1118
1119
  * @since v5.0.0
1119
1120
  */
1120
1121
  export function createMergeableStore(
@@ -1607,6 +1607,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
1607
1607
  * ];
1608
1608
  * ```
1609
1609
  * @category Creation
1610
+ * @essential Creating stores
1610
1611
  * @since v5.0.0
1611
1612
  */
1612
1613
  export function createMergeableStore(
@@ -956,6 +956,7 @@ export type DpcTabularValues = {
956
956
  * sessionStorage.clear();
957
957
  * ```
958
958
  * @category Persister
959
+ * @essential Persisting stores
959
960
  * @since v1.0.0
960
961
  */
961
962
  export interface Persister<Persist extends Persists = Persists.StoreOnly> {
@@ -134,6 +134,7 @@ export interface LocalPersister
134
134
  * sessionStorage.clear();
135
135
  * ```
136
136
  * @category Creation
137
+ * @essential Persisting stores
137
138
  * @since v1.0.0
138
139
  */
139
140
  export function createSessionPersister(
@@ -176,6 +177,7 @@ export function createSessionPersister(
176
177
  * localStorage.clear();
177
178
  * ```
178
179
  * @category Creation
180
+ * @essential Persisting stores
179
181
  * @since v1.0.0
180
182
  */
181
183
  export function createLocalPersister(
@@ -147,6 +147,7 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
147
147
  * sessionStorage.clear();
148
148
  * ```
149
149
  * @category Creation
150
+ * @essential Persisting stores
150
151
  * @since v1.0.0
151
152
  */
152
153
  export function createSessionPersister<Schemas extends OptionalSchemas>(
@@ -199,6 +200,7 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
199
200
  * localStorage.clear();
200
201
  * ```
201
202
  * @category Creation
203
+ * @essential Persisting stores
202
204
  * @since v1.0.0
203
205
  */
204
206
  export function createLocalPersister<Schemas extends OptionalSchemas>(
@@ -337,6 +337,7 @@ export interface DurableObjectSqlStoragePersister
337
337
  * }
338
338
  * ```
339
339
  * @category Creation
340
+ * @essential Persisting stores
340
341
  * @since v6.3.0
341
342
  */
342
343
  export function createDurableObjectSqlStoragePersister(
@@ -366,6 +366,7 @@ export interface DurableObjectSqlStoragePersister<
366
366
  * }
367
367
  * ```
368
368
  * @category Creation
369
+ * @essential Persisting stores
369
370
  * @since v6.3.0
370
371
  */
371
372
  export function createDurableObjectSqlStoragePersister<
@@ -166,6 +166,7 @@ export interface PglitePersister
166
166
  * await pglite.close();
167
167
  * ```
168
168
  * @category Creation
169
+ * @essential Persisting stores
169
170
  * @since 5.2.0
170
171
  */
171
172
  export function createPglitePersister(
@@ -185,6 +185,7 @@ export interface PglitePersister<Schemas extends OptionalSchemas>
185
185
  * await pglite.close();
186
186
  * ```
187
187
  * @category Creation
188
+ * @essential Persisting stores
188
189
  * @since 5.2.0
189
190
  */
190
191
  export function createPglitePersister<Schemas extends OptionalSchemas>(
@@ -163,6 +163,7 @@ export interface SqliteWasmPersister
163
163
  * await persister.destroy();
164
164
  * ```
165
165
  * @category Creation
166
+ * @essential Persisting stores
166
167
  * @since v4.0.0
167
168
  */
168
169
  export function createSqliteWasmPersister(
@@ -183,6 +183,7 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
183
183
  * await persister.destroy();
184
184
  * ```
185
185
  * @category Creation
186
+ * @essential Persisting stores
186
187
  * @since v4.0.0
187
188
  */
188
189
  export function createSqliteWasmPersister<Schemas extends OptionalSchemas>(
@@ -1031,6 +1031,7 @@ export type DpcTabularValues = {
1031
1031
  * sessionStorage.clear();
1032
1032
  * ```
1033
1033
  * @category Persister
1034
+ * @essential Persisting stores
1034
1035
  * @since v1.0.0
1035
1036
  */
1036
1037
  export interface Persister<
@@ -1872,6 +1872,7 @@ export type StoreListenerStats = {
1872
1872
  * @see Hello World demos
1873
1873
  * @see Todo App demos
1874
1874
  * @category Store
1875
+ * @essential Creating stores
1875
1876
  * @since v1.0.0
1876
1877
  */
1877
1878
  export interface Store {
@@ -2321,6 +2322,7 @@ export interface Store {
2321
2322
  * // -> {}
2322
2323
  * ```
2323
2324
  * @category Getter
2325
+ * @essential Getting data
2324
2326
  * @since v1.0.0
2325
2327
  */
2326
2328
  getRow(tableId: Id, rowId: Id): Row;
@@ -2394,6 +2396,7 @@ export interface Store {
2394
2396
  * // -> undefined
2395
2397
  * ```
2396
2398
  * @category Getter
2399
+ * @essential Getting data
2397
2400
  * @since v1.0.0
2398
2401
  */
2399
2402
  getCell(tableId: Id, rowId: Id, cellId: Id): CellOrUndefined;
@@ -2489,6 +2492,7 @@ export interface Store {
2489
2492
  * // -> undefined
2490
2493
  * ```
2491
2494
  * @category Getter
2495
+ * @essential Getting data
2492
2496
  * @since v3.0.0
2493
2497
  */
2494
2498
  getValue(valueId: Id): ValueOrUndefined;
@@ -3157,6 +3161,7 @@ export interface Store {
3157
3161
  * // -> {pets: {fido: {color: 'brown'}}}
3158
3162
  * ```
3159
3163
  * @category Setter
3164
+ * @essential Setting data
3160
3165
  * @since v1.0.0
3161
3166
  */
3162
3167
  setRow(tableId: Id, rowId: Id, row: Row): this;
@@ -3223,6 +3228,7 @@ export interface Store {
3223
3228
  * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
3224
3229
  * ```
3225
3230
  * @category Setter
3231
+ * @essential Setting data
3226
3232
  * @since v1.0.0
3227
3233
  */
3228
3234
  addRow(tableId: Id, row: Row, reuseRowIds?: boolean): Id | undefined;
@@ -3343,6 +3349,7 @@ export interface Store {
3343
3349
  * // -> {pets: {fido: {species: 'dog'}}}
3344
3350
  * ```
3345
3351
  * @category Setter
3352
+ * @essential Setting data
3346
3353
  * @since v1.0.0
3347
3354
  */
3348
3355
  setCell(tableId: Id, rowId: Id, cellId: Id, cell: Cell | MapCell): this;
@@ -3506,6 +3513,7 @@ export interface Store {
3506
3513
  * // -> {employees: 3}
3507
3514
  * ```
3508
3515
  * @category Setter
3516
+ * @essential Setting data
3509
3517
  * @since v3.0.0
3510
3518
  */
3511
3519
  setValue(valueId: Id, value: Value | MapValue): this;
@@ -4263,6 +4271,7 @@ export interface Store {
4263
4271
  * // -> {open: true}
4264
4272
  * ```
4265
4273
  * @category Transaction
4274
+ * @essential Setting data
4266
4275
  * @since v1.0.0
4267
4276
  */
4268
4277
  transaction<Return>(actions: () => Return, doRollback?: DoRollback): Return;
@@ -6025,6 +6034,7 @@ export interface Store {
6025
6034
  * store.delListener(listenerId);
6026
6035
  * ```
6027
6036
  * @category Listener
6037
+ * @essential Listening for changes
6028
6038
  * @since v1.0.0
6029
6039
  */
6030
6040
  addRowListener(
@@ -6392,6 +6402,7 @@ export interface Store {
6392
6402
  * store.delListener(listenerId);
6393
6403
  * ```
6394
6404
  * @category Listener
6405
+ * @essential Listening for changes
6395
6406
  * @since v1.0.0
6396
6407
  */
6397
6408
  addCellListener(
@@ -6794,6 +6805,7 @@ export interface Store {
6794
6805
  * store.delListener(listenerId);
6795
6806
  * ```
6796
6807
  * @category Listener
6808
+ * @essential Listening for changes
6797
6809
  * @since v3.0.0
6798
6810
  */
6799
6811
  addValueListener(
@@ -7715,6 +7727,7 @@ export interface Store {
7715
7727
  * ```
7716
7728
  * @see The Basics guides
7717
7729
  * @category Creation
7730
+ * @essential Creating stores
7718
7731
  * @since v1.0.0
7719
7732
  */
7720
7733
  export function createStore(): Store;
@@ -2843,6 +2843,7 @@ export type StoreListenerStats = {
2843
2843
  * @see Hello World demos
2844
2844
  * @see Todo App demos
2845
2845
  * @category Store
2846
+ * @essential Creating stores
2846
2847
  * @since v1.0.0
2847
2848
  */
2848
2849
  export interface Store<in out Schemas extends OptionalSchemas> {
@@ -3363,6 +3364,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
3363
3364
  * // -> {}
3364
3365
  * ```
3365
3366
  * @category Getter
3367
+ * @essential Getting data
3366
3368
  * @since v1.0.0
3367
3369
  */
3368
3370
  getRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -3454,6 +3456,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
3454
3456
  * // -> undefined
3455
3457
  * ```
3456
3458
  * @category Getter
3459
+ * @essential Getting data
3457
3460
  * @since v1.0.0
3458
3461
  */
3459
3462
  getCell<
@@ -3574,6 +3577,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
3574
3577
  * // -> undefined
3575
3578
  * ```
3576
3579
  * @category Getter
3580
+ * @essential Getting data
3577
3581
  * @since v3.0.0
3578
3582
  */
3579
3583
  getValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -4310,6 +4314,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
4310
4314
  * // -> {pets: {fido: {color: 'brown'}}}
4311
4315
  * ```
4312
4316
  * @category Setter
4317
+ * @essential Setting data
4313
4318
  * @since v1.0.0
4314
4319
  */
4315
4320
  setRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4386,6 +4391,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
4386
4391
  * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
4387
4392
  * ```
4388
4393
  * @category Setter
4394
+ * @essential Setting data
4389
4395
  * @since v1.0.0
4390
4396
  */
4391
4397
  addRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4526,6 +4532,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
4526
4532
  * // -> {pets: {fido: {species: 'dog'}}}
4527
4533
  * ```
4528
4534
  * @category Setter
4535
+ * @essential Setting data
4529
4536
  * @since v1.0.0
4530
4537
  */
4531
4538
  setCell<
@@ -4717,6 +4724,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
4717
4724
  * // -> {employees: 3}
4718
4725
  * ```
4719
4726
  * @category Setter
4727
+ * @essential Setting data
4720
4728
  * @since v3.0.0
4721
4729
  */
4722
4730
  setValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -5572,6 +5580,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
5572
5580
  * // -> {open: true}
5573
5581
  * ```
5574
5582
  * @category Transaction
5583
+ * @essential Setting data
5575
5584
  * @since v1.0.0
5576
5585
  */
5577
5586
  transaction<Return>(
@@ -7551,6 +7560,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
7551
7560
  * store.delListener(listenerId);
7552
7561
  * ```
7553
7562
  * @category Listener
7563
+ * @essential Listening for changes
7554
7564
  * @since v1.0.0
7555
7565
  */
7556
7566
  addRowListener<
@@ -7973,6 +7983,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
7973
7983
  * store.delListener(listenerId);
7974
7984
  * ```
7975
7985
  * @category Listener
7986
+ * @essential Listening for changes
7976
7987
  * @since v1.0.0
7977
7988
  */
7978
7989
  addCellListener<
@@ -8438,6 +8449,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
8438
8449
  * store.delListener(listenerId);
8439
8450
  * ```
8440
8451
  * @category Listener
8452
+ * @essential Listening for changes
8441
8453
  * @since v3.0.0
8442
8454
  */
8443
8455
  addValueListener<ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
@@ -9408,6 +9420,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
9408
9420
  * ```
9409
9421
  * @see The Basics guides
9410
9422
  * @category Creation
9423
+ * @essential Creating stores
9411
9424
  * @since v1.0.0
9412
9425
  */
9413
9426
  export function createStore(): Store<NoSchemas>;
@@ -198,6 +198,7 @@ export type SynchronizerStats = {
198
198
  * await synchronizer2.destroy();
199
199
  * ```
200
200
  * @category Synchronizer
201
+ * @essential Synchronizing stores
201
202
  * @since v5.0.0
202
203
  */
203
204
  export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {
@@ -148,6 +148,7 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
148
148
  * await server.destroy();
149
149
  * ```
150
150
  * @category Creation
151
+ * @essential Synchronizing stores
151
152
  * @since v5.0.0
152
153
  */
153
154
  export function createWsSynchronizer<WebSocketType extends WebSocketTypes>(
@@ -164,6 +164,7 @@ export interface WsSynchronizer<
164
164
  * await server.destroy();
165
165
  * ```
166
166
  * @category Creation
167
+ * @essential Synchronizing stores
167
168
  * @since v5.0.0
168
169
  */
169
170
  export function createWsSynchronizer<
@@ -28,6 +28,7 @@ import type {Persister, Persists} from '../../persisters/index.d.ts';
28
28
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
29
29
  * `webSocketClose`) if you further override them.
30
30
  * @category Creation
31
+ * @essential Synchronizing stores
31
32
  * @since v5.4.0
32
33
  */
33
34
  export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
@@ -36,6 +36,7 @@ import type {
36
36
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
37
37
  * `webSocketClose`) if you further override them.
38
38
  * @category Creation
39
+ * @essential Synchronizing stores
39
40
  * @since v5.4.0
40
41
  */
41
42
  export class WsServerDurableObject<
@@ -194,6 +194,7 @@ export type SynchronizerStats = {
194
194
  * await synchronizer2.destroy();
195
195
  * ```
196
196
  * @category Synchronizer
197
+ * @essential Synchronizing stores
197
198
  * @since v5.0.0
198
199
  */
199
200
  export interface Synchronizer<Schemas extends OptionalSchemas>
@@ -376,6 +376,7 @@ export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
376
376
  * // -> '<span>cat</span>'
377
377
  * ```
378
378
  * @category Store hooks
379
+ * @essential Using React
379
380
  * @since v1.0.0
380
381
  */
381
382
  export function useCreateStore(
@@ -1910,6 +1911,7 @@ export function useHasRow(
1910
1911
  * // -> '<span>{"color":"brown"}</span>'
1911
1912
  * ```
1912
1913
  * @category Store hooks
1914
+ * @essential Using React
1913
1915
  * @since v1.0.0
1914
1916
  */
1915
1917
  export function useRow(
@@ -2224,6 +2226,7 @@ export function useHasCell(
2224
2226
  * // -> '<span>brown</span>'
2225
2227
  * ```
2226
2228
  * @category Store hooks
2229
+ * @essential Using React
2227
2230
  * @since v1.0.0
2228
2231
  */
2229
2232
  export function useCell(
@@ -2701,6 +2704,7 @@ export function useHasValue(
2701
2704
  * // -> '<span>true</span>'
2702
2705
  * ```
2703
2706
  * @category Store hooks
2707
+ * @essential Using React
2704
2708
  * @since v3.0.0
2705
2709
  */
2706
2710
  export function useValue(
@@ -14343,6 +14347,7 @@ export type ComponentReturnType = ReactElement<any, any> | null;
14343
14347
  * // -> '<span>5,5,2</span>'
14344
14348
  * ```
14345
14349
  * @category Context components
14350
+ * @essential Using React
14346
14351
  * @since v1.0.0
14347
14352
  */
14348
14353
  export function Provider(
@@ -471,6 +471,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
471
471
  * // -> '<span>cat</span>'
472
472
  * ```
473
473
  * @category Store hooks
474
+ * @essential Using React
474
475
  * @since v1.0.0
475
476
  */
476
477
  useCreateStore: (
@@ -2153,6 +2154,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2153
2154
  * // -> '<span>{"color":"brown"}</span>'
2154
2155
  * ```
2155
2156
  * @category Store hooks
2157
+ * @essential Using React
2156
2158
  * @since v1.0.0
2157
2159
  */
2158
2160
  useRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -2502,6 +2504,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2502
2504
  * // -> '<span>brown</span>'
2503
2505
  * ```
2504
2506
  * @category Store hooks
2507
+ * @essential Using React
2505
2508
  * @since v1.0.0
2506
2509
  */
2507
2510
  useCell: <
@@ -3020,6 +3023,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3020
3023
  * // -> '<span>true</span>'
3021
3024
  * ```
3022
3025
  * @category Store hooks
3026
+ * @essential Using React
3023
3027
  * @since v3.0.0
3024
3028
  */
3025
3029
  useValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -14425,6 +14429,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
14425
14429
  * // -> '<span>5,5,2</span>'
14426
14430
  * ```
14427
14431
  * @category Context components
14432
+ * @essential Using React
14428
14433
  * @since v1.0.0
14429
14434
  */
14430
14435
  Provider: (
@@ -74,6 +74,7 @@ export type InspectorProps = {
74
74
  * // -> '<aside id="tinybaseInspector">'
75
75
  * ```
76
76
  * @category Development components
77
+ * @essential Using React
77
78
  * @since v5.0.0
78
79
  */
79
80
  export function Inspector(props: InspectorProps): ComponentReturnType;
@@ -1979,6 +1979,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1979
1979
  * // -> '<aside id="tinybaseInspector">'
1980
1980
  * ```
1981
1981
  * @category Development components
1982
+ * @essential Using React
1982
1983
  * @since v5.0.0
1983
1984
  */
1984
1985
  Inspector: (props: InspectorProps) => ComponentReturnType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tinybase",
3
- "version": "6.3.0",
3
+ "version": "6.3.1",
4
4
  "author": "jamesgpearce",
5
5
  "repository": "github:tinyplex/tinybase",
6
6
  "license": "MIT",
@@ -22,23 +22,23 @@
22
22
  "sideEffects": false,
23
23
  "peerDependencies": {
24
24
  "@automerge/automerge-repo": "^1.2.1",
25
- "@cloudflare/workers-types": "^4.20250619.0",
25
+ "@cloudflare/workers-types": "^4.20250709.0",
26
26
  "@electric-sql/pglite": "^0.2.17",
27
27
  "@libsql/client": "^0.15.9",
28
- "@powersync/common": "^1.33.0",
28
+ "@powersync/common": "^1.33.2",
29
29
  "@sqlite.org/sqlite-wasm": "^3.50.1-build1",
30
30
  "@vlcn.io/crsqlite-wasm": "^0.16.0",
31
- "bun": "^1.2.16",
31
+ "bun": "^1.2.18",
32
32
  "electric-sql": "^0.12.1",
33
33
  "expo": "^53.0.9",
34
- "expo-sqlite": "^15.2.12",
34
+ "expo-sqlite": "^15.2.14",
35
35
  "partykit": "^0.0.115",
36
36
  "partysocket": "^1.1.4",
37
37
  "postgres": "^3.4.7",
38
38
  "react": "^19.0.0",
39
39
  "react-dom": "^19.0.0",
40
40
  "sqlite3": "^5.1.7",
41
- "ws": "^8.18.2",
41
+ "ws": "^8.18.3",
42
42
  "yjs": "^13.6.27"
43
43
  },
44
44
  "peerDependenciesMeta": {