tinybase 6.1.0-beta.1 → 6.1.0-beta.2

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 (98) hide show
  1. package/@types/common/index.d.ts +4 -4
  2. package/@types/common/with-schemas/index.d.ts +4 -4
  3. package/index.js +15 -3
  4. package/indexes/index.js +15 -3
  5. package/indexes/with-schemas/index.js +15 -3
  6. package/min/index.js +1 -1
  7. package/min/index.js.gz +0 -0
  8. package/min/indexes/index.js +1 -1
  9. package/min/indexes/index.js.gz +0 -0
  10. package/min/indexes/with-schemas/index.js +1 -1
  11. package/min/indexes/with-schemas/index.js.gz +0 -0
  12. package/min/with-schemas/index.js +1 -1
  13. package/min/with-schemas/index.js.gz +0 -0
  14. package/package.json +7 -7
  15. package/readme.md +1 -1
  16. package/with-schemas/index.js +15 -3
  17. package/@types/_internal/queries/index.d.cts +0 -0
  18. package/@types/_internal/queries/with-schemas/index.d.cts +0 -22
  19. package/@types/_internal/store/index.d.cts +0 -3
  20. package/@types/_internal/store/with-schemas/index.d.cts +0 -106
  21. package/@types/_internal/ui-react/index.d.cts +0 -0
  22. package/@types/_internal/ui-react/with-schemas/index.d.cts +0 -1130
  23. package/@types/checkpoints/index.d.cts +0 -1059
  24. package/@types/checkpoints/with-schemas/index.d.cts +0 -1151
  25. package/@types/common/index.d.cts +0 -158
  26. package/@types/common/with-schemas/index.d.cts +0 -158
  27. package/@types/index.d.cts +0 -17
  28. package/@types/indexes/index.d.cts +0 -1064
  29. package/@types/indexes/with-schemas/index.d.cts +0 -1210
  30. package/@types/mergeable-store/index.d.cts +0 -1139
  31. package/@types/mergeable-store/with-schemas/index.d.cts +0 -1628
  32. package/@types/metrics/index.d.cts +0 -917
  33. package/@types/metrics/with-schemas/index.d.cts +0 -1004
  34. package/@types/persisters/index.d.cts +0 -1877
  35. package/@types/persisters/persister-automerge/index.d.cts +0 -165
  36. package/@types/persisters/persister-automerge/with-schemas/index.d.cts +0 -180
  37. package/@types/persisters/persister-browser/index.d.cts +0 -185
  38. package/@types/persisters/persister-browser/with-schemas/index.d.cts +0 -208
  39. package/@types/persisters/persister-cr-sqlite-wasm/index.d.cts +0 -159
  40. package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.cts +0 -178
  41. package/@types/persisters/persister-durable-object-storage/index.d.cts +0 -122
  42. package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.cts +0 -136
  43. package/@types/persisters/persister-electric-sql/index.d.cts +0 -185
  44. package/@types/persisters/persister-electric-sql/with-schemas/index.d.cts +0 -204
  45. package/@types/persisters/persister-expo-sqlite/index.d.cts +0 -186
  46. package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.cts +0 -205
  47. package/@types/persisters/persister-file/index.d.cts +0 -94
  48. package/@types/persisters/persister-file/with-schemas/index.d.cts +0 -107
  49. package/@types/persisters/persister-indexed-db/index.d.cts +0 -120
  50. package/@types/persisters/persister-indexed-db/with-schemas/index.d.cts +0 -135
  51. package/@types/persisters/persister-libsql/index.d.cts +0 -158
  52. package/@types/persisters/persister-libsql/with-schemas/index.d.cts +0 -177
  53. package/@types/persisters/persister-partykit-client/index.d.cts +0 -195
  54. package/@types/persisters/persister-partykit-client/with-schemas/index.d.cts +0 -210
  55. package/@types/persisters/persister-partykit-server/index.d.cts +0 -650
  56. package/@types/persisters/persister-partykit-server/with-schemas/index.d.cts +0 -695
  57. package/@types/persisters/persister-pglite/index.d.cts +0 -177
  58. package/@types/persisters/persister-pglite/with-schemas/index.d.cts +0 -196
  59. package/@types/persisters/persister-postgres/index.d.cts +0 -166
  60. package/@types/persisters/persister-postgres/with-schemas/index.d.cts +0 -185
  61. package/@types/persisters/persister-powersync/index.d.cts +0 -174
  62. package/@types/persisters/persister-powersync/with-schemas/index.d.cts +0 -193
  63. package/@types/persisters/persister-remote/index.d.cts +0 -117
  64. package/@types/persisters/persister-remote/with-schemas/index.d.cts +0 -133
  65. package/@types/persisters/persister-sqlite-wasm/index.d.cts +0 -175
  66. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.cts +0 -195
  67. package/@types/persisters/persister-sqlite3/index.d.cts +0 -176
  68. package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts +0 -195
  69. package/@types/persisters/persister-yjs/index.d.cts +0 -161
  70. package/@types/persisters/persister-yjs/with-schemas/index.d.cts +0 -176
  71. package/@types/persisters/with-schemas/index.d.cts +0 -2054
  72. package/@types/queries/index.d.cts +0 -3695
  73. package/@types/queries/with-schemas/index.d.cts +0 -4016
  74. package/@types/relationships/index.d.cts +0 -1320
  75. package/@types/relationships/with-schemas/index.d.cts +0 -1474
  76. package/@types/store/index.d.cts +0 -7598
  77. package/@types/store/with-schemas/index.d.cts +0 -9278
  78. package/@types/synchronizers/index.d.cts +0 -485
  79. package/@types/synchronizers/synchronizer-broadcast-channel/index.d.cts +0 -121
  80. package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.cts +0 -137
  81. package/@types/synchronizers/synchronizer-local/index.d.cts +0 -95
  82. package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts +0 -114
  83. package/@types/synchronizers/synchronizer-ws-client/index.d.cts +0 -160
  84. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.cts +0 -179
  85. package/@types/synchronizers/synchronizer-ws-server/index.d.cts +0 -736
  86. package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts +0 -765
  87. package/@types/synchronizers/synchronizer-ws-server-durable-object/index.d.cts +0 -311
  88. package/@types/synchronizers/synchronizer-ws-server-durable-object/with-schemas/index.d.cts +0 -349
  89. package/@types/synchronizers/synchronizer-ws-server-simple/index.d.cts +0 -144
  90. package/@types/synchronizers/synchronizer-ws-server-simple/with-schemas/index.d.cts +0 -144
  91. package/@types/synchronizers/with-schemas/index.d.cts +0 -503
  92. package/@types/ui-react/index.d.cts +0 -16640
  93. package/@types/ui-react/with-schemas/index.d.cts +0 -17281
  94. package/@types/ui-react-dom/index.d.cts +0 -1862
  95. package/@types/ui-react-dom/with-schemas/index.d.cts +0 -1994
  96. package/@types/ui-react-inspector/index.d.cts +0 -79
  97. package/@types/ui-react-inspector/with-schemas/index.d.cts +0 -1985
  98. package/@types/with-schemas/index.d.cts +0 -17
@@ -1,1130 +0,0 @@
1
- import type {ComponentType, ReactElement} from 'react';
2
- import type {Checkpoints} from '../../../checkpoints/with-schemas/index.d.cts';
3
- import type {Callback, Id} from '../../../common/with-schemas/index.d.cts';
4
- import type {Indexes} from '../../../indexes/with-schemas/index.d.cts';
5
- import type {Metrics} from '../../../metrics/with-schemas/index.d.cts';
6
- import type {
7
- Persister,
8
- Persists,
9
- } from '../../../persisters/with-schemas/index.d.cts';
10
- import type {Queries} from '../../../queries/with-schemas/index.d.cts';
11
- import type {Relationships} from '../../../relationships/with-schemas/index.d.cts';
12
- import type {
13
- OptionalSchemas,
14
- Store,
15
- } from '../../../store/with-schemas/index.d.cts';
16
- import type {Synchronizer} from '../../../synchronizers/with-schemas/index.d.cts';
17
- import type {
18
- CellIdFromSchema,
19
- TableIdFromSchema,
20
- ValueIdFromSchema,
21
- } from '../../store/with-schemas/index.d.cts';
22
-
23
- type StoreOrStoreId<Schemas extends OptionalSchemas> = Store<Schemas> | Id;
24
-
25
- type MetricsOrMetricsId<Schemas extends OptionalSchemas> =
26
- | Metrics<Schemas>
27
- | Id;
28
-
29
- type IndexesOrIndexesId<Schemas extends OptionalSchemas> =
30
- | Indexes<Schemas>
31
- | Id;
32
-
33
- type RelationshipsOrRelationshipsId<Schemas extends OptionalSchemas> =
34
- | Relationships<Schemas>
35
- | Id;
36
-
37
- type QueriesOrQueriesId<Schemas extends OptionalSchemas> =
38
- | Queries<Schemas>
39
- | Id;
40
-
41
- type CheckpointsOrCheckpointsId<Schemas extends OptionalSchemas> =
42
- | Checkpoints<Schemas>
43
- | Id;
44
-
45
- type PersisterOrPersisterId<Schemas extends OptionalSchemas> =
46
- | Persister<Schemas, Persists.StoreOrMergeableStore>
47
- | Id;
48
-
49
- type SynchronizerOrSynchronizerId<Schemas extends OptionalSchemas> =
50
- | Synchronizer<Schemas>
51
- | Id;
52
-
53
- type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
54
-
55
- type GetId<Schemas extends OptionalSchemas, Parameter, Id> = (
56
- parameter: Parameter,
57
- store: Store<Schemas>,
58
- ) => Id;
59
-
60
- type ExtraProps = {[propName: string]: any};
61
-
62
- type TablesProps<Schemas extends OptionalSchemas> = {
63
- /**
64
- * The Store to be accessed: omit for the default context Store, provide an Id
65
- * for a named context Store, or provide an explicit reference.
66
- * @category Prop
67
- * @since v1.0.0
68
- */
69
- readonly store?: StoreOrStoreId<Schemas>;
70
- /**
71
- * A component for rendering each Table in the Store (to override the default
72
- * TableView component).
73
- * @category Prop
74
- * @since v1.0.0
75
- */
76
- readonly tableComponent?: ComponentType<TableProps<Schemas>>;
77
- /**
78
- * A custom function for generating extra props for each Table component based
79
- * on its Id.
80
- * @category Prop
81
- * @since v1.0.0
82
- */
83
- readonly getTableComponentProps?: (tableId: Id) => ExtraProps;
84
- /**
85
- * A component or string to separate each Table component.
86
- * @category Prop
87
- * @since v1.0.0
88
- */
89
- readonly separator?: ReactElement | string;
90
- /**
91
- * Whether the component should also render the Ids of each Table, and its
92
- * descendent objects, to assist with debugging.
93
- * @category Prop
94
- * @since v1.0.0
95
- */
96
- readonly debugIds?: boolean;
97
- };
98
-
99
- export type TableProps<
100
- Schemas extends OptionalSchemas,
101
- TableIds extends TableIdFromSchema<Schemas[0]> = TableIdFromSchema<
102
- Schemas[0]
103
- >,
104
- > = TableIds extends infer TableId
105
- ? TableId extends TableIdFromSchema<Schemas[0]>
106
- ? {
107
- /**
108
- * The Id of the Table in the Store to be rendered.
109
- * @category Prop
110
- * @since v1.0.0
111
- */
112
- readonly tableId: TableId;
113
- /**
114
- * The Store to be accessed: omit for the default context Store, provide an Id
115
- * for a named context Store, or provide an explicit reference.
116
- * @category Prop
117
- * @since v1.0.0
118
- */
119
- readonly store?: StoreOrStoreId<Schemas>;
120
- /**
121
- * A custom component for rendering each Row in the Table (to override the
122
- * default RowView component).
123
- * @category Prop
124
- * @since v1.0.0
125
- */
126
- readonly rowComponent?: ComponentType<RowProps<Schemas, TableId>>;
127
- /**
128
- * A function for generating extra props for each custom Row component based
129
- * on its Id.
130
- * @category Prop
131
- * @since v1.0.0
132
- */
133
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
134
- /**
135
- * An optional list of Cell Ids to use for rendering a prescribed set of the
136
- * Table's Cells in a given order.
137
- * @category Prop
138
- * @since v1.0.0
139
- */
140
- readonly customCellIds?: CellIdFromSchema<Schemas[0], TableId>[];
141
- /**
142
- * A component or string to separate each Row component.
143
- * @category Prop
144
- * @since v1.0.0
145
- */
146
- readonly separator?: ReactElement | string;
147
- /**
148
- * Whether the component should also render the Id of the Table, and its
149
- * descendent objects, to assist with debugging.
150
- * @category Prop
151
- * @since v1.0.0
152
- */
153
- readonly debugIds?: boolean;
154
- }
155
- : never
156
- : never;
157
-
158
- export type SortedTableProps<
159
- Schemas extends OptionalSchemas,
160
- TableIds extends TableIdFromSchema<Schemas[0]> = TableIdFromSchema<
161
- Schemas[0]
162
- >,
163
- > = TableIds extends infer TableId
164
- ? TableId extends TableIdFromSchema<Schemas[0]>
165
- ? {
166
- /**
167
- * The Id of the Table in the Store to be rendered.
168
- * @category Prop
169
- * @since v1.0.0
170
- */
171
- readonly tableId: TableId;
172
- /**
173
- * The Id of the Cell whose values are used for the sorting. If omitted, the
174
- * view will sort the Row Id itself.
175
- * @category Prop
176
- * @since v1.0.0
177
- */
178
- readonly cellId?: CellIdFromSchema<Schemas[0], TableId>;
179
- /**
180
- * Whether the sorting should be in descending order.
181
- * @category Prop
182
- * @since v1.0.0
183
- */
184
- readonly descending?: boolean;
185
- /**
186
- * The number of Row Ids to skip for pagination purposes.
187
- * @category Prop
188
- * @since v1.0.0
189
- */
190
- readonly offset?: number;
191
- /**
192
- * The maximum number of Row Ids to return.
193
- * @category Prop
194
- * @since v1.0.0
195
- */
196
- readonly limit?: number;
197
- /**
198
- * The Store to be accessed: omit for the default context Store, provide an Id
199
- * for a named context Store, or provide an explicit reference.
200
- * @category Prop
201
- * @since v1.0.0
202
- */
203
- readonly store?: StoreOrStoreId<Schemas>;
204
- /**
205
- * A custom component for rendering each Row in the Table (to override the
206
- * default RowView component).
207
- * @category Prop
208
- * @since v1.0.0
209
- */
210
- readonly rowComponent?: ComponentType<RowProps<Schemas, TableId>>;
211
- /**
212
- * A function for generating extra props for each custom Row component based
213
- * on its Id.
214
- * @category Prop
215
- * @since v1.0.0
216
- */
217
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
218
- /**
219
- * An optional list of Cell Ids to use for rendering a prescribed set of the
220
- * sorted Table's Cells in a given order.
221
- * @category Prop
222
- * @since v1.0.0
223
- */
224
- readonly customCellIds?: CellIdFromSchema<Schemas[0], TableId>[];
225
- /**
226
- * A component or string to separate each Row component.
227
- * @category Prop
228
- * @since v1.0.0
229
- */
230
- readonly separator?: ReactElement | string;
231
- /**
232
- * Whether the component should also render the Id of the Table, and its
233
- * descendent objects, to assist with debugging.
234
- * @category Prop
235
- * @since v1.0.0
236
- */
237
- readonly debugIds?: boolean;
238
- }
239
- : never
240
- : never;
241
-
242
- export type RowProps<
243
- Schemas extends OptionalSchemas,
244
- TableIds extends TableIdFromSchema<Schemas[0]> = TableIdFromSchema<
245
- Schemas[0]
246
- >,
247
- > = TableIds extends infer TableId
248
- ? TableId extends TableIdFromSchema<Schemas[0]>
249
- ? {
250
- /**
251
- * The Id of the Table in the Store.
252
- * @category Prop
253
- * @since v1.0.0
254
- */
255
- readonly tableId: TableId;
256
- /**
257
- * The Id of the Row in the Table to be rendered.
258
- * @category Prop
259
- * @since v1.0.0
260
- */
261
- readonly rowId: Id;
262
- /**
263
- * The Store to be accessed: omit for the default context Store, provide an Id
264
- * for a named context Store, or provide an explicit reference.
265
- * @category Prop
266
- * @since v1.0.0
267
- */
268
- readonly store?: StoreOrStoreId<Schemas>;
269
- /**
270
- * A custom component for rendering each Cell in the Row (to override the
271
- * default CellView component).
272
- * @category Prop
273
- * @since v1.0.0
274
- */
275
- readonly cellComponent?: ComponentType<CellProps<Schemas, TableId>>;
276
- /**
277
- * A function for generating extra props for each custom Cell component based
278
- * on its Id.
279
- * @category Prop
280
- * @since v1.0.0
281
- */
282
- readonly getCellComponentProps?: (cellId: Id) => ExtraProps;
283
- /**
284
- * An optional list of Cell Ids to use for rendering a prescribed set of the
285
- * Row's Cells in a given order.
286
- * @category Prop
287
- * @since v1.0.0
288
- */
289
- readonly customCellIds?: CellIdFromSchema<Schemas[0], TableId>[];
290
- /**
291
- * A component or string to separate each Cell component.
292
- * @category Prop
293
- * @since v1.0.0
294
- */
295
- readonly separator?: ReactElement | string;
296
- /**
297
- * Whether the component should also render the Id of the Row, and its
298
- * descendent objects, to assist with debugging.
299
- * @category Prop
300
- * @since v1.0.0
301
- */
302
- readonly debugIds?: boolean;
303
- }
304
- : never
305
- : never;
306
-
307
- export type CellProps<
308
- Schemas extends OptionalSchemas,
309
- TableIds extends TableIdFromSchema<Schemas[0]> = TableIdFromSchema<
310
- Schemas[0]
311
- >,
312
- > = TableIds extends infer TableId
313
- ? TableId extends TableIdFromSchema<Schemas[0]>
314
- ? CellPropsForTableIdAndCellId<
315
- Schemas,
316
- TableId,
317
- CellIdFromSchema<Schemas[0], TableId>
318
- >
319
- : never
320
- : never;
321
-
322
- export type CellPropsForTableIdAndCellId<
323
- Schemas extends OptionalSchemas,
324
- TableId extends TableIdFromSchema<Schemas[0]>,
325
- CellId extends CellIdFromSchema<Schemas[0], TableId>,
326
- > = {
327
- /**
328
- * The Id of the Table in the Store.
329
- * @category Prop
330
- * @since v1.0.0
331
- */
332
- readonly tableId: TableId;
333
- /**
334
- * The Id of the Row in the Table.
335
- * @category Prop
336
- * @since v1.0.0
337
- */
338
- readonly rowId: Id;
339
- /**
340
- * The Id of the Cell in the Row to be rendered.
341
- * @category Prop
342
- * @since v1.0.0
343
- */
344
- readonly cellId: CellId;
345
- /**
346
- * The Store to be accessed: omit for the default context Store, provide an Id
347
- * for a named context Store, or provide an explicit reference.
348
- * @category Prop
349
- * @since v1.0.0
350
- */
351
- readonly store?: StoreOrStoreId<Schemas>;
352
- /**
353
- * Whether the component should also render the Id of the Cell to assist with
354
- * debugging.
355
- * @category Prop
356
- * @since v1.0.0
357
- */
358
- readonly debugIds?: boolean;
359
- };
360
-
361
- export type ValuesProps<Schemas extends OptionalSchemas> = {
362
- /**
363
- * The Store to be accessed: omit for the default context Store, provide an Id
364
- * for a named context Store, or provide an explicit reference.
365
- * @category Prop
366
- * @since v1.0.0
367
- */
368
- readonly store?: StoreOrStoreId<Schemas>;
369
- /**
370
- * A custom component for rendering each Value in the Store (to override the
371
- * default ValueView component).
372
- * @category Prop
373
- * @since v1.0.0
374
- */
375
- readonly valueComponent?: ComponentType<ValueProps<Schemas>>;
376
- /**
377
- * A function for generating extra props for each custom Value component based
378
- * on its Id.
379
- * @category Prop
380
- * @since v1.0.0
381
- */
382
- readonly getValueComponentProps?: (valueId: Id) => ExtraProps;
383
- /**
384
- * A component or string to separate each Value component.
385
- * @category Prop
386
- * @since v1.0.0
387
- */
388
- readonly separator?: ReactElement | string;
389
- /**
390
- * Whether the component should also render the Ids of each Value to assist
391
- * with debugging.
392
- * @category Prop
393
- * @since v1.0.0
394
- */
395
- readonly debugIds?: boolean;
396
- };
397
-
398
- export type ValueProps<Schemas extends OptionalSchemas> = {
399
- /**
400
- * The Id of the Value in the Row to be rendered.
401
- * @category Prop
402
- * @since v1.0.0
403
- */
404
- readonly valueId: ValueIdFromSchema<Schemas[1]>;
405
- /**
406
- * The Store to be accessed: omit for the default context Store, provide an Id
407
- * for a named context Store, or provide an explicit reference.
408
- * @category Prop
409
- * @since v1.0.0
410
- */
411
- readonly store?: StoreOrStoreId<Schemas>;
412
- /**
413
- * Whether the component should also render the Id of the Value to assist with
414
- * debugging.
415
- * @category Prop
416
- * @since v1.0.0
417
- */
418
- readonly debugIds?: boolean;
419
- };
420
-
421
- export type MetricProps<Schemas extends OptionalSchemas> = {
422
- /**
423
- * The Id of the Metric in the Metrics object to be rendered.
424
- * @category Prop
425
- * @since v1.0.0
426
- */
427
- readonly metricId: Id;
428
- /**
429
- * The Metrics object to be accessed: omit for the default context Metrics
430
- * object, provide an Id for a named context Metrics object, or provide an
431
- * explicit reference.
432
- * @category Prop
433
- * @since v1.0.0
434
- */
435
- readonly metrics?: MetricsOrMetricsId<Schemas>;
436
- /**
437
- * Whether the component should also render the Id of the Metric to assist
438
- * with debugging.
439
- * @category Prop
440
- * @since v1.0.0
441
- */
442
- readonly debugIds?: boolean;
443
- };
444
-
445
- export type IndexProps<Schemas extends OptionalSchemas> = {
446
- /**
447
- * The Id of the Index in the Indexes object to be rendered.
448
- * @category Prop
449
- * @since v1.0.0
450
- */
451
- readonly indexId: Id;
452
- /**
453
- * The Indexes object to be accessed: omit for the default context Indexes
454
- * object, provide an Id for a named context Indexes object, or provide an
455
- * explicit reference.
456
- * @category Prop
457
- * @since v1.0.0
458
- */
459
- readonly indexes?: IndexesOrIndexesId<Schemas>;
460
- /**
461
- * A component for rendering each Slice in the Index.
462
- * @category Prop
463
- * @since v1.0.0
464
- */
465
- readonly sliceComponent?: ComponentType<SliceProps<Schemas>>;
466
- /**
467
- * A function for generating extra props for each Slice component based on its
468
- * Id.
469
- * @category Prop
470
- * @since v1.0.0
471
- */
472
- readonly getSliceComponentProps?: (sliceId: Id) => ExtraProps;
473
- /**
474
- * A component or string to separate each Slice component.
475
- * @category Prop
476
- * @since v1.0.0
477
- */
478
- readonly separator?: ReactElement | string;
479
- /**
480
- * Whether the component should also render the Id of the Index, and its
481
- * descendent objects, to assist with debugging.
482
- * @category Prop
483
- * @since v1.0.0
484
- */
485
- readonly debugIds?: boolean;
486
- };
487
-
488
- export type SliceProps<Schemas extends OptionalSchemas> = {
489
- /**
490
- * The Id of the Index in the Indexes object.
491
- * @category Prop
492
- * @since v1.0.0
493
- */
494
- readonly indexId: Id;
495
- /**
496
- * The Id of the Slice in the Index to be rendered.
497
- * @category Prop
498
- * @since v1.0.0
499
- */
500
- readonly sliceId: Id;
501
- /**
502
- * The Indexes object to be accessed: omit for the default context Indexes
503
- * object, provide an Id for a named context Indexes object, or provide an
504
- * explicit reference.
505
- * @category Prop
506
- * @since v1.0.0
507
- */
508
- readonly indexes?: IndexesOrIndexesId<Schemas>;
509
- /**
510
- * A component for rendering each Row in the Index.
511
- * @category Prop
512
- * @since v1.0.0
513
- */
514
- readonly rowComponent?: ComponentType<RowProps<Schemas>>;
515
- /**
516
- * A function for generating extra props for each Row component based on its
517
- * Id.
518
- * @category Prop
519
- * @since v1.0.0
520
- */
521
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
522
- /**
523
- * A component or string to separate each Row component.
524
- * @category Prop
525
- * @since v1.0.0
526
- */
527
- readonly separator?: ReactElement | string;
528
- /**
529
- * Whether the component should also render the Id of the Slice, and its
530
- * descendent objects, to assist with debugging.
531
- * @category Prop
532
- * @since v1.0.0
533
- */
534
- readonly debugIds?: boolean;
535
- };
536
-
537
- export type RemoteRowProps<Schemas extends OptionalSchemas> = {
538
- /**
539
- * The Id of the Relationship in the Relationships object.
540
- * @category Prop
541
- * @since v1.0.0
542
- */
543
- readonly relationshipId: Id;
544
- /**
545
- * The Id of the local Row for which to render the remote Row.
546
- * @category Prop
547
- * @since v1.0.0
548
- */
549
- readonly localRowId: Id;
550
- /**
551
- * The Relationships object to be accessed: omit for the default context
552
- * Relationships object, provide an Id for a named context Relationships
553
- * object, or provide an explicit reference.
554
- * @category Prop
555
- * @since v1.0.0
556
- */
557
- readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
558
- /**
559
- * A component for rendering each (remote, local, or linked) Row in the
560
- * Relationship.
561
- * @category Prop
562
- * @since v1.0.0
563
- */
564
- readonly rowComponent?: ComponentType<RowProps<Schemas>>;
565
- /**
566
- * A function for generating extra props for each Row component based on its
567
- * Id.
568
- * @category Prop
569
- * @since v1.0.0
570
- */
571
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
572
- /**
573
- * Whether the component should also render the Id of the Row in the
574
- * Relationship, and its descendent objects, to assist with debugging.
575
- * @category Prop
576
- * @since v1.0.0
577
- */
578
- readonly debugIds?: boolean;
579
- };
580
-
581
- export type LocalRowsProps<Schemas extends OptionalSchemas> = {
582
- /**
583
- * The Id of the Relationship in the Relationships object.
584
- * @category Prop
585
- * @since v1.0.0
586
- */
587
- readonly relationshipId: Id;
588
- /**
589
- * The Id of the remote Row for which to render the local Rows.
590
- * @category Prop
591
- * @since v1.0.0
592
- */
593
- readonly remoteRowId: Id;
594
- /**
595
- * The Relationships object to be accessed: omit for the default context
596
- * Relationships object, provide an Id for a named context Relationships
597
- * object, or provide an explicit reference.
598
- * @category Prop
599
- * @since v1.0.0
600
- */
601
- readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
602
- /**
603
- * A component for rendering each (remote, local, or linked) Row in the
604
- * Relationship.
605
- * @category Prop
606
- * @since v1.0.0
607
- */
608
- readonly rowComponent?: ComponentType<RowProps<Schemas>>;
609
- /**
610
- * A function for generating extra props for each Row component based on its
611
- * Id.
612
- * @category Prop
613
- * @since v1.0.0
614
- */
615
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
616
- /**
617
- * A component or string to separate each Row component.
618
- * @category Prop
619
- * @since v1.0.0
620
- */
621
- readonly separator?: ReactElement | string;
622
- /**
623
- * Whether the component should also render the Id of the Row in the
624
- * Relationship, and its descendent objects, to assist with debugging.
625
- * @category Prop
626
- * @since v1.0.0
627
- */
628
- readonly debugIds?: boolean;
629
- };
630
-
631
- export type LinkedRowsProps<Schemas extends OptionalSchemas> = {
632
- /**
633
- * The Id of the Relationship in the Relationships object.
634
- * @category Prop
635
- * @since v1.0.0
636
- */
637
- readonly relationshipId: Id;
638
- /**
639
- * The Id of the first Row in the linked list Relationship.
640
- * @category Prop
641
- * @since v1.0.0
642
- */
643
- readonly firstRowId: Id;
644
- /**
645
- * The Relationships object to be accessed: omit for the default context
646
- * Relationships object, provide an Id for a named context Relationships
647
- * object, or provide an explicit reference.
648
- * @category Prop
649
- * @since v1.0.0
650
- */
651
- readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
652
- /**
653
- * A component for rendering each (remote, local, or linked) Row in the
654
- * Relationship.
655
- * @category Prop
656
- * @since v1.0.0
657
- */
658
- readonly rowComponent?: ComponentType<RowProps<Schemas>>;
659
- /**
660
- * A function for generating extra props for each Row component based on its
661
- * Id.
662
- * @category Prop
663
- * @since v1.0.0
664
- */
665
- readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
666
- /**
667
- * A component or string to separate each Row component.
668
- * @category Prop
669
- * @since v1.0.0
670
- */
671
- readonly separator?: ReactElement | string;
672
- /**
673
- * Whether the component should also render the Id of the Row in the
674
- * Relationship, and its descendent objects, to assist with debugging.
675
- * @category Prop
676
- * @since v1.0.0
677
- */
678
- readonly debugIds?: boolean;
679
- };
680
-
681
- export type ResultTableProps<Schemas extends OptionalSchemas> = {
682
- /**
683
- * The Id of the query in the Queries object for which the ResultTable will be
684
- * rendered.
685
- * @category Prop
686
- * @since v1.0.0
687
- */
688
- readonly queryId: Id;
689
- /**
690
- * The Queries object to be accessed: omit for the default context Queries
691
- * object, provide an Id for a named context Queries object, or provide an
692
- * explicit reference.
693
- * @category Prop
694
- * @since v1.0.0
695
- */
696
- readonly queries?: QueriesOrQueriesId<Schemas>;
697
- /**
698
- * A custom component for rendering each Row in the Table (to override the
699
- * default ResultRowView component).
700
- * @category Prop
701
- * @since v1.0.0
702
- */
703
- readonly resultRowComponent?: ComponentType<ResultRowProps<Schemas>>;
704
- /**
705
- * A function for generating extra props for each custom Row component based
706
- * on its Id.
707
- * @category Prop
708
- * @since v1.0.0
709
- */
710
- readonly getResultRowComponentProps?: (rowId: Id) => ExtraProps;
711
- /**
712
- * A component or string to separate each Row component.
713
- * @category Prop
714
- * @since v1.0.0
715
- */
716
- readonly separator?: ReactElement | string;
717
- /**
718
- * Whether the component should also render the Id of the query, and its
719
- * descendent objects, to assist with debugging.
720
- * @category Prop
721
- * @since v1.0.0
722
- */
723
- readonly debugIds?: boolean;
724
- };
725
-
726
- export type ResultSortedTableProps<Schemas extends OptionalSchemas> = {
727
- /**
728
- * The Id of the query in the Queries object for which the sorted ResultTable
729
- * will be rendered.
730
- * @category Prop
731
- * @since v1.0.0
732
- */
733
- readonly queryId: Id;
734
- /**
735
- * The Id of the Cell whose values are used for the sorting. If omitted, the
736
- * view will sort the Row Id itself.
737
- * @category Prop
738
- * @since v1.0.0
739
- */
740
- readonly cellId?: Id;
741
- /**
742
- * Whether the sorting should be in descending order.
743
- * @category Prop
744
- * @since v1.0.0
745
- */
746
- readonly descending?: boolean;
747
- /**
748
- * The number of Row Ids to skip for pagination purposes.
749
- * @category Prop
750
- * @since v1.0.0
751
- */
752
- readonly offset?: number;
753
- /**
754
- * The maximum number of Row Ids to return.
755
- * @category Prop
756
- * @since v1.0.0
757
- */
758
- readonly limit?: number;
759
- /**
760
- * The Queries object to be accessed: omit for the default context Queries
761
- * object, provide an Id for a named context Queries object, or provide an
762
- * explicit reference.
763
- * @category Prop
764
- * @since v1.0.0
765
- */
766
- readonly queries?: QueriesOrQueriesId<Schemas>;
767
- /**
768
- * A custom component for rendering each Row in the Table (to override the
769
- * default ResultRowView component).
770
- * @category Prop
771
- * @since v1.0.0
772
- */
773
- readonly resultRowComponent?: ComponentType<ResultRowProps<Schemas>>;
774
- /**
775
- * A function for generating extra props for each custom Row component based
776
- * on its Id.
777
- * @category Prop
778
- * @since v1.0.0
779
- */
780
- readonly getResultRowComponentProps?: (rowId: Id) => ExtraProps;
781
- /**
782
- * A component or string to separate each Row component.
783
- * @category Prop
784
- * @since v1.0.0
785
- */
786
- readonly separator?: ReactElement | string;
787
- /**
788
- * Whether the component should also render the Id of the query, and its
789
- * descendent objects, to assist with debugging.
790
- * @category Prop
791
- * @since v1.0.0
792
- */
793
- readonly debugIds?: boolean;
794
- };
795
-
796
- export type ResultRowProps<Schemas extends OptionalSchemas> = {
797
- /**
798
- * The Id of the query in the Queries object for which the ResultTable will be
799
- * rendered.
800
- * @category Prop
801
- * @since v1.0.0
802
- */
803
- readonly queryId: Id;
804
- /**
805
- * The Id of the Row in the ResultTable to be rendered.
806
- * @category Prop
807
- * @since v1.0.0
808
- */
809
- readonly rowId: Id;
810
- /**
811
- * The Queries object to be accessed: omit for the default context Queries
812
- * object, provide an Id for a named context Queries object, or provide an
813
- * explicit reference.
814
- * @category Prop
815
- * @since v1.0.0
816
- */
817
- readonly queries?: QueriesOrQueriesId<Schemas>;
818
- /**
819
- * A custom component for rendering each Cell in the Row (to override the
820
- * default CellView component).
821
- * @category Prop
822
- * @since v1.0.0
823
- */
824
- readonly resultCellComponent?: ComponentType<ResultCellProps<Schemas>>;
825
- /**
826
- * A function for generating extra props for each custom Cell component based
827
- * on its Id.
828
- * @category Prop
829
- * @since v1.0.0
830
- */
831
- readonly getResultCellComponentProps?: (cellId: Id) => ExtraProps;
832
- /**
833
- * A component or string to separate each Cell component.
834
- * @category Prop
835
- * @since v1.0.0
836
- */
837
- readonly separator?: ReactElement | string;
838
- /**
839
- * Whether the component should also render the Id of the Row, and its
840
- * descendent objects, to assist with debugging.
841
- * @category Prop
842
- * @since v1.0.0
843
- */
844
- readonly debugIds?: boolean;
845
- };
846
-
847
- export type ResultCellProps<Schemas extends OptionalSchemas> = {
848
- /**
849
- * The Id of the query in the Queries object for which the ResultTable will be
850
- * rendered.
851
- * @category Prop
852
- * @since v1.0.0
853
- */
854
- readonly queryId: Id;
855
- /**
856
- * The Id of the Row in the Table.
857
- * @category Prop
858
- * @since v1.0.0
859
- */
860
- readonly rowId: Id;
861
- /**
862
- * The Id of the Cell in the Row to be rendered.
863
- * @category Prop
864
- * @since v1.0.0
865
- */
866
- readonly cellId: Id;
867
- /**
868
- * The Queries object to be accessed: omit for the default context Queries
869
- * object, provide an Id for a named context Queries object, or provide an
870
- * explicit reference.
871
- * @category Prop
872
- * @since v1.0.0
873
- */
874
- readonly queries?: QueriesOrQueriesId<Schemas>;
875
- /**
876
- * Whether the component should also render the Id of the Cell to assist with
877
- * debugging.
878
- * @category Prop
879
- * @since v1.0.0
880
- */
881
- readonly debugIds?: boolean;
882
- };
883
-
884
- export type CheckpointProps<Schemas extends OptionalSchemas> = {
885
- /**
886
- * The Id of the checkpoint in the Checkpoints object.
887
- * @category Prop
888
- * @since v1.0.0
889
- */
890
- readonly checkpointId: Id;
891
- /**
892
- * The Checkpoints object to be accessed: omit for the default context
893
- * Checkpoints object, provide an Id for a named context Checkpoints object,
894
- * or provide an explicit reference.
895
- * @category Prop
896
- * @since v1.0.0
897
- */
898
- readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
899
- /**
900
- * Whether the component should also render the Id of the checkpoint to assist
901
- * with debugging.
902
- * @category Prop
903
- * @since v1.0.0
904
- */
905
- readonly debugIds?: boolean;
906
- };
907
-
908
- export type BackwardCheckpointsProps<Schemas extends OptionalSchemas> = {
909
- /**
910
- * The Checkpoints object to be accessed: omit for the default context
911
- * Checkpoints object, provide an Id for a named context Checkpoints object,
912
- * or provide an explicit reference.
913
- * @category Prop
914
- * @since v1.0.0
915
- */
916
- readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
917
- /**
918
- * A component for rendering each checkpoint in the Checkpoints object.
919
- * @category Prop
920
- * @since v1.0.0
921
- */
922
- readonly checkpointComponent?: ComponentType<CheckpointProps<Schemas>>;
923
- /**
924
- * A function for generating extra props for each checkpoint component based
925
- * on its Id.
926
- * @category Prop
927
- * @since v1.0.0
928
- */
929
- readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
930
- /**
931
- * A component or string to separate each Checkpoint component.
932
- * @category Prop
933
- * @since v1.0.0
934
- */
935
- readonly separator?: ReactElement | string;
936
- /**
937
- * Whether the component should also render the Ids of the checkpoints to
938
- * assist with debugging.
939
- * @category Prop
940
- * @since v1.0.0
941
- */
942
- readonly debugIds?: boolean;
943
- };
944
-
945
- export type CurrentCheckpointProps<Schemas extends OptionalSchemas> = {
946
- /**
947
- * The Checkpoints object to be accessed: omit for the default context
948
- * Checkpoints object, provide an Id for a named context Checkpoints object,
949
- * or provide an explicit reference.
950
- * @category Prop
951
- * @since v1.0.0
952
- */
953
- readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
954
- /**
955
- * A component for rendering each checkpoint in the Checkpoints object.
956
- * @category Prop
957
- * @since v1.0.0
958
- */
959
- readonly checkpointComponent?: ComponentType<CheckpointProps<Schemas>>;
960
- /**
961
- * A function for generating extra props for each checkpoint component based
962
- * on its Id.
963
- * @category Prop
964
- * @since v1.0.0
965
- */
966
- readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
967
- /**
968
- * Whether the component should also render the Ids of the checkpoints to
969
- * assist with debugging.
970
- * @category Prop
971
- * @since v1.0.0
972
- */
973
- readonly debugIds?: boolean;
974
- };
975
-
976
- export type ForwardCheckpointsProps<Schemas extends OptionalSchemas> = {
977
- /**
978
- * The Checkpoints object to be accessed: omit for the default context
979
- * Checkpoints object, provide an Id for a named context Checkpoints object,
980
- * or provide an explicit reference.
981
- * @category Prop
982
- * @since v1.0.0
983
- */
984
- readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
985
- /**
986
- * A component for rendering each checkpoint in the Checkpoints object.
987
- * @category Prop
988
- * @since v1.0.0
989
- */
990
- readonly checkpointComponent?: ComponentType<CheckpointProps<Schemas>>;
991
- /**
992
- * A function for generating extra props for each checkpoint component based
993
- * on its Id.
994
- * @category Prop
995
- * @since v1.0.0
996
- */
997
- readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
998
- /**
999
- * A component or string to separate each Checkpoint component.
1000
- * @category Prop
1001
- * @since v1.0.0
1002
- */
1003
- readonly separator?: ReactElement | string;
1004
- /**
1005
- * Whether the component should also render the Ids of the checkpoints to
1006
- * assist with debugging.
1007
- * @category Prop
1008
- * @since v1.0.0
1009
- */
1010
- readonly debugIds?: boolean;
1011
- };
1012
-
1013
- export type ProviderProps<Schemas extends OptionalSchemas> = {
1014
- /**
1015
- * A default single Store object that will be available within the Provider
1016
- * context.
1017
- * @category Prop
1018
- * @since v1.0.0
1019
- */
1020
- readonly store?: Store<Schemas>;
1021
- /**
1022
- * An object containing multiple Store objects that will be available within
1023
- * the Provider context by their Id.
1024
- * @category Prop
1025
- * @since v1.0.0
1026
- */
1027
- readonly storesById?: {[storeId: Id]: Store<Schemas>};
1028
- /**
1029
- * A default single Metrics object that will be available within the Provider
1030
- * context.
1031
- * @category Prop
1032
- * @since v1.0.0
1033
- */
1034
- readonly metrics?: Metrics<Schemas>;
1035
- /**
1036
- * An object containing multiple Metrics objects that will be available within
1037
- * the Provider context by their Id.
1038
- * @category Prop
1039
- * @since v1.0.0
1040
- */
1041
- readonly metricsById?: {[metricsId: Id]: Metrics<Schemas>};
1042
- /**
1043
- * A default single Indexes object that will be available within the Provider
1044
- * context.
1045
- * @category Prop
1046
- * @since v1.0.0
1047
- */
1048
- readonly indexes?: Indexes<Schemas>;
1049
- /**
1050
- * An object containing multiple Indexes objects that will be available within
1051
- * the Provider context by their Id.
1052
- * @category Prop
1053
- * @since v1.0.0
1054
- */
1055
- readonly indexesById?: {[indexesId: Id]: Indexes<Schemas>};
1056
- /**
1057
- * A default single Relationships object that will be available within the
1058
- * Provider context.
1059
- * @category Prop
1060
- * @since v1.0.0
1061
- */
1062
- readonly relationships?: Relationships<Schemas>;
1063
- /**
1064
- * An object containing multiple Relationships objects that will be available
1065
- * within the Provider context by their Id.
1066
- * @category Prop
1067
- * @since v1.0.0
1068
- */
1069
- readonly relationshipsById?: {[relationshipsId: Id]: Relationships<Schemas>};
1070
- /**
1071
- * A default single Queries object that will be available within the Provider
1072
- * context, since v2.0.
1073
- * @category Prop
1074
- * @since v1.0.0
1075
- */
1076
- readonly queries?: Queries<Schemas>;
1077
- /**
1078
- * An object containing multiple Queries objects that will be available within
1079
- * the Provider context by their Id, since v2.0.
1080
- * @category Prop
1081
- * @since v1.0.0
1082
- */
1083
- readonly queriesById?: {[queriesId: Id]: Queries<Schemas>};
1084
- /**
1085
- * A default single Checkpoints object that will be available within the
1086
- * Provider context.
1087
- * @category Prop
1088
- * @since v1.0.0
1089
- */
1090
- readonly checkpoints?: Checkpoints<Schemas>;
1091
- /**
1092
- * An object containing multiple Checkpoints objects that will be available
1093
- * within the Provider context by their Id.
1094
- * @category Prop
1095
- * @since v1.0.0
1096
- */
1097
- readonly checkpointsById?: {[checkpointsId: Id]: Checkpoints<Schemas>};
1098
- /**
1099
- * A default single Persister object that will be available within the
1100
- * Provider context.
1101
- * @category Prop
1102
- * @since v5.3.0
1103
- */
1104
- readonly persister?: Persister<Schemas, Persists.StoreOrMergeableStore>;
1105
- /**
1106
- * An object containing multiple Persister objects that will be available
1107
- * within the Provider context by their Id.
1108
- * @category Prop
1109
- * @since v5.3.0
1110
- */
1111
- readonly persistersById?: {
1112
- [persisterId: Id]: Persister<Schemas, Persists.StoreOrMergeableStore>;
1113
- };
1114
- /**
1115
- * A default single Synchronizer object that will be available within the
1116
- * Provider context.
1117
- * @category Prop
1118
- * @since v5.3.0
1119
- */
1120
- readonly synchronizer?: Synchronizer<Schemas>;
1121
- /**
1122
- * An object containing multiple Synchronizer objects that will be available
1123
- * within the Provider context by their Id.
1124
- * @category Prop
1125
- * @since v5.3.0
1126
- */
1127
- readonly synchronizersById?: {[synchronizerId: Id]: Synchronizer<Schemas>};
1128
- };
1129
-
1130
- export type ComponentReturnType = ReactElement<any, any> | null;