tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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 (249) hide show
  1. package/@types/_internal/ui-react/with-schemas/index.d.cts +274 -0
  2. package/@types/_internal/ui-react/with-schemas/index.d.ts +274 -0
  3. package/@types/checkpoints/index.d.cts +30 -1
  4. package/@types/checkpoints/index.d.ts +30 -1
  5. package/@types/checkpoints/with-schemas/index.d.cts +30 -1
  6. package/@types/checkpoints/with-schemas/index.d.ts +30 -1
  7. package/@types/common/index.d.cts +9 -0
  8. package/@types/common/index.d.ts +9 -0
  9. package/@types/common/with-schemas/index.d.cts +9 -0
  10. package/@types/common/with-schemas/index.d.ts +9 -0
  11. package/@types/index.d.cts +1 -0
  12. package/@types/index.d.ts +1 -0
  13. package/@types/indexes/index.d.cts +32 -1
  14. package/@types/indexes/index.d.ts +32 -1
  15. package/@types/indexes/with-schemas/index.d.cts +32 -1
  16. package/@types/indexes/with-schemas/index.d.ts +32 -1
  17. package/@types/mergeable-store/index.d.cts +0 -2
  18. package/@types/mergeable-store/index.d.ts +0 -2
  19. package/@types/mergeable-store/with-schemas/index.d.cts +2 -2
  20. package/@types/mergeable-store/with-schemas/index.d.ts +2 -2
  21. package/@types/metrics/index.d.cts +30 -4
  22. package/@types/metrics/index.d.ts +30 -4
  23. package/@types/metrics/with-schemas/index.d.cts +30 -4
  24. package/@types/metrics/with-schemas/index.d.ts +30 -4
  25. package/@types/persisters/index.d.cts +87 -25
  26. package/@types/persisters/index.d.ts +87 -25
  27. package/@types/persisters/persister-automerge/index.d.cts +4 -4
  28. package/@types/persisters/persister-automerge/index.d.ts +4 -4
  29. package/@types/persisters/persister-automerge/with-schemas/index.d.cts +4 -4
  30. package/@types/persisters/persister-automerge/with-schemas/index.d.ts +4 -4
  31. package/@types/persisters/persister-browser/index.d.cts +7 -4
  32. package/@types/persisters/persister-browser/index.d.ts +7 -4
  33. package/@types/persisters/persister-browser/with-schemas/index.d.cts +7 -4
  34. package/@types/persisters/persister-browser/with-schemas/index.d.ts +7 -4
  35. package/@types/persisters/persister-cr-sqlite-wasm/index.d.cts +4 -4
  36. package/@types/persisters/persister-cr-sqlite-wasm/index.d.ts +4 -4
  37. package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.cts +4 -4
  38. package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts +4 -4
  39. package/@types/persisters/persister-electric-sql/index.d.cts +4 -4
  40. package/@types/persisters/persister-electric-sql/index.d.ts +4 -4
  41. package/@types/persisters/persister-electric-sql/with-schemas/index.d.cts +4 -4
  42. package/@types/persisters/persister-electric-sql/with-schemas/index.d.ts +4 -4
  43. package/@types/persisters/persister-expo-sqlite/index.d.cts +4 -4
  44. package/@types/persisters/persister-expo-sqlite/index.d.ts +4 -4
  45. package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.cts +4 -4
  46. package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.ts +4 -4
  47. package/@types/persisters/persister-file/index.d.cts +6 -4
  48. package/@types/persisters/persister-file/index.d.ts +6 -4
  49. package/@types/persisters/persister-file/with-schemas/index.d.cts +6 -4
  50. package/@types/persisters/persister-file/with-schemas/index.d.ts +6 -4
  51. package/@types/persisters/persister-indexed-db/index.d.cts +5 -4
  52. package/@types/persisters/persister-indexed-db/index.d.ts +5 -4
  53. package/@types/persisters/persister-indexed-db/with-schemas/index.d.cts +5 -4
  54. package/@types/persisters/persister-indexed-db/with-schemas/index.d.ts +5 -4
  55. package/@types/persisters/persister-libsql/index.d.cts +5 -4
  56. package/@types/persisters/persister-libsql/index.d.ts +5 -4
  57. package/@types/persisters/persister-libsql/with-schemas/index.d.cts +5 -4
  58. package/@types/persisters/persister-libsql/with-schemas/index.d.ts +5 -4
  59. package/@types/persisters/persister-partykit-client/index.d.cts +12 -6
  60. package/@types/persisters/persister-partykit-client/index.d.ts +12 -6
  61. package/@types/persisters/persister-partykit-client/with-schemas/index.d.cts +12 -6
  62. package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts +12 -6
  63. package/@types/persisters/persister-partykit-server/index.d.cts +11 -3
  64. package/@types/persisters/persister-partykit-server/index.d.ts +11 -3
  65. package/@types/persisters/persister-partykit-server/with-schemas/index.d.cts +11 -3
  66. package/@types/persisters/persister-partykit-server/with-schemas/index.d.ts +11 -3
  67. package/@types/persisters/persister-powersync/index.d.cts +5 -4
  68. package/@types/persisters/persister-powersync/index.d.ts +5 -4
  69. package/@types/persisters/persister-powersync/with-schemas/index.d.cts +5 -4
  70. package/@types/persisters/persister-powersync/with-schemas/index.d.ts +5 -4
  71. package/@types/persisters/persister-remote/index.d.cts +6 -4
  72. package/@types/persisters/persister-remote/index.d.ts +6 -4
  73. package/@types/persisters/persister-remote/with-schemas/index.d.cts +6 -4
  74. package/@types/persisters/persister-remote/with-schemas/index.d.ts +6 -4
  75. package/@types/persisters/persister-sqlite-wasm/index.d.cts +4 -4
  76. package/@types/persisters/persister-sqlite-wasm/index.d.ts +4 -4
  77. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.cts +4 -4
  78. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.ts +4 -4
  79. package/@types/persisters/persister-sqlite3/index.d.cts +4 -4
  80. package/@types/persisters/persister-sqlite3/index.d.ts +4 -4
  81. package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts +4 -4
  82. package/@types/persisters/persister-sqlite3/with-schemas/index.d.ts +4 -4
  83. package/@types/persisters/persister-yjs/index.d.cts +4 -4
  84. package/@types/persisters/persister-yjs/index.d.ts +4 -4
  85. package/@types/persisters/persister-yjs/with-schemas/index.d.cts +4 -4
  86. package/@types/persisters/persister-yjs/with-schemas/index.d.ts +4 -4
  87. package/@types/persisters/with-schemas/index.d.cts +87 -25
  88. package/@types/persisters/with-schemas/index.d.ts +87 -25
  89. package/@types/queries/index.d.cts +64 -4
  90. package/@types/queries/index.d.ts +64 -4
  91. package/@types/queries/with-schemas/index.d.cts +64 -4
  92. package/@types/queries/with-schemas/index.d.ts +64 -4
  93. package/@types/relationships/index.d.cts +34 -1
  94. package/@types/relationships/index.d.ts +34 -1
  95. package/@types/relationships/with-schemas/index.d.cts +34 -1
  96. package/@types/relationships/with-schemas/index.d.ts +34 -1
  97. package/@types/store/index.d.cts +125 -0
  98. package/@types/store/index.d.ts +125 -0
  99. package/@types/store/with-schemas/index.d.cts +125 -0
  100. package/@types/store/with-schemas/index.d.ts +125 -0
  101. package/@types/synchronizers/index.d.cts +32 -10
  102. package/@types/synchronizers/index.d.ts +32 -10
  103. package/@types/synchronizers/synchronizer-broadcast-channel/index.d.cts +114 -0
  104. package/@types/synchronizers/synchronizer-broadcast-channel/index.d.ts +114 -0
  105. package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.cts +128 -0
  106. package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.ts +128 -0
  107. package/@types/synchronizers/synchronizer-local/index.d.cts +16 -17
  108. package/@types/synchronizers/synchronizer-local/index.d.ts +16 -17
  109. package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts +16 -17
  110. package/@types/synchronizers/synchronizer-local/with-schemas/index.d.ts +16 -17
  111. package/@types/synchronizers/synchronizer-ws-client/index.d.cts +66 -6
  112. package/@types/synchronizers/synchronizer-ws-client/index.d.ts +66 -6
  113. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.cts +77 -6
  114. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts +77 -6
  115. package/@types/synchronizers/synchronizer-ws-server/index.d.cts +486 -7
  116. package/@types/synchronizers/synchronizer-ws-server/index.d.ts +486 -7
  117. package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts +486 -7
  118. package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.ts +486 -7
  119. package/@types/synchronizers/with-schemas/index.d.cts +29 -11
  120. package/@types/synchronizers/with-schemas/index.d.ts +29 -11
  121. package/@types/tools/index.d.cts +22 -0
  122. package/@types/tools/index.d.ts +22 -0
  123. package/@types/tools/with-schemas/index.d.cts +22 -0
  124. package/@types/tools/with-schemas/index.d.ts +22 -0
  125. package/@types/ui-react/index.d.cts +375 -1
  126. package/@types/ui-react/index.d.ts +375 -1
  127. package/@types/ui-react/with-schemas/index.d.cts +100 -1
  128. package/@types/ui-react/with-schemas/index.d.ts +100 -1
  129. package/@types/ui-react-dom/index.d.cts +112 -0
  130. package/@types/ui-react-dom/index.d.ts +112 -0
  131. package/@types/ui-react-dom/with-schemas/index.d.cts +112 -0
  132. package/@types/ui-react-dom/with-schemas/index.d.ts +112 -0
  133. package/@types/ui-react-inspector/index.d.cts +6 -2
  134. package/@types/ui-react-inspector/index.d.ts +6 -2
  135. package/@types/ui-react-inspector/with-schemas/index.d.cts +118 -2
  136. package/@types/ui-react-inspector/with-schemas/index.d.ts +118 -2
  137. package/@types/with-schemas/index.d.cts +1 -0
  138. package/@types/with-schemas/index.d.ts +1 -0
  139. package/cjs/es6/index.cjs +2 -2
  140. package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/index.cjs +1 -0
  141. package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/index.cjs.gz +0 -0
  142. package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +1 -0
  143. package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs.gz +0 -0
  144. package/cjs/es6/min/synchronizers/synchronizer-ws-client/index.cjs +1 -1
  145. package/cjs/es6/min/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
  146. package/cjs/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -1
  147. package/cjs/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs.gz +0 -0
  148. package/cjs/es6/synchronizers/index.cjs +2 -2
  149. package/cjs/es6/synchronizers/synchronizer-broadcast-channel/index.cjs +628 -0
  150. package/cjs/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +628 -0
  151. package/cjs/es6/synchronizers/synchronizer-local/index.cjs +4 -4
  152. package/cjs/es6/synchronizers/synchronizer-local/with-schemas/index.cjs +4 -4
  153. package/cjs/es6/synchronizers/synchronizer-ws-client/index.cjs +15 -21
  154. package/cjs/es6/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +15 -21
  155. package/cjs/es6/synchronizers/with-schemas/index.cjs +2 -2
  156. package/cjs/es6/with-schemas/index.cjs +2 -2
  157. package/cjs/index.cjs +2 -2
  158. package/cjs/min/synchronizers/synchronizer-broadcast-channel/index.cjs +1 -0
  159. package/cjs/min/synchronizers/synchronizer-broadcast-channel/index.cjs.gz +0 -0
  160. package/cjs/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +1 -0
  161. package/cjs/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs.gz +0 -0
  162. package/cjs/min/synchronizers/synchronizer-ws-client/index.cjs +1 -1
  163. package/cjs/min/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
  164. package/cjs/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -1
  165. package/cjs/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs.gz +0 -0
  166. package/cjs/synchronizers/index.cjs +2 -2
  167. package/cjs/synchronizers/synchronizer-broadcast-channel/index.cjs +500 -0
  168. package/cjs/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +500 -0
  169. package/cjs/synchronizers/synchronizer-local/index.cjs +4 -4
  170. package/cjs/synchronizers/synchronizer-local/with-schemas/index.cjs +4 -4
  171. package/cjs/synchronizers/synchronizer-ws-client/index.cjs +15 -21
  172. package/cjs/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +15 -21
  173. package/cjs/synchronizers/with-schemas/index.cjs +2 -2
  174. package/cjs/with-schemas/index.cjs +2 -2
  175. package/es6/index.js +2 -2
  176. package/es6/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
  177. package/es6/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
  178. package/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
  179. package/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
  180. package/es6/min/synchronizers/synchronizer-ws-client/index.js +1 -1
  181. package/es6/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  182. package/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
  183. package/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
  184. package/es6/synchronizers/index.js +2 -2
  185. package/es6/synchronizers/synchronizer-broadcast-channel/index.js +626 -0
  186. package/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +626 -0
  187. package/es6/synchronizers/synchronizer-local/index.js +4 -4
  188. package/es6/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
  189. package/es6/synchronizers/synchronizer-ws-client/index.js +15 -21
  190. package/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
  191. package/es6/synchronizers/with-schemas/index.js +2 -2
  192. package/es6/with-schemas/index.js +2 -2
  193. package/index.js +2 -2
  194. package/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
  195. package/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
  196. package/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
  197. package/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
  198. package/min/synchronizers/synchronizer-ws-client/index.js +1 -1
  199. package/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  200. package/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
  201. package/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
  202. package/package.json +105 -1
  203. package/readme.md +9 -9
  204. package/releases.md +4 -4
  205. package/synchronizers/index.js +2 -2
  206. package/synchronizers/synchronizer-broadcast-channel/index.js +498 -0
  207. package/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +498 -0
  208. package/synchronizers/synchronizer-local/index.js +4 -4
  209. package/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
  210. package/synchronizers/synchronizer-ws-client/index.js +15 -21
  211. package/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
  212. package/synchronizers/with-schemas/index.js +2 -2
  213. package/umd/es6/index.js +2 -2
  214. package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
  215. package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
  216. package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
  217. package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
  218. package/umd/es6/min/synchronizers/synchronizer-ws-client/index.js +1 -1
  219. package/umd/es6/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  220. package/umd/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
  221. package/umd/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
  222. package/umd/es6/synchronizers/index.js +2 -2
  223. package/umd/es6/synchronizers/synchronizer-broadcast-channel/index.js +654 -0
  224. package/umd/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +654 -0
  225. package/umd/es6/synchronizers/synchronizer-local/index.js +4 -4
  226. package/umd/es6/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
  227. package/umd/es6/synchronizers/synchronizer-ws-client/index.js +15 -21
  228. package/umd/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
  229. package/umd/es6/synchronizers/with-schemas/index.js +2 -2
  230. package/umd/es6/with-schemas/index.js +2 -2
  231. package/umd/index.js +2 -2
  232. package/umd/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
  233. package/umd/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
  234. package/umd/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
  235. package/umd/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
  236. package/umd/min/synchronizers/synchronizer-ws-client/index.js +1 -1
  237. package/umd/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  238. package/umd/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
  239. package/umd/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
  240. package/umd/synchronizers/index.js +2 -2
  241. package/umd/synchronizers/synchronizer-broadcast-channel/index.js +516 -0
  242. package/umd/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +516 -0
  243. package/umd/synchronizers/synchronizer-local/index.js +4 -4
  244. package/umd/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
  245. package/umd/synchronizers/synchronizer-ws-client/index.js +15 -21
  246. package/umd/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
  247. package/umd/synchronizers/with-schemas/index.js +2 -2
  248. package/umd/with-schemas/index.js +2 -2
  249. package/with-schemas/index.js +2 -2
@@ -20,6 +20,7 @@
20
20
  * @see Drawing demo
21
21
  * @packageDocumentation
22
22
  * @module ui-react
23
+ * @since v1.0.0
23
24
  */
24
25
 
25
26
  import type {
@@ -110,6 +111,7 @@ import type {Synchronizer} from '../synchronizers/index.d.cts';
110
111
  * Many hooks and components in this ui-react module take this type as a
111
112
  * parameter or a prop, allowing you to pass in either the Store or its Id.
112
113
  * @category Identity
114
+ * @since v1.0.0
113
115
  */
114
116
  export type StoreOrStoreId = Store | Id;
115
117
 
@@ -128,6 +130,7 @@ export type StoreOrStoreId = Store | Id;
128
130
  * Many hooks and components in this ui-react module take this type as a
129
131
  * parameter or a prop, allowing you to pass in either the Store or its Id.
130
132
  * @category Identity
133
+ * @since v1.0.0
131
134
  */
132
135
  export type MetricsOrMetricsId = Metrics | Id;
133
136
 
@@ -146,6 +149,7 @@ export type MetricsOrMetricsId = Metrics | Id;
146
149
  * Many hooks and components in this ui-react module take this type as a
147
150
  * parameter or a prop, allowing you to pass in either the Store or its Id.
148
151
  * @category Identity
152
+ * @since v1.0.0
149
153
  */
150
154
  export type IndexesOrIndexesId = Indexes | Id;
151
155
 
@@ -164,6 +168,7 @@ export type IndexesOrIndexesId = Indexes | Id;
164
168
  * Many hooks and components in this ui-react module take this type as a
165
169
  * parameter or a prop, allowing you to pass in either the Store or its Id.
166
170
  * @category Identity
171
+ * @since v1.0.0
167
172
  */
168
173
  export type RelationshipsOrRelationshipsId = Relationships | Id;
169
174
 
@@ -201,6 +206,7 @@ export type QueriesOrQueriesId = Queries | Id;
201
206
  * Many hooks and components in this ui-react module take this type as a
202
207
  * parameter or a prop, allowing you to pass in either the Store or its Id.
203
208
  * @category Identity
209
+ * @since v1.0.0
204
210
  */
205
211
  export type CheckpointsOrCheckpointsId = Checkpoints | Id;
206
212
 
@@ -213,6 +219,7 @@ export type CheckpointsOrCheckpointsId = Checkpoints | Id;
213
219
  * useUndoInformation hook and the useRedoInformation hook for more details and
214
220
  * examples.
215
221
  * @category Checkpoints
222
+ * @since v1.0.0
216
223
  */
217
224
  export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
218
225
 
@@ -225,6 +232,7 @@ export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
225
232
  * of the object to set can also be dependent on the event or parameter
226
233
  * provided (as well as the object itself being set).
227
234
  * @category Identity
235
+ * @since v1.0.0
228
236
  */
229
237
  export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
230
238
 
@@ -317,6 +325,7 @@ export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
317
325
  * // -> '<span>cat</span>'
318
326
  * ```
319
327
  * @category Store hooks
328
+ * @since v1.0.0
320
329
  */
321
330
  export function useCreateStore(
322
331
  create: () => Store,
@@ -325,6 +334,8 @@ export function useCreateStore(
325
334
 
326
335
  /**
327
336
  * The useCreateMergeableStore hook.
337
+ * @category Store hooks
338
+ * @since v1.0.0
328
339
  */
329
340
  export function useCreateMergeableStore(
330
341
  create: () => MergeableStore,
@@ -433,6 +444,7 @@ export function useStoreIds(): Ids;
433
444
  * // -> '<span>0</span>'
434
445
  * ```
435
446
  * @category Store hooks
447
+ * @since v1.0.0
436
448
  */
437
449
  export function useStore(id?: Id): Store | undefined;
438
450
 
@@ -734,6 +746,7 @@ export function useHasTables(storeOrStoreId?: StoreOrStoreId): boolean;
734
746
  * // -> '<span>{"pets":{"fido":{"color":"brown"}}}</span>'
735
747
  * ```
736
748
  * @category Store hooks
749
+ * @since v1.0.0
737
750
  */
738
751
  export function useTables(storeOrStoreId?: StoreOrStoreId): Tables;
739
752
 
@@ -824,6 +837,7 @@ export function useTables(storeOrStoreId?: StoreOrStoreId): Tables;
824
837
  * // -> '<span>["pets"]</span>'
825
838
  * ```
826
839
  * @category Store hooks
840
+ * @since v1.0.0
827
841
  */
828
842
  export function useTableIds(storeOrStoreId?: StoreOrStoreId): Ids;
829
843
 
@@ -1019,6 +1033,7 @@ export function useHasTable(
1019
1033
  * // -> '<span>{"fido":{"color":"brown"}}</span>'
1020
1034
  * ```
1021
1035
  * @category Store hooks
1036
+ * @since v1.0.0
1022
1037
  */
1023
1038
  export function useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
1024
1039
 
@@ -1416,6 +1431,7 @@ export function useRowCount(
1416
1431
  * // -> '<span>["fido"]</span>'
1417
1432
  * ```
1418
1433
  * @category Store hooks
1434
+ * @since v1.0.0
1419
1435
  */
1420
1436
  export function useRowIds(tableId: Id, storeOrStoreId?: StoreOrStoreId): Ids;
1421
1437
 
@@ -1750,6 +1766,7 @@ export function useHasRow(
1750
1766
  * // -> '<span>{"color":"brown"}</span>'
1751
1767
  * ```
1752
1768
  * @category Store hooks
1769
+ * @since v1.0.0
1753
1770
  */
1754
1771
  export function useRow(
1755
1772
  tableId: Id,
@@ -1853,6 +1870,7 @@ export function useRow(
1853
1870
  * // -> '<span>["color"]</span>'
1854
1871
  * ```
1855
1872
  * @category Store hooks
1873
+ * @since v1.0.0
1856
1874
  */
1857
1875
  export function useCellIds(
1858
1876
  tableId: Id,
@@ -2062,6 +2080,7 @@ export function useHasCell(
2062
2080
  * // -> '<span>brown</span>'
2063
2081
  * ```
2064
2082
  * @category Store hooks
2083
+ * @since v1.0.0
2065
2084
  */
2066
2085
  export function useCell(
2067
2086
  tableId: Id,
@@ -2623,6 +2642,7 @@ export function useValue(
2623
2642
  * // -> '{"pets":{"nemo":{"species":"fish","bubbles":true}}}'
2624
2643
  * ```
2625
2644
  * @category Store hooks
2645
+ * @since v1.0.0
2626
2646
  */
2627
2647
  export function useSetTablesCallback<Parameter>(
2628
2648
  getTables: (parameter: Parameter, store: Store) => Tables,
@@ -2714,6 +2734,7 @@ export function useSetTablesCallback<Parameter>(
2714
2734
  * // -> '{"nemo":{"species":"fish","bubbles":true}}'
2715
2735
  * ```
2716
2736
  * @category Store hooks
2737
+ * @since v1.0.0
2717
2738
  */
2718
2739
  export function useSetTableCallback<Parameter>(
2719
2740
  tableId: Id | GetId<Parameter>,
@@ -2810,6 +2831,7 @@ export function useSetTableCallback<Parameter>(
2810
2831
  * // -> '{"species":"fish","bubbles":true}'
2811
2832
  * ```
2812
2833
  * @category Store hooks
2834
+ * @since v1.0.0
2813
2835
  */
2814
2836
  export function useSetRowCallback<Parameter>(
2815
2837
  tableId: Id | GetId<Parameter>,
@@ -2912,6 +2934,7 @@ export function useSetRowCallback<Parameter>(
2912
2934
  * // -> '{"0":{"species":"frog","bubbles":true},"nemo":{"species":"fish"}}'
2913
2935
  * ```
2914
2936
  * @category Store hooks
2937
+ * @since v1.0.0
2915
2938
  */
2916
2939
  export function useAddRowCallback<Parameter>(
2917
2940
  tableId: Id | GetId<Parameter>,
@@ -3011,6 +3034,7 @@ export function useAddRowCallback<Parameter>(
3011
3034
  * // -> '{"species":"fish","bubbles":true}'
3012
3035
  * ```
3013
3036
  * @category Store hooks
3037
+ * @since v1.0.0
3014
3038
  */
3015
3039
  export function useSetPartialRowCallback<Parameter>(
3016
3040
  tableId: Id | GetId<Parameter>,
@@ -3153,6 +3177,7 @@ export function useSetPartialRowCallback<Parameter>(
3153
3177
  * // -> '{"visits":2}'
3154
3178
  * ```
3155
3179
  * @category Store hooks
3180
+ * @since v1.0.0
3156
3181
  */
3157
3182
  export function useSetCellCallback<Parameter>(
3158
3183
  tableId: Id | GetId<Parameter>,
@@ -3496,6 +3521,7 @@ export function useSetValueCallback<Parameter>(
3496
3521
  * // -> '{}'
3497
3522
  * ```
3498
3523
  * @category Store hooks
3524
+ * @since v1.0.0
3499
3525
  */
3500
3526
  export function useDelTablesCallback(
3501
3527
  storeOrStoreId?: StoreOrStoreId,
@@ -3564,6 +3590,7 @@ export function useDelTablesCallback(
3564
3590
  * // -> '{}'
3565
3591
  * ```
3566
3592
  * @category Store hooks
3593
+ * @since v1.0.0
3567
3594
  */
3568
3595
  export function useDelTableCallback(
3569
3596
  tableId: Id,
@@ -3634,6 +3661,7 @@ export function useDelTableCallback(
3634
3661
  * // -> '{}'
3635
3662
  * ```
3636
3663
  * @category Store hooks
3664
+ * @since v1.0.0
3637
3665
  */
3638
3666
  export function useDelRowCallback(
3639
3667
  tableId: Id,
@@ -3714,6 +3742,7 @@ export function useDelRowCallback(
3714
3742
  * // -> '{}'
3715
3743
  * ```
3716
3744
  * @category Store hooks
3745
+ * @since v1.0.0
3717
3746
  */
3718
3747
  export function useDelCellCallback(
3719
3748
  tableId: Id,
@@ -3990,6 +4019,7 @@ export function useHasTablesListener(
3990
4019
  * // -> 0
3991
4020
  * ```
3992
4021
  * @category Store hooks
4022
+ * @since v1.0.0
3993
4023
  */
3994
4024
  export function useTablesListener(
3995
4025
  listener: TablesListener,
@@ -4057,6 +4087,7 @@ export function useTablesListener(
4057
4087
  * // -> 0
4058
4088
  * ```
4059
4089
  * @category Store hooks
4090
+ * @since v1.0.0
4060
4091
  */
4061
4092
  export function useTableIdsListener(
4062
4093
  listener: TableIdsListener,
@@ -4202,6 +4233,7 @@ export function useHasTableListener(
4202
4233
  * // -> 0
4203
4234
  * ```
4204
4235
  * @category Store hooks
4236
+ * @since v1.0.0
4205
4237
  */
4206
4238
  export function useTableListener(
4207
4239
  tableId: IdOrNull,
@@ -4275,6 +4307,7 @@ export function useTableListener(
4275
4307
  * // -> 0
4276
4308
  * ```
4277
4309
  * @category Store hooks
4310
+ * @since v1.0.0
4278
4311
  */
4279
4312
  export function useTableCellIdsListener(
4280
4313
  tableId: IdOrNull,
@@ -4498,6 +4531,7 @@ export function useRowCountListener(
4498
4531
  * // -> 0
4499
4532
  * ```
4500
4533
  * @category Store hooks
4534
+ * @since v1.0.0
4501
4535
  */
4502
4536
  export function useRowIdsListener(
4503
4537
  tableId: IdOrNull,
@@ -4745,6 +4779,7 @@ export function useHasRowListener(
4745
4779
  * // -> 0
4746
4780
  * ```
4747
4781
  * @category Store hooks
4782
+ * @since v1.0.0
4748
4783
  */
4749
4784
  export function useRowListener(
4750
4785
  tableId: IdOrNull,
@@ -4827,6 +4862,7 @@ export function useRowListener(
4827
4862
  * // -> 0
4828
4863
  * ```
4829
4864
  * @category Store hooks
4865
+ * @since v1.0.0
4830
4866
  */
4831
4867
  export function useCellIdsListener(
4832
4868
  tableId: IdOrNull,
@@ -4994,6 +5030,7 @@ export function useHasCellListener(
4994
5030
  * // -> 0
4995
5031
  * ```
4996
5032
  * @category Store hooks
5033
+ * @since v1.0.0
4997
5034
  */
4998
5035
  export function useCellListener(
4999
5036
  tableId: IdOrNull,
@@ -5663,6 +5700,7 @@ export function useDidFinishTransactionListener(
5663
5700
  * // -> '<span>2</span>'
5664
5701
  * ```
5665
5702
  * @category Metrics hooks
5703
+ * @since v1.0.0
5666
5704
  */
5667
5705
  export function useCreateMetrics(
5668
5706
  store: Store | undefined,
@@ -5781,6 +5819,7 @@ export function useMetricsIds(): Ids;
5781
5819
  * // -> '<span>0</span>'
5782
5820
  * ```
5783
5821
  * @category Metrics hooks
5822
+ * @since v1.0.0
5784
5823
  */
5785
5824
  export function useMetrics(id?: Id): Metrics | undefined;
5786
5825
 
@@ -6010,6 +6049,7 @@ export function useMetricIds(metricsOrMetricsId?: MetricsOrMetricsId): Ids;
6010
6049
  * // -> '<span>5</span>'
6011
6050
  * ```
6012
6051
  * @category Metrics hooks
6052
+ * @since v1.0.0
6013
6053
  */
6014
6054
  export function useMetric(
6015
6055
  metricId: Id,
@@ -6084,6 +6124,7 @@ export function useMetric(
6084
6124
  * // -> 0
6085
6125
  * ```
6086
6126
  * @category Metrics hooks
6127
+ * @since v1.0.0
6087
6128
  */
6088
6129
  export function useMetricListener(
6089
6130
  metricId: IdOrNull,
@@ -6211,6 +6252,7 @@ export function useMetricListener(
6211
6252
  * // -> '<span>["brown","black"]</span>'
6212
6253
  * ```
6213
6254
  * @category Indexes hooks
6255
+ * @since v1.0.0
6214
6256
  */
6215
6257
  export function useCreateIndexes(
6216
6258
  store: Store | undefined,
@@ -6329,6 +6371,7 @@ export function useIndexesIds(): Ids;
6329
6371
  * // -> '<span>0</span>'
6330
6372
  * ```
6331
6373
  * @category Indexes hooks
6374
+ * @since v1.0.0
6332
6375
  */
6333
6376
  export function useIndexes(id?: Id): Indexes | undefined;
6334
6377
 
@@ -6560,6 +6603,7 @@ export function useIndexIds(indexesOrIndexesId?: IndexesOrIndexesId): Ids;
6560
6603
  * // -> '<span>["dog","cat"]</span>'
6561
6604
  * ```
6562
6605
  * @category Indexes hooks
6606
+ * @since v1.0.0
6563
6607
  */
6564
6608
  export function useSliceIds(
6565
6609
  indexId: Id,
@@ -6687,6 +6731,7 @@ export function useSliceIds(
6687
6731
  * // -> '<span>["fido","cujo"]</span>'
6688
6732
  * ```
6689
6733
  * @category Indexes hooks
6734
+ * @since v1.0.0
6690
6735
  */
6691
6736
  export function useSliceRowIds(
6692
6737
  indexId: Id,
@@ -6763,6 +6808,7 @@ export function useSliceRowIds(
6763
6808
  * // -> 0
6764
6809
  * ```
6765
6810
  * @category Indexes hooks
6811
+ * @since v1.0.0
6766
6812
  */
6767
6813
  export function useSliceIdsListener(
6768
6814
  indexId: IdOrNull,
@@ -6848,6 +6894,7 @@ export function useSliceIdsListener(
6848
6894
  * // -> 0
6849
6895
  * ```
6850
6896
  * @category Indexes hooks
6897
+ * @since v1.0.0
6851
6898
  */
6852
6899
  export function useSliceRowIdsListener(
6853
6900
  indexId: IdOrNull,
@@ -6987,6 +7034,7 @@ export function useSliceRowIdsListener(
6987
7034
  * // -> '<span>brown</span>'
6988
7035
  * ```
6989
7036
  * @category Relationships hooks
7037
+ * @since v1.0.0
6990
7038
  */
6991
7039
  export function useCreateRelationships(
6992
7040
  store: Store | undefined,
@@ -7119,6 +7167,7 @@ export function useRelationshipsIds(): Ids;
7119
7167
  * // -> '<span>0</span>'
7120
7168
  * ```
7121
7169
  * @category Relationships hooks
7170
+ * @since v1.0.0
7122
7171
  */
7123
7172
  export function useRelationships(id?: Id): Relationships | undefined;
7124
7173
 
@@ -7373,6 +7422,7 @@ export function useRelationshipIds(
7373
7422
  * // -> '<span>dog</span>'
7374
7423
  * ```
7375
7424
  * @category Relationships hooks
7425
+ * @since v1.0.0
7376
7426
  */
7377
7427
  export function useRemoteRowId(
7378
7428
  relationshipId: Id,
@@ -7504,6 +7554,7 @@ export function useRemoteRowId(
7504
7554
  * // -> '<span>["fido","cujo"]</span>'
7505
7555
  * ```
7506
7556
  * @category Relationships hooks
7557
+ * @since v1.0.0
7507
7558
  */
7508
7559
  export function useLocalRowIds(
7509
7560
  relationshipId: Id,
@@ -7642,6 +7693,7 @@ export function useLocalRowIds(
7642
7693
  * // -> '<span>["fido","felix","cujo"]</span>'
7643
7694
  * ```
7644
7695
  * @category Relationships hooks
7696
+ * @since v1.0.0
7645
7697
  */
7646
7698
  export function useLinkedRowIds(
7647
7699
  relationshipId: Id,
@@ -7733,6 +7785,7 @@ export function useLinkedRowIds(
7733
7785
  * // -> 0
7734
7786
  * ```
7735
7787
  * @category Relationships hooks
7788
+ * @since v1.0.0
7736
7789
  */
7737
7790
  export function useRemoteRowIdListener(
7738
7791
  relationshipId: IdOrNull,
@@ -7826,6 +7879,7 @@ export function useRemoteRowIdListener(
7826
7879
  * // -> 0
7827
7880
  * ```
7828
7881
  * @category Relationships hooks
7882
+ * @since v1.0.0
7829
7883
  */
7830
7884
  export function useLocalRowIdsListener(
7831
7885
  relationshipId: IdOrNull,
@@ -7916,6 +7970,7 @@ export function useLocalRowIdsListener(
7916
7970
  * // -> 0
7917
7971
  * ```
7918
7972
  * @category Relationships hooks
7973
+ * @since v1.0.0
7919
7974
  */
7920
7975
  export function useLinkedRowIdsListener(
7921
7976
  relationshipId: Id,
@@ -10227,6 +10282,7 @@ export function useResultCellListener(
10227
10282
  * // -> '<span>[[],"0",[]]</span>'
10228
10283
  * ```
10229
10284
  * @category Checkpoints hooks
10285
+ * @since v1.0.0
10230
10286
  */
10231
10287
  export function useCreateCheckpoints(
10232
10288
  store: Store | undefined,
@@ -10351,6 +10407,7 @@ export function useCheckpointsIds(): Ids;
10351
10407
  * // -> '<span>0</span>'
10352
10408
  * ```
10353
10409
  * @category Checkpoints hooks
10410
+ * @since v1.0.0
10354
10411
  */
10355
10412
  export function useCheckpoints(id?: Id): Checkpoints | undefined;
10356
10413
 
@@ -10525,6 +10582,7 @@ export function useCheckpointsOrCheckpointsById(
10525
10582
  * // -> '<span>[[],"0",[]]</span>'
10526
10583
  * ```
10527
10584
  * @category Checkpoints hooks
10585
+ * @since v1.0.0
10528
10586
  */
10529
10587
  export function useCheckpointIds(
10530
10588
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
@@ -10632,6 +10690,7 @@ export function useCheckpointIds(
10632
10690
  * // -> '<span>initial</span>'
10633
10691
  * ```
10634
10692
  * @category Checkpoints hooks
10693
+ * @since v1.0.0
10635
10694
  */
10636
10695
  export function useCheckpoint(
10637
10696
  checkpointId: Id,
@@ -10716,6 +10775,7 @@ export function useCheckpoint(
10716
10775
  * // -> 'Checkpoint 1 set, with #span button'
10717
10776
  * ```
10718
10777
  * @category Checkpoints hooks
10778
+ * @since v1.0.0
10719
10779
  */
10720
10780
  export function useSetCheckpointCallback<Parameter>(
10721
10781
  getCheckpoint?: (parameter: Parameter) => string,
@@ -10772,6 +10832,7 @@ export function useSetCheckpointCallback<Parameter>(
10772
10832
  * // -> [[], "0", ["1"]]
10773
10833
  * ```
10774
10834
  * @category Checkpoints hooks
10835
+ * @since v1.0.0
10775
10836
  */
10776
10837
  export function useGoBackwardCallback(
10777
10838
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
@@ -10828,6 +10889,7 @@ export function useGoBackwardCallback(
10828
10889
  * // -> [["0"], "1", []]
10829
10890
  * ```
10830
10891
  * @category Checkpoints hooks
10892
+ * @since v1.0.0
10831
10893
  */
10832
10894
  export function useGoForwardCallback(
10833
10895
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
@@ -10908,6 +10970,7 @@ export function useGoForwardCallback(
10908
10970
  * // -> [[], "0", ["1"]]
10909
10971
  * ```
10910
10972
  * @category Checkpoints hooks
10973
+ * @since v1.0.0
10911
10974
  */
10912
10975
  export function useGoToCallback<Parameter>(
10913
10976
  getCheckpointId: (parameter: Parameter) => Id,
@@ -10963,6 +11026,7 @@ export function useGoToCallback<Parameter>(
10963
11026
  * // -> '<span>Undo color</span>'
10964
11027
  * ```
10965
11028
  * @category Checkpoints hooks
11029
+ * @since v1.0.0
10966
11030
  */
10967
11031
  export function useUndoInformation(
10968
11032
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
@@ -11015,6 +11079,7 @@ export function useUndoInformation(
11015
11079
  * // -> '<span>Redo color</span>'
11016
11080
  * ```
11017
11081
  * @category Checkpoints hooks
11082
+ * @since v1.0.0
11018
11083
  */
11019
11084
  export function useRedoInformation(
11020
11085
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
@@ -11082,6 +11147,7 @@ export function useRedoInformation(
11082
11147
  * // -> 0
11083
11148
  * ```
11084
11149
  * @category Checkpoints hooks
11150
+ * @since v1.0.0
11085
11151
  */
11086
11152
  export function useCheckpointIdsListener(
11087
11153
  listener: CheckpointIdsListener,
@@ -11157,6 +11223,7 @@ export function useCheckpointIdsListener(
11157
11223
  * // -> 0
11158
11224
  * ```
11159
11225
  * @category Checkpoints hooks
11226
+ * @since v1.0.0
11160
11227
  */
11161
11228
  export function useCheckpointListener(
11162
11229
  checkpointId: IdOrNull,
@@ -11342,7 +11409,8 @@ export function useCheckpointListener(
11342
11409
  * root.unmount(); // !act
11343
11410
  * // -> 'Persister destroyed for session key cujoStore'
11344
11411
  * ```
11345
- * @category Persister hooks
11412
+ * @category Persister hooks
11413
+ * @since v1.0.0
11346
11414
  */
11347
11415
  export function useCreatePersister<
11348
11416
  PersisterOrUndefined extends Persister | undefined,
@@ -11503,6 +11571,7 @@ export function useCreateSynchronizer<
11503
11571
  /**
11504
11572
  * The ExtraProps type represents a set of arbitrary additional props.
11505
11573
  * @category Props
11574
+ * @since v1.0.0
11506
11575
  */
11507
11576
  export type ExtraProps = {[propName: string]: any};
11508
11577
 
@@ -11510,30 +11579,41 @@ export type ExtraProps = {[propName: string]: any};
11510
11579
  * TablesProps props are used for components that refer to all the Tables in a
11511
11580
  * Store, such as the TablesView component.
11512
11581
  * @category Props
11582
+ * @since v1.0.0
11513
11583
  */
11514
11584
  export type TablesProps = {
11515
11585
  /**
11516
11586
  * The Store to be accessed: omit for the default context Store, provide an Id
11517
11587
  * for a named context Store, or provide an explicit reference.
11588
+ * @category Prop
11589
+ * @since v1.0.0
11518
11590
  */
11519
11591
  readonly store?: StoreOrStoreId;
11520
11592
  /**
11521
11593
  * A component for rendering each Table in the Store (to override the default
11522
11594
  * TableView component).
11595
+ * @category Prop
11596
+ * @since v1.0.0
11523
11597
  */
11524
11598
  readonly tableComponent?: ComponentType<TableProps>;
11525
11599
  /**
11526
11600
  * A custom function for generating extra props for each Table component based
11527
11601
  * on its Id.
11602
+ * @category Prop
11603
+ * @since v1.0.0
11528
11604
  */
11529
11605
  readonly getTableComponentProps?: (tableId: Id) => ExtraProps;
11530
11606
  /**
11531
11607
  * A component or string to separate each Table component.
11608
+ * @category Prop
11609
+ * @since v1.0.0
11532
11610
  */
11533
11611
  readonly separator?: ReactElement | string;
11534
11612
  /**
11535
11613
  * Whether the component should also render the Ids of each Table, and its
11536
11614
  * descendent objects, to assist with debugging.
11615
+ * @category Prop
11616
+ * @since v1.0.0
11537
11617
  */
11538
11618
  readonly debugIds?: boolean;
11539
11619
  };
@@ -11542,39 +11622,54 @@ export type TablesProps = {
11542
11622
  * TableProps props are used for components that refer to a single Table in a
11543
11623
  * Store, such as the TableView component.
11544
11624
  * @category Props
11625
+ * @since v1.0.0
11545
11626
  */
11546
11627
  export type TableProps = {
11547
11628
  /**
11548
11629
  * The Id of the Table in the Store to be rendered.
11630
+ * @category Prop
11631
+ * @since v1.0.0
11549
11632
  */
11550
11633
  readonly tableId: Id;
11551
11634
  /**
11552
11635
  * The Store to be accessed: omit for the default context Store, provide an Id
11553
11636
  * for a named context Store, or provide an explicit reference.
11637
+ * @category Prop
11638
+ * @since v1.0.0
11554
11639
  */
11555
11640
  readonly store?: StoreOrStoreId;
11556
11641
  /**
11557
11642
  * A custom component for rendering each Row in the Table (to override the
11558
11643
  * default RowView component).
11644
+ * @category Prop
11645
+ * @since v1.0.0
11559
11646
  */
11560
11647
  readonly rowComponent?: ComponentType<RowProps>;
11561
11648
  /**
11562
11649
  * A function for generating extra props for each custom Row component based
11563
11650
  * on its Id.
11651
+ * @category Prop
11652
+ * @since v1.0.0
11564
11653
  */
11565
11654
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11566
11655
  /**
11567
11656
  * An optional list of Cell Ids to use for rendering a prescribed set of the
11568
11657
  * Table's Cells in a given order.
11658
+ * @category Prop
11659
+ * @since v1.0.0
11569
11660
  */
11570
11661
  readonly customCellIds?: Ids;
11571
11662
  /**
11572
11663
  * A component or string to separate each Row component.
11664
+ * @category Prop
11665
+ * @since v1.0.0
11573
11666
  */
11574
11667
  readonly separator?: ReactElement | string;
11575
11668
  /**
11576
11669
  * Whether the component should also render the Id of the Table, and its
11577
11670
  * descendent objects, to assist with debugging.
11671
+ * @category Prop
11672
+ * @since v1.0.0
11578
11673
  */
11579
11674
  readonly debugIds?: boolean;
11580
11675
  };
@@ -11588,52 +11683,74 @@ export type TableProps = {
11588
11683
  export type SortedTableProps = {
11589
11684
  /**
11590
11685
  * The Id of the Table in the Store to be rendered.
11686
+ * @category Prop
11687
+ * @since v1.0.0
11591
11688
  */
11592
11689
  readonly tableId: Id;
11593
11690
  /**
11594
11691
  * The Id of the Cell whose values are used for the sorting. If omitted, the
11595
11692
  * view will sort the Row Id itself.
11693
+ * @category Prop
11694
+ * @since v1.0.0
11596
11695
  */
11597
11696
  readonly cellId?: Id;
11598
11697
  /**
11599
11698
  * Whether the sorting should be in descending order.
11699
+ * @category Prop
11700
+ * @since v1.0.0
11600
11701
  */
11601
11702
  readonly descending?: boolean;
11602
11703
  /**
11603
11704
  * The number of Row Ids to skip for pagination purposes.
11705
+ * @category Prop
11706
+ * @since v1.0.0
11604
11707
  */
11605
11708
  readonly offset?: number;
11606
11709
  /**
11607
11710
  * The maximum number of Row Ids to return.
11711
+ * @category Prop
11712
+ * @since v1.0.0
11608
11713
  */
11609
11714
  readonly limit?: number;
11610
11715
  /**
11611
11716
  * The Store to be accessed: omit for the default context Store, provide an Id
11612
11717
  * for a named context Store, or provide an explicit reference.
11718
+ * @category Prop
11719
+ * @since v1.0.0
11613
11720
  */
11614
11721
  readonly store?: StoreOrStoreId;
11615
11722
  /**
11616
11723
  * A custom component for rendering each Row in the Table (to override the
11617
11724
  * default RowView component).
11725
+ * @category Prop
11726
+ * @since v1.0.0
11618
11727
  */
11619
11728
  readonly rowComponent?: ComponentType<RowProps>;
11620
11729
  /**
11621
11730
  * A function for generating extra props for each custom Row component based
11622
11731
  * on its Id.
11732
+ * @category Prop
11733
+ * @since v1.0.0
11623
11734
  */
11624
11735
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11625
11736
  /**
11626
11737
  * An optional list of Cell Ids to use for rendering a prescribed set of the
11627
11738
  * sorted Table's Cells in a given order.
11739
+ * @category Prop
11740
+ * @since v1.0.0
11628
11741
  */
11629
11742
  readonly customCellIds?: Ids;
11630
11743
  /**
11631
11744
  * A component or string to separate each Row component.
11745
+ * @category Prop
11746
+ * @since v1.0.0
11632
11747
  */
11633
11748
  readonly separator?: ReactElement | string;
11634
11749
  /**
11635
11750
  * Whether the component should also render the Id of the Table, and its
11636
11751
  * descendent objects, to assist with debugging.
11752
+ * @category Prop
11753
+ * @since v1.0.0
11637
11754
  */
11638
11755
  readonly debugIds?: boolean;
11639
11756
  };
@@ -11642,43 +11759,60 @@ export type SortedTableProps = {
11642
11759
  * RowProps props are used for components that refer to a single Row in a Table,
11643
11760
  * such as the RowView component.
11644
11761
  * @category Props
11762
+ * @since v1.0.0
11645
11763
  */
11646
11764
  export type RowProps = {
11647
11765
  /**
11648
11766
  * The Id of the Table in the Store.
11767
+ * @category Prop
11768
+ * @since v1.0.0
11649
11769
  */
11650
11770
  readonly tableId: Id;
11651
11771
  /**
11652
11772
  * The Id of the Row in the Table to be rendered.
11773
+ * @category Prop
11774
+ * @since v1.0.0
11653
11775
  */
11654
11776
  readonly rowId: Id;
11655
11777
  /**
11656
11778
  * The Store to be accessed: omit for the default context Store, provide an Id
11657
11779
  * for a named context Store, or provide an explicit reference.
11780
+ * @category Prop
11781
+ * @since v1.0.0
11658
11782
  */
11659
11783
  readonly store?: StoreOrStoreId;
11660
11784
  /**
11661
11785
  * A custom component for rendering each Cell in the Row (to override the
11662
11786
  * default CellView component).
11787
+ * @category Prop
11788
+ * @since v1.0.0
11663
11789
  */
11664
11790
  readonly cellComponent?: ComponentType<CellProps>;
11665
11791
  /**
11666
11792
  * A function for generating extra props for each custom Cell component based
11667
11793
  * on its Id.
11794
+ * @category Prop
11795
+ * @since v1.0.0
11668
11796
  */
11669
11797
  readonly getCellComponentProps?: (cellId: Id) => ExtraProps;
11670
11798
  /**
11671
11799
  * An optional list of Cell Ids to use for rendering a prescribed set of the
11672
11800
  * Row's Cells in a given order.
11801
+ * @category Prop
11802
+ * @since v1.0.0
11673
11803
  */
11674
11804
  readonly customCellIds?: Ids;
11675
11805
  /**
11676
11806
  * A component or string to separate each Cell component.
11807
+ * @category Prop
11808
+ * @since v1.0.0
11677
11809
  */
11678
11810
  readonly separator?: ReactElement | string;
11679
11811
  /**
11680
11812
  * Whether the component should also render the Id of the Row, and its
11681
11813
  * descendent objects, to assist with debugging.
11814
+ * @category Prop
11815
+ * @since v1.0.0
11682
11816
  */
11683
11817
  readonly debugIds?: boolean;
11684
11818
  };
@@ -11687,28 +11821,39 @@ export type RowProps = {
11687
11821
  * CellProps props are used for components that refer to a single Cell in a Row,
11688
11822
  * such as the CellView component.
11689
11823
  * @category Props
11824
+ * @since v1.0.0
11690
11825
  */
11691
11826
  export type CellProps = {
11692
11827
  /**
11693
11828
  * The Id of the Table in the Store.
11829
+ * @category Prop
11830
+ * @since v1.0.0
11694
11831
  */
11695
11832
  readonly tableId: Id;
11696
11833
  /**
11697
11834
  * The Id of the Row in the Table.
11835
+ * @category Prop
11836
+ * @since v1.0.0
11698
11837
  */
11699
11838
  readonly rowId: Id;
11700
11839
  /**
11701
11840
  * The Id of the Cell in the Row to be rendered.
11841
+ * @category Prop
11842
+ * @since v1.0.0
11702
11843
  */
11703
11844
  readonly cellId: Id;
11704
11845
  /**
11705
11846
  * The Store to be accessed: omit for the default context Store, provide an Id
11706
11847
  * for a named context Store, or provide an explicit reference.
11848
+ * @category Prop
11849
+ * @since v1.0.0
11707
11850
  */
11708
11851
  readonly store?: StoreOrStoreId;
11709
11852
  /**
11710
11853
  * Whether the component should also render the Id of the Cell to assist with
11711
11854
  * debugging.
11855
+ * @category Prop
11856
+ * @since v1.0.0
11712
11857
  */
11713
11858
  readonly debugIds?: boolean;
11714
11859
  };
@@ -11723,25 +11868,35 @@ export type ValuesProps = {
11723
11868
  /**
11724
11869
  * The Store to be accessed: omit for the default context Store, provide an Id
11725
11870
  * for a named context Store, or provide an explicit reference.
11871
+ * @category Prop
11872
+ * @since v1.0.0
11726
11873
  */
11727
11874
  readonly store?: StoreOrStoreId;
11728
11875
  /**
11729
11876
  * A custom component for rendering each Value in the Store (to override the
11730
11877
  * default ValueView component).
11878
+ * @category Prop
11879
+ * @since v1.0.0
11731
11880
  */
11732
11881
  readonly valueComponent?: ComponentType<ValueProps>;
11733
11882
  /**
11734
11883
  * A function for generating extra props for each custom Value component based
11735
11884
  * on its Id.
11885
+ * @category Prop
11886
+ * @since v1.0.0
11736
11887
  */
11737
11888
  readonly getValueComponentProps?: (valueId: Id) => ExtraProps;
11738
11889
  /**
11739
11890
  * A component or string to separate each Value component.
11891
+ * @category Prop
11892
+ * @since v1.0.0
11740
11893
  */
11741
11894
  readonly separator?: ReactElement | string;
11742
11895
  /**
11743
11896
  * Whether the component should also render the Ids of each Value to assist
11744
11897
  * with debugging.
11898
+ * @category Prop
11899
+ * @since v1.0.0
11745
11900
  */
11746
11901
  readonly debugIds?: boolean;
11747
11902
  };
@@ -11755,16 +11910,22 @@ export type ValuesProps = {
11755
11910
  export type ValueProps = {
11756
11911
  /**
11757
11912
  * The Id of the Value in the Row to be rendered.
11913
+ * @category Prop
11914
+ * @since v1.0.0
11758
11915
  */
11759
11916
  readonly valueId: Id;
11760
11917
  /**
11761
11918
  * The Store to be accessed: omit for the default context Store, provide an Id
11762
11919
  * for a named context Store, or provide an explicit reference.
11920
+ * @category Prop
11921
+ * @since v1.0.0
11763
11922
  */
11764
11923
  readonly store?: StoreOrStoreId;
11765
11924
  /**
11766
11925
  * Whether the component should also render the Id of the Value to assist with
11767
11926
  * debugging.
11927
+ * @category Prop
11928
+ * @since v1.0.0
11768
11929
  */
11769
11930
  readonly debugIds?: boolean;
11770
11931
  };
@@ -11773,21 +11934,28 @@ export type ValueProps = {
11773
11934
  * MetricProps props are used for components that refer to a single Metric in a
11774
11935
  * Metrics object, such as the MetricView component.
11775
11936
  * @category Props
11937
+ * @since v1.0.0
11776
11938
  */
11777
11939
  export type MetricProps = {
11778
11940
  /**
11779
11941
  * The Id of the Metric in the Metrics object to be rendered.
11942
+ * @category Prop
11943
+ * @since v1.0.0
11780
11944
  */
11781
11945
  readonly metricId: Id;
11782
11946
  /**
11783
11947
  * The Metrics object to be accessed: omit for the default context Metrics
11784
11948
  * object, provide an Id for a named context Metrics object, or provide an
11785
11949
  * explicit reference.
11950
+ * @category Prop
11951
+ * @since v1.0.0
11786
11952
  */
11787
11953
  readonly metrics?: MetricsOrMetricsId;
11788
11954
  /**
11789
11955
  * Whether the component should also render the Id of the Metric to assist
11790
11956
  * with debugging.
11957
+ * @category Prop
11958
+ * @since v1.0.0
11791
11959
  */
11792
11960
  readonly debugIds?: boolean;
11793
11961
  };
@@ -11796,34 +11964,47 @@ export type MetricProps = {
11796
11964
  * IndexProps props are used for components that refer to a single Index in an
11797
11965
  * Indexes object, such as the IndexView component.
11798
11966
  * @category Props
11967
+ * @since v1.0.0
11799
11968
  */
11800
11969
  export type IndexProps = {
11801
11970
  /**
11802
11971
  * The Id of the Index in the Indexes object to be rendered.
11972
+ * @category Prop
11973
+ * @since v1.0.0
11803
11974
  */
11804
11975
  readonly indexId: Id;
11805
11976
  /**
11806
11977
  * The Indexes object to be accessed: omit for the default context Indexes
11807
11978
  * object, provide an Id for a named context Indexes object, or provide an
11808
11979
  * explicit reference.
11980
+ * @category Prop
11981
+ * @since v1.0.0
11809
11982
  */
11810
11983
  readonly indexes?: IndexesOrIndexesId;
11811
11984
  /**
11812
11985
  * A component for rendering each Slice in the Index.
11986
+ * @category Prop
11987
+ * @since v1.0.0
11813
11988
  */
11814
11989
  readonly sliceComponent?: ComponentType<SliceProps>;
11815
11990
  /**
11816
11991
  * A function for generating extra props for each Slice component based on its
11817
11992
  * Id.
11993
+ * @category Prop
11994
+ * @since v1.0.0
11818
11995
  */
11819
11996
  readonly getSliceComponentProps?: (sliceId: Id) => ExtraProps;
11820
11997
  /**
11821
11998
  * A component or string to separate each Slice component.
11999
+ * @category Prop
12000
+ * @since v1.0.0
11822
12001
  */
11823
12002
  readonly separator?: ReactElement | string;
11824
12003
  /**
11825
12004
  * Whether the component should also render the Id of the Index, and its
11826
12005
  * descendent objects, to assist with debugging.
12006
+ * @category Prop
12007
+ * @since v1.0.0
11827
12008
  */
11828
12009
  readonly debugIds?: boolean;
11829
12010
  };
@@ -11832,38 +12013,53 @@ export type IndexProps = {
11832
12013
  * SliceProps props are used for components that refer to a single Slice in an
11833
12014
  * Index object, such as the SliceView component.
11834
12015
  * @category Props
12016
+ * @since v1.0.0
11835
12017
  */
11836
12018
  export type SliceProps = {
11837
12019
  /**
11838
12020
  * The Id of the Index in the Indexes object.
12021
+ * @category Prop
12022
+ * @since v1.0.0
11839
12023
  */
11840
12024
  readonly indexId: Id;
11841
12025
  /**
11842
12026
  * The Id of the Slice in the Index to be rendered.
12027
+ * @category Prop
12028
+ * @since v1.0.0
11843
12029
  */
11844
12030
  readonly sliceId: Id;
11845
12031
  /**
11846
12032
  * The Indexes object to be accessed: omit for the default context Indexes
11847
12033
  * object, provide an Id for a named context Indexes object, or provide an
11848
12034
  * explicit reference.
12035
+ * @category Prop
12036
+ * @since v1.0.0
11849
12037
  */
11850
12038
  readonly indexes?: IndexesOrIndexesId;
11851
12039
  /**
11852
12040
  * A component for rendering each Row in the Index.
12041
+ * @category Prop
12042
+ * @since v1.0.0
11853
12043
  */
11854
12044
  readonly rowComponent?: ComponentType<RowProps>;
11855
12045
  /**
11856
12046
  * A function for generating extra props for each Row component based on its
11857
12047
  * Id.
12048
+ * @category Prop
12049
+ * @since v1.0.0
11858
12050
  */
11859
12051
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11860
12052
  /**
11861
12053
  * A component or string to separate each Row component.
12054
+ * @category Prop
12055
+ * @since v1.0.0
11862
12056
  */
11863
12057
  readonly separator?: ReactElement | string;
11864
12058
  /**
11865
12059
  * Whether the component should also render the Id of the Slice, and its
11866
12060
  * descendent objects, to assist with debugging.
12061
+ * @category Prop
12062
+ * @since v1.0.0
11867
12063
  */
11868
12064
  readonly debugIds?: boolean;
11869
12065
  };
@@ -11873,35 +12069,48 @@ export type SliceProps = {
11873
12069
  * Relationship in a Relationships object, and where you want to render a remote
11874
12070
  * Row based on a local Row, such as in the RemoteRowView component.
11875
12071
  * @category Props
12072
+ * @since v1.0.0
11876
12073
  */
11877
12074
  export type RemoteRowProps = {
11878
12075
  /**
11879
12076
  * The Id of the Relationship in the Relationships object.
12077
+ * @category Prop
12078
+ * @since v1.0.0
11880
12079
  */
11881
12080
  readonly relationshipId: Id;
11882
12081
  /**
11883
12082
  * The Id of the local Row for which to render the remote Row.
12083
+ * @category Prop
12084
+ * @since v1.0.0
11884
12085
  */
11885
12086
  readonly localRowId: Id;
11886
12087
  /**
11887
12088
  * The Relationships object to be accessed: omit for the default context
11888
12089
  * Relationships object, provide an Id for a named context Relationships
11889
12090
  * object, or provide an explicit reference.
12091
+ * @category Prop
12092
+ * @since v1.0.0
11890
12093
  */
11891
12094
  readonly relationships?: RelationshipsOrRelationshipsId;
11892
12095
  /**
11893
12096
  * A component for rendering each (remote, local, or linked) Row in the
11894
12097
  * Relationship.
12098
+ * @category Prop
12099
+ * @since v1.0.0
11895
12100
  */
11896
12101
  readonly rowComponent?: ComponentType<RowProps>;
11897
12102
  /**
11898
12103
  * A function for generating extra props for each Row component based on its
11899
12104
  * Id.
12105
+ * @category Prop
12106
+ * @since v1.0.0
11900
12107
  */
11901
12108
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11902
12109
  /**
11903
12110
  * Whether the component should also render the Id of the Row in the
11904
12111
  * Relationship, and its descendent objects, to assist with debugging.
12112
+ * @category Prop
12113
+ * @since v1.0.0
11905
12114
  */
11906
12115
  readonly debugIds?: boolean;
11907
12116
  };
@@ -11911,39 +12120,54 @@ export type RemoteRowProps = {
11911
12120
  * Relationship in a Relationships object, and where you want to render local
11912
12121
  * Rows based on a remote Row, such as the LocalRowsView component.
11913
12122
  * @category Props
12123
+ * @since v1.0.0
11914
12124
  */
11915
12125
  export type LocalRowsProps = {
11916
12126
  /**
11917
12127
  * The Id of the Relationship in the Relationships object.
12128
+ * @category Prop
12129
+ * @since v1.0.0
11918
12130
  */
11919
12131
  readonly relationshipId: Id;
11920
12132
  /**
11921
12133
  * The Id of the remote Row for which to render the local Rows.
12134
+ * @category Prop
12135
+ * @since v1.0.0
11922
12136
  */
11923
12137
  readonly remoteRowId: Id;
11924
12138
  /**
11925
12139
  * The Relationships object to be accessed: omit for the default context
11926
12140
  * Relationships object, provide an Id for a named context Relationships
11927
12141
  * object, or provide an explicit reference.
12142
+ * @category Prop
12143
+ * @since v1.0.0
11928
12144
  */
11929
12145
  readonly relationships?: RelationshipsOrRelationshipsId;
11930
12146
  /**
11931
12147
  * A component for rendering each (remote, local, or linked) Row in the
11932
12148
  * Relationship.
12149
+ * @category Prop
12150
+ * @since v1.0.0
11933
12151
  */
11934
12152
  readonly rowComponent?: ComponentType<RowProps>;
11935
12153
  /**
11936
12154
  * A function for generating extra props for each Row component based on its
11937
12155
  * Id.
12156
+ * @category Prop
12157
+ * @since v1.0.0
11938
12158
  */
11939
12159
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11940
12160
  /**
11941
12161
  * A component or string to separate each Row component.
12162
+ * @category Prop
12163
+ * @since v1.0.0
11942
12164
  */
11943
12165
  readonly separator?: ReactElement | string;
11944
12166
  /**
11945
12167
  * Whether the component should also render the Id of the Row in the
11946
12168
  * Relationship, and its descendent objects, to assist with debugging.
12169
+ * @category Prop
12170
+ * @since v1.0.0
11947
12171
  */
11948
12172
  readonly debugIds?: boolean;
11949
12173
  };
@@ -11953,39 +12177,54 @@ export type LocalRowsProps = {
11953
12177
  * Relationship in a Relationships object, and where you want to render a linked
11954
12178
  * list of Rows starting from a first Row, such as the LinkedRowsView component.
11955
12179
  * @category Props
12180
+ * @since v1.0.0
11956
12181
  */
11957
12182
  export type LinkedRowsProps = {
11958
12183
  /**
11959
12184
  * The Id of the Relationship in the Relationships object.
12185
+ * @category Prop
12186
+ * @since v1.0.0
11960
12187
  */
11961
12188
  readonly relationshipId: Id;
11962
12189
  /**
11963
12190
  * The Id of the first Row in the linked list Relationship.
12191
+ * @category Prop
12192
+ * @since v1.0.0
11964
12193
  */
11965
12194
  readonly firstRowId: Id;
11966
12195
  /**
11967
12196
  * The Relationships object to be accessed: omit for the default context
11968
12197
  * Relationships object, provide an Id for a named context Relationships
11969
12198
  * object, or provide an explicit reference.
12199
+ * @category Prop
12200
+ * @since v1.0.0
11970
12201
  */
11971
12202
  readonly relationships?: RelationshipsOrRelationshipsId;
11972
12203
  /**
11973
12204
  * A component for rendering each (remote, local, or linked) Row in the
11974
12205
  * Relationship.
12206
+ * @category Prop
12207
+ * @since v1.0.0
11975
12208
  */
11976
12209
  readonly rowComponent?: ComponentType<RowProps>;
11977
12210
  /**
11978
12211
  * A function for generating extra props for each Row component based on its
11979
12212
  * Id.
12213
+ * @category Prop
12214
+ * @since v1.0.0
11980
12215
  */
11981
12216
  readonly getRowComponentProps?: (rowId: Id) => ExtraProps;
11982
12217
  /**
11983
12218
  * A component or string to separate each Row component.
12219
+ * @category Prop
12220
+ * @since v1.0.0
11984
12221
  */
11985
12222
  readonly separator?: ReactElement | string;
11986
12223
  /**
11987
12224
  * Whether the component should also render the Id of the Row in the
11988
12225
  * Relationship, and its descendent objects, to assist with debugging.
12226
+ * @category Prop
12227
+ * @since v1.0.0
11989
12228
  */
11990
12229
  readonly debugIds?: boolean;
11991
12230
  };
@@ -12000,31 +12239,43 @@ export type ResultTableProps = {
12000
12239
  /**
12001
12240
  * The Id of the query in the Queries object for which the ResultTable will be
12002
12241
  * rendered.
12242
+ * @category Prop
12243
+ * @since v1.0.0
12003
12244
  */
12004
12245
  readonly queryId: Id;
12005
12246
  /**
12006
12247
  * The Queries object to be accessed: omit for the default context Queries
12007
12248
  * object, provide an Id for a named context Queries object, or provide an
12008
12249
  * explicit reference.
12250
+ * @category Prop
12251
+ * @since v1.0.0
12009
12252
  */
12010
12253
  readonly queries?: QueriesOrQueriesId;
12011
12254
  /**
12012
12255
  * A custom component for rendering each Row in the Table (to override the
12013
12256
  * default ResultRowView component).
12257
+ * @category Prop
12258
+ * @since v1.0.0
12014
12259
  */
12015
12260
  readonly resultRowComponent?: ComponentType<ResultRowProps>;
12016
12261
  /**
12017
12262
  * A function for generating extra props for each custom Row component based
12018
12263
  * on its Id.
12264
+ * @category Prop
12265
+ * @since v1.0.0
12019
12266
  */
12020
12267
  readonly getResultRowComponentProps?: (rowId: Id) => ExtraProps;
12021
12268
  /**
12022
12269
  * A component or string to separate each Row component.
12270
+ * @category Prop
12271
+ * @since v1.0.0
12023
12272
  */
12024
12273
  readonly separator?: ReactElement | string;
12025
12274
  /**
12026
12275
  * Whether the component should also render the Id of the query, and its
12027
12276
  * descendent objects, to assist with debugging.
12277
+ * @category Prop
12278
+ * @since v1.0.0
12028
12279
  */
12029
12280
  readonly debugIds?: boolean;
12030
12281
  };
@@ -12039,48 +12290,68 @@ export type ResultSortedTableProps = {
12039
12290
  /**
12040
12291
  * The Id of the query in the Queries object for which the sorted ResultTable
12041
12292
  * will be rendered.
12293
+ * @category Prop
12294
+ * @since v1.0.0
12042
12295
  */
12043
12296
  readonly queryId: Id;
12044
12297
  /**
12045
12298
  * The Id of the Cell whose values are used for the sorting. If omitted, the
12046
12299
  * view will sort the Row Id itself.
12300
+ * @category Prop
12301
+ * @since v1.0.0
12047
12302
  */
12048
12303
  readonly cellId?: Id;
12049
12304
  /**
12050
12305
  * Whether the sorting should be in descending order.
12306
+ * @category Prop
12307
+ * @since v1.0.0
12051
12308
  */
12052
12309
  readonly descending?: boolean;
12053
12310
  /**
12054
12311
  * The number of Row Ids to skip for pagination purposes.
12312
+ * @category Prop
12313
+ * @since v1.0.0
12055
12314
  */
12056
12315
  readonly offset?: number;
12057
12316
  /**
12058
12317
  * The maximum number of Row Ids to return.
12318
+ * @category Prop
12319
+ * @since v1.0.0
12059
12320
  */
12060
12321
  readonly limit?: number;
12061
12322
  /**
12062
12323
  * The Queries object to be accessed: omit for the default context Queries
12063
12324
  * object, provide an Id for a named context Queries object, or provide an
12064
12325
  * explicit reference.
12326
+ * @category Prop
12327
+ * @since v1.0.0
12065
12328
  */
12066
12329
  readonly queries?: QueriesOrQueriesId;
12067
12330
  /**
12068
12331
  * A custom component for rendering each Row in the Table (to override the
12069
12332
  * default ResultRowView component).
12333
+ * @category Prop
12334
+ * @since v1.0.0
12070
12335
  */
12071
12336
  readonly resultRowComponent?: ComponentType<ResultRowProps>;
12072
12337
  /**
12073
12338
  * A function for generating extra props for each custom Row component based
12074
12339
  * on its Id.
12340
+ * @category Prop
12341
+ * @since v1.0.0
12075
12342
  */
12076
12343
  readonly getResultRowComponentProps?: (rowId: Id) => ExtraProps;
12077
12344
  /**
12078
12345
  * A component or string to separate each Row component.
12346
+ * @category Prop
12347
+ * @since v1.0.0
12079
12348
  */
12080
12349
  readonly separator?: ReactElement | string;
12081
12350
  /**
12082
12351
  * Whether the component should also render the Id of the query, and its
12083
12352
  * descendent objects, to assist with debugging.
12353
+ * @category Prop
12354
+ * @since v1.0.0
12084
12355
  */
12085
12356
  readonly debugIds?: boolean;
12086
12357
  };
@@ -12095,35 +12366,49 @@ export type ResultRowProps = {
12095
12366
  /**
12096
12367
  * The Id of the query in the Queries object for which the ResultTable will be
12097
12368
  * rendered.
12369
+ * @category Prop
12370
+ * @since v1.0.0
12098
12371
  */
12099
12372
  readonly queryId: Id;
12100
12373
  /**
12101
12374
  * The Id of the Row in the ResultTable to be rendered.
12375
+ * @category Prop
12376
+ * @since v1.0.0
12102
12377
  */
12103
12378
  readonly rowId: Id;
12104
12379
  /**
12105
12380
  * The Queries object to be accessed: omit for the default context Queries
12106
12381
  * object, provide an Id for a named context Queries object, or provide an
12107
12382
  * explicit reference.
12383
+ * @category Prop
12384
+ * @since v1.0.0
12108
12385
  */
12109
12386
  readonly queries?: QueriesOrQueriesId;
12110
12387
  /**
12111
12388
  * A custom component for rendering each Cell in the Row (to override the
12112
12389
  * default CellView component).
12390
+ * @category Prop
12391
+ * @since v1.0.0
12113
12392
  */
12114
12393
  readonly resultCellComponent?: ComponentType<ResultCellProps>;
12115
12394
  /**
12116
12395
  * A function for generating extra props for each custom Cell component based
12117
12396
  * on its Id.
12397
+ * @category Prop
12398
+ * @since v1.0.0
12118
12399
  */
12119
12400
  readonly getResultCellComponentProps?: (cellId: Id) => ExtraProps;
12120
12401
  /**
12121
12402
  * A component or string to separate each Cell component.
12403
+ * @category Prop
12404
+ * @since v1.0.0
12122
12405
  */
12123
12406
  readonly separator?: ReactElement | string;
12124
12407
  /**
12125
12408
  * Whether the component should also render the Id of the Row, and its
12126
12409
  * descendent objects, to assist with debugging.
12410
+ * @category Prop
12411
+ * @since v1.0.0
12127
12412
  */
12128
12413
  readonly debugIds?: boolean;
12129
12414
  };
@@ -12138,25 +12423,35 @@ export type ResultCellProps = {
12138
12423
  /**
12139
12424
  * The Id of the query in the Queries object for which the ResultTable will be
12140
12425
  * rendered.
12426
+ * @category Prop
12427
+ * @since v1.0.0
12141
12428
  */
12142
12429
  readonly queryId: Id;
12143
12430
  /**
12144
12431
  * The Id of the Row in the Table.
12432
+ * @category Prop
12433
+ * @since v1.0.0
12145
12434
  */
12146
12435
  readonly rowId: Id;
12147
12436
  /**
12148
12437
  * The Id of the Cell in the Row to be rendered.
12438
+ * @category Prop
12439
+ * @since v1.0.0
12149
12440
  */
12150
12441
  readonly cellId: Id;
12151
12442
  /**
12152
12443
  * The Queries object to be accessed: omit for the default context Queries
12153
12444
  * object, provide an Id for a named context Queries object, or provide an
12154
12445
  * explicit reference.
12446
+ * @category Prop
12447
+ * @since v1.0.0
12155
12448
  */
12156
12449
  readonly queries?: QueriesOrQueriesId;
12157
12450
  /**
12158
12451
  * Whether the component should also render the Id of the Cell to assist with
12159
12452
  * debugging.
12453
+ * @category Prop
12454
+ * @since v1.0.0
12160
12455
  */
12161
12456
  readonly debugIds?: boolean;
12162
12457
  };
@@ -12165,21 +12460,28 @@ export type ResultCellProps = {
12165
12460
  * CheckpointProps props are used for components that refer to a single
12166
12461
  * checkpoint in a Checkpoints object, such as the CheckpointView component.
12167
12462
  * @category Props
12463
+ * @since v1.0.0
12168
12464
  */
12169
12465
  export type CheckpointProps = {
12170
12466
  /**
12171
12467
  * The Id of the checkpoint in the Checkpoints object.
12468
+ * @category Prop
12469
+ * @since v1.0.0
12172
12470
  */
12173
12471
  readonly checkpointId: Id;
12174
12472
  /**
12175
12473
  * The Checkpoints object to be accessed: omit for the default context
12176
12474
  * Checkpoints object, provide an Id for a named context Checkpoints object,
12177
12475
  * or provide an explicit reference.
12476
+ * @category Prop
12477
+ * @since v1.0.0
12178
12478
  */
12179
12479
  readonly checkpoints?: CheckpointsOrCheckpointsId;
12180
12480
  /**
12181
12481
  * Whether the component should also render the Id of the checkpoint to assist
12182
12482
  * with debugging.
12483
+ * @category Prop
12484
+ * @since v1.0.0
12183
12485
  */
12184
12486
  readonly debugIds?: boolean;
12185
12487
  };
@@ -12189,30 +12491,41 @@ export type CheckpointProps = {
12189
12491
  * of previous checkpoints in a Checkpoints object, such as the
12190
12492
  * BackwardCheckpointsView component.
12191
12493
  * @category Props
12494
+ * @since v1.0.0
12192
12495
  */
12193
12496
  export type BackwardCheckpointsProps = {
12194
12497
  /**
12195
12498
  * The Checkpoints object to be accessed: omit for the default context
12196
12499
  * Checkpoints object, provide an Id for a named context Checkpoints object,
12197
12500
  * or provide an explicit reference.
12501
+ * @category Prop
12502
+ * @since v1.0.0
12198
12503
  */
12199
12504
  readonly checkpoints?: CheckpointsOrCheckpointsId;
12200
12505
  /**
12201
12506
  * A component for rendering each checkpoint in the Checkpoints object.
12507
+ * @category Prop
12508
+ * @since v1.0.0
12202
12509
  */
12203
12510
  readonly checkpointComponent?: ComponentType<CheckpointProps>;
12204
12511
  /**
12205
12512
  * A function for generating extra props for each checkpoint component based
12206
12513
  * on its Id.
12514
+ * @category Prop
12515
+ * @since v1.0.0
12207
12516
  */
12208
12517
  readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
12209
12518
  /**
12210
12519
  * A component or string to separate each Checkpoint component.
12520
+ * @category Prop
12521
+ * @since v1.0.0
12211
12522
  */
12212
12523
  readonly separator?: ReactElement | string;
12213
12524
  /**
12214
12525
  * Whether the component should also render the Ids of the checkpoints to
12215
12526
  * assist with debugging.
12527
+ * @category Prop
12528
+ * @since v1.0.0
12216
12529
  */
12217
12530
  readonly debugIds?: boolean;
12218
12531
  };
@@ -12222,26 +12535,35 @@ export type BackwardCheckpointsProps = {
12222
12535
  * current checkpoints in a Checkpoints object, such as the
12223
12536
  * BackwardCheckpointsView component.
12224
12537
  * @category Props
12538
+ * @since v1.0.0
12225
12539
  */
12226
12540
  export type CurrentCheckpointProps = {
12227
12541
  /**
12228
12542
  * The Checkpoints object to be accessed: omit for the default context
12229
12543
  * Checkpoints object, provide an Id for a named context Checkpoints object,
12230
12544
  * or provide an explicit reference.
12545
+ * @category Prop
12546
+ * @since v1.0.0
12231
12547
  */
12232
12548
  readonly checkpoints?: CheckpointsOrCheckpointsId;
12233
12549
  /**
12234
12550
  * A component for rendering each checkpoint in the Checkpoints object.
12551
+ * @category Prop
12552
+ * @since v1.0.0
12235
12553
  */
12236
12554
  readonly checkpointComponent?: ComponentType<CheckpointProps>;
12237
12555
  /**
12238
12556
  * A function for generating extra props for each checkpoint component based
12239
12557
  * on its Id.
12558
+ * @category Prop
12559
+ * @since v1.0.0
12240
12560
  */
12241
12561
  readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
12242
12562
  /**
12243
12563
  * Whether the component should also render the Ids of the checkpoints to
12244
12564
  * assist with debugging.
12565
+ * @category Prop
12566
+ * @since v1.0.0
12245
12567
  */
12246
12568
  readonly debugIds?: boolean;
12247
12569
  };
@@ -12251,30 +12573,41 @@ export type CurrentCheckpointProps = {
12251
12573
  * future checkpoints in a Checkpoints object, such as the
12252
12574
  * ForwardCheckpointsView component.
12253
12575
  * @category Props
12576
+ * @since v1.0.0
12254
12577
  */
12255
12578
  export type ForwardCheckpointsProps = {
12256
12579
  /**
12257
12580
  * The Checkpoints object to be accessed: omit for the default context
12258
12581
  * Checkpoints object, provide an Id for a named context Checkpoints object,
12259
12582
  * or provide an explicit reference.
12583
+ * @category Prop
12584
+ * @since v1.0.0
12260
12585
  */
12261
12586
  readonly checkpoints?: CheckpointsOrCheckpointsId;
12262
12587
  /**
12263
12588
  * A component for rendering each checkpoint in the Checkpoints object.
12589
+ * @category Prop
12590
+ * @since v1.0.0
12264
12591
  */
12265
12592
  readonly checkpointComponent?: ComponentType<CheckpointProps>;
12266
12593
  /**
12267
12594
  * A function for generating extra props for each checkpoint component based
12268
12595
  * on its Id.
12596
+ * @category Prop
12597
+ * @since v1.0.0
12269
12598
  */
12270
12599
  readonly getCheckpointComponentProps?: (checkpointId: Id) => ExtraProps;
12271
12600
  /**
12272
12601
  * A component or string to separate each Checkpoint component.
12602
+ * @category Prop
12603
+ * @since v1.0.0
12273
12604
  */
12274
12605
  readonly separator?: ReactElement | string;
12275
12606
  /**
12276
12607
  * Whether the component should also render the Ids of the checkpoints to
12277
12608
  * assist with debugging.
12609
+ * @category Prop
12610
+ * @since v1.0.0
12278
12611
  */
12279
12612
  readonly debugIds?: boolean;
12280
12613
  };
@@ -12288,66 +12621,91 @@ export type ForwardCheckpointsProps = {
12288
12621
  * Additionally, multiple of each type of object can be provided in an Id-keyed
12289
12622
  * map to the `___ById` props.
12290
12623
  * @category Props
12624
+ * @since v1.0.0
12291
12625
  */
12292
12626
  export type ProviderProps = {
12293
12627
  /**
12294
12628
  * A default single Store object that will be available within the Provider
12295
12629
  * context.
12630
+ * @category Prop
12631
+ * @since v1.0.0
12296
12632
  */
12297
12633
  readonly store?: Store;
12298
12634
  /**
12299
12635
  * An object containing multiple Store objects that will be available within
12300
12636
  * the Provider context by their Id.
12637
+ * @category Prop
12638
+ * @since v1.0.0
12301
12639
  */
12302
12640
  readonly storesById?: {[storeId: Id]: Store};
12303
12641
  /**
12304
12642
  * A default single Metrics object that will be available within the Provider
12305
12643
  * context.
12644
+ * @category Prop
12645
+ * @since v1.0.0
12306
12646
  */
12307
12647
  readonly metrics?: Metrics;
12308
12648
  /**
12309
12649
  * An object containing multiple Metrics objects that will be available within
12310
12650
  * the Provider context by their Id.
12651
+ * @category Prop
12652
+ * @since v1.0.0
12311
12653
  */
12312
12654
  readonly metricsById?: {[metricsId: Id]: Metrics};
12313
12655
  /**
12314
12656
  * A default single Indexes object that will be available within the Provider
12315
12657
  * context.
12658
+ * @category Prop
12659
+ * @since v1.0.0
12316
12660
  */
12317
12661
  readonly indexes?: Indexes;
12318
12662
  /**
12319
12663
  * An object containing multiple Indexes objects that will be available within
12320
12664
  * the Provider context by their Id.
12665
+ * @category Prop
12666
+ * @since v1.0.0
12321
12667
  */
12322
12668
  readonly indexesById?: {[indexesId: Id]: Indexes};
12323
12669
  /**
12324
12670
  * A default single Relationships object that will be available within the
12325
12671
  * Provider context.
12672
+ * @category Prop
12673
+ * @since v1.0.0
12326
12674
  */
12327
12675
  readonly relationships?: Relationships;
12328
12676
  /**
12329
12677
  * An object containing multiple Relationships objects that will be available
12330
12678
  * within the Provider context by their Id.
12679
+ * @category Prop
12680
+ * @since v1.0.0
12331
12681
  */
12332
12682
  readonly relationshipsById?: {[relationshipsId: Id]: Relationships};
12333
12683
  /**
12334
12684
  * A default single Queries object that will be available within the Provider
12335
12685
  * context, since v2.0.
12686
+ * @category Prop
12687
+ * @since v1.0.0
12336
12688
  */
12337
12689
  readonly queries?: Queries;
12338
12690
  /**
12339
12691
  * An object containing multiple Queries objects that will be available within
12340
12692
  * the Provider context by their Id, since v2.0.
12693
+ * @category Prop
12694
+ * @since v1.0.0
12341
12695
  */
12342
12696
  readonly queriesById?: {[queriesId: Id]: Queries};
12343
12697
  /**
12344
12698
  * A default single Checkpoints object that will be available within the
12345
12699
  * Provider context.
12700
+ * @category Prop
12701
+ * @since v1.0.0
12346
12702
  */
12347
12703
  readonly checkpoints?: Checkpoints;
12348
12704
  /**
12349
12705
  * An object containing multiple Checkpoints objects that will be available
12350
12706
  * within the Provider context by their Id.
12707
+ * @category Prop
12708
+ * @since v1.0.0
12351
12709
  */
12352
12710
  readonly checkpointsById?: {[checkpointsId: Id]: Checkpoints};
12353
12711
  };
@@ -12356,6 +12714,7 @@ export type ProviderProps = {
12356
12714
  * ComponentReturnType is a simple alias for what a React component can return:
12357
12715
  * either a ReactElement, or `null` for an empty component.
12358
12716
  * @category Component
12717
+ * @since v1.0.0
12359
12718
  */
12360
12719
  export type ComponentReturnType = ReactElement<any, any> | null;
12361
12720
 
@@ -12468,6 +12827,7 @@ export type ComponentReturnType = ReactElement<any, any> | null;
12468
12827
  * // -> '<span>5,5,2</span>'
12469
12828
  * ```
12470
12829
  * @category Context components
12830
+ * @since v1.0.0
12471
12831
  */
12472
12832
  export function Provider(
12473
12833
  props: ProviderProps & {children: React.ReactNode},
@@ -12575,6 +12935,7 @@ export function Provider(
12575
12935
  * // -> '<span></span>'
12576
12936
  * ```
12577
12937
  * @category Store components
12938
+ * @since v1.0.0
12578
12939
  */
12579
12940
  export function CellView(props: CellProps): ComponentReturnType;
12580
12941
 
@@ -12713,6 +13074,7 @@ export function CellView(props: CellProps): ComponentReturnType;
12713
13074
  * // -> '<div><span><b>species</b>: dog</span><span>color: walnut</span></div>'
12714
13075
  * ```
12715
13076
  * @category Store components
13077
+ * @since v1.0.0
12716
13078
  */
12717
13079
  export function RowView(props: RowProps): ComponentReturnType;
12718
13080
 
@@ -13002,6 +13364,7 @@ export function SortedTableView(props: SortedTableProps): ComponentReturnType;
13002
13364
  * // -> '<div><span><b>fido</b>: dog</span><span>felix: cat</span></div>'
13003
13365
  * ```
13004
13366
  * @category Store components
13367
+ * @since v1.0.0
13005
13368
  */
13006
13369
  export function TableView(props: TableProps): ComponentReturnType;
13007
13370
 
@@ -13125,6 +13488,7 @@ export function TableView(props: TableProps): ComponentReturnType;
13125
13488
  * // -> '<div><span><b>pets</b>: dog</span><span>species: 5</span></div>'
13126
13489
  * ```
13127
13490
  * @category Store components
13491
+ * @since v1.0.0
13128
13492
  */
13129
13493
  export function TablesView(props: TablesProps): ComponentReturnType;
13130
13494
 
@@ -13470,6 +13834,7 @@ export function ValuesView(props: ValuesProps): ComponentReturnType;
13470
13834
  * // -> '<div></div>'
13471
13835
  * ```
13472
13836
  * @category Metrics components
13837
+ * @since v1.0.0
13473
13838
  */
13474
13839
  export function MetricView(props: MetricProps): ComponentReturnType;
13475
13840
 
@@ -13612,6 +13977,7 @@ export function MetricView(props: MetricProps): ComponentReturnType;
13612
13977
  * // -> '<div><span><b>fido</b>: dog/brown</span><span>cujo: dog</span></div>'
13613
13978
  * ```
13614
13979
  * @category Indexes components
13980
+ * @since v1.0.0
13615
13981
  */
13616
13982
  export function SliceView(props: SliceProps): ComponentReturnType;
13617
13983
 
@@ -13748,6 +14114,7 @@ export function SliceView(props: SliceProps): ComponentReturnType;
13748
14114
  * // -> '<div><span><b>dog</b>: dog/dog</span><span>cat: cat</span></div>'
13749
14115
  * ```
13750
14116
  * @category Indexes components
14117
+ * @since v1.0.0
13751
14118
  */
13752
14119
  export function IndexView(props: IndexProps): ComponentReturnType;
13753
14120
 
@@ -13897,6 +14264,7 @@ export function IndexView(props: IndexProps): ComponentReturnType;
13897
14264
  * // -> '<div><span><b>dog</b>: 5</span></div>'
13898
14265
  * ```
13899
14266
  * @category Relationships components
14267
+ * @since v1.0.0
13900
14268
  */
13901
14269
  export function RemoteRowView(props: RemoteRowProps): ComponentReturnType;
13902
14270
 
@@ -14047,6 +14415,7 @@ export function RemoteRowView(props: RemoteRowProps): ComponentReturnType;
14047
14415
  * // -> '<div><span><b>fido</b>: dog</span><span>cujo: dog</span></div>'
14048
14416
  * ```
14049
14417
  * @category Relationships components
14418
+ * @since v1.0.0
14050
14419
  */
14051
14420
  export function LocalRowsView(props: LocalRowsProps): ComponentReturnType;
14052
14421
 
@@ -14202,6 +14571,7 @@ export function LocalRowsView(props: LocalRowsProps): ComponentReturnType;
14202
14571
  * // -> '<div><span><b>fido</b>: felix</span><span>felix: cat</span></div>'
14203
14572
  * ```
14204
14573
  * @category Relationships components
14574
+ * @since v1.0.0
14205
14575
  */
14206
14576
  export function LinkedRowsView(props: LinkedRowsProps): ComponentReturnType;
14207
14577
 
@@ -14851,6 +15221,7 @@ export function ResultTableView(props: ResultTableProps): ComponentReturnType;
14851
15221
  * // -> '<div>1:{sold}</div>'
14852
15222
  * ```
14853
15223
  * @category Checkpoints components
15224
+ * @since v1.0.0
14854
15225
  */
14855
15226
  export function CheckpointView(props: CheckpointProps): ComponentReturnType;
14856
15227
 
@@ -15003,6 +15374,7 @@ export function CheckpointView(props: CheckpointProps): ComponentReturnType;
15003
15374
  * // -> '<div><span><b>0</b>: initial</span><span>1: identified</span></div>'
15004
15375
  * ```
15005
15376
  * @category Checkpoints components
15377
+ * @since v1.0.0
15006
15378
  */
15007
15379
  export function BackwardCheckpointsView(
15008
15380
  props: BackwardCheckpointsProps,
@@ -15157,6 +15529,7 @@ export function BackwardCheckpointsView(
15157
15529
  * // -> '<div><span>2: sale</span></div>'
15158
15530
  * ```
15159
15531
  * @category Checkpoints components
15532
+ * @since v1.0.0
15160
15533
  */
15161
15534
  export function CurrentCheckpointView(
15162
15535
  props: CurrentCheckpointProps,
@@ -15312,6 +15685,7 @@ export function CurrentCheckpointView(
15312
15685
  * // -> '<div><span><b>1</b>: identified</span><span>2: sale</span></div>'
15313
15686
  * ```
15314
15687
  * @category Checkpoints components
15688
+ * @since v1.0.0
15315
15689
  */
15316
15690
  export function ForwardCheckpointsView(
15317
15691
  props: ForwardCheckpointsProps,