tinybase 5.0.0-beta.2 → 5.0.0-beta.21

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 (1591) hide show
  1. package/@types/_internal/queries/index.d.cts +0 -0
  2. package/@types/_internal/queries/index.d.ts +0 -0
  3. package/@types/_internal/queries/with-schemas/index.d.cts +22 -0
  4. package/@types/_internal/queries/with-schemas/index.d.ts +22 -0
  5. package/@types/_internal/store/index.d.cts +3 -0
  6. package/@types/_internal/store/index.d.ts +3 -0
  7. package/@types/_internal/store/with-schemas/index.d.cts +106 -0
  8. package/@types/_internal/store/with-schemas/index.d.ts +106 -0
  9. package/@types/_internal/ui-react/index.d.cts +0 -0
  10. package/@types/_internal/ui-react/index.d.ts +0 -0
  11. package/@types/_internal/ui-react/with-schemas/index.d.cts +813 -0
  12. package/@types/_internal/ui-react/with-schemas/index.d.ts +813 -0
  13. package/@types/checkpoints/index.d.cts +1033 -0
  14. package/@types/checkpoints/index.d.ts +1033 -0
  15. package/@types/checkpoints/with-schemas/index.d.cts +1125 -0
  16. package/@types/checkpoints/with-schemas/index.d.ts +1125 -0
  17. package/@types/common/index.d.cts +117 -0
  18. package/@types/common/index.d.ts +117 -0
  19. package/@types/common/with-schemas/index.d.cts +117 -0
  20. package/@types/common/with-schemas/index.d.ts +117 -0
  21. package/@types/index.d.cts +18 -0
  22. package/@types/index.d.ts +18 -0
  23. package/@types/indexes/index.d.cts +1037 -0
  24. package/@types/indexes/index.d.ts +1037 -0
  25. package/@types/indexes/with-schemas/index.d.cts +1183 -0
  26. package/@types/indexes/with-schemas/index.d.ts +1183 -0
  27. package/@types/mergeable-store/index.d.cts +222 -0
  28. package/@types/mergeable-store/index.d.ts +222 -0
  29. package/@types/mergeable-store/with-schemas/index.d.cts +509 -0
  30. package/@types/mergeable-store/with-schemas/index.d.ts +509 -0
  31. package/@types/metrics/index.d.cts +895 -0
  32. package/@types/metrics/index.d.ts +895 -0
  33. package/@types/metrics/with-schemas/index.d.cts +982 -0
  34. package/@types/metrics/with-schemas/index.d.ts +982 -0
  35. package/@types/persisters/index.d.cts +1319 -0
  36. package/@types/persisters/index.d.ts +1319 -0
  37. package/@types/persisters/persister-automerge/index.d.cts +162 -0
  38. package/@types/persisters/persister-automerge/index.d.ts +162 -0
  39. package/@types/persisters/persister-automerge/with-schemas/index.d.cts +177 -0
  40. package/@types/persisters/persister-automerge/with-schemas/index.d.ts +177 -0
  41. package/@types/persisters/persister-browser/index.d.cts +174 -0
  42. package/@types/persisters/persister-browser/index.d.ts +174 -0
  43. package/@types/persisters/persister-browser/with-schemas/index.d.cts +199 -0
  44. package/@types/persisters/persister-browser/with-schemas/index.d.ts +199 -0
  45. package/@types/persisters/persister-cr-sqlite-wasm/index.d.cts +157 -0
  46. package/@types/persisters/persister-cr-sqlite-wasm/index.d.ts +157 -0
  47. package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.cts +176 -0
  48. package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts +176 -0
  49. package/@types/persisters/persister-electric-sql/index.d.cts +183 -0
  50. package/@types/persisters/persister-electric-sql/index.d.ts +183 -0
  51. package/@types/persisters/persister-electric-sql/with-schemas/index.d.cts +202 -0
  52. package/@types/persisters/persister-electric-sql/with-schemas/index.d.ts +202 -0
  53. package/@types/persisters/persister-expo-sqlite/index.d.cts +186 -0
  54. package/@types/persisters/persister-expo-sqlite/index.d.ts +186 -0
  55. package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.cts +205 -0
  56. package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.ts +205 -0
  57. package/@types/persisters/persister-expo-sqlite-next/index.d.cts +187 -0
  58. package/@types/persisters/persister-expo-sqlite-next/index.d.ts +187 -0
  59. package/@types/persisters/persister-expo-sqlite-next/with-schemas/index.d.cts +206 -0
  60. package/@types/persisters/persister-expo-sqlite-next/with-schemas/index.d.ts +206 -0
  61. package/@types/persisters/persister-file/index.d.cts +88 -0
  62. package/@types/persisters/persister-file/index.d.ts +88 -0
  63. package/@types/persisters/persister-file/with-schemas/index.d.cts +102 -0
  64. package/@types/persisters/persister-file/with-schemas/index.d.ts +102 -0
  65. package/@types/persisters/persister-indexed-db/index.d.cts +116 -0
  66. package/@types/persisters/persister-indexed-db/index.d.ts +116 -0
  67. package/@types/persisters/persister-indexed-db/with-schemas/index.d.cts +131 -0
  68. package/@types/persisters/persister-indexed-db/with-schemas/index.d.ts +131 -0
  69. package/@types/persisters/persister-libsql/index.d.cts +154 -0
  70. package/@types/persisters/persister-libsql/index.d.ts +154 -0
  71. package/@types/persisters/persister-libsql/with-schemas/index.d.cts +173 -0
  72. package/@types/persisters/persister-libsql/with-schemas/index.d.ts +173 -0
  73. package/@types/persisters/persister-partykit-client/index.d.cts +185 -0
  74. package/@types/persisters/persister-partykit-client/index.d.ts +185 -0
  75. package/@types/persisters/persister-partykit-client/with-schemas/index.d.cts +200 -0
  76. package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts +200 -0
  77. package/@types/persisters/persister-partykit-server/index.d.cts +631 -0
  78. package/@types/persisters/persister-partykit-server/index.d.ts +631 -0
  79. package/@types/persisters/persister-partykit-server/with-schemas/index.d.cts +673 -0
  80. package/@types/persisters/persister-partykit-server/with-schemas/index.d.ts +673 -0
  81. package/@types/persisters/persister-powersync/index.d.cts +169 -0
  82. package/@types/persisters/persister-powersync/index.d.ts +169 -0
  83. package/@types/persisters/persister-powersync/with-schemas/index.d.cts +188 -0
  84. package/@types/persisters/persister-powersync/with-schemas/index.d.ts +188 -0
  85. package/@types/persisters/persister-remote/index.d.cts +113 -0
  86. package/@types/persisters/persister-remote/index.d.ts +113 -0
  87. package/@types/persisters/persister-remote/with-schemas/index.d.cts +129 -0
  88. package/@types/persisters/persister-remote/with-schemas/index.d.ts +129 -0
  89. package/@types/persisters/persister-sqlite-wasm/index.d.cts +170 -0
  90. package/@types/persisters/persister-sqlite-wasm/index.d.ts +170 -0
  91. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.cts +190 -0
  92. package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.ts +190 -0
  93. package/@types/persisters/persister-sqlite3/index.d.cts +171 -0
  94. package/@types/persisters/persister-sqlite3/index.d.ts +171 -0
  95. package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts +190 -0
  96. package/@types/persisters/persister-sqlite3/with-schemas/index.d.ts +190 -0
  97. package/@types/persisters/persister-yjs/index.d.cts +157 -0
  98. package/@types/persisters/persister-yjs/index.d.ts +157 -0
  99. package/@types/persisters/persister-yjs/with-schemas/index.d.cts +172 -0
  100. package/@types/persisters/persister-yjs/with-schemas/index.d.ts +172 -0
  101. package/@types/persisters/with-schemas/index.d.cts +1393 -0
  102. package/@types/persisters/with-schemas/index.d.ts +1393 -0
  103. package/@types/queries/index.d.cts +3640 -0
  104. package/@types/queries/index.d.ts +3640 -0
  105. package/@types/queries/with-schemas/index.d.cts +3961 -0
  106. package/@types/queries/with-schemas/index.d.ts +3961 -0
  107. package/@types/relationships/index.d.cts +1266 -0
  108. package/@types/relationships/index.d.ts +1266 -0
  109. package/@types/relationships/with-schemas/index.d.cts +1420 -0
  110. package/@types/relationships/with-schemas/index.d.ts +1420 -0
  111. package/@types/store/index.d.cts +7453 -0
  112. package/@types/store/index.d.ts +7453 -0
  113. package/@types/store/with-schemas/index.d.cts +9131 -0
  114. package/@types/store/with-schemas/index.d.ts +9131 -0
  115. package/@types/synchronizers/index.d.cts +139 -0
  116. package/@types/synchronizers/index.d.ts +139 -0
  117. package/@types/synchronizers/synchronizer-local/index.d.cts +27 -0
  118. package/@types/synchronizers/synchronizer-local/index.d.ts +27 -0
  119. package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts +29 -0
  120. package/@types/synchronizers/synchronizer-local/with-schemas/index.d.ts +29 -0
  121. package/@types/synchronizers/synchronizer-ws-client/index.d.cts +36 -0
  122. package/@types/synchronizers/synchronizer-ws-client/index.d.ts +36 -0
  123. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.cts +42 -0
  124. package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts +42 -0
  125. package/@types/synchronizers/synchronizer-ws-server/index.d.cts +58 -0
  126. package/@types/synchronizers/synchronizer-ws-server/index.d.ts +58 -0
  127. package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts +58 -0
  128. package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.ts +58 -0
  129. package/@types/synchronizers/with-schemas/index.d.cts +156 -0
  130. package/@types/synchronizers/with-schemas/index.d.ts +156 -0
  131. package/@types/tools/index.d.cts +556 -0
  132. package/@types/tools/index.d.ts +556 -0
  133. package/@types/tools/with-schemas/index.d.cts +567 -0
  134. package/@types/tools/with-schemas/index.d.ts +567 -0
  135. package/@types/ui-react/index.d.cts +15318 -0
  136. package/@types/ui-react/index.d.ts +15318 -0
  137. package/@types/ui-react/with-schemas/index.d.cts +16235 -0
  138. package/@types/ui-react/with-schemas/index.d.ts +16235 -0
  139. package/@types/ui-react-dom/index.d.cts +1751 -0
  140. package/@types/ui-react-dom/index.d.ts +1751 -0
  141. package/@types/ui-react-dom/with-schemas/index.d.cts +1883 -0
  142. package/@types/ui-react-dom/with-schemas/index.d.ts +1883 -0
  143. package/@types/ui-react-inspector/index.d.cts +76 -0
  144. package/@types/ui-react-inspector/index.d.ts +76 -0
  145. package/@types/ui-react-inspector/with-schemas/index.d.cts +1870 -0
  146. package/@types/ui-react-inspector/with-schemas/index.d.ts +1870 -0
  147. package/@types/with-schemas/index.d.cts +18 -0
  148. package/@types/with-schemas/index.d.ts +18 -0
  149. package/checkpoints/index.js +1 -0
  150. package/checkpoints/index.js.gz +0 -0
  151. package/checkpoints/with-schemas/index.js +1 -0
  152. package/cjs/checkpoints/index.cjs +1 -0
  153. package/cjs/checkpoints/index.cjs.gz +0 -0
  154. package/cjs/checkpoints/with-schemas/index.cjs +1 -0
  155. package/cjs/common/index.cjs +1 -0
  156. package/cjs/common/index.cjs.gz +0 -0
  157. package/cjs/common/with-schemas/index.cjs +1 -0
  158. package/cjs/debug/checkpoints/index.cjs +433 -0
  159. package/cjs/debug/checkpoints/with-schemas/index.cjs +433 -0
  160. package/cjs/debug/common/index.cjs +28 -0
  161. package/cjs/debug/common/with-schemas/index.cjs +28 -0
  162. package/cjs/debug/index.cjs +4102 -0
  163. package/cjs/debug/indexes/index.cjs +555 -0
  164. package/cjs/debug/indexes/with-schemas/index.cjs +555 -0
  165. package/cjs/debug/mergeable-store/index.cjs +2249 -0
  166. package/cjs/debug/mergeable-store/with-schemas/index.cjs +2249 -0
  167. package/cjs/debug/metrics/index.cjs +521 -0
  168. package/cjs/debug/metrics/with-schemas/index.cjs +521 -0
  169. package/cjs/debug/persisters/index.cjs +230 -0
  170. package/cjs/debug/persisters/persister-automerge/index.cjs +378 -0
  171. package/cjs/debug/persisters/persister-automerge/with-schemas/index.cjs +378 -0
  172. package/cjs/debug/persisters/persister-browser/index.cjs +282 -0
  173. package/cjs/debug/persisters/persister-browser/with-schemas/index.cjs +282 -0
  174. package/cjs/debug/persisters/persister-cr-sqlite-wasm/index.cjs +929 -0
  175. package/cjs/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.cjs +929 -0
  176. package/cjs/debug/persisters/persister-electric-sql/index.cjs +937 -0
  177. package/cjs/debug/persisters/persister-electric-sql/with-schemas/index.cjs +937 -0
  178. package/cjs/debug/persisters/persister-expo-sqlite/index.cjs +930 -0
  179. package/cjs/debug/persisters/persister-expo-sqlite/with-schemas/index.cjs +930 -0
  180. package/cjs/debug/persisters/persister-expo-sqlite-next/index.cjs +932 -0
  181. package/cjs/debug/persisters/persister-expo-sqlite-next/with-schemas/index.cjs +932 -0
  182. package/cjs/debug/persisters/persister-file/index.cjs +265 -0
  183. package/cjs/debug/persisters/persister-file/with-schemas/index.cjs +265 -0
  184. package/cjs/debug/persisters/persister-indexed-db/index.cjs +342 -0
  185. package/cjs/debug/persisters/persister-indexed-db/with-schemas/index.cjs +342 -0
  186. package/cjs/debug/persisters/persister-libsql/index.cjs +930 -0
  187. package/cjs/debug/persisters/persister-libsql/with-schemas/index.cjs +930 -0
  188. package/cjs/debug/persisters/persister-partykit-client/index.cjs +329 -0
  189. package/cjs/debug/persisters/persister-partykit-client/with-schemas/index.cjs +329 -0
  190. package/cjs/debug/persisters/persister-partykit-server/index.cjs +284 -0
  191. package/cjs/debug/persisters/persister-partykit-server/with-schemas/index.cjs +284 -0
  192. package/cjs/debug/persisters/persister-powersync/index.cjs +945 -0
  193. package/cjs/debug/persisters/persister-powersync/with-schemas/index.cjs +945 -0
  194. package/cjs/debug/persisters/persister-remote/index.cjs +287 -0
  195. package/cjs/debug/persisters/persister-remote/with-schemas/index.cjs +287 -0
  196. package/cjs/debug/persisters/persister-sqlite-wasm/index.cjs +938 -0
  197. package/cjs/debug/persisters/persister-sqlite-wasm/with-schemas/index.cjs +938 -0
  198. package/cjs/debug/persisters/persister-sqlite3/index.cjs +940 -0
  199. package/cjs/debug/persisters/persister-sqlite3/with-schemas/index.cjs +940 -0
  200. package/cjs/debug/persisters/persister-yjs/index.cjs +427 -0
  201. package/cjs/debug/persisters/persister-yjs/with-schemas/index.cjs +427 -0
  202. package/cjs/debug/persisters/with-schemas/index.cjs +230 -0
  203. package/cjs/debug/queries/index.cjs +814 -0
  204. package/cjs/debug/queries/with-schemas/index.cjs +814 -0
  205. package/cjs/debug/relationships/index.cjs +531 -0
  206. package/cjs/debug/relationships/with-schemas/index.cjs +531 -0
  207. package/cjs/debug/store/index.cjs +1636 -0
  208. package/cjs/debug/store/with-schemas/index.cjs +1636 -0
  209. package/cjs/debug/synchronizers/index.cjs +466 -0
  210. package/cjs/debug/synchronizers/synchronizer-local/index.cjs +506 -0
  211. package/cjs/debug/synchronizers/synchronizer-local/with-schemas/index.cjs +506 -0
  212. package/cjs/debug/synchronizers/synchronizer-ws-client/index.cjs +529 -0
  213. package/cjs/debug/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +529 -0
  214. package/cjs/debug/synchronizers/synchronizer-ws-server/index.cjs +243 -0
  215. package/cjs/debug/synchronizers/synchronizer-ws-server/with-schemas/index.cjs +243 -0
  216. package/cjs/debug/synchronizers/with-schemas/index.cjs +466 -0
  217. package/cjs/debug/tools/index.cjs +3300 -0
  218. package/cjs/debug/tools/with-schemas/index.cjs +3300 -0
  219. package/cjs/debug/ui-react/index.cjs +1985 -0
  220. package/cjs/debug/ui-react/with-schemas/index.cjs +1985 -0
  221. package/cjs/debug/ui-react-dom/index.cjs +779 -0
  222. package/cjs/debug/ui-react-dom/with-schemas/index.cjs +779 -0
  223. package/cjs/debug/ui-react-inspector/index.cjs +3263 -0
  224. package/cjs/debug/ui-react-inspector/with-schemas/index.cjs +3263 -0
  225. package/cjs/debug/with-schemas/index.cjs +4102 -0
  226. package/cjs/es6/checkpoints/index.cjs +1 -0
  227. package/cjs/es6/checkpoints/index.cjs.gz +0 -0
  228. package/cjs/es6/checkpoints/with-schemas/index.cjs +1 -0
  229. package/cjs/es6/common/index.cjs +1 -0
  230. package/cjs/es6/common/index.cjs.gz +0 -0
  231. package/cjs/es6/common/with-schemas/index.cjs +1 -0
  232. package/cjs/es6/debug/checkpoints/index.cjs +473 -0
  233. package/cjs/es6/debug/checkpoints/with-schemas/index.cjs +473 -0
  234. package/cjs/es6/debug/common/index.cjs +30 -0
  235. package/cjs/es6/debug/common/with-schemas/index.cjs +30 -0
  236. package/cjs/es6/debug/index.cjs +4358 -0
  237. package/cjs/es6/debug/indexes/index.cjs +602 -0
  238. package/cjs/es6/debug/indexes/with-schemas/index.cjs +602 -0
  239. package/cjs/es6/debug/mergeable-store/index.cjs +2349 -0
  240. package/cjs/es6/debug/mergeable-store/with-schemas/index.cjs +2349 -0
  241. package/cjs/es6/debug/metrics/index.cjs +574 -0
  242. package/cjs/es6/debug/metrics/with-schemas/index.cjs +574 -0
  243. package/cjs/es6/debug/persisters/index.cjs +302 -0
  244. package/cjs/es6/debug/persisters/persister-automerge/index.cjs +476 -0
  245. package/cjs/es6/debug/persisters/persister-automerge/with-schemas/index.cjs +476 -0
  246. package/cjs/es6/debug/persisters/persister-browser/index.cjs +384 -0
  247. package/cjs/es6/debug/persisters/persister-browser/with-schemas/index.cjs +384 -0
  248. package/cjs/es6/debug/persisters/persister-cr-sqlite-wasm/index.cjs +1256 -0
  249. package/cjs/es6/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.cjs +1256 -0
  250. package/cjs/es6/debug/persisters/persister-electric-sql/index.cjs +1264 -0
  251. package/cjs/es6/debug/persisters/persister-electric-sql/with-schemas/index.cjs +1264 -0
  252. package/cjs/es6/debug/persisters/persister-expo-sqlite/index.cjs +1256 -0
  253. package/cjs/es6/debug/persisters/persister-expo-sqlite/with-schemas/index.cjs +1256 -0
  254. package/cjs/es6/debug/persisters/persister-expo-sqlite-next/index.cjs +1259 -0
  255. package/cjs/es6/debug/persisters/persister-expo-sqlite-next/with-schemas/index.cjs +1259 -0
  256. package/cjs/es6/debug/persisters/persister-file/index.cjs +365 -0
  257. package/cjs/es6/debug/persisters/persister-file/with-schemas/index.cjs +365 -0
  258. package/cjs/es6/debug/persisters/persister-indexed-db/index.cjs +481 -0
  259. package/cjs/es6/debug/persisters/persister-indexed-db/with-schemas/index.cjs +481 -0
  260. package/cjs/es6/debug/persisters/persister-libsql/index.cjs +1257 -0
  261. package/cjs/es6/debug/persisters/persister-libsql/with-schemas/index.cjs +1257 -0
  262. package/cjs/es6/debug/persisters/persister-partykit-client/index.cjs +459 -0
  263. package/cjs/es6/debug/persisters/persister-partykit-client/with-schemas/index.cjs +459 -0
  264. package/cjs/es6/debug/persisters/persister-partykit-server/index.cjs +411 -0
  265. package/cjs/es6/debug/persisters/persister-partykit-server/with-schemas/index.cjs +411 -0
  266. package/cjs/es6/debug/persisters/persister-powersync/index.cjs +1312 -0
  267. package/cjs/es6/debug/persisters/persister-powersync/with-schemas/index.cjs +1312 -0
  268. package/cjs/es6/debug/persisters/persister-remote/index.cjs +389 -0
  269. package/cjs/es6/debug/persisters/persister-remote/with-schemas/index.cjs +389 -0
  270. package/cjs/es6/debug/persisters/persister-sqlite-wasm/index.cjs +1286 -0
  271. package/cjs/es6/debug/persisters/persister-sqlite-wasm/with-schemas/index.cjs +1286 -0
  272. package/cjs/es6/debug/persisters/persister-sqlite3/index.cjs +1266 -0
  273. package/cjs/es6/debug/persisters/persister-sqlite3/with-schemas/index.cjs +1266 -0
  274. package/cjs/es6/debug/persisters/persister-yjs/index.cjs +536 -0
  275. package/cjs/es6/debug/persisters/persister-yjs/with-schemas/index.cjs +536 -0
  276. package/cjs/es6/debug/persisters/with-schemas/index.cjs +302 -0
  277. package/cjs/es6/debug/queries/index.cjs +859 -0
  278. package/cjs/es6/debug/queries/with-schemas/index.cjs +859 -0
  279. package/cjs/es6/debug/relationships/index.cjs +591 -0
  280. package/cjs/es6/debug/relationships/with-schemas/index.cjs +591 -0
  281. package/cjs/es6/debug/store/index.cjs +1716 -0
  282. package/cjs/es6/debug/store/with-schemas/index.cjs +1716 -0
  283. package/cjs/es6/debug/synchronizers/index.cjs +594 -0
  284. package/cjs/es6/debug/synchronizers/synchronizer-local/index.cjs +630 -0
  285. package/cjs/es6/debug/synchronizers/synchronizer-local/with-schemas/index.cjs +630 -0
  286. package/cjs/es6/debug/synchronizers/synchronizer-ws-client/index.cjs +681 -0
  287. package/cjs/es6/debug/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +681 -0
  288. package/cjs/es6/debug/synchronizers/synchronizer-ws-server/index.cjs +292 -0
  289. package/cjs/es6/debug/synchronizers/synchronizer-ws-server/with-schemas/index.cjs +292 -0
  290. package/cjs/es6/debug/synchronizers/with-schemas/index.cjs +594 -0
  291. package/cjs/es6/debug/tools/index.cjs +3423 -0
  292. package/cjs/es6/debug/tools/with-schemas/index.cjs +3423 -0
  293. package/cjs/es6/debug/ui-react/index.cjs +2189 -0
  294. package/cjs/es6/debug/ui-react/with-schemas/index.cjs +2189 -0
  295. package/cjs/es6/debug/ui-react-dom/index.cjs +906 -0
  296. package/cjs/es6/debug/ui-react-dom/with-schemas/index.cjs +906 -0
  297. package/cjs/es6/debug/ui-react-inspector/index.cjs +3654 -0
  298. package/cjs/es6/debug/ui-react-inspector/with-schemas/index.cjs +3654 -0
  299. package/cjs/es6/debug/with-schemas/index.cjs +4358 -0
  300. package/cjs/es6/index.cjs +1 -0
  301. package/cjs/es6/index.cjs.gz +0 -0
  302. package/cjs/es6/indexes/index.cjs +1 -0
  303. package/cjs/es6/indexes/index.cjs.gz +0 -0
  304. package/cjs/es6/indexes/with-schemas/index.cjs +1 -0
  305. package/cjs/es6/mergeable-store/index.cjs +1 -0
  306. package/cjs/es6/mergeable-store/index.cjs.gz +0 -0
  307. package/cjs/es6/mergeable-store/with-schemas/index.cjs +1 -0
  308. package/cjs/es6/metrics/index.cjs +1 -0
  309. package/cjs/es6/metrics/index.cjs.gz +0 -0
  310. package/cjs/es6/metrics/with-schemas/index.cjs +1 -0
  311. package/cjs/es6/persisters/index.cjs +1 -0
  312. package/cjs/es6/persisters/index.cjs.gz +0 -0
  313. package/cjs/es6/persisters/persister-automerge/index.cjs +1 -0
  314. package/cjs/es6/persisters/persister-automerge/index.cjs.gz +0 -0
  315. package/cjs/es6/persisters/persister-automerge/with-schemas/index.cjs +1 -0
  316. package/cjs/es6/persisters/persister-browser/index.cjs +1 -0
  317. package/cjs/es6/persisters/persister-browser/index.cjs.gz +0 -0
  318. package/cjs/es6/persisters/persister-browser/with-schemas/index.cjs +1 -0
  319. package/cjs/es6/persisters/persister-cr-sqlite-wasm/index.cjs +1 -0
  320. package/cjs/es6/persisters/persister-cr-sqlite-wasm/index.cjs.gz +0 -0
  321. package/cjs/es6/persisters/persister-cr-sqlite-wasm/with-schemas/index.cjs +1 -0
  322. package/cjs/es6/persisters/persister-electric-sql/index.cjs +1 -0
  323. package/cjs/es6/persisters/persister-electric-sql/index.cjs.gz +0 -0
  324. package/cjs/es6/persisters/persister-electric-sql/with-schemas/index.cjs +1 -0
  325. package/cjs/es6/persisters/persister-expo-sqlite/index.cjs +1 -0
  326. package/cjs/es6/persisters/persister-expo-sqlite/index.cjs.gz +0 -0
  327. package/cjs/es6/persisters/persister-expo-sqlite/with-schemas/index.cjs +1 -0
  328. package/cjs/es6/persisters/persister-expo-sqlite-next/index.cjs +1 -0
  329. package/cjs/es6/persisters/persister-expo-sqlite-next/index.cjs.gz +0 -0
  330. package/cjs/es6/persisters/persister-expo-sqlite-next/with-schemas/index.cjs +1 -0
  331. package/cjs/es6/persisters/persister-file/index.cjs +1 -0
  332. package/cjs/es6/persisters/persister-file/index.cjs.gz +0 -0
  333. package/cjs/es6/persisters/persister-file/with-schemas/index.cjs +1 -0
  334. package/cjs/es6/persisters/persister-indexed-db/index.cjs +1 -0
  335. package/cjs/es6/persisters/persister-indexed-db/index.cjs.gz +0 -0
  336. package/cjs/es6/persisters/persister-indexed-db/with-schemas/index.cjs +1 -0
  337. package/cjs/es6/persisters/persister-libsql/index.cjs +1 -0
  338. package/cjs/es6/persisters/persister-libsql/index.cjs.gz +0 -0
  339. package/cjs/es6/persisters/persister-libsql/with-schemas/index.cjs +1 -0
  340. package/cjs/es6/persisters/persister-partykit-client/index.cjs +1 -0
  341. package/cjs/es6/persisters/persister-partykit-client/index.cjs.gz +0 -0
  342. package/cjs/es6/persisters/persister-partykit-client/with-schemas/index.cjs +1 -0
  343. package/cjs/es6/persisters/persister-partykit-server/index.cjs +1 -0
  344. package/cjs/es6/persisters/persister-partykit-server/index.cjs.gz +0 -0
  345. package/cjs/es6/persisters/persister-partykit-server/with-schemas/index.cjs +1 -0
  346. package/cjs/es6/persisters/persister-powersync/index.cjs +1 -0
  347. package/cjs/es6/persisters/persister-powersync/index.cjs.gz +0 -0
  348. package/cjs/es6/persisters/persister-powersync/with-schemas/index.cjs +1 -0
  349. package/cjs/es6/persisters/persister-remote/index.cjs +1 -0
  350. package/cjs/es6/persisters/persister-remote/index.cjs.gz +0 -0
  351. package/cjs/es6/persisters/persister-remote/with-schemas/index.cjs +1 -0
  352. package/cjs/es6/persisters/persister-sqlite-wasm/index.cjs +1 -0
  353. package/cjs/es6/persisters/persister-sqlite-wasm/index.cjs.gz +0 -0
  354. package/cjs/es6/persisters/persister-sqlite-wasm/with-schemas/index.cjs +1 -0
  355. package/cjs/es6/persisters/persister-sqlite3/index.cjs +1 -0
  356. package/cjs/es6/persisters/persister-sqlite3/index.cjs.gz +0 -0
  357. package/cjs/es6/persisters/persister-sqlite3/with-schemas/index.cjs +1 -0
  358. package/cjs/es6/persisters/persister-yjs/index.cjs +1 -0
  359. package/cjs/es6/persisters/persister-yjs/index.cjs.gz +0 -0
  360. package/cjs/es6/persisters/persister-yjs/with-schemas/index.cjs +1 -0
  361. package/cjs/es6/persisters/with-schemas/index.cjs +1 -0
  362. package/cjs/es6/queries/index.cjs +1 -0
  363. package/cjs/es6/queries/index.cjs.gz +0 -0
  364. package/cjs/es6/queries/with-schemas/index.cjs +1 -0
  365. package/cjs/es6/relationships/index.cjs +1 -0
  366. package/cjs/es6/relationships/index.cjs.gz +0 -0
  367. package/cjs/es6/relationships/with-schemas/index.cjs +1 -0
  368. package/cjs/es6/store/index.cjs +1 -0
  369. package/cjs/es6/store/index.cjs.gz +0 -0
  370. package/cjs/es6/store/with-schemas/index.cjs +1 -0
  371. package/cjs/es6/synchronizers/index.cjs +1 -0
  372. package/cjs/es6/synchronizers/index.cjs.gz +0 -0
  373. package/cjs/es6/synchronizers/synchronizer-local/index.cjs +1 -0
  374. package/cjs/es6/synchronizers/synchronizer-local/index.cjs.gz +0 -0
  375. package/cjs/es6/synchronizers/synchronizer-local/with-schemas/index.cjs +1 -0
  376. package/cjs/es6/synchronizers/synchronizer-ws-client/index.cjs +1 -0
  377. package/cjs/es6/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
  378. package/cjs/es6/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -0
  379. package/cjs/es6/synchronizers/synchronizer-ws-server/index.cjs +1 -0
  380. package/cjs/es6/synchronizers/synchronizer-ws-server/index.cjs.gz +0 -0
  381. package/cjs/es6/synchronizers/synchronizer-ws-server/with-schemas/index.cjs +1 -0
  382. package/cjs/es6/synchronizers/with-schemas/index.cjs +1 -0
  383. package/cjs/es6/tools/index.cjs +1 -0
  384. package/cjs/es6/tools/index.cjs.gz +0 -0
  385. package/cjs/es6/tools/with-schemas/index.cjs +1 -0
  386. package/cjs/es6/ui-react/index.cjs +1 -0
  387. package/cjs/es6/ui-react/index.cjs.gz +0 -0
  388. package/cjs/es6/ui-react/with-schemas/index.cjs +1 -0
  389. package/cjs/es6/ui-react-dom/index.cjs +1 -0
  390. package/cjs/es6/ui-react-dom/index.cjs.gz +0 -0
  391. package/cjs/es6/ui-react-dom/with-schemas/index.cjs +1 -0
  392. package/cjs/es6/ui-react-inspector/index.cjs +1 -0
  393. package/cjs/es6/ui-react-inspector/index.cjs.gz +0 -0
  394. package/cjs/es6/ui-react-inspector/with-schemas/index.cjs +1 -0
  395. package/cjs/es6/with-schemas/index.cjs +1 -0
  396. package/cjs/index.cjs +1 -0
  397. package/cjs/index.cjs.gz +0 -0
  398. package/cjs/indexes/index.cjs +1 -0
  399. package/cjs/indexes/index.cjs.gz +0 -0
  400. package/cjs/indexes/with-schemas/index.cjs +1 -0
  401. package/cjs/mergeable-store/index.cjs +1 -0
  402. package/cjs/mergeable-store/index.cjs.gz +0 -0
  403. package/cjs/mergeable-store/with-schemas/index.cjs +1 -0
  404. package/cjs/metrics/index.cjs +1 -0
  405. package/cjs/metrics/index.cjs.gz +0 -0
  406. package/cjs/metrics/with-schemas/index.cjs +1 -0
  407. package/cjs/persisters/index.cjs +1 -0
  408. package/cjs/persisters/index.cjs.gz +0 -0
  409. package/cjs/persisters/persister-automerge/index.cjs +1 -0
  410. package/cjs/persisters/persister-automerge/index.cjs.gz +0 -0
  411. package/cjs/persisters/persister-automerge/with-schemas/index.cjs +1 -0
  412. package/cjs/persisters/persister-browser/index.cjs +1 -0
  413. package/cjs/persisters/persister-browser/index.cjs.gz +0 -0
  414. package/cjs/persisters/persister-browser/with-schemas/index.cjs +1 -0
  415. package/cjs/persisters/persister-cr-sqlite-wasm/index.cjs +1 -0
  416. package/cjs/persisters/persister-cr-sqlite-wasm/index.cjs.gz +0 -0
  417. package/cjs/persisters/persister-cr-sqlite-wasm/with-schemas/index.cjs +1 -0
  418. package/cjs/persisters/persister-electric-sql/index.cjs +1 -0
  419. package/cjs/persisters/persister-electric-sql/index.cjs.gz +0 -0
  420. package/cjs/persisters/persister-electric-sql/with-schemas/index.cjs +1 -0
  421. package/cjs/persisters/persister-expo-sqlite/index.cjs +1 -0
  422. package/cjs/persisters/persister-expo-sqlite/index.cjs.gz +0 -0
  423. package/cjs/persisters/persister-expo-sqlite/with-schemas/index.cjs +1 -0
  424. package/cjs/persisters/persister-expo-sqlite-next/index.cjs +1 -0
  425. package/cjs/persisters/persister-expo-sqlite-next/index.cjs.gz +0 -0
  426. package/cjs/persisters/persister-expo-sqlite-next/with-schemas/index.cjs +1 -0
  427. package/cjs/persisters/persister-file/index.cjs +1 -0
  428. package/cjs/persisters/persister-file/index.cjs.gz +0 -0
  429. package/cjs/persisters/persister-file/with-schemas/index.cjs +1 -0
  430. package/cjs/persisters/persister-indexed-db/index.cjs +1 -0
  431. package/cjs/persisters/persister-indexed-db/index.cjs.gz +0 -0
  432. package/cjs/persisters/persister-indexed-db/with-schemas/index.cjs +1 -0
  433. package/cjs/persisters/persister-libsql/index.cjs +1 -0
  434. package/cjs/persisters/persister-libsql/index.cjs.gz +0 -0
  435. package/cjs/persisters/persister-libsql/with-schemas/index.cjs +1 -0
  436. package/cjs/persisters/persister-partykit-client/index.cjs +1 -0
  437. package/cjs/persisters/persister-partykit-client/index.cjs.gz +0 -0
  438. package/cjs/persisters/persister-partykit-client/with-schemas/index.cjs +1 -0
  439. package/cjs/persisters/persister-partykit-server/index.cjs +1 -0
  440. package/cjs/persisters/persister-partykit-server/index.cjs.gz +0 -0
  441. package/cjs/persisters/persister-partykit-server/with-schemas/index.cjs +1 -0
  442. package/cjs/persisters/persister-powersync/index.cjs +1 -0
  443. package/cjs/persisters/persister-powersync/index.cjs.gz +0 -0
  444. package/cjs/persisters/persister-powersync/with-schemas/index.cjs +1 -0
  445. package/cjs/persisters/persister-remote/index.cjs +1 -0
  446. package/cjs/persisters/persister-remote/index.cjs.gz +0 -0
  447. package/cjs/persisters/persister-remote/with-schemas/index.cjs +1 -0
  448. package/cjs/persisters/persister-sqlite-wasm/index.cjs +1 -0
  449. package/cjs/persisters/persister-sqlite-wasm/index.cjs.gz +0 -0
  450. package/cjs/persisters/persister-sqlite-wasm/with-schemas/index.cjs +1 -0
  451. package/cjs/persisters/persister-sqlite3/index.cjs +1 -0
  452. package/cjs/persisters/persister-sqlite3/index.cjs.gz +0 -0
  453. package/cjs/persisters/persister-sqlite3/with-schemas/index.cjs +1 -0
  454. package/cjs/persisters/persister-yjs/index.cjs +1 -0
  455. package/cjs/persisters/persister-yjs/index.cjs.gz +0 -0
  456. package/cjs/persisters/persister-yjs/with-schemas/index.cjs +1 -0
  457. package/cjs/persisters/with-schemas/index.cjs +1 -0
  458. package/cjs/queries/index.cjs +1 -0
  459. package/cjs/queries/index.cjs.gz +0 -0
  460. package/cjs/queries/with-schemas/index.cjs +1 -0
  461. package/cjs/relationships/index.cjs +1 -0
  462. package/cjs/relationships/index.cjs.gz +0 -0
  463. package/cjs/relationships/with-schemas/index.cjs +1 -0
  464. package/cjs/store/index.cjs +1 -0
  465. package/cjs/store/index.cjs.gz +0 -0
  466. package/cjs/store/with-schemas/index.cjs +1 -0
  467. package/cjs/synchronizers/index.cjs +1 -0
  468. package/cjs/synchronizers/index.cjs.gz +0 -0
  469. package/cjs/synchronizers/synchronizer-local/index.cjs +1 -0
  470. package/cjs/synchronizers/synchronizer-local/index.cjs.gz +0 -0
  471. package/cjs/synchronizers/synchronizer-local/with-schemas/index.cjs +1 -0
  472. package/cjs/synchronizers/synchronizer-ws-client/index.cjs +1 -0
  473. package/cjs/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
  474. package/cjs/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -0
  475. package/cjs/synchronizers/synchronizer-ws-server/index.cjs +1 -0
  476. package/cjs/synchronizers/synchronizer-ws-server/index.cjs.gz +0 -0
  477. package/cjs/synchronizers/synchronizer-ws-server/with-schemas/index.cjs +1 -0
  478. package/cjs/synchronizers/with-schemas/index.cjs +1 -0
  479. package/cjs/tools/index.cjs +1 -0
  480. package/cjs/tools/index.cjs.gz +0 -0
  481. package/cjs/tools/with-schemas/index.cjs +1 -0
  482. package/cjs/ui-react/index.cjs +1 -0
  483. package/cjs/ui-react/index.cjs.gz +0 -0
  484. package/cjs/ui-react/with-schemas/index.cjs +1 -0
  485. package/cjs/ui-react-dom/index.cjs +1 -0
  486. package/cjs/ui-react-dom/index.cjs.gz +0 -0
  487. package/cjs/ui-react-dom/with-schemas/index.cjs +1 -0
  488. package/cjs/ui-react-inspector/index.cjs +1 -0
  489. package/cjs/ui-react-inspector/index.cjs.gz +0 -0
  490. package/cjs/ui-react-inspector/with-schemas/index.cjs +1 -0
  491. package/cjs/with-schemas/index.cjs +1 -0
  492. package/cli/index.js +2 -0
  493. package/common/index.js +1 -0
  494. package/common/index.js.gz +0 -0
  495. package/common/with-schemas/index.js +1 -0
  496. package/debug/checkpoints/index.js +431 -0
  497. package/debug/checkpoints/with-schemas/index.js +431 -0
  498. package/debug/common/index.js +25 -0
  499. package/debug/common/with-schemas/index.js +25 -0
  500. package/debug/index.js +4102 -0
  501. package/debug/indexes/index.js +553 -0
  502. package/debug/indexes/with-schemas/index.js +553 -0
  503. package/debug/mergeable-store/index.js +2247 -0
  504. package/debug/mergeable-store/with-schemas/index.js +2247 -0
  505. package/debug/metrics/index.js +519 -0
  506. package/debug/metrics/with-schemas/index.js +519 -0
  507. package/debug/persisters/index.js +228 -0
  508. package/debug/persisters/persister-automerge/index.js +376 -0
  509. package/debug/persisters/persister-automerge/with-schemas/index.js +376 -0
  510. package/debug/persisters/persister-browser/index.js +279 -0
  511. package/debug/persisters/persister-browser/with-schemas/index.js +279 -0
  512. package/debug/persisters/persister-cr-sqlite-wasm/index.js +927 -0
  513. package/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +927 -0
  514. package/debug/persisters/persister-electric-sql/index.js +935 -0
  515. package/debug/persisters/persister-electric-sql/with-schemas/index.js +935 -0
  516. package/debug/persisters/persister-expo-sqlite/index.js +928 -0
  517. package/debug/persisters/persister-expo-sqlite/with-schemas/index.js +928 -0
  518. package/debug/persisters/persister-expo-sqlite-next/index.js +930 -0
  519. package/debug/persisters/persister-expo-sqlite-next/with-schemas/index.js +930 -0
  520. package/debug/persisters/persister-file/index.js +258 -0
  521. package/debug/persisters/persister-file/with-schemas/index.js +258 -0
  522. package/debug/persisters/persister-indexed-db/index.js +339 -0
  523. package/debug/persisters/persister-indexed-db/with-schemas/index.js +339 -0
  524. package/debug/persisters/persister-libsql/index.js +928 -0
  525. package/debug/persisters/persister-libsql/with-schemas/index.js +928 -0
  526. package/debug/persisters/persister-partykit-client/index.js +327 -0
  527. package/debug/persisters/persister-partykit-client/with-schemas/index.js +327 -0
  528. package/debug/persisters/persister-partykit-server/index.js +284 -0
  529. package/debug/persisters/persister-partykit-server/with-schemas/index.js +284 -0
  530. package/debug/persisters/persister-powersync/index.js +943 -0
  531. package/debug/persisters/persister-powersync/with-schemas/index.js +943 -0
  532. package/debug/persisters/persister-remote/index.js +285 -0
  533. package/debug/persisters/persister-remote/with-schemas/index.js +285 -0
  534. package/debug/persisters/persister-sqlite-wasm/index.js +936 -0
  535. package/debug/persisters/persister-sqlite-wasm/with-schemas/index.js +936 -0
  536. package/debug/persisters/persister-sqlite3/index.js +938 -0
  537. package/debug/persisters/persister-sqlite3/with-schemas/index.js +938 -0
  538. package/debug/persisters/persister-yjs/index.js +424 -0
  539. package/debug/persisters/persister-yjs/with-schemas/index.js +424 -0
  540. package/debug/persisters/with-schemas/index.js +228 -0
  541. package/debug/queries/index.js +812 -0
  542. package/debug/queries/with-schemas/index.js +812 -0
  543. package/debug/relationships/index.js +529 -0
  544. package/debug/relationships/with-schemas/index.js +529 -0
  545. package/debug/store/index.js +1634 -0
  546. package/debug/store/with-schemas/index.js +1634 -0
  547. package/debug/synchronizers/index.js +464 -0
  548. package/debug/synchronizers/synchronizer-local/index.js +504 -0
  549. package/debug/synchronizers/synchronizer-local/with-schemas/index.js +504 -0
  550. package/debug/synchronizers/synchronizer-ws-client/index.js +527 -0
  551. package/debug/synchronizers/synchronizer-ws-client/with-schemas/index.js +527 -0
  552. package/debug/synchronizers/synchronizer-ws-server/index.js +241 -0
  553. package/debug/synchronizers/synchronizer-ws-server/with-schemas/index.js +241 -0
  554. package/debug/synchronizers/with-schemas/index.js +464 -0
  555. package/debug/tools/index.js +3298 -0
  556. package/debug/tools/with-schemas/index.js +3298 -0
  557. package/debug/ui-react/index.js +1984 -0
  558. package/debug/ui-react/with-schemas/index.js +1984 -0
  559. package/debug/ui-react-dom/index.js +789 -0
  560. package/debug/ui-react-dom/with-schemas/index.js +789 -0
  561. package/debug/ui-react-inspector/index.js +3281 -0
  562. package/debug/ui-react-inspector/with-schemas/index.js +3281 -0
  563. package/debug/with-schemas/index.js +4102 -0
  564. package/es6/checkpoints/index.js +1 -0
  565. package/es6/checkpoints/index.js.gz +0 -0
  566. package/es6/checkpoints/with-schemas/index.js +1 -0
  567. package/es6/common/index.js +1 -0
  568. package/es6/common/index.js.gz +0 -0
  569. package/es6/common/with-schemas/index.js +1 -0
  570. package/es6/debug/checkpoints/index.js +471 -0
  571. package/es6/debug/checkpoints/with-schemas/index.js +471 -0
  572. package/es6/debug/common/index.js +27 -0
  573. package/es6/debug/common/with-schemas/index.js +27 -0
  574. package/es6/debug/index.js +4358 -0
  575. package/es6/debug/indexes/index.js +600 -0
  576. package/es6/debug/indexes/with-schemas/index.js +600 -0
  577. package/es6/debug/mergeable-store/index.js +2347 -0
  578. package/es6/debug/mergeable-store/with-schemas/index.js +2347 -0
  579. package/es6/debug/metrics/index.js +572 -0
  580. package/es6/debug/metrics/with-schemas/index.js +572 -0
  581. package/es6/debug/persisters/index.js +300 -0
  582. package/es6/debug/persisters/persister-automerge/index.js +474 -0
  583. package/es6/debug/persisters/persister-automerge/with-schemas/index.js +474 -0
  584. package/es6/debug/persisters/persister-browser/index.js +381 -0
  585. package/es6/debug/persisters/persister-browser/with-schemas/index.js +381 -0
  586. package/es6/debug/persisters/persister-cr-sqlite-wasm/index.js +1254 -0
  587. package/es6/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1254 -0
  588. package/es6/debug/persisters/persister-electric-sql/index.js +1262 -0
  589. package/es6/debug/persisters/persister-electric-sql/with-schemas/index.js +1262 -0
  590. package/es6/debug/persisters/persister-expo-sqlite/index.js +1254 -0
  591. package/es6/debug/persisters/persister-expo-sqlite/with-schemas/index.js +1254 -0
  592. package/es6/debug/persisters/persister-expo-sqlite-next/index.js +1257 -0
  593. package/es6/debug/persisters/persister-expo-sqlite-next/with-schemas/index.js +1257 -0
  594. package/es6/debug/persisters/persister-file/index.js +362 -0
  595. package/es6/debug/persisters/persister-file/with-schemas/index.js +362 -0
  596. package/es6/debug/persisters/persister-indexed-db/index.js +478 -0
  597. package/es6/debug/persisters/persister-indexed-db/with-schemas/index.js +478 -0
  598. package/es6/debug/persisters/persister-libsql/index.js +1255 -0
  599. package/es6/debug/persisters/persister-libsql/with-schemas/index.js +1255 -0
  600. package/es6/debug/persisters/persister-partykit-client/index.js +457 -0
  601. package/es6/debug/persisters/persister-partykit-client/with-schemas/index.js +457 -0
  602. package/es6/debug/persisters/persister-partykit-server/index.js +411 -0
  603. package/es6/debug/persisters/persister-partykit-server/with-schemas/index.js +411 -0
  604. package/es6/debug/persisters/persister-powersync/index.js +1310 -0
  605. package/es6/debug/persisters/persister-powersync/with-schemas/index.js +1310 -0
  606. package/es6/debug/persisters/persister-remote/index.js +387 -0
  607. package/es6/debug/persisters/persister-remote/with-schemas/index.js +387 -0
  608. package/es6/debug/persisters/persister-sqlite-wasm/index.js +1284 -0
  609. package/es6/debug/persisters/persister-sqlite-wasm/with-schemas/index.js +1284 -0
  610. package/es6/debug/persisters/persister-sqlite3/index.js +1264 -0
  611. package/es6/debug/persisters/persister-sqlite3/with-schemas/index.js +1264 -0
  612. package/es6/debug/persisters/persister-yjs/index.js +534 -0
  613. package/es6/debug/persisters/persister-yjs/with-schemas/index.js +534 -0
  614. package/es6/debug/persisters/with-schemas/index.js +300 -0
  615. package/es6/debug/queries/index.js +857 -0
  616. package/es6/debug/queries/with-schemas/index.js +857 -0
  617. package/es6/debug/relationships/index.js +589 -0
  618. package/es6/debug/relationships/with-schemas/index.js +589 -0
  619. package/es6/debug/store/index.js +1714 -0
  620. package/es6/debug/store/with-schemas/index.js +1714 -0
  621. package/es6/debug/synchronizers/index.js +592 -0
  622. package/es6/debug/synchronizers/synchronizer-local/index.js +628 -0
  623. package/es6/debug/synchronizers/synchronizer-local/with-schemas/index.js +628 -0
  624. package/es6/debug/synchronizers/synchronizer-ws-client/index.js +679 -0
  625. package/es6/debug/synchronizers/synchronizer-ws-client/with-schemas/index.js +679 -0
  626. package/es6/debug/synchronizers/synchronizer-ws-server/index.js +290 -0
  627. package/es6/debug/synchronizers/synchronizer-ws-server/with-schemas/index.js +290 -0
  628. package/es6/debug/synchronizers/with-schemas/index.js +592 -0
  629. package/es6/debug/tools/index.js +3421 -0
  630. package/es6/debug/tools/with-schemas/index.js +3421 -0
  631. package/es6/debug/ui-react/index.js +2188 -0
  632. package/es6/debug/ui-react/with-schemas/index.js +2188 -0
  633. package/es6/debug/ui-react-dom/index.js +907 -0
  634. package/es6/debug/ui-react-dom/with-schemas/index.js +907 -0
  635. package/es6/debug/ui-react-inspector/index.js +3659 -0
  636. package/es6/debug/ui-react-inspector/with-schemas/index.js +3659 -0
  637. package/es6/debug/with-schemas/index.js +4358 -0
  638. package/es6/index.js +1 -0
  639. package/es6/index.js.gz +0 -0
  640. package/es6/indexes/index.js +1 -0
  641. package/es6/indexes/index.js.gz +0 -0
  642. package/es6/indexes/with-schemas/index.js +1 -0
  643. package/es6/mergeable-store/index.js +1 -0
  644. package/es6/mergeable-store/index.js.gz +0 -0
  645. package/es6/mergeable-store/with-schemas/index.js +1 -0
  646. package/es6/metrics/index.js +1 -0
  647. package/es6/metrics/index.js.gz +0 -0
  648. package/es6/metrics/with-schemas/index.js +1 -0
  649. package/es6/persisters/index.js +1 -0
  650. package/es6/persisters/index.js.gz +0 -0
  651. package/es6/persisters/persister-automerge/index.js +1 -0
  652. package/es6/persisters/persister-automerge/index.js.gz +0 -0
  653. package/es6/persisters/persister-automerge/with-schemas/index.js +1 -0
  654. package/es6/persisters/persister-browser/index.js +1 -0
  655. package/es6/persisters/persister-browser/index.js.gz +0 -0
  656. package/es6/persisters/persister-browser/with-schemas/index.js +1 -0
  657. package/es6/persisters/persister-cr-sqlite-wasm/index.js +1 -0
  658. package/es6/persisters/persister-cr-sqlite-wasm/index.js.gz +0 -0
  659. package/es6/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1 -0
  660. package/es6/persisters/persister-electric-sql/index.js +1 -0
  661. package/es6/persisters/persister-electric-sql/index.js.gz +0 -0
  662. package/es6/persisters/persister-electric-sql/with-schemas/index.js +1 -0
  663. package/es6/persisters/persister-expo-sqlite/index.js +1 -0
  664. package/es6/persisters/persister-expo-sqlite/index.js.gz +0 -0
  665. package/es6/persisters/persister-expo-sqlite/with-schemas/index.js +1 -0
  666. package/es6/persisters/persister-expo-sqlite-next/index.js +1 -0
  667. package/es6/persisters/persister-expo-sqlite-next/index.js.gz +0 -0
  668. package/es6/persisters/persister-expo-sqlite-next/with-schemas/index.js +1 -0
  669. package/es6/persisters/persister-file/index.js +1 -0
  670. package/es6/persisters/persister-file/index.js.gz +0 -0
  671. package/es6/persisters/persister-file/with-schemas/index.js +1 -0
  672. package/es6/persisters/persister-indexed-db/index.js +1 -0
  673. package/es6/persisters/persister-indexed-db/index.js.gz +0 -0
  674. package/es6/persisters/persister-indexed-db/with-schemas/index.js +1 -0
  675. package/es6/persisters/persister-libsql/index.js +1 -0
  676. package/es6/persisters/persister-libsql/index.js.gz +0 -0
  677. package/es6/persisters/persister-libsql/with-schemas/index.js +1 -0
  678. package/es6/persisters/persister-partykit-client/index.js +1 -0
  679. package/es6/persisters/persister-partykit-client/index.js.gz +0 -0
  680. package/es6/persisters/persister-partykit-client/with-schemas/index.js +1 -0
  681. package/es6/persisters/persister-partykit-server/index.js +1 -0
  682. package/es6/persisters/persister-partykit-server/index.js.gz +0 -0
  683. package/es6/persisters/persister-partykit-server/with-schemas/index.js +1 -0
  684. package/es6/persisters/persister-powersync/index.js +1 -0
  685. package/es6/persisters/persister-powersync/index.js.gz +0 -0
  686. package/es6/persisters/persister-powersync/with-schemas/index.js +1 -0
  687. package/es6/persisters/persister-remote/index.js +1 -0
  688. package/es6/persisters/persister-remote/index.js.gz +0 -0
  689. package/es6/persisters/persister-remote/with-schemas/index.js +1 -0
  690. package/es6/persisters/persister-sqlite-wasm/index.js +1 -0
  691. package/es6/persisters/persister-sqlite-wasm/index.js.gz +0 -0
  692. package/es6/persisters/persister-sqlite-wasm/with-schemas/index.js +1 -0
  693. package/es6/persisters/persister-sqlite3/index.js +1 -0
  694. package/es6/persisters/persister-sqlite3/index.js.gz +0 -0
  695. package/es6/persisters/persister-sqlite3/with-schemas/index.js +1 -0
  696. package/es6/persisters/persister-yjs/index.js +1 -0
  697. package/es6/persisters/persister-yjs/index.js.gz +0 -0
  698. package/es6/persisters/persister-yjs/with-schemas/index.js +1 -0
  699. package/es6/persisters/with-schemas/index.js +1 -0
  700. package/es6/queries/index.js +1 -0
  701. package/es6/queries/index.js.gz +0 -0
  702. package/es6/queries/with-schemas/index.js +1 -0
  703. package/es6/relationships/index.js +1 -0
  704. package/es6/relationships/index.js.gz +0 -0
  705. package/es6/relationships/with-schemas/index.js +1 -0
  706. package/es6/store/index.js +1 -0
  707. package/es6/store/index.js.gz +0 -0
  708. package/es6/store/with-schemas/index.js +1 -0
  709. package/es6/synchronizers/index.js +1 -0
  710. package/es6/synchronizers/index.js.gz +0 -0
  711. package/es6/synchronizers/synchronizer-local/index.js +1 -0
  712. package/es6/synchronizers/synchronizer-local/index.js.gz +0 -0
  713. package/es6/synchronizers/synchronizer-local/with-schemas/index.js +1 -0
  714. package/es6/synchronizers/synchronizer-ws-client/index.js +1 -0
  715. package/es6/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  716. package/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -0
  717. package/es6/synchronizers/synchronizer-ws-server/index.js +1 -0
  718. package/es6/synchronizers/synchronizer-ws-server/index.js.gz +0 -0
  719. package/es6/synchronizers/synchronizer-ws-server/with-schemas/index.js +1 -0
  720. package/es6/synchronizers/with-schemas/index.js +1 -0
  721. package/es6/tools/index.js +1 -0
  722. package/es6/tools/index.js.gz +0 -0
  723. package/es6/tools/with-schemas/index.js +1 -0
  724. package/es6/ui-react/index.js +1 -0
  725. package/es6/ui-react/index.js.gz +0 -0
  726. package/es6/ui-react/with-schemas/index.js +1 -0
  727. package/es6/ui-react-dom/index.js +1 -0
  728. package/es6/ui-react-dom/index.js.gz +0 -0
  729. package/es6/ui-react-dom/with-schemas/index.js +1 -0
  730. package/es6/ui-react-inspector/index.js +1 -0
  731. package/es6/ui-react-inspector/index.js.gz +0 -0
  732. package/es6/ui-react-inspector/with-schemas/index.js +1 -0
  733. package/es6/with-schemas/index.js +1 -0
  734. package/index.js +1 -0
  735. package/index.js.gz +0 -0
  736. package/indexes/index.js +1 -0
  737. package/indexes/index.js.gz +0 -0
  738. package/indexes/with-schemas/index.js +1 -0
  739. package/mergeable-store/index.js +1 -0
  740. package/mergeable-store/index.js.gz +0 -0
  741. package/mergeable-store/with-schemas/index.js +1 -0
  742. package/metrics/index.js +1 -0
  743. package/metrics/index.js.gz +0 -0
  744. package/metrics/with-schemas/index.js +1 -0
  745. package/package.json +3571 -279
  746. package/persisters/index.js +1 -0
  747. package/persisters/index.js.gz +0 -0
  748. package/persisters/persister-automerge/index.js +1 -0
  749. package/persisters/persister-automerge/index.js.gz +0 -0
  750. package/persisters/persister-automerge/with-schemas/index.js +1 -0
  751. package/persisters/persister-browser/index.js +1 -0
  752. package/persisters/persister-browser/index.js.gz +0 -0
  753. package/persisters/persister-browser/with-schemas/index.js +1 -0
  754. package/persisters/persister-cr-sqlite-wasm/index.js +1 -0
  755. package/persisters/persister-cr-sqlite-wasm/index.js.gz +0 -0
  756. package/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1 -0
  757. package/persisters/persister-electric-sql/index.js +1 -0
  758. package/persisters/persister-electric-sql/index.js.gz +0 -0
  759. package/persisters/persister-electric-sql/with-schemas/index.js +1 -0
  760. package/persisters/persister-expo-sqlite/index.js +1 -0
  761. package/persisters/persister-expo-sqlite/index.js.gz +0 -0
  762. package/persisters/persister-expo-sqlite/with-schemas/index.js +1 -0
  763. package/persisters/persister-expo-sqlite-next/index.js +1 -0
  764. package/persisters/persister-expo-sqlite-next/index.js.gz +0 -0
  765. package/persisters/persister-expo-sqlite-next/with-schemas/index.js +1 -0
  766. package/persisters/persister-file/index.js +1 -0
  767. package/persisters/persister-file/index.js.gz +0 -0
  768. package/persisters/persister-file/with-schemas/index.js +1 -0
  769. package/persisters/persister-indexed-db/index.js +1 -0
  770. package/persisters/persister-indexed-db/index.js.gz +0 -0
  771. package/persisters/persister-indexed-db/with-schemas/index.js +1 -0
  772. package/persisters/persister-libsql/index.js +1 -0
  773. package/persisters/persister-libsql/index.js.gz +0 -0
  774. package/persisters/persister-libsql/with-schemas/index.js +1 -0
  775. package/persisters/persister-partykit-client/index.js +1 -0
  776. package/persisters/persister-partykit-client/index.js.gz +0 -0
  777. package/persisters/persister-partykit-client/with-schemas/index.js +1 -0
  778. package/persisters/persister-partykit-server/index.js +1 -0
  779. package/persisters/persister-partykit-server/index.js.gz +0 -0
  780. package/persisters/persister-partykit-server/with-schemas/index.js +1 -0
  781. package/persisters/persister-powersync/index.js +1 -0
  782. package/persisters/persister-powersync/index.js.gz +0 -0
  783. package/persisters/persister-powersync/with-schemas/index.js +1 -0
  784. package/persisters/persister-remote/index.js +1 -0
  785. package/persisters/persister-remote/index.js.gz +0 -0
  786. package/persisters/persister-remote/with-schemas/index.js +1 -0
  787. package/persisters/persister-sqlite-wasm/index.js +1 -0
  788. package/persisters/persister-sqlite-wasm/index.js.gz +0 -0
  789. package/persisters/persister-sqlite-wasm/with-schemas/index.js +1 -0
  790. package/persisters/persister-sqlite3/index.js +1 -0
  791. package/persisters/persister-sqlite3/index.js.gz +0 -0
  792. package/persisters/persister-sqlite3/with-schemas/index.js +1 -0
  793. package/persisters/persister-yjs/index.js +1 -0
  794. package/persisters/persister-yjs/index.js.gz +0 -0
  795. package/persisters/persister-yjs/with-schemas/index.js +1 -0
  796. package/persisters/with-schemas/index.js +1 -0
  797. package/queries/index.js +1 -0
  798. package/queries/index.js.gz +0 -0
  799. package/queries/with-schemas/index.js +1 -0
  800. package/readme.md +22 -4
  801. package/relationships/index.js +1 -0
  802. package/relationships/index.js.gz +0 -0
  803. package/relationships/with-schemas/index.js +1 -0
  804. package/releases.md +452 -0
  805. package/store/index.js +1 -0
  806. package/store/index.js.gz +0 -0
  807. package/store/with-schemas/index.js +1 -0
  808. package/synchronizers/index.js +1 -0
  809. package/synchronizers/index.js.gz +0 -0
  810. package/synchronizers/synchronizer-local/index.js +1 -0
  811. package/synchronizers/synchronizer-local/index.js.gz +0 -0
  812. package/synchronizers/synchronizer-local/with-schemas/index.js +1 -0
  813. package/synchronizers/synchronizer-ws-client/index.js +1 -0
  814. package/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  815. package/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -0
  816. package/synchronizers/synchronizer-ws-server/index.js +1 -0
  817. package/synchronizers/synchronizer-ws-server/index.js.gz +0 -0
  818. package/synchronizers/synchronizer-ws-server/with-schemas/index.js +1 -0
  819. package/synchronizers/with-schemas/index.js +1 -0
  820. package/tools/index.js +1 -0
  821. package/tools/index.js.gz +0 -0
  822. package/tools/with-schemas/index.js +1 -0
  823. package/ui-react/index.js +1 -0
  824. package/ui-react/index.js.gz +0 -0
  825. package/ui-react/with-schemas/index.js +1 -0
  826. package/ui-react-dom/index.js +1 -0
  827. package/ui-react-dom/index.js.gz +0 -0
  828. package/ui-react-dom/with-schemas/index.js +1 -0
  829. package/ui-react-inspector/index.js +1 -0
  830. package/ui-react-inspector/index.js.gz +0 -0
  831. package/ui-react-inspector/with-schemas/index.js +1 -0
  832. package/umd/checkpoints/index.js +1 -0
  833. package/umd/checkpoints/index.js.gz +0 -0
  834. package/umd/checkpoints/with-schemas/index.js +1 -0
  835. package/umd/common/index.js +1 -0
  836. package/umd/common/index.js.gz +0 -0
  837. package/umd/common/with-schemas/index.js +1 -0
  838. package/umd/debug/checkpoints/index.js +450 -0
  839. package/umd/debug/checkpoints/with-schemas/index.js +450 -0
  840. package/umd/debug/common/index.js +38 -0
  841. package/umd/debug/common/with-schemas/index.js +38 -0
  842. package/umd/debug/index.js +4192 -0
  843. package/umd/debug/indexes/index.js +578 -0
  844. package/umd/debug/indexes/with-schemas/index.js +578 -0
  845. package/umd/debug/mergeable-store/index.js +2312 -0
  846. package/umd/debug/mergeable-store/with-schemas/index.js +2312 -0
  847. package/umd/debug/metrics/index.js +544 -0
  848. package/umd/debug/metrics/with-schemas/index.js +544 -0
  849. package/umd/debug/persisters/index.js +242 -0
  850. package/umd/debug/persisters/persister-automerge/index.js +390 -0
  851. package/umd/debug/persisters/persister-automerge/with-schemas/index.js +390 -0
  852. package/umd/debug/persisters/persister-browser/index.js +296 -0
  853. package/umd/debug/persisters/persister-browser/with-schemas/index.js +296 -0
  854. package/umd/debug/persisters/persister-cr-sqlite-wasm/index.js +959 -0
  855. package/umd/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +959 -0
  856. package/umd/debug/persisters/persister-electric-sql/index.js +967 -0
  857. package/umd/debug/persisters/persister-electric-sql/with-schemas/index.js +967 -0
  858. package/umd/debug/persisters/persister-expo-sqlite/index.js +960 -0
  859. package/umd/debug/persisters/persister-expo-sqlite/with-schemas/index.js +960 -0
  860. package/umd/debug/persisters/persister-expo-sqlite-next/index.js +963 -0
  861. package/umd/debug/persisters/persister-expo-sqlite-next/with-schemas/index.js +963 -0
  862. package/umd/debug/persisters/persister-file/index.js +280 -0
  863. package/umd/debug/persisters/persister-file/with-schemas/index.js +280 -0
  864. package/umd/debug/persisters/persister-indexed-db/index.js +354 -0
  865. package/umd/debug/persisters/persister-indexed-db/with-schemas/index.js +354 -0
  866. package/umd/debug/persisters/persister-libsql/index.js +960 -0
  867. package/umd/debug/persisters/persister-libsql/with-schemas/index.js +960 -0
  868. package/umd/debug/persisters/persister-partykit-client/index.js +341 -0
  869. package/umd/debug/persisters/persister-partykit-client/with-schemas/index.js +341 -0
  870. package/umd/debug/persisters/persister-partykit-server/index.js +312 -0
  871. package/umd/debug/persisters/persister-partykit-server/with-schemas/index.js +312 -0
  872. package/umd/debug/persisters/persister-powersync/index.js +977 -0
  873. package/umd/debug/persisters/persister-powersync/with-schemas/index.js +977 -0
  874. package/umd/debug/persisters/persister-remote/index.js +299 -0
  875. package/umd/debug/persisters/persister-remote/with-schemas/index.js +299 -0
  876. package/umd/debug/persisters/persister-sqlite-wasm/index.js +968 -0
  877. package/umd/debug/persisters/persister-sqlite-wasm/with-schemas/index.js +968 -0
  878. package/umd/debug/persisters/persister-sqlite3/index.js +970 -0
  879. package/umd/debug/persisters/persister-sqlite3/with-schemas/index.js +970 -0
  880. package/umd/debug/persisters/persister-yjs/index.js +439 -0
  881. package/umd/debug/persisters/persister-yjs/with-schemas/index.js +439 -0
  882. package/umd/debug/persisters/with-schemas/index.js +242 -0
  883. package/umd/debug/queries/index.js +828 -0
  884. package/umd/debug/queries/with-schemas/index.js +828 -0
  885. package/umd/debug/relationships/index.js +551 -0
  886. package/umd/debug/relationships/with-schemas/index.js +551 -0
  887. package/umd/debug/store/index.js +1686 -0
  888. package/umd/debug/store/with-schemas/index.js +1686 -0
  889. package/umd/debug/synchronizers/index.js +482 -0
  890. package/umd/debug/synchronizers/synchronizer-local/index.js +522 -0
  891. package/umd/debug/synchronizers/synchronizer-local/with-schemas/index.js +522 -0
  892. package/umd/debug/synchronizers/synchronizer-ws-client/index.js +547 -0
  893. package/umd/debug/synchronizers/synchronizer-ws-client/with-schemas/index.js +547 -0
  894. package/umd/debug/synchronizers/synchronizer-ws-server/index.js +261 -0
  895. package/umd/debug/synchronizers/synchronizer-ws-server/with-schemas/index.js +261 -0
  896. package/umd/debug/synchronizers/with-schemas/index.js +482 -0
  897. package/umd/debug/tools/index.js +3351 -0
  898. package/umd/debug/tools/with-schemas/index.js +3351 -0
  899. package/umd/debug/ui-react/index.js +2036 -0
  900. package/umd/debug/ui-react/with-schemas/index.js +2036 -0
  901. package/umd/debug/ui-react-dom/index.js +802 -0
  902. package/umd/debug/ui-react-dom/with-schemas/index.js +802 -0
  903. package/umd/debug/ui-react-inspector/index.js +3342 -0
  904. package/umd/debug/ui-react-inspector/with-schemas/index.js +3342 -0
  905. package/umd/debug/with-schemas/index.js +4192 -0
  906. package/umd/es6/checkpoints/index.js +1 -0
  907. package/umd/es6/checkpoints/index.js.gz +0 -0
  908. package/umd/es6/checkpoints/with-schemas/index.js +1 -0
  909. package/umd/es6/common/index.js +1 -0
  910. package/umd/es6/common/index.js.gz +0 -0
  911. package/umd/es6/common/with-schemas/index.js +1 -0
  912. package/umd/es6/debug/checkpoints/index.js +492 -0
  913. package/umd/es6/debug/checkpoints/with-schemas/index.js +492 -0
  914. package/umd/es6/debug/common/index.js +40 -0
  915. package/umd/es6/debug/common/with-schemas/index.js +40 -0
  916. package/umd/es6/debug/index.js +4456 -0
  917. package/umd/es6/debug/indexes/index.js +627 -0
  918. package/umd/es6/debug/indexes/with-schemas/index.js +627 -0
  919. package/umd/es6/debug/mergeable-store/index.js +2418 -0
  920. package/umd/es6/debug/mergeable-store/with-schemas/index.js +2418 -0
  921. package/umd/es6/debug/metrics/index.js +599 -0
  922. package/umd/es6/debug/metrics/with-schemas/index.js +599 -0
  923. package/umd/es6/debug/persisters/index.js +316 -0
  924. package/umd/es6/debug/persisters/persister-automerge/index.js +490 -0
  925. package/umd/es6/debug/persisters/persister-automerge/with-schemas/index.js +490 -0
  926. package/umd/es6/debug/persisters/persister-browser/index.js +400 -0
  927. package/umd/es6/debug/persisters/persister-browser/with-schemas/index.js +400 -0
  928. package/umd/es6/debug/persisters/persister-cr-sqlite-wasm/index.js +1295 -0
  929. package/umd/es6/debug/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1295 -0
  930. package/umd/es6/debug/persisters/persister-electric-sql/index.js +1303 -0
  931. package/umd/es6/debug/persisters/persister-electric-sql/with-schemas/index.js +1303 -0
  932. package/umd/es6/debug/persisters/persister-expo-sqlite/index.js +1295 -0
  933. package/umd/es6/debug/persisters/persister-expo-sqlite/with-schemas/index.js +1295 -0
  934. package/umd/es6/debug/persisters/persister-expo-sqlite-next/index.js +1299 -0
  935. package/umd/es6/debug/persisters/persister-expo-sqlite-next/with-schemas/index.js +1299 -0
  936. package/umd/es6/debug/persisters/persister-file/index.js +382 -0
  937. package/umd/es6/debug/persisters/persister-file/with-schemas/index.js +382 -0
  938. package/umd/es6/debug/persisters/persister-indexed-db/index.js +495 -0
  939. package/umd/es6/debug/persisters/persister-indexed-db/with-schemas/index.js +495 -0
  940. package/umd/es6/debug/persisters/persister-libsql/index.js +1296 -0
  941. package/umd/es6/debug/persisters/persister-libsql/with-schemas/index.js +1296 -0
  942. package/umd/es6/debug/persisters/persister-partykit-client/index.js +473 -0
  943. package/umd/es6/debug/persisters/persister-partykit-client/with-schemas/index.js +473 -0
  944. package/umd/es6/debug/persisters/persister-partykit-server/index.js +432 -0
  945. package/umd/es6/debug/persisters/persister-partykit-server/with-schemas/index.js +432 -0
  946. package/umd/es6/debug/persisters/persister-powersync/index.js +1355 -0
  947. package/umd/es6/debug/persisters/persister-powersync/with-schemas/index.js +1355 -0
  948. package/umd/es6/debug/persisters/persister-remote/index.js +403 -0
  949. package/umd/es6/debug/persisters/persister-remote/with-schemas/index.js +403 -0
  950. package/umd/es6/debug/persisters/persister-sqlite-wasm/index.js +1329 -0
  951. package/umd/es6/debug/persisters/persister-sqlite-wasm/with-schemas/index.js +1329 -0
  952. package/umd/es6/debug/persisters/persister-sqlite3/index.js +1305 -0
  953. package/umd/es6/debug/persisters/persister-sqlite3/with-schemas/index.js +1305 -0
  954. package/umd/es6/debug/persisters/persister-yjs/index.js +550 -0
  955. package/umd/es6/debug/persisters/persister-yjs/with-schemas/index.js +550 -0
  956. package/umd/es6/debug/persisters/with-schemas/index.js +316 -0
  957. package/umd/es6/debug/queries/index.js +875 -0
  958. package/umd/es6/debug/queries/with-schemas/index.js +875 -0
  959. package/umd/es6/debug/relationships/index.js +613 -0
  960. package/umd/es6/debug/relationships/with-schemas/index.js +613 -0
  961. package/umd/es6/debug/store/index.js +1770 -0
  962. package/umd/es6/debug/store/with-schemas/index.js +1770 -0
  963. package/umd/es6/debug/synchronizers/index.js +616 -0
  964. package/umd/es6/debug/synchronizers/synchronizer-local/index.js +652 -0
  965. package/umd/es6/debug/synchronizers/synchronizer-local/with-schemas/index.js +652 -0
  966. package/umd/es6/debug/synchronizers/synchronizer-ws-client/index.js +705 -0
  967. package/umd/es6/debug/synchronizers/synchronizer-ws-client/with-schemas/index.js +705 -0
  968. package/umd/es6/debug/synchronizers/synchronizer-ws-server/index.js +314 -0
  969. package/umd/es6/debug/synchronizers/synchronizer-ws-server/with-schemas/index.js +314 -0
  970. package/umd/es6/debug/synchronizers/with-schemas/index.js +616 -0
  971. package/umd/es6/debug/tools/index.js +3481 -0
  972. package/umd/es6/debug/tools/with-schemas/index.js +3481 -0
  973. package/umd/es6/debug/ui-react/index.js +2248 -0
  974. package/umd/es6/debug/ui-react/with-schemas/index.js +2248 -0
  975. package/umd/es6/debug/ui-react-dom/index.js +921 -0
  976. package/umd/es6/debug/ui-react-dom/with-schemas/index.js +921 -0
  977. package/umd/es6/debug/ui-react-inspector/index.js +3735 -0
  978. package/umd/es6/debug/ui-react-inspector/with-schemas/index.js +3735 -0
  979. package/umd/es6/debug/with-schemas/index.js +4456 -0
  980. package/umd/es6/index.js +1 -0
  981. package/umd/es6/index.js.gz +0 -0
  982. package/umd/es6/indexes/index.js +1 -0
  983. package/umd/es6/indexes/index.js.gz +0 -0
  984. package/umd/es6/indexes/with-schemas/index.js +1 -0
  985. package/umd/es6/mergeable-store/index.js +1 -0
  986. package/umd/es6/mergeable-store/index.js.gz +0 -0
  987. package/umd/es6/mergeable-store/with-schemas/index.js +1 -0
  988. package/umd/es6/metrics/index.js +1 -0
  989. package/umd/es6/metrics/index.js.gz +0 -0
  990. package/umd/es6/metrics/with-schemas/index.js +1 -0
  991. package/umd/es6/persisters/index.js +1 -0
  992. package/umd/es6/persisters/index.js.gz +0 -0
  993. package/umd/es6/persisters/persister-automerge/index.js +1 -0
  994. package/umd/es6/persisters/persister-automerge/index.js.gz +0 -0
  995. package/umd/es6/persisters/persister-automerge/with-schemas/index.js +1 -0
  996. package/umd/es6/persisters/persister-browser/index.js +1 -0
  997. package/umd/es6/persisters/persister-browser/index.js.gz +0 -0
  998. package/umd/es6/persisters/persister-browser/with-schemas/index.js +1 -0
  999. package/umd/es6/persisters/persister-cr-sqlite-wasm/index.js +1 -0
  1000. package/umd/es6/persisters/persister-cr-sqlite-wasm/index.js.gz +0 -0
  1001. package/umd/es6/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1 -0
  1002. package/umd/es6/persisters/persister-electric-sql/index.js +1 -0
  1003. package/umd/es6/persisters/persister-electric-sql/index.js.gz +0 -0
  1004. package/umd/es6/persisters/persister-electric-sql/with-schemas/index.js +1 -0
  1005. package/umd/es6/persisters/persister-expo-sqlite/index.js +1 -0
  1006. package/umd/es6/persisters/persister-expo-sqlite/index.js.gz +0 -0
  1007. package/umd/es6/persisters/persister-expo-sqlite/with-schemas/index.js +1 -0
  1008. package/umd/es6/persisters/persister-expo-sqlite-next/index.js +1 -0
  1009. package/umd/es6/persisters/persister-expo-sqlite-next/index.js.gz +0 -0
  1010. package/umd/es6/persisters/persister-expo-sqlite-next/with-schemas/index.js +1 -0
  1011. package/umd/es6/persisters/persister-file/index.js +1 -0
  1012. package/umd/es6/persisters/persister-file/index.js.gz +0 -0
  1013. package/umd/es6/persisters/persister-file/with-schemas/index.js +1 -0
  1014. package/umd/es6/persisters/persister-indexed-db/index.js +1 -0
  1015. package/umd/es6/persisters/persister-indexed-db/index.js.gz +0 -0
  1016. package/umd/es6/persisters/persister-indexed-db/with-schemas/index.js +1 -0
  1017. package/umd/es6/persisters/persister-libsql/index.js +1 -0
  1018. package/umd/es6/persisters/persister-libsql/index.js.gz +0 -0
  1019. package/umd/es6/persisters/persister-libsql/with-schemas/index.js +1 -0
  1020. package/umd/es6/persisters/persister-partykit-client/index.js +1 -0
  1021. package/umd/es6/persisters/persister-partykit-client/index.js.gz +0 -0
  1022. package/umd/es6/persisters/persister-partykit-client/with-schemas/index.js +1 -0
  1023. package/umd/es6/persisters/persister-partykit-server/index.js +1 -0
  1024. package/umd/es6/persisters/persister-partykit-server/index.js.gz +0 -0
  1025. package/umd/es6/persisters/persister-partykit-server/with-schemas/index.js +1 -0
  1026. package/umd/es6/persisters/persister-powersync/index.js +1 -0
  1027. package/umd/es6/persisters/persister-powersync/index.js.gz +0 -0
  1028. package/umd/es6/persisters/persister-powersync/with-schemas/index.js +1 -0
  1029. package/umd/es6/persisters/persister-remote/index.js +1 -0
  1030. package/umd/es6/persisters/persister-remote/index.js.gz +0 -0
  1031. package/umd/es6/persisters/persister-remote/with-schemas/index.js +1 -0
  1032. package/umd/es6/persisters/persister-sqlite-wasm/index.js +1 -0
  1033. package/umd/es6/persisters/persister-sqlite-wasm/index.js.gz +0 -0
  1034. package/umd/es6/persisters/persister-sqlite-wasm/with-schemas/index.js +1 -0
  1035. package/umd/es6/persisters/persister-sqlite3/index.js +1 -0
  1036. package/umd/es6/persisters/persister-sqlite3/index.js.gz +0 -0
  1037. package/umd/es6/persisters/persister-sqlite3/with-schemas/index.js +1 -0
  1038. package/umd/es6/persisters/persister-yjs/index.js +1 -0
  1039. package/umd/es6/persisters/persister-yjs/index.js.gz +0 -0
  1040. package/umd/es6/persisters/persister-yjs/with-schemas/index.js +1 -0
  1041. package/umd/es6/persisters/with-schemas/index.js +1 -0
  1042. package/umd/es6/queries/index.js +1 -0
  1043. package/umd/es6/queries/index.js.gz +0 -0
  1044. package/umd/es6/queries/with-schemas/index.js +1 -0
  1045. package/umd/es6/relationships/index.js +1 -0
  1046. package/umd/es6/relationships/index.js.gz +0 -0
  1047. package/umd/es6/relationships/with-schemas/index.js +1 -0
  1048. package/umd/es6/store/index.js +1 -0
  1049. package/umd/es6/store/index.js.gz +0 -0
  1050. package/umd/es6/store/with-schemas/index.js +1 -0
  1051. package/umd/es6/synchronizers/index.js +1 -0
  1052. package/umd/es6/synchronizers/index.js.gz +0 -0
  1053. package/umd/es6/synchronizers/synchronizer-local/index.js +1 -0
  1054. package/umd/es6/synchronizers/synchronizer-local/index.js.gz +0 -0
  1055. package/umd/es6/synchronizers/synchronizer-local/with-schemas/index.js +1 -0
  1056. package/umd/es6/synchronizers/synchronizer-ws-client/index.js +1 -0
  1057. package/umd/es6/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  1058. package/umd/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -0
  1059. package/umd/es6/synchronizers/synchronizer-ws-server/index.js +1 -0
  1060. package/umd/es6/synchronizers/synchronizer-ws-server/index.js.gz +0 -0
  1061. package/umd/es6/synchronizers/synchronizer-ws-server/with-schemas/index.js +1 -0
  1062. package/umd/es6/synchronizers/with-schemas/index.js +1 -0
  1063. package/umd/es6/tools/index.js +1 -0
  1064. package/umd/es6/tools/index.js.gz +0 -0
  1065. package/umd/es6/tools/with-schemas/index.js +1 -0
  1066. package/umd/es6/ui-react/index.js +1 -0
  1067. package/umd/es6/ui-react/index.js.gz +0 -0
  1068. package/umd/es6/ui-react/with-schemas/index.js +1 -0
  1069. package/umd/es6/ui-react-dom/index.js +1 -0
  1070. package/umd/es6/ui-react-dom/index.js.gz +0 -0
  1071. package/umd/es6/ui-react-dom/with-schemas/index.js +1 -0
  1072. package/umd/es6/ui-react-inspector/index.js +1 -0
  1073. package/umd/es6/ui-react-inspector/index.js.gz +0 -0
  1074. package/umd/es6/ui-react-inspector/with-schemas/index.js +1 -0
  1075. package/umd/es6/with-schemas/index.js +1 -0
  1076. package/umd/index.js +1 -0
  1077. package/umd/index.js.gz +0 -0
  1078. package/umd/indexes/index.js +1 -0
  1079. package/umd/indexes/index.js.gz +0 -0
  1080. package/umd/indexes/with-schemas/index.js +1 -0
  1081. package/umd/mergeable-store/index.js +1 -0
  1082. package/umd/mergeable-store/index.js.gz +0 -0
  1083. package/umd/mergeable-store/with-schemas/index.js +1 -0
  1084. package/umd/metrics/index.js +1 -0
  1085. package/umd/metrics/index.js.gz +0 -0
  1086. package/umd/metrics/with-schemas/index.js +1 -0
  1087. package/umd/persisters/index.js +1 -0
  1088. package/umd/persisters/index.js.gz +0 -0
  1089. package/umd/persisters/persister-automerge/index.js +1 -0
  1090. package/umd/persisters/persister-automerge/index.js.gz +0 -0
  1091. package/umd/persisters/persister-automerge/with-schemas/index.js +1 -0
  1092. package/umd/persisters/persister-browser/index.js +1 -0
  1093. package/umd/persisters/persister-browser/index.js.gz +0 -0
  1094. package/umd/persisters/persister-browser/with-schemas/index.js +1 -0
  1095. package/umd/persisters/persister-cr-sqlite-wasm/index.js +1 -0
  1096. package/umd/persisters/persister-cr-sqlite-wasm/index.js.gz +0 -0
  1097. package/umd/persisters/persister-cr-sqlite-wasm/with-schemas/index.js +1 -0
  1098. package/umd/persisters/persister-electric-sql/index.js +1 -0
  1099. package/umd/persisters/persister-electric-sql/index.js.gz +0 -0
  1100. package/umd/persisters/persister-electric-sql/with-schemas/index.js +1 -0
  1101. package/umd/persisters/persister-expo-sqlite/index.js +1 -0
  1102. package/umd/persisters/persister-expo-sqlite/index.js.gz +0 -0
  1103. package/umd/persisters/persister-expo-sqlite/with-schemas/index.js +1 -0
  1104. package/umd/persisters/persister-expo-sqlite-next/index.js +1 -0
  1105. package/umd/persisters/persister-expo-sqlite-next/index.js.gz +0 -0
  1106. package/umd/persisters/persister-expo-sqlite-next/with-schemas/index.js +1 -0
  1107. package/umd/persisters/persister-file/index.js +1 -0
  1108. package/umd/persisters/persister-file/index.js.gz +0 -0
  1109. package/umd/persisters/persister-file/with-schemas/index.js +1 -0
  1110. package/umd/persisters/persister-indexed-db/index.js +1 -0
  1111. package/umd/persisters/persister-indexed-db/index.js.gz +0 -0
  1112. package/umd/persisters/persister-indexed-db/with-schemas/index.js +1 -0
  1113. package/umd/persisters/persister-libsql/index.js +1 -0
  1114. package/umd/persisters/persister-libsql/index.js.gz +0 -0
  1115. package/umd/persisters/persister-libsql/with-schemas/index.js +1 -0
  1116. package/umd/persisters/persister-partykit-client/index.js +1 -0
  1117. package/umd/persisters/persister-partykit-client/index.js.gz +0 -0
  1118. package/umd/persisters/persister-partykit-client/with-schemas/index.js +1 -0
  1119. package/umd/persisters/persister-partykit-server/index.js +1 -0
  1120. package/umd/persisters/persister-partykit-server/index.js.gz +0 -0
  1121. package/umd/persisters/persister-partykit-server/with-schemas/index.js +1 -0
  1122. package/umd/persisters/persister-powersync/index.js +1 -0
  1123. package/umd/persisters/persister-powersync/index.js.gz +0 -0
  1124. package/umd/persisters/persister-powersync/with-schemas/index.js +1 -0
  1125. package/umd/persisters/persister-remote/index.js +1 -0
  1126. package/umd/persisters/persister-remote/index.js.gz +0 -0
  1127. package/umd/persisters/persister-remote/with-schemas/index.js +1 -0
  1128. package/umd/persisters/persister-sqlite-wasm/index.js +1 -0
  1129. package/umd/persisters/persister-sqlite-wasm/index.js.gz +0 -0
  1130. package/umd/persisters/persister-sqlite-wasm/with-schemas/index.js +1 -0
  1131. package/umd/persisters/persister-sqlite3/index.js +1 -0
  1132. package/umd/persisters/persister-sqlite3/index.js.gz +0 -0
  1133. package/umd/persisters/persister-sqlite3/with-schemas/index.js +1 -0
  1134. package/umd/persisters/persister-yjs/index.js +1 -0
  1135. package/umd/persisters/persister-yjs/index.js.gz +0 -0
  1136. package/umd/persisters/persister-yjs/with-schemas/index.js +1 -0
  1137. package/umd/persisters/with-schemas/index.js +1 -0
  1138. package/umd/queries/index.js +1 -0
  1139. package/umd/queries/index.js.gz +0 -0
  1140. package/umd/queries/with-schemas/index.js +1 -0
  1141. package/umd/relationships/index.js +1 -0
  1142. package/umd/relationships/index.js.gz +0 -0
  1143. package/umd/relationships/with-schemas/index.js +1 -0
  1144. package/umd/store/index.js +1 -0
  1145. package/umd/store/index.js.gz +0 -0
  1146. package/umd/store/with-schemas/index.js +1 -0
  1147. package/umd/synchronizers/index.js +1 -0
  1148. package/umd/synchronizers/index.js.gz +0 -0
  1149. package/umd/synchronizers/synchronizer-local/index.js +1 -0
  1150. package/umd/synchronizers/synchronizer-local/index.js.gz +0 -0
  1151. package/umd/synchronizers/synchronizer-local/with-schemas/index.js +1 -0
  1152. package/umd/synchronizers/synchronizer-ws-client/index.js +1 -0
  1153. package/umd/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
  1154. package/umd/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -0
  1155. package/umd/synchronizers/synchronizer-ws-server/index.js +1 -0
  1156. package/umd/synchronizers/synchronizer-ws-server/index.js.gz +0 -0
  1157. package/umd/synchronizers/synchronizer-ws-server/with-schemas/index.js +1 -0
  1158. package/umd/synchronizers/with-schemas/index.js +1 -0
  1159. package/umd/tools/index.js +1 -0
  1160. package/umd/tools/index.js.gz +0 -0
  1161. package/umd/tools/with-schemas/index.js +1 -0
  1162. package/umd/ui-react/index.js +1 -0
  1163. package/umd/ui-react/index.js.gz +0 -0
  1164. package/umd/ui-react/with-schemas/index.js +1 -0
  1165. package/umd/ui-react-dom/index.js +1 -0
  1166. package/umd/ui-react-dom/index.js.gz +0 -0
  1167. package/umd/ui-react-dom/with-schemas/index.js +1 -0
  1168. package/umd/ui-react-inspector/index.js +1 -0
  1169. package/umd/ui-react-inspector/index.js.gz +0 -0
  1170. package/umd/ui-react-inspector/with-schemas/index.js +1 -0
  1171. package/umd/with-schemas/index.js +1 -0
  1172. package/with-schemas/index.js +1 -0
  1173. package/bin/cli.js +0 -2
  1174. package/lib/checkpoints.js +0 -1
  1175. package/lib/checkpoints.js.gz +0 -0
  1176. package/lib/cjs/checkpoints.cjs +0 -1
  1177. package/lib/cjs/checkpoints.cjs.gz +0 -0
  1178. package/lib/cjs/common.cjs +0 -1
  1179. package/lib/cjs/common.cjs.gz +0 -0
  1180. package/lib/cjs/indexes.cjs +0 -1
  1181. package/lib/cjs/indexes.cjs.gz +0 -0
  1182. package/lib/cjs/mergeable-store.cjs +0 -1
  1183. package/lib/cjs/mergeable-store.cjs.gz +0 -0
  1184. package/lib/cjs/metrics.cjs +0 -1
  1185. package/lib/cjs/metrics.cjs.gz +0 -0
  1186. package/lib/cjs/persisters/persister-automerge.cjs +0 -1
  1187. package/lib/cjs/persisters/persister-automerge.cjs.gz +0 -0
  1188. package/lib/cjs/persisters/persister-browser.cjs +0 -1
  1189. package/lib/cjs/persisters/persister-browser.cjs.gz +0 -0
  1190. package/lib/cjs/persisters/persister-cr-sqlite-wasm.cjs +0 -1
  1191. package/lib/cjs/persisters/persister-cr-sqlite-wasm.cjs.gz +0 -0
  1192. package/lib/cjs/persisters/persister-electric-sql.cjs +0 -1
  1193. package/lib/cjs/persisters/persister-electric-sql.cjs.gz +0 -0
  1194. package/lib/cjs/persisters/persister-expo-sqlite-next.cjs +0 -1
  1195. package/lib/cjs/persisters/persister-expo-sqlite-next.cjs.gz +0 -0
  1196. package/lib/cjs/persisters/persister-expo-sqlite.cjs +0 -1
  1197. package/lib/cjs/persisters/persister-expo-sqlite.cjs.gz +0 -0
  1198. package/lib/cjs/persisters/persister-file.cjs +0 -1
  1199. package/lib/cjs/persisters/persister-file.cjs.gz +0 -0
  1200. package/lib/cjs/persisters/persister-indexed-db.cjs +0 -1
  1201. package/lib/cjs/persisters/persister-indexed-db.cjs.gz +0 -0
  1202. package/lib/cjs/persisters/persister-partykit-client.cjs +0 -1
  1203. package/lib/cjs/persisters/persister-partykit-client.cjs.gz +0 -0
  1204. package/lib/cjs/persisters/persister-partykit-server.cjs +0 -1
  1205. package/lib/cjs/persisters/persister-partykit-server.cjs.gz +0 -0
  1206. package/lib/cjs/persisters/persister-remote.cjs +0 -1
  1207. package/lib/cjs/persisters/persister-remote.cjs.gz +0 -0
  1208. package/lib/cjs/persisters/persister-sqlite-wasm.cjs +0 -1
  1209. package/lib/cjs/persisters/persister-sqlite-wasm.cjs.gz +0 -0
  1210. package/lib/cjs/persisters/persister-sqlite3.cjs +0 -1
  1211. package/lib/cjs/persisters/persister-sqlite3.cjs.gz +0 -0
  1212. package/lib/cjs/persisters/persister-yjs.cjs +0 -1
  1213. package/lib/cjs/persisters/persister-yjs.cjs.gz +0 -0
  1214. package/lib/cjs/persisters.cjs +0 -1
  1215. package/lib/cjs/persisters.cjs.gz +0 -0
  1216. package/lib/cjs/queries.cjs +0 -1
  1217. package/lib/cjs/queries.cjs.gz +0 -0
  1218. package/lib/cjs/relationships.cjs +0 -1
  1219. package/lib/cjs/relationships.cjs.gz +0 -0
  1220. package/lib/cjs/store.cjs +0 -1
  1221. package/lib/cjs/store.cjs.gz +0 -0
  1222. package/lib/cjs/tinybase.cjs +0 -1
  1223. package/lib/cjs/tinybase.cjs.gz +0 -0
  1224. package/lib/cjs/tools.cjs +0 -1
  1225. package/lib/cjs/tools.cjs.gz +0 -0
  1226. package/lib/cjs/ui-react-dom-debug.cjs +0 -1
  1227. package/lib/cjs/ui-react-dom-debug.cjs.gz +0 -0
  1228. package/lib/cjs/ui-react-dom.cjs +0 -1
  1229. package/lib/cjs/ui-react-dom.cjs.gz +0 -0
  1230. package/lib/cjs/ui-react.cjs +0 -1
  1231. package/lib/cjs/ui-react.cjs.gz +0 -0
  1232. package/lib/cjs-es6/checkpoints.cjs +0 -1
  1233. package/lib/cjs-es6/checkpoints.cjs.gz +0 -0
  1234. package/lib/cjs-es6/common.cjs +0 -1
  1235. package/lib/cjs-es6/common.cjs.gz +0 -0
  1236. package/lib/cjs-es6/indexes.cjs +0 -1
  1237. package/lib/cjs-es6/indexes.cjs.gz +0 -0
  1238. package/lib/cjs-es6/mergeable-store.cjs +0 -1
  1239. package/lib/cjs-es6/mergeable-store.cjs.gz +0 -0
  1240. package/lib/cjs-es6/metrics.cjs +0 -1
  1241. package/lib/cjs-es6/metrics.cjs.gz +0 -0
  1242. package/lib/cjs-es6/persisters/persister-automerge.cjs +0 -1
  1243. package/lib/cjs-es6/persisters/persister-automerge.cjs.gz +0 -0
  1244. package/lib/cjs-es6/persisters/persister-browser.cjs +0 -1
  1245. package/lib/cjs-es6/persisters/persister-browser.cjs.gz +0 -0
  1246. package/lib/cjs-es6/persisters/persister-cr-sqlite-wasm.cjs +0 -1
  1247. package/lib/cjs-es6/persisters/persister-cr-sqlite-wasm.cjs.gz +0 -0
  1248. package/lib/cjs-es6/persisters/persister-electric-sql.cjs +0 -1
  1249. package/lib/cjs-es6/persisters/persister-electric-sql.cjs.gz +0 -0
  1250. package/lib/cjs-es6/persisters/persister-expo-sqlite-next.cjs +0 -1
  1251. package/lib/cjs-es6/persisters/persister-expo-sqlite-next.cjs.gz +0 -0
  1252. package/lib/cjs-es6/persisters/persister-expo-sqlite.cjs +0 -1
  1253. package/lib/cjs-es6/persisters/persister-expo-sqlite.cjs.gz +0 -0
  1254. package/lib/cjs-es6/persisters/persister-file.cjs +0 -1
  1255. package/lib/cjs-es6/persisters/persister-file.cjs.gz +0 -0
  1256. package/lib/cjs-es6/persisters/persister-indexed-db.cjs +0 -1
  1257. package/lib/cjs-es6/persisters/persister-indexed-db.cjs.gz +0 -0
  1258. package/lib/cjs-es6/persisters/persister-partykit-client.cjs +0 -1
  1259. package/lib/cjs-es6/persisters/persister-partykit-client.cjs.gz +0 -0
  1260. package/lib/cjs-es6/persisters/persister-partykit-server.cjs +0 -1
  1261. package/lib/cjs-es6/persisters/persister-partykit-server.cjs.gz +0 -0
  1262. package/lib/cjs-es6/persisters/persister-remote.cjs +0 -1
  1263. package/lib/cjs-es6/persisters/persister-remote.cjs.gz +0 -0
  1264. package/lib/cjs-es6/persisters/persister-sqlite-wasm.cjs +0 -1
  1265. package/lib/cjs-es6/persisters/persister-sqlite-wasm.cjs.gz +0 -0
  1266. package/lib/cjs-es6/persisters/persister-sqlite3.cjs +0 -1
  1267. package/lib/cjs-es6/persisters/persister-sqlite3.cjs.gz +0 -0
  1268. package/lib/cjs-es6/persisters/persister-yjs.cjs +0 -1
  1269. package/lib/cjs-es6/persisters/persister-yjs.cjs.gz +0 -0
  1270. package/lib/cjs-es6/persisters.cjs +0 -1
  1271. package/lib/cjs-es6/persisters.cjs.gz +0 -0
  1272. package/lib/cjs-es6/queries.cjs +0 -1
  1273. package/lib/cjs-es6/queries.cjs.gz +0 -0
  1274. package/lib/cjs-es6/relationships.cjs +0 -1
  1275. package/lib/cjs-es6/relationships.cjs.gz +0 -0
  1276. package/lib/cjs-es6/store.cjs +0 -1
  1277. package/lib/cjs-es6/store.cjs.gz +0 -0
  1278. package/lib/cjs-es6/tinybase.cjs +0 -1
  1279. package/lib/cjs-es6/tinybase.cjs.gz +0 -0
  1280. package/lib/cjs-es6/tools.cjs +0 -1
  1281. package/lib/cjs-es6/tools.cjs.gz +0 -0
  1282. package/lib/cjs-es6/ui-react-dom-debug.cjs +0 -1
  1283. package/lib/cjs-es6/ui-react-dom-debug.cjs.gz +0 -0
  1284. package/lib/cjs-es6/ui-react-dom.cjs +0 -1
  1285. package/lib/cjs-es6/ui-react-dom.cjs.gz +0 -0
  1286. package/lib/cjs-es6/ui-react.cjs +0 -1
  1287. package/lib/cjs-es6/ui-react.cjs.gz +0 -0
  1288. package/lib/common.js +0 -1
  1289. package/lib/common.js.gz +0 -0
  1290. package/lib/debug/checkpoints.js +0 -429
  1291. package/lib/debug/common.js +0 -4
  1292. package/lib/debug/indexes.js +0 -546
  1293. package/lib/debug/mergeable-store.js +0 -1892
  1294. package/lib/debug/metrics.js +0 -518
  1295. package/lib/debug/persisters/persister-automerge.js +0 -341
  1296. package/lib/debug/persisters/persister-browser.js +0 -228
  1297. package/lib/debug/persisters/persister-cr-sqlite-wasm.js +0 -850
  1298. package/lib/debug/persisters/persister-electric-sql.js +0 -858
  1299. package/lib/debug/persisters/persister-expo-sqlite-next.js +0 -853
  1300. package/lib/debug/persisters/persister-expo-sqlite.js +0 -851
  1301. package/lib/debug/persisters/persister-file.js +0 -213
  1302. package/lib/debug/persisters/persister-indexed-db.js +0 -296
  1303. package/lib/debug/persisters/persister-partykit-client.js +0 -284
  1304. package/lib/debug/persisters/persister-partykit-server.js +0 -292
  1305. package/lib/debug/persisters/persister-remote.js +0 -241
  1306. package/lib/debug/persisters/persister-sqlite-wasm.js +0 -859
  1307. package/lib/debug/persisters/persister-sqlite3.js +0 -861
  1308. package/lib/debug/persisters/persister-yjs.js +0 -386
  1309. package/lib/debug/persisters.js +0 -184
  1310. package/lib/debug/queries.js +0 -810
  1311. package/lib/debug/relationships.js +0 -528
  1312. package/lib/debug/store.js +0 -1614
  1313. package/lib/debug/tinybase.js +0 -3507
  1314. package/lib/debug/tools.js +0 -3299
  1315. package/lib/debug/ui-react-dom.js +0 -3251
  1316. package/lib/debug/ui-react.js +0 -1944
  1317. package/lib/es6/checkpoints.js +0 -1
  1318. package/lib/es6/checkpoints.js.gz +0 -0
  1319. package/lib/es6/common.js +0 -1
  1320. package/lib/es6/common.js.gz +0 -0
  1321. package/lib/es6/indexes.js +0 -1
  1322. package/lib/es6/indexes.js.gz +0 -0
  1323. package/lib/es6/mergeable-store.js +0 -1
  1324. package/lib/es6/mergeable-store.js.gz +0 -0
  1325. package/lib/es6/metrics.js +0 -1
  1326. package/lib/es6/metrics.js.gz +0 -0
  1327. package/lib/es6/persisters/persister-automerge.js +0 -1
  1328. package/lib/es6/persisters/persister-automerge.js.gz +0 -0
  1329. package/lib/es6/persisters/persister-browser.js +0 -1
  1330. package/lib/es6/persisters/persister-browser.js.gz +0 -0
  1331. package/lib/es6/persisters/persister-cr-sqlite-wasm.js +0 -1
  1332. package/lib/es6/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
  1333. package/lib/es6/persisters/persister-electric-sql.js +0 -1
  1334. package/lib/es6/persisters/persister-electric-sql.js.gz +0 -0
  1335. package/lib/es6/persisters/persister-expo-sqlite-next.js +0 -1
  1336. package/lib/es6/persisters/persister-expo-sqlite-next.js.gz +0 -0
  1337. package/lib/es6/persisters/persister-expo-sqlite.js +0 -1
  1338. package/lib/es6/persisters/persister-expo-sqlite.js.gz +0 -0
  1339. package/lib/es6/persisters/persister-file.js +0 -1
  1340. package/lib/es6/persisters/persister-file.js.gz +0 -0
  1341. package/lib/es6/persisters/persister-indexed-db.js +0 -1
  1342. package/lib/es6/persisters/persister-indexed-db.js.gz +0 -0
  1343. package/lib/es6/persisters/persister-partykit-client.js +0 -1
  1344. package/lib/es6/persisters/persister-partykit-client.js.gz +0 -0
  1345. package/lib/es6/persisters/persister-partykit-server.js +0 -1
  1346. package/lib/es6/persisters/persister-partykit-server.js.gz +0 -0
  1347. package/lib/es6/persisters/persister-remote.js +0 -1
  1348. package/lib/es6/persisters/persister-remote.js.gz +0 -0
  1349. package/lib/es6/persisters/persister-sqlite-wasm.js +0 -1
  1350. package/lib/es6/persisters/persister-sqlite-wasm.js.gz +0 -0
  1351. package/lib/es6/persisters/persister-sqlite3.js +0 -1
  1352. package/lib/es6/persisters/persister-sqlite3.js.gz +0 -0
  1353. package/lib/es6/persisters/persister-yjs.js +0 -1
  1354. package/lib/es6/persisters/persister-yjs.js.gz +0 -0
  1355. package/lib/es6/persisters.js +0 -1
  1356. package/lib/es6/persisters.js.gz +0 -0
  1357. package/lib/es6/queries.js +0 -1
  1358. package/lib/es6/queries.js.gz +0 -0
  1359. package/lib/es6/relationships.js +0 -1
  1360. package/lib/es6/relationships.js.gz +0 -0
  1361. package/lib/es6/store.js +0 -1
  1362. package/lib/es6/store.js.gz +0 -0
  1363. package/lib/es6/tinybase.js +0 -1
  1364. package/lib/es6/tinybase.js.gz +0 -0
  1365. package/lib/es6/tools.js +0 -1
  1366. package/lib/es6/tools.js.gz +0 -0
  1367. package/lib/es6/ui-react-dom-debug.js +0 -1
  1368. package/lib/es6/ui-react-dom-debug.js.gz +0 -0
  1369. package/lib/es6/ui-react-dom.js +0 -1
  1370. package/lib/es6/ui-react-dom.js.gz +0 -0
  1371. package/lib/es6/ui-react.js +0 -1
  1372. package/lib/es6/ui-react.js.gz +0 -0
  1373. package/lib/indexes.js +0 -1
  1374. package/lib/indexes.js.gz +0 -0
  1375. package/lib/mergeable-store.js +0 -1
  1376. package/lib/mergeable-store.js.gz +0 -0
  1377. package/lib/metrics.js +0 -1
  1378. package/lib/metrics.js.gz +0 -0
  1379. package/lib/persisters/persister-automerge.js +0 -1
  1380. package/lib/persisters/persister-automerge.js.gz +0 -0
  1381. package/lib/persisters/persister-browser.js +0 -1
  1382. package/lib/persisters/persister-browser.js.gz +0 -0
  1383. package/lib/persisters/persister-cr-sqlite-wasm.js +0 -1
  1384. package/lib/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
  1385. package/lib/persisters/persister-electric-sql.js +0 -1
  1386. package/lib/persisters/persister-electric-sql.js.gz +0 -0
  1387. package/lib/persisters/persister-expo-sqlite-next.js +0 -1
  1388. package/lib/persisters/persister-expo-sqlite-next.js.gz +0 -0
  1389. package/lib/persisters/persister-expo-sqlite.js +0 -1
  1390. package/lib/persisters/persister-expo-sqlite.js.gz +0 -0
  1391. package/lib/persisters/persister-file.js +0 -1
  1392. package/lib/persisters/persister-file.js.gz +0 -0
  1393. package/lib/persisters/persister-indexed-db.js +0 -1
  1394. package/lib/persisters/persister-indexed-db.js.gz +0 -0
  1395. package/lib/persisters/persister-partykit-client.js +0 -1
  1396. package/lib/persisters/persister-partykit-client.js.gz +0 -0
  1397. package/lib/persisters/persister-partykit-server.js +0 -1
  1398. package/lib/persisters/persister-partykit-server.js.gz +0 -0
  1399. package/lib/persisters/persister-remote.js +0 -1
  1400. package/lib/persisters/persister-remote.js.gz +0 -0
  1401. package/lib/persisters/persister-sqlite-wasm.js +0 -1
  1402. package/lib/persisters/persister-sqlite-wasm.js.gz +0 -0
  1403. package/lib/persisters/persister-sqlite3.js +0 -1
  1404. package/lib/persisters/persister-sqlite3.js.gz +0 -0
  1405. package/lib/persisters/persister-yjs.js +0 -1
  1406. package/lib/persisters/persister-yjs.js.gz +0 -0
  1407. package/lib/persisters.js +0 -1
  1408. package/lib/persisters.js.gz +0 -0
  1409. package/lib/queries.js +0 -1
  1410. package/lib/queries.js.gz +0 -0
  1411. package/lib/relationships.js +0 -1
  1412. package/lib/relationships.js.gz +0 -0
  1413. package/lib/store.js +0 -1
  1414. package/lib/store.js.gz +0 -0
  1415. package/lib/tinybase.js +0 -1
  1416. package/lib/tinybase.js.gz +0 -0
  1417. package/lib/tools.js +0 -1
  1418. package/lib/tools.js.gz +0 -0
  1419. package/lib/types/checkpoints.d.ts +0 -986
  1420. package/lib/types/common.d.ts +0 -106
  1421. package/lib/types/indexes.d.ts +0 -993
  1422. package/lib/types/mergeable-store.d.ts +0 -55
  1423. package/lib/types/metrics.d.ts +0 -856
  1424. package/lib/types/persisters/persister-automerge.d.ts +0 -146
  1425. package/lib/types/persisters/persister-browser.d.ts +0 -155
  1426. package/lib/types/persisters/persister-cr-sqlite-wasm.d.ts +0 -142
  1427. package/lib/types/persisters/persister-electric-sql.d.ts +0 -165
  1428. package/lib/types/persisters/persister-expo-sqlite-next.d.ts +0 -169
  1429. package/lib/types/persisters/persister-expo-sqlite.d.ts +0 -170
  1430. package/lib/types/persisters/persister-file.d.ts +0 -78
  1431. package/lib/types/persisters/persister-indexed-db.d.ts +0 -107
  1432. package/lib/types/persisters/persister-partykit-client.d.ts +0 -175
  1433. package/lib/types/persisters/persister-partykit-server.d.ts +0 -604
  1434. package/lib/types/persisters/persister-remote.d.ts +0 -104
  1435. package/lib/types/persisters/persister-sqlite-wasm.d.ts +0 -154
  1436. package/lib/types/persisters/persister-sqlite3.d.ts +0 -155
  1437. package/lib/types/persisters/persister-yjs.d.ts +0 -142
  1438. package/lib/types/persisters.d.ts +0 -1137
  1439. package/lib/types/queries.d.ts +0 -3506
  1440. package/lib/types/relationships.d.ts +0 -1242
  1441. package/lib/types/store.d.ts +0 -6967
  1442. package/lib/types/tinybase.d.ts +0 -14
  1443. package/lib/types/tools.d.ts +0 -521
  1444. package/lib/types/ui-react-dom.d.ts +0 -1705
  1445. package/lib/types/ui-react.d.ts +0 -13695
  1446. package/lib/types/with-schemas/checkpoints.d.ts +0 -1078
  1447. package/lib/types/with-schemas/common.d.ts +0 -106
  1448. package/lib/types/with-schemas/indexes.d.ts +0 -1131
  1449. package/lib/types/with-schemas/internal/queries.d.ts +0 -16
  1450. package/lib/types/with-schemas/internal/store.d.ts +0 -106
  1451. package/lib/types/with-schemas/internal/ui-react.d.ts +0 -806
  1452. package/lib/types/with-schemas/mergeable-store.d.ts +0 -85
  1453. package/lib/types/with-schemas/metrics.d.ts +0 -936
  1454. package/lib/types/with-schemas/persisters/persister-automerge.d.ts +0 -158
  1455. package/lib/types/with-schemas/persisters/persister-browser.d.ts +0 -177
  1456. package/lib/types/with-schemas/persisters/persister-cr-sqlite-wasm.d.ts +0 -155
  1457. package/lib/types/with-schemas/persisters/persister-electric-sql.d.ts +0 -178
  1458. package/lib/types/with-schemas/persisters/persister-expo-sqlite-next.d.ts +0 -182
  1459. package/lib/types/with-schemas/persisters/persister-expo-sqlite.d.ts +0 -183
  1460. package/lib/types/with-schemas/persisters/persister-file.d.ts +0 -89
  1461. package/lib/types/with-schemas/persisters/persister-indexed-db.d.ts +0 -119
  1462. package/lib/types/with-schemas/persisters/persister-partykit-client.d.ts +0 -187
  1463. package/lib/types/with-schemas/persisters/persister-partykit-server.d.ts +0 -652
  1464. package/lib/types/with-schemas/persisters/persister-remote.d.ts +0 -117
  1465. package/lib/types/with-schemas/persisters/persister-sqlite-wasm.d.ts +0 -168
  1466. package/lib/types/with-schemas/persisters/persister-sqlite3.d.ts +0 -168
  1467. package/lib/types/with-schemas/persisters/persister-yjs.d.ts +0 -154
  1468. package/lib/types/with-schemas/persisters.d.ts +0 -1242
  1469. package/lib/types/with-schemas/queries.d.ts +0 -3827
  1470. package/lib/types/with-schemas/relationships.d.ts +0 -1393
  1471. package/lib/types/with-schemas/store.d.ts +0 -8639
  1472. package/lib/types/with-schemas/tinybase.d.ts +0 -14
  1473. package/lib/types/with-schemas/tools.d.ts +0 -532
  1474. package/lib/types/with-schemas/ui-react-dom.d.ts +0 -1834
  1475. package/lib/types/with-schemas/ui-react.d.ts +0 -14595
  1476. package/lib/ui-react-dom.js +0 -1
  1477. package/lib/ui-react-dom.js.gz +0 -0
  1478. package/lib/ui-react.js +0 -1
  1479. package/lib/ui-react.js.gz +0 -0
  1480. package/lib/umd/checkpoints.js +0 -1
  1481. package/lib/umd/checkpoints.js.gz +0 -0
  1482. package/lib/umd/common.js +0 -1
  1483. package/lib/umd/common.js.gz +0 -0
  1484. package/lib/umd/indexes.js +0 -1
  1485. package/lib/umd/indexes.js.gz +0 -0
  1486. package/lib/umd/mergeable-store.js +0 -1
  1487. package/lib/umd/mergeable-store.js.gz +0 -0
  1488. package/lib/umd/metrics.js +0 -1
  1489. package/lib/umd/metrics.js.gz +0 -0
  1490. package/lib/umd/persisters/persister-automerge.js +0 -1
  1491. package/lib/umd/persisters/persister-automerge.js.gz +0 -0
  1492. package/lib/umd/persisters/persister-browser.js +0 -1
  1493. package/lib/umd/persisters/persister-browser.js.gz +0 -0
  1494. package/lib/umd/persisters/persister-cr-sqlite-wasm.js +0 -1
  1495. package/lib/umd/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
  1496. package/lib/umd/persisters/persister-electric-sql.js +0 -1
  1497. package/lib/umd/persisters/persister-electric-sql.js.gz +0 -0
  1498. package/lib/umd/persisters/persister-expo-sqlite-next.js +0 -1
  1499. package/lib/umd/persisters/persister-expo-sqlite-next.js.gz +0 -0
  1500. package/lib/umd/persisters/persister-expo-sqlite.js +0 -1
  1501. package/lib/umd/persisters/persister-expo-sqlite.js.gz +0 -0
  1502. package/lib/umd/persisters/persister-file.js +0 -1
  1503. package/lib/umd/persisters/persister-file.js.gz +0 -0
  1504. package/lib/umd/persisters/persister-indexed-db.js +0 -1
  1505. package/lib/umd/persisters/persister-indexed-db.js.gz +0 -0
  1506. package/lib/umd/persisters/persister-partykit-client.js +0 -1
  1507. package/lib/umd/persisters/persister-partykit-client.js.gz +0 -0
  1508. package/lib/umd/persisters/persister-partykit-server.js +0 -1
  1509. package/lib/umd/persisters/persister-partykit-server.js.gz +0 -0
  1510. package/lib/umd/persisters/persister-remote.js +0 -1
  1511. package/lib/umd/persisters/persister-remote.js.gz +0 -0
  1512. package/lib/umd/persisters/persister-sqlite-wasm.js +0 -1
  1513. package/lib/umd/persisters/persister-sqlite-wasm.js.gz +0 -0
  1514. package/lib/umd/persisters/persister-sqlite3.js +0 -1
  1515. package/lib/umd/persisters/persister-sqlite3.js.gz +0 -0
  1516. package/lib/umd/persisters/persister-yjs.js +0 -1
  1517. package/lib/umd/persisters/persister-yjs.js.gz +0 -0
  1518. package/lib/umd/persisters.js +0 -1
  1519. package/lib/umd/persisters.js.gz +0 -0
  1520. package/lib/umd/queries.js +0 -1
  1521. package/lib/umd/queries.js.gz +0 -0
  1522. package/lib/umd/relationships.js +0 -1
  1523. package/lib/umd/relationships.js.gz +0 -0
  1524. package/lib/umd/store.js +0 -1
  1525. package/lib/umd/store.js.gz +0 -0
  1526. package/lib/umd/tinybase.js +0 -1
  1527. package/lib/umd/tinybase.js.gz +0 -0
  1528. package/lib/umd/tools.js +0 -1
  1529. package/lib/umd/tools.js.gz +0 -0
  1530. package/lib/umd/ui-react-dom-debug.js +0 -1
  1531. package/lib/umd/ui-react-dom-debug.js.gz +0 -0
  1532. package/lib/umd/ui-react-dom.js +0 -1
  1533. package/lib/umd/ui-react-dom.js.gz +0 -0
  1534. package/lib/umd/ui-react.js +0 -1
  1535. package/lib/umd/ui-react.js.gz +0 -0
  1536. package/lib/umd-es6/checkpoints.js +0 -1
  1537. package/lib/umd-es6/checkpoints.js.gz +0 -0
  1538. package/lib/umd-es6/common.js +0 -1
  1539. package/lib/umd-es6/common.js.gz +0 -0
  1540. package/lib/umd-es6/indexes.js +0 -1
  1541. package/lib/umd-es6/indexes.js.gz +0 -0
  1542. package/lib/umd-es6/mergeable-store.js +0 -1
  1543. package/lib/umd-es6/mergeable-store.js.gz +0 -0
  1544. package/lib/umd-es6/metrics.js +0 -1
  1545. package/lib/umd-es6/metrics.js.gz +0 -0
  1546. package/lib/umd-es6/persisters/persister-automerge.js +0 -1
  1547. package/lib/umd-es6/persisters/persister-automerge.js.gz +0 -0
  1548. package/lib/umd-es6/persisters/persister-browser.js +0 -1
  1549. package/lib/umd-es6/persisters/persister-browser.js.gz +0 -0
  1550. package/lib/umd-es6/persisters/persister-cr-sqlite-wasm.js +0 -1
  1551. package/lib/umd-es6/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
  1552. package/lib/umd-es6/persisters/persister-electric-sql.js +0 -1
  1553. package/lib/umd-es6/persisters/persister-electric-sql.js.gz +0 -0
  1554. package/lib/umd-es6/persisters/persister-expo-sqlite-next.js +0 -1
  1555. package/lib/umd-es6/persisters/persister-expo-sqlite-next.js.gz +0 -0
  1556. package/lib/umd-es6/persisters/persister-expo-sqlite.js +0 -1
  1557. package/lib/umd-es6/persisters/persister-expo-sqlite.js.gz +0 -0
  1558. package/lib/umd-es6/persisters/persister-file.js +0 -1
  1559. package/lib/umd-es6/persisters/persister-file.js.gz +0 -0
  1560. package/lib/umd-es6/persisters/persister-indexed-db.js +0 -1
  1561. package/lib/umd-es6/persisters/persister-indexed-db.js.gz +0 -0
  1562. package/lib/umd-es6/persisters/persister-partykit-client.js +0 -1
  1563. package/lib/umd-es6/persisters/persister-partykit-client.js.gz +0 -0
  1564. package/lib/umd-es6/persisters/persister-partykit-server.js +0 -1
  1565. package/lib/umd-es6/persisters/persister-partykit-server.js.gz +0 -0
  1566. package/lib/umd-es6/persisters/persister-remote.js +0 -1
  1567. package/lib/umd-es6/persisters/persister-remote.js.gz +0 -0
  1568. package/lib/umd-es6/persisters/persister-sqlite-wasm.js +0 -1
  1569. package/lib/umd-es6/persisters/persister-sqlite-wasm.js.gz +0 -0
  1570. package/lib/umd-es6/persisters/persister-sqlite3.js +0 -1
  1571. package/lib/umd-es6/persisters/persister-sqlite3.js.gz +0 -0
  1572. package/lib/umd-es6/persisters/persister-yjs.js +0 -1
  1573. package/lib/umd-es6/persisters/persister-yjs.js.gz +0 -0
  1574. package/lib/umd-es6/persisters.js +0 -1
  1575. package/lib/umd-es6/persisters.js.gz +0 -0
  1576. package/lib/umd-es6/queries.js +0 -1
  1577. package/lib/umd-es6/queries.js.gz +0 -0
  1578. package/lib/umd-es6/relationships.js +0 -1
  1579. package/lib/umd-es6/relationships.js.gz +0 -0
  1580. package/lib/umd-es6/store.js +0 -1
  1581. package/lib/umd-es6/store.js.gz +0 -0
  1582. package/lib/umd-es6/tinybase.js +0 -1
  1583. package/lib/umd-es6/tinybase.js.gz +0 -0
  1584. package/lib/umd-es6/tools.js +0 -1
  1585. package/lib/umd-es6/tools.js.gz +0 -0
  1586. package/lib/umd-es6/ui-react-dom-debug.js +0 -1
  1587. package/lib/umd-es6/ui-react-dom-debug.js.gz +0 -0
  1588. package/lib/umd-es6/ui-react-dom.js +0 -1
  1589. package/lib/umd-es6/ui-react-dom.js.gz +0 -0
  1590. package/lib/umd-es6/ui-react.js +0 -1
  1591. package/lib/umd-es6/ui-react.js.gz +0 -0
@@ -1,3506 +0,0 @@
1
- /**
2
- * The queries module of the TinyBase project provides the ability to create and
3
- * track queries of the data in Store objects.
4
- *
5
- * The main entry point to using the queries module is the createQueries
6
- * function, which returns a new Queries object. That object in turn has methods
7
- * that let you create new query definitions, access their results directly, and
8
- * register listeners for when those results change.
9
- * @packageDocumentation
10
- * @module queries
11
- * @since v2.0.0
12
- */
13
-
14
- import {Cell, CellOrUndefined, GetCell, GetIdChanges, Store} from './store.d';
15
- import {Id, IdOrNull, Ids} from './common.d';
16
-
17
- /**
18
- * The ResultTable type is the data structure representing the results of a
19
- * query.
20
- *
21
- * A ResultTable is typically accessed with the getResultTable method or
22
- * addResultTableListener method. It is similar to the Table type in the store
23
- * module, but without schema-specific typing, and is a regular JavaScript
24
- * object containing individual ResultRow objects, keyed by their Id.
25
- * @example
26
- * ```js
27
- * const resultTable: ResultTable = {
28
- * fido: {species: 'dog', color: 'brown'},
29
- * felix: {species: 'cat'},
30
- * };
31
- * ```
32
- * @category Result
33
- */
34
- export type ResultTable = {[rowId: Id]: ResultRow};
35
-
36
- /**
37
- * The ResultRow type is the data structure representing a single row in the
38
- * results of a query.
39
- *
40
- * A ResultRow is typically accessed with the getResultRow method or
41
- * addResultRowListener method. It is similar to the Row type in the store
42
- * module, but without schema-specific typing, and is a regular JavaScript
43
- * object containing individual ResultCell objects, keyed by their Id.
44
- * @example
45
- * ```js
46
- * const resultRow: ResultRow = {species: 'dog', color: 'brown'};
47
- * ```
48
- * @category Result
49
- */
50
- export type ResultRow = {[cellId: Id]: ResultCell};
51
-
52
- /**
53
- * The ResultCell type is the data structure representing a single cell in the
54
- * results of a query.
55
- *
56
- * A ResultCell is typically accessed with the getResultCell method or
57
- * addResultCellListener method. It is similar to the Cell type in the store
58
- * module, but without schema-specific typing, and is a JavaScript string,
59
- * number, or boolean.
60
- * @example
61
- * ```js
62
- * const resultCell: ResultCell = 'dog';
63
- * ```
64
- * @category Result
65
- */
66
- export type ResultCell = string | number | boolean;
67
-
68
- /**
69
- * The ResultCellOrUndefined type is the data structure representing a single
70
- * cell in the results of a query, or the value `undefined`.
71
- * @category Result
72
- */
73
- export type ResultCellOrUndefined = ResultCell | undefined;
74
-
75
- /**
76
- * The Aggregate type describes a custom function that takes an array of Cell
77
- * values and returns an aggregate of them.
78
- *
79
- * There are a number of common predefined aggregators, such as for counting,
80
- * summing, and averaging values. This type is instead used for when you wish to
81
- * use a more complex aggregation of your own devising.
82
- * @param cells The array of Cell values to be aggregated.
83
- * @param length The length of the array of Cell values to be aggregated.
84
- * @returns The value of the aggregation.
85
- * @category Aggregators
86
- * @since v2.0.0
87
- */
88
- export type Aggregate = (cells: Cell[], length: number) => ResultCell;
89
-
90
- /**
91
- * The AggregateAdd type describes a function that can be used to optimize a
92
- * custom Aggregate by providing a shortcut for when a single value is added to
93
- * the input values.
94
- *
95
- * Some aggregation functions do not need to recalculate the aggregation of the
96
- * whole set when one value changes. For example, when adding a new number to a
97
- * series, the new sum of the series is the new value added to the previous sum.
98
- *
99
- * If it is not possible to shortcut the aggregation based on just one value
100
- * being added, return `undefined` and the aggregation will be completely
101
- * recalculated.
102
- *
103
- * Where possible, if you are providing a custom Aggregate, seek an
104
- * implementation of an AggregateAdd function that can reduce the complexity
105
- * cost of growing the input data set.
106
- * @param current The current value of the aggregation.
107
- * @param add The Cell value being added to the aggregation.
108
- * @param length The length of the array of Cell values in the aggregation.
109
- * @returns The new value of the aggregation.
110
- * @category Aggregators
111
- * @since v2.0.0
112
- */
113
- export type AggregateAdd = (
114
- current: Cell,
115
- add: Cell,
116
- length: number,
117
- ) => ResultCellOrUndefined;
118
-
119
- /**
120
- * The AggregateRemove type describes a function that can be used to optimize a
121
- * custom Aggregate by providing a shortcut for when a single value is removed
122
- * from the input values.
123
- *
124
- * Some aggregation functions do not need to recalculate the aggregation of the
125
- * whole set when one value changes. For example, when removing a number from a
126
- * series, the new sum of the series is the new value subtracted from the
127
- * previous sum.
128
- *
129
- * If it is not possible to shortcut the aggregation based on just one value
130
- * being removed, return `undefined` and the aggregation will be completely
131
- * recalculated. One example might be if you were taking the minimum of the
132
- * values, and the previous minimum is being removed. The whole of the rest of
133
- * the list will need to be re-scanned to find a new minimum.
134
- *
135
- * Where possible, if you are providing a custom Aggregate, seek an
136
- * implementation of an AggregateRemove function that can reduce the complexity
137
- * cost of shrinking the input data set.
138
- * @param current The current value of the aggregation.
139
- * @param remove The Cell value being removed from the aggregation.
140
- * @param length The length of the array of Cell values in the aggregation.
141
- * @returns The new value of the aggregation.
142
- * @category Aggregators
143
- * @since v2.0.0
144
- */
145
- export type AggregateRemove = (
146
- current: Cell,
147
- remove: Cell,
148
- length: number,
149
- ) => ResultCellOrUndefined;
150
-
151
- /**
152
- * The AggregateReplace type describes a function that can be used to optimize a
153
- * custom Aggregate by providing a shortcut for when a single value in the input
154
- * values is replaced with another.
155
- *
156
- * Some aggregation functions do not need to recalculate the aggregation of the
157
- * whole set when one value changes. For example, when replacing a number in a
158
- * series, the new sum of the series is the previous sum, plus the new value,
159
- * minus the old value.
160
- *
161
- * If it is not possible to shortcut the aggregation based on just one value
162
- * changing, return `undefined` and the aggregation will be completely
163
- * recalculated.
164
- *
165
- * Where possible, if you are providing a custom Aggregate, seek an
166
- * implementation of an AggregateReplace function that can reduce the complexity
167
- * cost of changing the input data set in place.
168
- * @param current The current value of the aggregation.
169
- * @param add The Cell value being added to the aggregation.
170
- * @param remove The Cell value being removed from the aggregation.
171
- * @param length The length of the array of Cell values in the aggregation.
172
- * @returns The new value of the aggregation.
173
- * @category Aggregators
174
- * @since v2.0.0
175
- */
176
- export type AggregateReplace = (
177
- current: Cell,
178
- add: Cell,
179
- remove: Cell,
180
- length: number,
181
- ) => ResultCellOrUndefined;
182
-
183
- /**
184
- * The QueryCallback type describes a function that takes a query's Id.
185
- *
186
- * A QueryCallback is provided when using the forEachQuery method, so that you
187
- * can do something based on every query in the Queries object. See that method
188
- * for specific examples.
189
- * @param queryId The Id of the query that the callback can operate on.
190
- * @category Callback
191
- * @since v2.0.0
192
- */
193
- export type QueryCallback = (queryId: Id) => void;
194
-
195
- /**
196
- * The ResultTableCallback type describes a function that takes a ResultTable's
197
- * Id and a callback to loop over each ResultRow within it.
198
- *
199
- * A ResultTableCallback is provided when using the forEachResultTable method,
200
- * so that you can do something based on every ResultTable in the Queries
201
- * object. See that method for specific examples.
202
- * @param tableId The Id of the ResultTable that the callback can operate on.
203
- * @param forEachRow A function that will let you iterate over the ResultRow
204
- * objects in this ResultTable.
205
- * @category Callback
206
- */
207
- export type ResultTableCallback = (
208
- tableId: Id,
209
- forEachRow: (rowCallback: ResultRowCallback) => void,
210
- ) => void;
211
-
212
- /**
213
- * The ResultRowCallback type describes a function that takes a ResultRow's Id
214
- * and a callback to loop over each ResultCell within it.
215
- *
216
- * A ResultRowCallback is provided when using the forEachResultRow method, so
217
- * that you can do something based on every ResultRow in a ResultTable. See that
218
- * method for specific examples.
219
- * @param rowId The Id of the ResultRow that the callback can operate on.
220
- * @param forEachRow A function that will let you iterate over the ResultCell
221
- * values in this ResultRow.
222
- * @category Callback
223
- */
224
- export type ResultRowCallback = (
225
- rowId: Id,
226
- forEachCell: (cellCallback: ResultCellCallback) => void,
227
- ) => void;
228
-
229
- /**
230
- * The ResultCellCallback type describes a function that takes a ResultCell's Id
231
- * and its value.
232
- *
233
- * A ResultCellCallback is provided when using the forEachResultCell method, so
234
- * that you can do something based on every ResultCell in a ResultRow. See that
235
- * method for specific examples.
236
- * @param cellId The Id of the ResultCell that the callback can operate on.
237
- * @param cell The value of the ResultCell.
238
- * @category Callback
239
- */
240
- export type ResultCellCallback = (cellId: Id, cell: ResultCell) => void;
241
-
242
- /**
243
- * The QueryIdsListener type describes a function that is used to listen
244
- * to Query definitions being added or removed.
245
- *
246
- * A QueryIdsListener is provided when using the
247
- * addQueryIdsListener method. See that method for specific examples.
248
- *
249
- * When called, a QueryIdsListener is given a reference to the
250
- * Queries object.
251
- * @param queries A reference to the Queries object that changed.
252
- * @category Listener
253
- */
254
- export type QueryIdsListener = (queries: Queries) => void;
255
-
256
- /**
257
- * The ResultTableListener type describes a function that is used to listen to
258
- * changes to a query's ResultTable.
259
- *
260
- * A ResultTableListener is provided when using the addResultTableListener
261
- * method. See that method for specific examples.
262
- *
263
- * When called, a ResultTableListener is given a reference to the Queries
264
- * object, the Id of the ResultTable that changed (which is the same as the
265
- * query Id), and a GetResultCellChange function that can be used to query
266
- * ResultCell values before and after the change.
267
- *
268
- * You can create new query definitions within the body of this listener, though
269
- * obviously be aware of the possible cascading effects of doing so.
270
- * @param queries A reference to the Queries object that changed.
271
- * @param tableId The Id of the ResultTable that changed, which is also the
272
- * query Id.
273
- * @param getCellChange A function that returns information about any
274
- * ResultCell's changes.
275
- * @category Listener
276
- * @since v2.0.0
277
- */
278
- export type ResultTableListener = (
279
- queries: Queries,
280
- tableId: Id,
281
- getCellChange: GetResultCellChange,
282
- ) => void;
283
-
284
- /**
285
- * The ResultTableCellIdsListener type describes a function that is used to
286
- * listen to changes to the Cell Ids that appear anywhere in a query's
287
- * ResultTable.
288
- *
289
- * A ResultTableCellIdsListener is provided when using the
290
- * addResultTableCellIdsListener method. See that method for specific examples.
291
- *
292
- * When called, a ResultTableCellIdsListener is given a reference to the Queries
293
- * object, and the Id of the ResultTable whose Cell Ids changed (which is the
294
- * same as the query Id).
295
- *
296
- * You can create new query definitions within the body of this listener, though
297
- * obviously be aware of the possible cascading effects of doing so.
298
- * @param queries A reference to the Queries object that changed.
299
- * @param tableId The Id of the ResultTable that changed, which is also the
300
- * query Id.
301
- * @category Listener
302
- * @since v4.1.0
303
- */
304
- export type ResultTableCellIdsListener = (
305
- queries: Queries,
306
- tableId: Id,
307
- getIdChanges: GetIdChanges | undefined,
308
- ) => void;
309
-
310
- /**
311
- * The ResultRowCountListener type describes a function that is used to listen
312
- * to changes to the number of ResultRow objects in a query's ResultTable.
313
- *
314
- * A ResultRowCountListener is provided when using the addResultRowCountListener
315
- * method. See that method for specific examples.
316
- *
317
- * When called, a ResultRowCountListener is given a reference to the Queries
318
- * object, the Id of the ResultTable whose ResultRow Ids changed (which is the
319
- * same as the query Id), and the count of ResultRow objects in the ResultTable.
320
- *
321
- * You can create new query definitions within the body of this listener, though
322
- * obviously be aware of the possible cascading effects of doing so.
323
- * @param queries A reference to the Queries object that changed.
324
- * @param tableId The Id of the ResultTable that changed, which is also the
325
- * query Id.
326
- * @param count The number of ResultRow objects in the ResultTable
327
- * @category Listener
328
- * @since v4.1.0
329
- */
330
- export type ResultRowCountListener = (
331
- queries: Queries,
332
- tableId: Id,
333
- count: number,
334
- ) => void;
335
-
336
- /**
337
- * The ResultRowIdsListener type describes a function that is used to listen to
338
- * changes to the ResultRow Ids in a query's ResultTable.
339
- *
340
- * A ResultRowIdsListener is provided when using the addResultRowIdsListener
341
- * method. See that method for specific examples.
342
- *
343
- * When called, a ResultRowIdsListener is given a reference to the Queries
344
- * object, and the Id of the ResultTable whose ResultRow Ids changed (which is
345
- * the same as the query Id).
346
- *
347
- * You can create new query definitions within the body of this listener, though
348
- * obviously be aware of the possible cascading effects of doing so.
349
- * @param queries A reference to the Queries object that changed.
350
- * @param tableId The Id of the ResultTable that changed, which is also the
351
- * query Id.
352
- * @category Listener
353
- * @since v2.0.0
354
- */
355
- export type ResultRowIdsListener = (
356
- queries: Queries,
357
- tableId: Id,
358
- getIdChanges: GetIdChanges | undefined,
359
- ) => void;
360
-
361
- /**
362
- * The ResultSortedRowIdsListener type describes a function that is used to
363
- * listen to changes to the sorted ResultRow Ids in a query's ResultTable.
364
- *
365
- * A ResultSortedRowIdsListener is provided when using the
366
- * addResultSortedRowIdsListener method. See that method for specific examples.
367
- *
368
- * When called, a ResultSortedRowIdsListener is given a reference to the Queries
369
- * object, the Id of the ResultTable whose ResultRow Ids changed (which is the
370
- * same as the query Id), the ResultCell Id being used to sort them, whether
371
- * descending or not, and the offset and limit of the number of Ids returned,
372
- * for pagination purposes. It also receives the sorted array of Ids itself, so
373
- * that you can use them in the listener without the additional cost of an
374
- * explicit call to getResultSortedRowIds.
375
- *
376
- * You can create new query definitions within the body of this listener, though
377
- * obviously be aware of the possible cascading effects of doing so.
378
- * @param queries A reference to the Queries object that changed.
379
- * @param tableId The Id of the ResultTable that changed, which is also the
380
- * query Id.
381
- * @param cellId The Id of the ResultCell whose values were used for the
382
- * sorting.
383
- * @param descending Whether the sorting was in descending order.
384
- * @param offset The number of ResultRow Ids skipped.
385
- * @param limit The maximum number of ResultRow Ids returned.
386
- * @param sortedRowIds The sorted ResultRow Ids themselves.
387
- * @category Listener
388
- * @since v2.0.0
389
- */
390
- export type ResultSortedRowIdsListener = (
391
- queries: Queries,
392
- tableId: Id,
393
- cellId: Id | undefined,
394
- descending: boolean,
395
- offset: number,
396
- limit: number | undefined,
397
- sortedRowIds: Ids,
398
- ) => void;
399
-
400
- /**
401
- * The ResultRowListener type describes a function that is used to listen to
402
- * changes to a ResultRow in a query's ResultTable.
403
- *
404
- * A ResultRowListener is provided when using the addResultRowListener method.
405
- * See that method for specific examples.
406
- *
407
- * When called, a ResultRowListener is given a reference to the Queries object,
408
- * the Id of the ResultTable that changed (which is the same as the query Id),
409
- * the Id of the ResultRow that changed, and a GetResultCellChange function that
410
- * can be used to query ResultCell values before and after the change.
411
- *
412
- * You can create new query definitions within the body of this listener, though
413
- * obviously be aware of the possible cascading effects of doing so.
414
- * @param queries A reference to the Queries object that changed.
415
- * @param tableId The Id of the ResultTable that changed, which is also the
416
- * query Id.
417
- * @param rowId The Id of the ResultRow that changed.
418
- * @param getCellChange A function that returns information about any
419
- * ResultCell's changes.
420
- * @category Listener
421
- * @since v2.0.0
422
- */
423
- export type ResultRowListener = (
424
- queries: Queries,
425
- tableId: Id,
426
- rowId: Id,
427
- getCellChange: GetResultCellChange,
428
- ) => void;
429
-
430
- /**
431
- * The ResultCellIdsListener type describes a function that is used to listen to
432
- * changes to the ResultCell Ids in a ResultRow in a query's ResultTable.
433
- *
434
- * A ResultCellIdsListener is provided when using the addResultCellIdsListener
435
- * method. See that method for specific examples.
436
- *
437
- * When called, a ResultCellIdsListener is given a reference to the Queries
438
- * object, the Id of the ResultTable that changed (which is the same as the
439
- * query Id), and the Id of the ResultRow whose ResultCell Ids changed.
440
- *
441
- * You can create new query definitions within the body of this listener, though
442
- * obviously be aware of the possible cascading effects of doing so.
443
- * @param queries A reference to the Queries object that changed.
444
- * @param tableId The Id of the ResultTable that changed, which is also the
445
- * query Id.
446
- * @param rowId The Id of the ResultRow that changed.
447
- * @category Listener
448
- * @since v2.0.0
449
- */
450
- export type ResultCellIdsListener = (
451
- queries: Queries,
452
- tableId: Id,
453
- rowId: Id,
454
- getIdChanges: GetIdChanges | undefined,
455
- ) => void;
456
-
457
- /**
458
- * The ResultCellListener type describes a function that is used to listen to
459
- * changes to a ResultCell in a query's ResultTable.
460
- *
461
- * A ResultCellListener is provided when using the addResultCellListener method.
462
- * See that method for specific examples.
463
- *
464
- * When called, a ResultCellListener is given a reference to the Queries object,
465
- * the Id of the ResultTable that changed (which is the same as the query Id),
466
- * the Id of the ResultRow that changed, and the Id of ResultCell that changed.
467
- * It is also given the new value of the ResultCell, the old value of the
468
- * ResultCell, and a GetResultCellChange function that can be used to query
469
- * ResultCell values before and after the change.
470
- *
471
- * You can create new query definitions within the body of this listener, though
472
- * obviously be aware of the possible cascading effects of doing so.
473
- * @param queries A reference to the Queries object that changed.
474
- * @param tableId The Id of the ResultTable that changed, which is also the
475
- * query Id.
476
- * @param rowId The Id of the ResultRow that changed.
477
- * @param cellId The Id of the ResultCell that changed.
478
- * @param newCell The new value of the ResultCell that changed.
479
- * @param oldCell The old value of the ResultCell that changed.
480
- * @param getCellChange A function that returns information about any
481
- * ResultCell's changes.
482
- * @category Listener
483
- * @since v2.0.0
484
- */
485
- export type ResultCellListener = (
486
- queries: Queries,
487
- tableId: Id,
488
- rowId: Id,
489
- cellId: Id,
490
- newCell: ResultCell,
491
- oldCell: ResultCell,
492
- getCellChange: GetResultCellChange,
493
- ) => void;
494
-
495
- /**
496
- * The GetResultCellChange type describes a function that returns information
497
- * about any ResultCell's changes during a transaction.
498
- *
499
- * A GetResultCellChange function is provided to every listener when called due
500
- * the Store changing. The listener can then fetch the previous value of a
501
- * ResultCell before the current transaction, the new value after it, and a
502
- * convenience flag that indicates that the value has changed.
503
- * @param tableId The Id of the ResultTable to inspect.
504
- * @param rowId The Id of the ResultRow to inspect.
505
- * @param cellId The Id of the ResultCell to inspect.
506
- * @returns A ResultCellChange array containing information about the
507
- * ResultCell's changes.
508
- * @category Listener
509
- */
510
- export type GetResultCellChange = (
511
- tableId: Id,
512
- rowId: Id,
513
- cellId: Id,
514
- ) => ResultCellChange;
515
-
516
- /**
517
- * The ResultCellChange type describes a ResultCell's changes during a
518
- * transaction.
519
- *
520
- * This is returned by the GetResultCellChange function that is provided to
521
- * every listener when called. This array contains the previous value of a
522
- * ResultCell before the current transaction, the new value after it, and a
523
- * convenience flag that indicates that the value has changed.
524
- * @category Listener
525
- */
526
- export type ResultCellChange = [
527
- changed: boolean,
528
- oldCell: ResultCellOrUndefined,
529
- newCell: ResultCellOrUndefined,
530
- ];
531
-
532
- /**
533
- * The QueriesListenerStats type describes the number of listeners registered
534
- * with the Queries object, and can be used for debugging purposes.
535
- *
536
- * A QueriesListenerStats object is returned from the getListenerStats method,
537
- * and is only populated in a debug build.
538
- * @category Development
539
- * @since v2.0.0
540
- */
541
- export type QueriesListenerStats = {
542
- /**
543
- * The number of ResultTableListener functions registered with the Queries
544
- * object.
545
- */
546
- table?: number;
547
- /**
548
- * The number of ResultTableCellIdsListener functions registered with the
549
- * Queries object, since v3.3.
550
- */
551
- tableCellIds?: number;
552
- /**
553
- * The number of ResultRowCountListener functions registered with the Queries
554
- * object, since v4.1.
555
- */
556
- rowCount?: number;
557
- /**
558
- * The number of ResultRowIdsListener functions registered with the Queries
559
- * object.
560
- */
561
- rowIds?: number;
562
- /**
563
- * The number of SortedRowIdsListener functions registered with the Queries
564
- * object.
565
- */
566
- sortedRowIds?: number;
567
- /**
568
- * The number of ResultRowListener functions registered with the Queries
569
- * object.
570
- */
571
- row?: number;
572
- /**
573
- * The number of ResultCellIdsListener functions registered with the Queries
574
- * object.
575
- */
576
- cellIds?: number;
577
- /**
578
- * The number of ResultCellListener functions registered with the Queries
579
- * object.
580
- */
581
- cell?: number;
582
- };
583
-
584
- /**
585
- * The GetTableCell type describes a function that takes a Id and returns the
586
- * Cell value for a particular Row, optionally in a joined Table.
587
- *
588
- * A GetTableCell can be provided when setting query definitions, specifically
589
- * in the Select and Where clauses when you want to create or filter on
590
- * calculated values. See those methods for specific examples.
591
- * @category Callback
592
- * @since v2.0.0
593
- */
594
- export type GetTableCell = {
595
- /**
596
- * When called with one parameter, this function will return the value of
597
- * the specified Cell from the query's root Table for the Row being selected
598
- * or filtered.
599
- * @param cellId The Id of the Cell to fetch the value for.
600
- * @returns A Cell value or `undefined`.
601
- */
602
- (cellId: Id): CellOrUndefined;
603
- /**
604
- * When called with two parameters, this function will return the value of
605
- * the specified Cell from a Table that has been joined in the query, for
606
- * the Row being selected or filtered.
607
- * @param joinedTableId The Id of the Table to fetch the value from. If the
608
- * underlying Table was joined 'as' a different Id, that should instead be
609
- * used.
610
- * @param joinedCellId The Id of the Cell to fetch the value for.
611
- * @returns A Cell value or `undefined`.
612
- */
613
- (joinedTableId: Id, joinedCellId: Id): CellOrUndefined;
614
- };
615
-
616
- /**
617
- * The Select type describes a function that lets you specify a Cell or
618
- * calculated value for including into the query's result.
619
- *
620
- * The Select function is provided to the third `query` parameter of the
621
- * setQueryDefinition method. A query definition must call the Select function
622
- * at least once, otherwise it will be meaningless and return no data.
623
- * @example
624
- * This example shows a query that selects two Cells from the main query Table.
625
- *
626
- * ```js
627
- * const store = createStore().setTable('pets', {
628
- * fido: {species: 'dog', color: 'brown', legs: 4},
629
- * felix: {species: 'cat', color: 'black', legs: 4},
630
- * cujo: {species: 'dog', color: 'black', legs: 4},
631
- * });
632
- *
633
- * const queries = createQueries(store);
634
- * queries.setQueryDefinition('query', 'pets', ({select}) => {
635
- * select('species');
636
- * select('color');
637
- * });
638
- *
639
- * queries.forEachResultRow('query', (rowId) => {
640
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
641
- * });
642
- * // -> {fido: {species: 'dog', color: 'brown'}}
643
- * // -> {felix: {species: 'cat', color: 'black'}}
644
- * // -> {cujo: {species: 'dog', color: 'black'}}
645
- * ```
646
- * @example
647
- * This example shows a query that selects two Cells, one from a joined Table.
648
- *
649
- * ```js
650
- * const store = createStore()
651
- * .setTable('pets', {
652
- * fido: {species: 'dog', ownerId: '1'},
653
- * felix: {species: 'cat', ownerId: '2'},
654
- * cujo: {species: 'dog', ownerId: '3'},
655
- * })
656
- * .setTable('owners', {
657
- * '1': {name: 'Alice'},
658
- * '2': {name: 'Bob'},
659
- * '3': {name: 'Carol'},
660
- * });
661
- *
662
- * const queries = createQueries(store);
663
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
664
- * select('species');
665
- * select('owners', 'name');
666
- * // from pets
667
- * join('owners', 'ownerId');
668
- * });
669
- *
670
- * queries.forEachResultRow('query', (rowId) => {
671
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
672
- * });
673
- * // -> {fido: {species: 'dog', name: 'Alice'}}
674
- * // -> {felix: {species: 'cat', name: 'Bob'}}
675
- * // -> {cujo: {species: 'dog', name: 'Carol'}}
676
- * ```
677
- * @example
678
- * This example shows a query that calculates a value from two underlying Cells.
679
- *
680
- * ```js
681
- * const store = createStore()
682
- * .setTable('pets', {
683
- * fido: {species: 'dog', ownerId: '1'},
684
- * felix: {species: 'cat', ownerId: '2'},
685
- * cujo: {species: 'dog', ownerId: '3'},
686
- * })
687
- * .setTable('owners', {
688
- * '1': {name: 'Alice'},
689
- * '2': {name: 'Bob'},
690
- * '3': {name: 'Carol'},
691
- * });
692
- *
693
- * const queries = createQueries(store);
694
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
695
- * select(
696
- * (getTableCell, rowId) =>
697
- * `${getTableCell('species')} for ${getTableCell('owners', 'name')}`,
698
- * ).as('description');
699
- * join('owners', 'ownerId');
700
- * });
701
- *
702
- * queries.forEachResultRow('query', (rowId) => {
703
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
704
- * });
705
- * // -> {fido: {description: 'dog for Alice'}}
706
- * // -> {felix: {description: 'cat for Bob'}}
707
- * // -> {cujo: {description: 'dog for Carol'}}
708
- * ```
709
- * @category Definition
710
- * @since v2.0.0
711
- */
712
- export type Select = {
713
- /**
714
- * Calling this function with one Id parameter will indicate that the query
715
- * should select the value of the specified Cell from the query's root Table.
716
- * @param cellId The Id of the Cell to fetch the value for.
717
- * @returns A SelectedAs object so that the selected Cell Id can be optionally
718
- * aliased.
719
- */
720
- (cellId: Id): SelectedAs;
721
- /**
722
- * Calling this function with two parameters will indicate that the query
723
- * should select the value of the specified Cell from a Table that has been
724
- * joined in the query.
725
- * @param joinedTableId The Id of the Table to fetch the value from. If the
726
- * underlying Table was joined 'as' a different Id, that should instead be
727
- * used.
728
- * @param joinedCellId The Id of the Cell to fetch the value for.
729
- * @returns A SelectedAs object so that the selected Cell Id can be optionally
730
- * aliased.
731
- */
732
- (joinedTableId: Id, joinedCellId: Id): SelectedAs;
733
- /**
734
- * Calling this function with one callback parameter will indicate that the
735
- * query should select a calculated value, based on one or more Cell values in
736
- * the root Table or a joined Table, or on the root Table's Row Id.
737
- * @param getCell A callback that takes a GetTableCell function and the main
738
- * Table's Row Id. These can be used to programmatically create a calculated
739
- * value from multiple Cell values and the Row Id.
740
- * @returns A SelectedAs object so that the selected Cell Id can be optionally
741
- * aliased.
742
- */
743
- (
744
- getCell: (getTableCell: GetTableCell, rowId: Id) => ResultCellOrUndefined,
745
- ): SelectedAs;
746
- };
747
-
748
- /**
749
- * The SelectedAs type describes an object returned from calling a Select
750
- * function so that the selected Cell Id can be optionally aliased.
751
- *
752
- * If you are using a callback in the Select cause, it is highly recommended to
753
- * use the 'as' function, since otherwise a machine-generated column name will
754
- * be used.
755
- *
756
- * Note that if two Select clauses are both aliased to the same name (or if two
757
- * columns with the same underlying name are selected, both _without_ aliases),
758
- * only the latter of two will be used in the query.
759
- * @example
760
- * This example shows a query that selects two Cells, one from a joined Table.
761
- * Both are aliased with the 'as' function:
762
- *
763
- * ```js
764
- * const store = createStore()
765
- * .setTable('pets', {
766
- * fido: {species: 'dog', ownerId: '1'},
767
- * felix: {species: 'cat', ownerId: '2'},
768
- * cujo: {species: 'dog', ownerId: '3'},
769
- * })
770
- * .setTable('owners', {
771
- * '1': {name: 'Alice'},
772
- * '2': {name: 'Bob'},
773
- * '3': {name: 'Carol'},
774
- * });
775
- *
776
- * const queries = createQueries(store);
777
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
778
- * select('species').as('petSpecies');
779
- * select('owners', 'name').as('ownerName');
780
- * // from pets
781
- * join('owners', 'ownerId');
782
- * });
783
- *
784
- * queries.forEachResultRow('query', (rowId) => {
785
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
786
- * });
787
- * // -> {fido: {petSpecies: 'dog', ownerName: 'Alice'}}
788
- * // -> {felix: {petSpecies: 'cat', ownerName: 'Bob'}}
789
- * // -> {cujo: {petSpecies: 'dog', ownerName: 'Carol'}}
790
- * ```
791
- * @category Definition
792
- * @since v2.0.0
793
- */
794
- export type SelectedAs = {
795
- /**
796
- * A function that lets you specify an alias for the Cell Id.
797
- */
798
- as: (selectedCellId: Id) => void;
799
- };
800
-
801
- /**
802
- * The Join type describes a function that lets you specify a Cell or calculated
803
- * value to join the main query Table to other Tables, by their Row Id.
804
- *
805
- * The Join function is provided to the third `query` parameter of the
806
- * setQueryDefinition method.
807
- *
808
- * You can join zero, one, or many Tables. You can join the same underlying
809
- * Table multiple times, but in that case you will need to use the 'as' function
810
- * to distinguish them from each other.
811
- *
812
- * By default, each join is made from the main query Table to the joined table,
813
- * but it is also possible to connect via an intermediate join Table to a more
814
- * distant join Table.
815
- *
816
- * Because a Join clause is used to identify which unique Row Id of the joined
817
- * Table will be joined to each Row of the root Table, queries follow the 'left
818
- * join' semantics you may be familiar with from SQL. This means that an
819
- * unfiltered query will only ever return the same number of Rows as the main
820
- * Table being queried, and indeed the resulting table (assuming it has not been
821
- * aggregated) will even preserve the root Table's original Row Ids.
822
- * @example
823
- * This example shows a query that joins a single Table by using an Id present
824
- * in the main query Table.
825
- *
826
- * ```js
827
- * const store = createStore()
828
- * .setTable('pets', {
829
- * fido: {species: 'dog', ownerId: '1'},
830
- * felix: {species: 'cat', ownerId: '2'},
831
- * cujo: {species: 'dog', ownerId: '3'},
832
- * })
833
- * .setTable('owners', {
834
- * '1': {name: 'Alice'},
835
- * '2': {name: 'Bob'},
836
- * '3': {name: 'Carol'},
837
- * });
838
- *
839
- * const queries = createQueries(store);
840
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
841
- * select('species');
842
- * select('owners', 'name');
843
- * // from pets
844
- * join('owners', 'ownerId');
845
- * });
846
- *
847
- * queries.forEachResultRow('query', (rowId) => {
848
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
849
- * });
850
- * // -> {fido: {species: 'dog', name: 'Alice'}}
851
- * // -> {felix: {species: 'cat', name: 'Bob'}}
852
- * // -> {cujo: {species: 'dog', name: 'Carol'}}
853
- * ```
854
- * @example
855
- * This example shows a query that joins the same underlying Table twice, and
856
- * aliases them (and the selected Cell Ids). Note the left-join semantics: Felix
857
- * the cat was bought, but the seller was unknown. The record still exists in
858
- * the ResultTable.
859
- *
860
- * ```js
861
- * const store = createStore()
862
- * .setTable('pets', {
863
- * fido: {species: 'dog', buyerId: '1', sellerId: '2'},
864
- * felix: {species: 'cat', buyerId: '2'},
865
- * cujo: {species: 'dog', buyerId: '3', sellerId: '1'},
866
- * })
867
- * .setTable('humans', {
868
- * '1': {name: 'Alice'},
869
- * '2': {name: 'Bob'},
870
- * '3': {name: 'Carol'},
871
- * });
872
- *
873
- * const queries = createQueries(store);
874
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
875
- * select('buyers', 'name').as('buyer');
876
- * select('sellers', 'name').as('seller');
877
- * // from pets
878
- * join('humans', 'buyerId').as('buyers');
879
- * join('humans', 'sellerId').as('sellers');
880
- * });
881
- *
882
- * queries.forEachResultRow('query', (rowId) => {
883
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
884
- * });
885
- * // -> {fido: {buyer: 'Alice', seller: 'Bob'}}
886
- * // -> {felix: {buyer: 'Bob'}}
887
- * // -> {cujo: {buyer: 'Carol', seller: 'Alice'}}
888
- * ```
889
- * @example
890
- * This example shows a query that calculates the Id of the joined Table based
891
- * from multiple values in the root Table rather than a single Cell.
892
- *
893
- * ```js
894
- * const store = createStore()
895
- * .setTable('pets', {
896
- * fido: {species: 'dog', color: 'brown'},
897
- * felix: {species: 'cat', color: 'black'},
898
- * cujo: {species: 'dog', color: 'black'},
899
- * })
900
- * .setTable('colorSpecies', {
901
- * 'brown-dog': {price: 6},
902
- * 'black-dog': {price: 5},
903
- * 'brown-cat': {price: 4},
904
- * 'black-cat': {price: 3},
905
- * });
906
- *
907
- * const queries = createQueries(store);
908
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
909
- * select('colorSpecies', 'price');
910
- * // from pets
911
- * join(
912
- * 'colorSpecies',
913
- * (getCell) => `${getCell('color')}-${getCell('species')}`,
914
- * );
915
- * });
916
- *
917
- * queries.forEachResultRow('query', (rowId) => {
918
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
919
- * });
920
- * // -> {fido: {price: 6}}
921
- * // -> {felix: {price: 3}}
922
- * // -> {cujo: {price: 5}}
923
- * ```
924
- * @example
925
- * This example shows a query that joins two Tables, one through the
926
- * intermediate other.
927
- *
928
- * ```js
929
- * const store = createStore()
930
- * .setTable('pets', {
931
- * fido: {species: 'dog', ownerId: '1'},
932
- * felix: {species: 'cat', ownerId: '2'},
933
- * cujo: {species: 'dog', ownerId: '3'},
934
- * })
935
- * .setTable('owners', {
936
- * '1': {name: 'Alice', state: 'CA'},
937
- * '2': {name: 'Bob', state: 'CA'},
938
- * '3': {name: 'Carol', state: 'WA'},
939
- * })
940
- * .setTable('states', {
941
- * CA: {name: 'California'},
942
- * WA: {name: 'Washington'},
943
- * });
944
- *
945
- * const queries = createQueries(store);
946
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
947
- * select(
948
- * (getTableCell, rowId) =>
949
- * `${getTableCell('species')} in ${getTableCell('states', 'name')}`,
950
- * ).as('description');
951
- * // from pets
952
- * join('owners', 'ownerId');
953
- * join('states', 'owners', 'state');
954
- * });
955
- *
956
- * queries.forEachResultRow('query', (rowId) => {
957
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
958
- * });
959
- * // -> {fido: {description: 'dog in California'}}
960
- * // -> {felix: {description: 'cat in California'}}
961
- * // -> {cujo: {description: 'dog in Washington'}}
962
- * ```
963
- * @category Definition
964
- * @since v2.0.0
965
- */
966
- export type Join = {
967
- /**
968
- * Calling this function with two Id parameters will indicate that the join to
969
- * a Row in an adjacent Table is made by finding its Id in a Cell of the
970
- * query's root Table.
971
- * @param joinedTableId The Id of the Table to join to.
972
- * @param on The Id of the Cell in the root Table that contains the joined
973
- * Table's Row Id.
974
- * @returns A JoinedAs object so that the joined Table Id can be optionally
975
- * aliased.
976
- */
977
- (joinedTableId: Id, on: Id): JoinedAs;
978
- /**
979
- * Calling this function with two parameters (where the second is a function)
980
- * will indicate that the join to a Row in an adjacent Table is made by
981
- * calculating its Id from the Cells and the Row Id of the query's root Table.
982
- * @param joinedTableId The Id of the Table to join to.
983
- * @param on A callback that takes a GetCell function and the root Table's Row
984
- * Id. These can be used to programmatically calculate the joined Table's Row
985
- * Id.
986
- * @returns A JoinedAs object so that the joined Table Id can be optionally
987
- * aliased.
988
- */
989
- (
990
- joinedTableId: Id,
991
- on: (getCell: GetCell, rowId: Id) => Id | undefined,
992
- ): JoinedAs;
993
- /**
994
- * Calling this function with three Id parameters will indicate that the join
995
- * to a Row in distant Table is made by finding its Id in a Cell of an
996
- * intermediately joined Table.
997
- * @param joinedTableId The Id of the distant Table to join to.
998
- * @param fromIntermediateJoinedTableId The Id of an intermediate Table (which
999
- * should have been in turn joined to the main query table via other Join
1000
- * clauses).
1001
- * @param on The Id of the Cell in the intermediate Table that contains the
1002
- * joined Table's Row Id.
1003
- * @returns A JoinedAs object so that the joined Table Id can be optionally
1004
- * aliased.
1005
- */
1006
- (joinedTableId: Id, fromIntermediateJoinedTableId: Id, on: Id): JoinedAs;
1007
- /**
1008
- * Calling this function with three parameters (where the third is a function)
1009
- * will indicate that the join to a Row in distant Table is made by
1010
- * calculating its Id from the Cells and the Row Id of an intermediately
1011
- * joined Table.
1012
- * @param joinedTableId The Id of the Table to join to.
1013
- * @param fromIntermediateJoinedTableId The Id of an intermediate Table (which
1014
- * should have been in turn joined to the main query table via other Join
1015
- * clauses).
1016
- * @param on A callback that takes a GetCell function and the intermediate
1017
- * Table's Row Id. These can be used to programmatically calculate the joined
1018
- * Table's Row Id.
1019
- * @returns A JoinedAs object so that the joined Table Id can be optionally
1020
- * aliased.
1021
- */
1022
- (
1023
- joinedTableId: Id,
1024
- fromIntermediateJoinedTableId: Id,
1025
- on: (
1026
- getIntermediateJoinedCell: GetCell,
1027
- intermediateJoinedRowId: Id,
1028
- ) => Id | undefined,
1029
- ): JoinedAs;
1030
- };
1031
-
1032
- /**
1033
- * The JoinedAs type describes an object returned from calling a Join function
1034
- * so that the joined Table Id can be optionally aliased.
1035
- *
1036
- * Note that if two Join clauses are both aliased to the same name (or if you
1037
- * create two joins to the same underlying Table, both _without_ aliases), only
1038
- * the latter of two will be used in the query.
1039
- *
1040
- * For the purposes of clarity, it's recommended to use an alias that does not
1041
- * collide with a real underlying Table (whether included in the query or not).
1042
- * @example
1043
- * This example shows a query that joins the same underlying Table twice, for
1044
- * different purposes. Both joins are aliased with the 'as' function to
1045
- * disambiguate them. Note that the selected Cells are also aliased.
1046
- *
1047
- * ```js
1048
- * const store = createStore()
1049
- * .setTable('pets', {
1050
- * fido: {species: 'dog', buyerId: '1', sellerId: '2'},
1051
- * felix: {species: 'cat', buyerId: '2'},
1052
- * cujo: {species: 'dog', buyerId: '3', sellerId: '1'},
1053
- * })
1054
- * .setTable('humans', {
1055
- * '1': {name: 'Alice'},
1056
- * '2': {name: 'Bob'},
1057
- * '3': {name: 'Carol'},
1058
- * });
1059
- *
1060
- * const queries = createQueries(store);
1061
- * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
1062
- * select('buyers', 'name').as('buyer');
1063
- * select('sellers', 'name').as('seller');
1064
- * // from pets
1065
- * join('humans', 'buyerId').as('buyers');
1066
- * join('humans', 'sellerId').as('sellers');
1067
- * });
1068
- *
1069
- * queries.forEachResultRow('query', (rowId) => {
1070
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1071
- * });
1072
- * // -> {fido: {buyer: 'Alice', seller: 'Bob'}}
1073
- * // -> {felix: {buyer: 'Bob'}}
1074
- * // -> {cujo: {buyer: 'Carol', seller: 'Alice'}}
1075
- * ```
1076
- * @category Definition
1077
- * @since v2.0.0
1078
- */
1079
- export type JoinedAs = {
1080
- /**
1081
- * A function that lets you specify an alias for the joined Table Id.
1082
- */
1083
- as: (joinedTableId: Id) => void;
1084
- };
1085
-
1086
- /**
1087
- * The Where type describes a function that lets you specify conditions to
1088
- * filter results, based on the underlying Cells of the root or joined Tables.
1089
- *
1090
- * The Where function is provided to the third `query` parameter of the
1091
- * setQueryDefinition method.
1092
- *
1093
- * If you do not specify a Where clause, you should expect every non-empty Row
1094
- * of the root Table to appear in the query's results.
1095
- *
1096
- * A Where condition has to be true for a Row to be included in the results.
1097
- * Each Where class is additive, as though combined with a logical 'and'. If you
1098
- * wish to create an 'or' expression, use the single parameter version of the
1099
- * type that allows arbitrary programmatic conditions.
1100
- *
1101
- * The Where keyword differs from the Having keyword in that the former
1102
- * describes conditions that should be met by underlying Cell values (whether
1103
- * selected or not), and the latter describes conditions based on calculated and
1104
- * aggregated values - after Group clauses have been applied.
1105
- * @example
1106
- * This example shows a query that filters the results from a single Table by
1107
- * comparing an underlying Cell from it with a value.
1108
- *
1109
- * ```js
1110
- * const store = createStore().setTable('pets', {
1111
- * fido: {species: 'dog'},
1112
- * felix: {species: 'cat'},
1113
- * cujo: {species: 'dog'},
1114
- * });
1115
- *
1116
- * const queries = createQueries(store);
1117
- * queries.setQueryDefinition('query', 'pets', ({select, where}) => {
1118
- * select('species');
1119
- * where('species', 'dog');
1120
- * });
1121
- *
1122
- * queries.forEachResultRow('query', (rowId) => {
1123
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1124
- * });
1125
- * // -> {fido: {species: 'dog'}}
1126
- * // -> {cujo: {species: 'dog'}}
1127
- * ```
1128
- * @example
1129
- * This example shows a query that filters the results of a query by comparing
1130
- * an underlying Cell from a joined Table with a value. Note that the joined
1131
- * table has also been aliased, and so its alias is used in the Where clause.
1132
- *
1133
- * ```js
1134
- * const store = createStore()
1135
- * .setTable('pets', {
1136
- * fido: {species: 'dog', ownerId: '1'},
1137
- * felix: {species: 'cat', ownerId: '2'},
1138
- * cujo: {species: 'dog', ownerId: '3'},
1139
- * })
1140
- * .setTable('owners', {
1141
- * '1': {name: 'Alice', state: 'CA'},
1142
- * '2': {name: 'Bob', state: 'CA'},
1143
- * '3': {name: 'Carol', state: 'WA'},
1144
- * });
1145
- *
1146
- * const queries = createQueries(store);
1147
- * queries.setQueryDefinition('query', 'pets', ({select, join, where}) => {
1148
- * select('species');
1149
- * // from pets
1150
- * join('owners', 'ownerId').as('petOwners');
1151
- * where('petOwners', 'state', 'CA');
1152
- * });
1153
- *
1154
- * queries.forEachResultRow('query', (rowId) => {
1155
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1156
- * });
1157
- * // -> {fido: {species: 'dog'}}
1158
- * // -> {felix: {species: 'cat'}}
1159
- * ```
1160
- * @example
1161
- * This example shows a query that filters the results of a query with a
1162
- * condition that is calculated from underlying Cell values from the main and
1163
- * joined Table. Note that the joined table has also been aliased, and so its
1164
- * alias is used in the Where clause.
1165
- *
1166
- * ```js
1167
- * const store = createStore()
1168
- * .setTable('pets', {
1169
- * fido: {species: 'dog', ownerId: '1'},
1170
- * felix: {species: 'cat', ownerId: '2'},
1171
- * cujo: {species: 'dog', ownerId: '3'},
1172
- * })
1173
- * .setTable('owners', {
1174
- * '1': {name: 'Alice', state: 'CA'},
1175
- * '2': {name: 'Bob', state: 'CA'},
1176
- * '3': {name: 'Carol', state: 'WA'},
1177
- * });
1178
- *
1179
- * const queries = createQueries(store);
1180
- * queries.setQueryDefinition('query', 'pets', ({select, join, where}) => {
1181
- * select('species');
1182
- * select('petOwners', 'state');
1183
- * // from pets
1184
- * join('owners', 'ownerId').as('petOwners');
1185
- * where(
1186
- * (getTableCell) =>
1187
- * getTableCell('pets', 'species') === 'cat' ||
1188
- * getTableCell('petOwners', 'state') === 'WA',
1189
- * );
1190
- * });
1191
- *
1192
- * queries.forEachResultRow('query', (rowId) => {
1193
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1194
- * });
1195
- * // -> {felix: {species: 'cat', state: 'CA'}}
1196
- * // -> {cujo: {species: 'dog', state: 'WA'}}
1197
- * ```
1198
- * @category Definition
1199
- * @since v2.0.0
1200
- */
1201
- export type Where = {
1202
- /**
1203
- * Calling this function with two parameters is used to include only those
1204
- * Rows for which a specified Cell in the query's root Table has a specified
1205
- * value.
1206
- * @param cellId The Id of the Cell in the query's root Table to test.
1207
- * @param equals The value that the Cell has to have for the Row to be
1208
- * included in the result.
1209
- */
1210
- (cellId: Id, equals: Cell): void;
1211
- /**
1212
- * Calling this function with three parameters is used to include only those
1213
- * Rows for which a specified Cell in a joined Table has a specified value.
1214
- * @param joinedTableId The Id of the joined Table to test a value in. If the
1215
- * underlying Table was joined 'as' a different Id, that should instead be
1216
- * used.
1217
- * @param joinedCellId The Id of the Cell in the joined Table to test.
1218
- * @param equals The value that the Cell has to have for the Row to be
1219
- * included in the result.
1220
- */
1221
- (joinedTableId: Id, joinedCellId: Id, equals: Cell): void;
1222
- /**
1223
- * Calling this function with one callback parameter is used to include only
1224
- * those Rows which meet a calculated boolean condition, based on values in
1225
- * the main and (optionally) joined Tables.
1226
- * @param condition A callback that takes a GetTableCell function and that
1227
- * should return `true` for the Row to be included in the result.
1228
- */
1229
- (condition: (getTableCell: GetTableCell) => boolean): void;
1230
- };
1231
-
1232
- /**
1233
- * The Group type describes a function that lets you specify that the values of
1234
- * a Cell in multiple ResultRows should be aggregated together.
1235
- *
1236
- * The Group function is provided to the third `query` parameter of the
1237
- * setQueryDefinition method. When called, it should refer to a Cell Id (or
1238
- * aliased Id) specified in one of the Select functions, and indicate how the
1239
- * values should be aggregated.
1240
- *
1241
- * This is applied after any joins or where-based filtering.
1242
- *
1243
- * If you provide a Group for every Select, the result will be a single Row with
1244
- * every Cell having been aggregated. If you provide a Group for only one, or
1245
- * some, of the Select clauses, the _others_ will be automatically used as
1246
- * dimensional values (analogous to the 'group by` semantics in SQL), within
1247
- * which the aggregations of Group Cells will be performed.
1248
- *
1249
- * You can join the same underlying Cell multiple times, but in that case you
1250
- * will need to use the 'as' function to distinguish them from each other.
1251
- *
1252
- * The second parameter can be one of five predefined aggregates - 'count',
1253
- * 'sum', 'avg', 'min', and 'max' - or a custom function that produces your own
1254
- * aggregation of an array of Cell values.
1255
- *
1256
- * The final three parameters, `aggregateAdd`, `aggregateRemove`,
1257
- * `aggregateReplace` need only be provided when you are using your own custom
1258
- * `aggregate` function. These give you the opportunity to reduce your custom
1259
- * function's algorithmic complexity by providing shortcuts that can nudge an
1260
- * aggregation result when a single value is added, removed, or replaced in the
1261
- * input values.
1262
- * @param selectedCellId The Id of the Cell to aggregate. If the underlying Cell
1263
- * was selected 'as' a different Id, that should instead be used.
1264
- * @param aggregate Either a string representing one of a set of common
1265
- * aggregation techniques ('count', 'sum', 'avg', 'min', or 'max'), or a
1266
- * function that aggregates Cell values from each Row to create the aggregate's
1267
- * overall.
1268
- * @param aggregateAdd A function that can be used to optimize a custom
1269
- * Aggregate by providing a shortcut for when a single value is added to the
1270
- * input values - for example, when a Row is added to the Table.
1271
- * @param aggregateRemove A function that can be used to optimize a custom
1272
- * Aggregate by providing a shortcut for when a single value is removed from the
1273
- * input values - for example, when a Row is removed from the Table.
1274
- * @param aggregateReplace A function that can be used to optimize a custom
1275
- * Aggregate by providing a shortcut for when a single value in the input values
1276
- * is replaced with another - for example, when a Row is updated.
1277
- * @returns A GroupedAs object so that the grouped Cell Id can be optionally
1278
- * aliased.
1279
- * @example
1280
- * This example shows a query that calculates the average of all the values in a
1281
- * single selected Cell from a joined Table.
1282
- *
1283
- * ```js
1284
- * const store = createStore()
1285
- * .setTable('pets', {
1286
- * fido: {species: 'dog'},
1287
- * felix: {species: 'cat'},
1288
- * cujo: {species: 'dog'},
1289
- * lowly: {species: 'worm'},
1290
- * })
1291
- * .setTable('species', {
1292
- * dog: {price: 5},
1293
- * cat: {price: 4},
1294
- * worm: {price: 1},
1295
- * });
1296
- *
1297
- * const queries = createQueries(store);
1298
- * queries.setQueryDefinition('query', 'pets', ({select, join, group}) => {
1299
- * select('species', 'price');
1300
- * // from pets
1301
- * join('species', 'species');
1302
- * group('price', 'avg').as('avgPrice');
1303
- * });
1304
- *
1305
- * console.log(queries.getResultTable('query'));
1306
- * // -> {0: {avgPrice: 3.75}}
1307
- * // 2 dogs at 5, 1 cat at 4, 1 worm at 1: a total of 15 for 4 pets
1308
- * ```
1309
- * @example
1310
- * This example shows a query that calculates the average of a two Cell values,
1311
- * aggregated by the two other dimensional 'group by' Cells.
1312
- *
1313
- * ```js
1314
- * const store = createStore()
1315
- * .setTable('pets', {
1316
- * fido: {species: 'dog', owner: 'alice'},
1317
- * felix: {species: 'cat', owner: 'bob'},
1318
- * cujo: {species: 'dog', owner: 'bob'},
1319
- * lowly: {species: 'worm', owner: 'alice'},
1320
- * carnaby: {species: 'parrot', owner: 'bob'},
1321
- * polly: {species: 'parrot', owner: 'alice'},
1322
- * })
1323
- * .setTable('species', {
1324
- * dog: {price: 5, legs: 4},
1325
- * cat: {price: 4, legs: 4},
1326
- * parrot: {price: 3, legs: 2},
1327
- * worm: {price: 1, legs: 0},
1328
- * });
1329
- *
1330
- * const queries = createQueries(store);
1331
- * queries.setQueryDefinition('query', 'pets', ({select, join, group}) => {
1332
- * select('pets', 'owner'); // group by
1333
- * select('species', 'price'); // grouped
1334
- * // from pets
1335
- * join('species', 'species');
1336
- * group(
1337
- * 'price',
1338
- * (cells) => Math.min(...cells.filter((cell) => cell > 2)),
1339
- * (current, add) => (add > 2 ? Math.min(current, add) : current),
1340
- * (current, remove) => (remove == current ? undefined : current),
1341
- * (current, add, remove) =>
1342
- * remove == current
1343
- * ? undefined
1344
- * : add > 2
1345
- * ? Math.min(current, add)
1346
- * : current,
1347
- * ).as('lowestPriceOver2');
1348
- * });
1349
- *
1350
- * queries.forEachResultRow('query', (rowId) => {
1351
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1352
- * });
1353
- * // -> {0: {owner: 'alice', lowestPriceOver2: 3}}
1354
- * // -> {1: {owner: 'bob', lowestPriceOver2: 3}}
1355
- * // Both have a parrot at 3. Alice's worm at 1 is excluded from aggregation.
1356
- * ```
1357
- * @category Definition
1358
- * @since v2.0.0
1359
- */
1360
- export type Group = (
1361
- selectedCellId: Id,
1362
- aggregate: 'count' | 'sum' | 'avg' | 'min' | 'max' | Aggregate,
1363
- aggregateAdd?: AggregateAdd,
1364
- aggregateRemove?: AggregateRemove,
1365
- aggregateReplace?: AggregateReplace,
1366
- ) => GroupedAs;
1367
-
1368
- /**
1369
- * The GroupedAs type describes an object returned from calling a Group function
1370
- * so that the grouped Cell Id can be optionally aliased.
1371
- *
1372
- * Note that if two Group clauses are both aliased to the same name (or if you
1373
- * create two groups of the same underlying Cell, both _without_ aliases), only
1374
- * the latter of two will be used in the query.
1375
- * @example
1376
- * This example shows a query that groups the same underlying Cell twice, for
1377
- * different purposes. Both groups are aliased with the 'as' function to
1378
- * disambiguate them.
1379
- *
1380
- * ```js
1381
- * const store = createStore().setTable('pets', {
1382
- * fido: {species: 'dog', price: 5},
1383
- * felix: {species: 'cat', price: 4},
1384
- * cujo: {species: 'dog', price: 4},
1385
- * tom: {species: 'cat', price: 3},
1386
- * });
1387
- *
1388
- * const queries = createQueries(store);
1389
- * queries.setQueryDefinition('query', 'pets', ({select, group}) => {
1390
- * select('pets', 'species');
1391
- * select('pets', 'price');
1392
- * group('price', 'min').as('minPrice');
1393
- * group('price', 'max').as('maxPrice');
1394
- * });
1395
- *
1396
- * queries.forEachResultRow('query', (rowId) => {
1397
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1398
- * });
1399
- * // -> {0: {species: 'dog', minPrice: 4, maxPrice: 5}}
1400
- * // -> {1: {species: 'cat', minPrice: 3, maxPrice: 4}}
1401
- * ```
1402
- * @category Definition
1403
- * @since v2.0.0
1404
- */
1405
- export type GroupedAs = {
1406
- /**
1407
- * A function that lets you specify an alias for the grouped Cell Id.
1408
- */
1409
- as: (groupedCellId: Id) => void;
1410
- };
1411
-
1412
- /**
1413
- * The Having type describes a function that lets you specify conditions to
1414
- * filter results, based on the grouped Cells resulting from a Group clause.
1415
- *
1416
- * The Having function is provided to the third `query` parameter of the
1417
- * setQueryDefinition method.
1418
- *
1419
- * A Having condition has to be true for a Row to be included in the results.
1420
- * Each Having class is additive, as though combined with a logical 'and'. If
1421
- * you wish to create an 'or' expression, use the single parameter version of
1422
- * the type that allows arbitrary programmatic conditions.
1423
- *
1424
- * The Where keyword differs from the Having keyword in that the former
1425
- * describes conditions that should be met by underlying Cell values (whether
1426
- * selected or not), and the latter describes conditions based on calculated and
1427
- * aggregated values - after Group clauses have been applied.
1428
- *
1429
- * Whilst it is technically possible to use a Having clause even if the results
1430
- * have not been grouped with a Group clause, you should expect it to be less
1431
- * performant than using a Where clause, due to that being applied earlier in
1432
- * the query process.
1433
- * @example
1434
- * This example shows a query that filters the results from a grouped Table by
1435
- * comparing a Cell from it with a value.
1436
- *
1437
- * ```js
1438
- * const store = createStore().setTable('pets', {
1439
- * fido: {species: 'dog', price: 5},
1440
- * felix: {species: 'cat', price: 4},
1441
- * cujo: {species: 'dog', price: 4},
1442
- * tom: {species: 'cat', price: 3},
1443
- * carnaby: {species: 'parrot', price: 3},
1444
- * polly: {species: 'parrot', price: 3},
1445
- * });
1446
- *
1447
- * const queries = createQueries(store);
1448
- * queries.setQueryDefinition('query', 'pets', ({select, group, having}) => {
1449
- * select('pets', 'species');
1450
- * select('pets', 'price');
1451
- * group('price', 'min').as('minPrice');
1452
- * group('price', 'max').as('maxPrice');
1453
- * having('minPrice', 3);
1454
- * });
1455
- *
1456
- * queries.forEachResultRow('query', (rowId) => {
1457
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1458
- * });
1459
- * // -> {0: {species: 'cat', minPrice: 3, maxPrice: 4}}
1460
- * // -> {1: {species: 'parrot', minPrice: 3, maxPrice: 3}}
1461
- * ```
1462
- * @example
1463
- * This example shows a query that filters the results from a grouped Table with
1464
- * a condition that is calculated from Cell values.
1465
- *
1466
- * ```js
1467
- * const store = createStore().setTable('pets', {
1468
- * fido: {species: 'dog', price: 5},
1469
- * felix: {species: 'cat', price: 4},
1470
- * cujo: {species: 'dog', price: 4},
1471
- * tom: {species: 'cat', price: 3},
1472
- * carnaby: {species: 'parrot', price: 3},
1473
- * polly: {species: 'parrot', price: 3},
1474
- * });
1475
- *
1476
- * const queries = createQueries(store);
1477
- * queries.setQueryDefinition('query', 'pets', ({select, group, having}) => {
1478
- * select('pets', 'species');
1479
- * select('pets', 'price');
1480
- * group('price', 'min').as('minPrice');
1481
- * group('price', 'max').as('maxPrice');
1482
- * having(
1483
- * (getSelectedOrGroupedCell) =>
1484
- * getSelectedOrGroupedCell('minPrice') !=
1485
- * getSelectedOrGroupedCell('maxPrice'),
1486
- * );
1487
- * });
1488
- *
1489
- * queries.forEachResultRow('query', (rowId) => {
1490
- * console.log({[rowId]: queries.getResultRow('query', rowId)});
1491
- * });
1492
- * // -> {0: {species: 'dog', minPrice: 4, maxPrice: 5}}
1493
- * // -> {1: {species: 'cat', minPrice: 3, maxPrice: 4}}
1494
- * // Parrots are filtered out because they have zero range in price.
1495
- * ```
1496
- * @category Definition
1497
- * @since v2.0.0
1498
- */
1499
- export type Having = {
1500
- /**
1501
- * Calling this function with two parameters is used to include only those
1502
- * Rows for which a specified Cell in the query's root Table has a specified
1503
- * value.
1504
- * @param selectedOrGroupedCellId The Id of the Cell in the query to test.
1505
- * @param equals The value that the Cell has to have for the Row to be
1506
- * included in the result.
1507
- */
1508
- (selectedOrGroupedCellId: Id, equals: Cell): void;
1509
- /**
1510
- * Calling this function with one callback parameter is used to include only
1511
- * those Rows which meet a calculated boolean condition.
1512
- * @param condition A callback that takes a GetCell function and that should
1513
- * return `true` for the Row to be included in the result.
1514
- */
1515
- (condition: (getSelectedOrGroupedCell: GetCell) => boolean): void;
1516
- };
1517
-
1518
- /**
1519
- * A Queries object lets you create and track queries of the data in Store
1520
- * objects.
1521
- *
1522
- * This is useful for creating a reactive view of data that is stored in
1523
- * physical tables: selecting columns, joining tables together, filtering rows,
1524
- * aggregating data, sorting it, and so on.
1525
- *
1526
- * This provides a generalized query concept for Store data. If you just want to
1527
- * create and track metrics, indexes, or relationships between rows, you may
1528
- * prefer to use the dedicated Metrics, Indexes, and Relationships objects,
1529
- * which have simpler APIs.
1530
- *
1531
- * Create a Queries object easily with the createQueries function. From there,
1532
- * you can add new query definitions (with the setQueryDefinition method), query
1533
- * the results (with the getResultTable method, the getResultRow method, the
1534
- * getResultCell method, and so on), and add listeners for when they change
1535
- * (with the addResultTableListener method, the addResultRowListener method, the
1536
- * addResultCellListener method, and so on).
1537
- * @example
1538
- * This example shows a very simple lifecycle of a Queries object: from
1539
- * creation, to adding definitions, getting their contents, and then registering
1540
- * and removing listeners for them.
1541
- *
1542
- * ```js
1543
- * const store = createStore()
1544
- * .setTable('pets', {
1545
- * fido: {species: 'dog', color: 'brown', ownerId: '1'},
1546
- * felix: {species: 'cat', color: 'black', ownerId: '2'},
1547
- * cujo: {species: 'dog', color: 'black', ownerId: '3'},
1548
- * })
1549
- * .setTable('species', {
1550
- * dog: {price: 5},
1551
- * cat: {price: 4},
1552
- * worm: {price: 1},
1553
- * })
1554
- * .setTable('owners', {
1555
- * '1': {name: 'Alice'},
1556
- * '2': {name: 'Bob'},
1557
- * '3': {name: 'Carol'},
1558
- * });
1559
- *
1560
- * const queries = createQueries(store);
1561
- *
1562
- * // A filtered table query:
1563
- * queries.setQueryDefinition('blackPets', 'pets', ({select, where}) => {
1564
- * select('species');
1565
- * where('color', 'black');
1566
- * });
1567
- * console.log(queries.getResultTable('blackPets'));
1568
- * // -> {felix: {species: 'cat'}, cujo: {species: 'dog'}}
1569
- *
1570
- * // A joined table query:
1571
- * queries.setQueryDefinition('petOwners', 'pets', ({select, join}) => {
1572
- * select('owners', 'name').as('owner');
1573
- * join('owners', 'ownerId');
1574
- * });
1575
- * console.log(queries.getResultTable('petOwners'));
1576
- * // -> {fido: {owner: 'Alice'}, felix: {owner: 'Bob'}, cujo: {owner: 'Carol'}}
1577
- *
1578
- * // A grouped query:
1579
- * queries.setQueryDefinition(
1580
- * 'colorPrice',
1581
- * 'pets',
1582
- * ({select, join, group}) => {
1583
- * select('color');
1584
- * select('species', 'price');
1585
- * join('species', 'species');
1586
- * group('price', 'avg');
1587
- * },
1588
- * );
1589
- * console.log(queries.getResultTable('colorPrice'));
1590
- * // -> {"1": {color: 'black', price: 4.5}, "0": {color: 'brown', price: 5}}
1591
- * console.log(queries.getResultSortedRowIds('colorPrice', 'price', true));
1592
- * // -> ["0", "1"]
1593
- *
1594
- * const listenerId = queries.addResultTableListener('colorPrice', () => {
1595
- * console.log('Average prices per color changed');
1596
- * console.log(queries.getResultTable('colorPrice'));
1597
- * console.log(queries.getResultSortedRowIds('colorPrice', 'price', true));
1598
- * });
1599
- *
1600
- * store.setRow('pets', 'lowly', {species: 'worm', color: 'brown'});
1601
- * // -> 'Average prices per color changed'
1602
- * // -> {"0": {color: 'brown', price: 3}, "1": {color: 'black', price: 4.5}}
1603
- * // -> ["1", "0"]
1604
- *
1605
- * queries.delListener(listenerId);
1606
- * queries.destroy();
1607
- * ```
1608
- * @see Making Queries guides
1609
- * @see Car Analysis demo
1610
- * @see Movie Database demo
1611
- * @category Queries
1612
- * @since v2.0.0
1613
- */
1614
- export interface Queries {
1615
- //
1616
- /**
1617
- * The setQueryDefinition method lets you set the definition of a query.
1618
- *
1619
- * Every query definition is identified by a unique Id, and if you re-use an
1620
- * existing Id with this method, the previous definition is overwritten.
1621
- *
1622
- * A query provides a tabular result formed from each Row within a root Table.
1623
- * The definition must specify this Table (by its Id) to be aggregated. Other
1624
- * Tables can be joined to that using Join clauses.
1625
- *
1626
- * The third `query` parameter is a callback that you provide to define the
1627
- * query. That callback is provided with a `keywords` object that contains the
1628
- * functions you use to define the query, like `select`, `join`, and so on.
1629
- * You can see how that is used in the simple example below. The following
1630
- * five clause types are supported:
1631
- *
1632
- * - The Select type describes a function that lets you specify a Cell or
1633
- * calculated value for including into the query's result.
1634
- * - The Join type describes a function that lets you specify a Cell or
1635
- * calculated value to join the main query Table to others, by Row Id.
1636
- * - The Where type describes a function that lets you specify conditions to
1637
- * filter results, based on the underlying Cells of the main or joined
1638
- * Tables.
1639
- * - The Group type describes a function that lets you specify that the values
1640
- * of a Cell in multiple ResultRows should be aggregated together.
1641
- * - The Having type describes a function that lets you specify conditions to
1642
- * filter results, based on the grouped Cells resulting from a Group clause.
1643
- *
1644
- * Full documentation and examples are provided in the sections for each of
1645
- * those clause types.
1646
- *
1647
- * Additionally, you can use the getResultSortedRowIds method and
1648
- * addResultSortedRowIdsListener method to sort and paginate the results.
1649
- * @param queryId The Id of the query to define.
1650
- * @param tableId The Id of the root Table the query will be based on.
1651
- * @param query A callback which can take a `keywords` object and which uses
1652
- the functions it contains to define the query.
1653
- * @returns A reference to the Queries object.
1654
- * @example
1655
- * This example creates a Store, creates a Queries object, and defines a
1656
- * simple query to select just one column from the Table, for each Row where
1657
- * the `species` Cell matches as certain value.
1658
- *
1659
- * ```js
1660
- * const store = createStore().setTable('pets', {
1661
- * fido: {species: 'dog', color: 'brown'},
1662
- * felix: {species: 'cat', color: 'black'},
1663
- * cujo: {species: 'dog', color: 'black'},
1664
- * });
1665
- *
1666
- * const queries = createQueries(store);
1667
- * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
1668
- * select('color');
1669
- * where('species', 'dog');
1670
- * });
1671
- *
1672
- * console.log(queries.getResultTable('dogColors'));
1673
- * // -> {fido: {color: 'brown'}, cujo: {color: 'black'}}
1674
- * ```
1675
- * @category Configuration
1676
- * @since v2.0.0
1677
- */
1678
- setQueryDefinition(
1679
- queryId: Id,
1680
- tableId: Id,
1681
- query: (keywords: {
1682
- select: Select;
1683
- join: Join;
1684
- where: Where;
1685
- group: Group;
1686
- having: Having;
1687
- }) => void,
1688
- ): Queries;
1689
-
1690
- /**
1691
- * The delQueryDefinition method removes an existing query definition.
1692
- * @param queryId The Id of the query to remove.
1693
- * @returns A reference to the Queries object.
1694
- * @example
1695
- * This example creates a Store, creates a Queries object, defines a simple
1696
- * query, and then removes it.
1697
- *
1698
- * ```js
1699
- * const store = createStore().setTable('pets', {
1700
- * fido: {species: 'dog', color: 'brown'},
1701
- * felix: {species: 'cat', color: 'black'},
1702
- * cujo: {species: 'dog', color: 'black'},
1703
- * });
1704
- *
1705
- * const queries = createQueries(store);
1706
- * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
1707
- * select('color');
1708
- * where('species', 'dog');
1709
- * });
1710
- * console.log(queries.getQueryIds());
1711
- * // -> ['dogColors']
1712
- *
1713
- * queries.delQueryDefinition('dogColors');
1714
- * console.log(queries.getQueryIds());
1715
- * // -> []
1716
- * ```
1717
- * @category Configuration
1718
- * @since v2.0.0
1719
- */
1720
- delQueryDefinition(queryId: Id): Queries;
1721
-
1722
- /**
1723
- * The getStore method returns a reference to the underlying Store that is
1724
- * backing this Queries object.
1725
- * @returns A reference to the Store.
1726
- * @example
1727
- * This example creates a Queries object against a newly-created Store and
1728
- * then gets its reference in order to update its data.
1729
- *
1730
- * ```js
1731
- * const queries = createQueries(createStore());
1732
- * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
1733
- * select('color');
1734
- * where('species', 'dog');
1735
- * });
1736
- * queries
1737
- * .getStore()
1738
- * .setRow('pets', 'fido', {species: 'dog', color: 'brown'});
1739
- * console.log(queries.getResultTable('dogColors'));
1740
- * // -> {fido: {color: 'brown'}}
1741
- * ```
1742
- * @category Getter
1743
- * @since v2.0.0
1744
- */
1745
- getStore(): Store;
1746
-
1747
- /**
1748
- * The getQueryIds method returns an array of the query Ids registered with
1749
- * this Queries object.
1750
- * @returns An array of Ids.
1751
- * @example
1752
- * This example creates a Queries object with two definitions, and then gets
1753
- * the Ids of the definitions.
1754
- *
1755
- * ```js
1756
- * const queries = createQueries(createStore())
1757
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
1758
- * select('color');
1759
- * where('species', 'dog');
1760
- * })
1761
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
1762
- * select('color');
1763
- * where('species', 'cat');
1764
- * });
1765
- *
1766
- * console.log(queries.getQueryIds());
1767
- * // -> ['dogColors', 'catColors']
1768
- * ```
1769
- * @category Getter
1770
- * @since v2.0.0
1771
- */
1772
- getQueryIds(): Ids;
1773
-
1774
- /**
1775
- * The forEachQuery method takes a function that it will then call for each
1776
- * Query in the Queries object.
1777
- *
1778
- * This method is useful for iterating over all the queries in a functional
1779
- * style. The `queryCallback` parameter is a QueryCallback function that will
1780
- * be called with the Id of each query.
1781
- * @param queryCallback The function that should be called for every query.
1782
- * @example
1783
- * This example iterates over each query in a Queries object.
1784
- *
1785
- * ```js
1786
- * const queries = createQueries(createStore())
1787
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
1788
- * select('color');
1789
- * where('species', 'dog');
1790
- * })
1791
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
1792
- * select('color');
1793
- * where('species', 'cat');
1794
- * });
1795
- *
1796
- * queries.forEachQuery((queryId) => {
1797
- * console.log(queryId);
1798
- * });
1799
- * // -> 'dogColors'
1800
- * // -> 'catColors'
1801
- * ```
1802
- * @category Iterator
1803
- * @since v2.0.0
1804
- */
1805
- forEachQuery(queryCallback: QueryCallback): void;
1806
-
1807
- /**
1808
- * The hasQuery method returns a boolean indicating whether a given query
1809
- * exists in the Queries object.
1810
- * @param queryId The Id of a possible query in the Queries object.
1811
- * @returns Whether a query with that Id exists.
1812
- * @example
1813
- * This example shows two simple query existence checks.
1814
- *
1815
- * ```js
1816
- * const queries = createQueries(createStore()).setQueryDefinition(
1817
- * 'dogColors',
1818
- * 'pets',
1819
- * ({select, where}) => {
1820
- * select('color');
1821
- * where('species', 'dog');
1822
- * },
1823
- * );
1824
- *
1825
- * console.log(queries.hasQuery('dogColors'));
1826
- * // -> true
1827
- * console.log(queries.hasQuery('catColors'));
1828
- * // -> false
1829
- * ```
1830
- * @category Getter
1831
- * @since v2.0.0
1832
- */
1833
- hasQuery(queryId: Id): boolean;
1834
-
1835
- /**
1836
- * The getTableId method returns the Id of the underlying Table that is
1837
- * backing a query.
1838
- *
1839
- * If the query Id is invalid, the method returns `undefined`.
1840
- * @param queryId The Id of a query.
1841
- * @returns The Id of the Table backing the query, or `undefined`.
1842
- * @example
1843
- * This example creates a Queries object, a single query definition, and then
1844
- * calls this method on it (as well as a non-existent definition) to get the
1845
- * underlying Table Id.
1846
- *
1847
- * ```js
1848
- * const queries = createQueries(createStore()).setQueryDefinition(
1849
- * 'dogColors',
1850
- * 'pets',
1851
- * ({select, where}) => {
1852
- * select('color');
1853
- * where('species', 'dog');
1854
- * },
1855
- * );
1856
- *
1857
- * console.log(queries.getTableId('dogColors'));
1858
- * // -> 'pets'
1859
- * console.log(queries.getTableId('catColors'));
1860
- * // -> undefined
1861
- * ```
1862
- * @category Getter
1863
- * @since v2.0.0
1864
- */
1865
- getTableId(queryId: Id): Id | undefined;
1866
-
1867
- /**
1868
- * The getResultTable method returns an object containing the entire data of
1869
- * the ResultTable of the given query.
1870
- *
1871
- * This has the same behavior as a Store's getTable method. For example, if
1872
- * the query Id is invalid, the method returns an empty object. Similarly, it
1873
- * returns a copy of, rather than a reference to the underlying data, so
1874
- * changes made to the returned object are not made to the query results
1875
- * themselves.
1876
- * @param queryId The Id of a query.
1877
- * @returns An object containing the entire data of the ResultTable of the
1878
- * query.
1879
- * @returns The result of the query, structured as a ResultTable.
1880
- * @example
1881
- * This example creates a Queries object, a single query definition, and then
1882
- * calls this method on it (as well as a non-existent definition) to get the
1883
- * ResultTable.
1884
- *
1885
- * ```js
1886
- * const store = createStore().setTable('pets', {
1887
- * fido: {species: 'dog', color: 'brown'},
1888
- * felix: {species: 'cat', color: 'black'},
1889
- * cujo: {species: 'dog', color: 'black'},
1890
- * });
1891
- *
1892
- * const queries = createQueries(store).setQueryDefinition(
1893
- * 'dogColors',
1894
- * 'pets',
1895
- * ({select, where}) => {
1896
- * select('color');
1897
- * where('species', 'dog');
1898
- * },
1899
- * );
1900
- *
1901
- * console.log(queries.getResultTable('dogColors'));
1902
- * // -> {fido: {color: 'brown'}, cujo: {color: 'black'}}
1903
- *
1904
- * console.log(queries.getResultTable('catColors'));
1905
- * // -> {}
1906
- * ```
1907
- * @category Result
1908
- * @since v2.0.0
1909
- */
1910
- getResultTable(queryId: Id): ResultTable;
1911
-
1912
- /**
1913
- * The getResultTableCellIds method returns the Ids of every ResultCell used
1914
- * across the ResultTable of the given query.
1915
- *
1916
- * This has the same behavior as a Store's getTableCellIds method. For
1917
- * example, if the query Id is invalid, the method returns an empty array.
1918
- * Similarly, it returns a copy of, rather than a reference to the list of
1919
- * Ids, so changes made to the list object are not made to the query results
1920
- * themselves.
1921
- * @param queryId The Id of a query.
1922
- * @returns An array of the Ids of every ResultCell used across the
1923
- * ResultTable of the query.
1924
- * @example
1925
- * This example creates a Queries object, a single query definition, and then
1926
- * calls this method on it (as well as a non-existent definition) to get the
1927
- * ResultCell Ids.
1928
- *
1929
- * ```js
1930
- * const store = createStore().setTable('pets', {
1931
- * fido: {species: 'dog', color: 'brown'},
1932
- * felix: {species: 'cat', color: 'black'},
1933
- * cujo: {species: 'dog', color: 'black', legs: 4},
1934
- * });
1935
- *
1936
- * const queries = createQueries(store).setQueryDefinition(
1937
- * 'dogColors',
1938
- * 'pets',
1939
- * ({select, where}) => {
1940
- * select('color');
1941
- * select('legs');
1942
- * where('species', 'dog');
1943
- * },
1944
- * );
1945
- *
1946
- * console.log(queries.getResultTableCellIds('dogColors'));
1947
- * // -> ['color', 'legs']
1948
- *
1949
- * console.log(queries.getResultTableCellIds('catColors'));
1950
- * // -> []
1951
- * ```
1952
- * @category Result
1953
- * @since v4.1.0
1954
- */
1955
- getResultTableCellIds(queryId: Id): Ids;
1956
-
1957
- /**
1958
- * The getResultRowCount method returns the count of the ResultRow objects in
1959
- * the ResultTable of the given query.
1960
- *
1961
- * This has the same behavior as a Store's getRowCount method. For example, if
1962
- * the query Id is invalid, the method returns zero.
1963
- * @param queryId The Id of a query.
1964
- * @returns The number of ResultRow objects in the result of the query.
1965
- * @example
1966
- * This example creates a Queries object, a single query definition, and then
1967
- * calls this method on it (as well as a non-existent definition) to get the
1968
- * ResultRow count.
1969
- *
1970
- * ```js
1971
- * const store = createStore().setTable('pets', {
1972
- * fido: {species: 'dog', color: 'brown'},
1973
- * felix: {species: 'cat', color: 'black'},
1974
- * cujo: {species: 'dog', color: 'black'},
1975
- * });
1976
- *
1977
- * const queries = createQueries(store).setQueryDefinition(
1978
- * 'dogColors',
1979
- * 'pets',
1980
- * ({select, where}) => {
1981
- * select('color');
1982
- * where('species', 'dog');
1983
- * },
1984
- * );
1985
- *
1986
- * console.log(queries.getResultRowCount('dogColors'));
1987
- * // -> 2
1988
- *
1989
- * console.log(queries.getResultRowCount('catColors'));
1990
- * // -> 0
1991
- * ```
1992
- * @category Result
1993
- * @since v4.1.0
1994
- */
1995
- getResultRowCount(queryId: Id): number;
1996
-
1997
- /**
1998
- * The getResultRowIds method returns the Ids of every ResultRow in the
1999
- * ResultTable of the given query.
2000
- *
2001
- * This has the same behavior as a Store's getRowIds method. For example, if
2002
- * the query Id is invalid, the method returns an empty array. Similarly, it
2003
- * returns a copy of, rather than a reference to the list of Ids, so changes
2004
- * made to the list object are not made to the query results themselves.
2005
- * @param queryId The Id of a query.
2006
- * @returns An array of the Ids of every ResultRow in the result of the query.
2007
- * @example
2008
- * This example creates a Queries object, a single query definition, and then
2009
- * calls this method on it (as well as a non-existent definition) to get the
2010
- * ResultRow Ids.
2011
- *
2012
- * ```js
2013
- * const store = createStore().setTable('pets', {
2014
- * fido: {species: 'dog', color: 'brown'},
2015
- * felix: {species: 'cat', color: 'black'},
2016
- * cujo: {species: 'dog', color: 'black'},
2017
- * });
2018
- *
2019
- * const queries = createQueries(store).setQueryDefinition(
2020
- * 'dogColors',
2021
- * 'pets',
2022
- * ({select, where}) => {
2023
- * select('color');
2024
- * where('species', 'dog');
2025
- * },
2026
- * );
2027
- *
2028
- * console.log(queries.getResultRowIds('dogColors'));
2029
- * // -> ['fido', 'cujo']
2030
- *
2031
- * console.log(queries.getResultRowIds('catColors'));
2032
- * // -> []
2033
- * ```
2034
- * @category Result
2035
- * @since v2.0.0
2036
- */
2037
- getResultRowIds(queryId: Id): Ids;
2038
-
2039
- /**
2040
- * The getResultSortedRowIds method returns the Ids of every ResultRow in the
2041
- * ResultTable of the given query, sorted according to the values in a
2042
- * specified ResultCell.
2043
- *
2044
- * This has the same behavior as a Store's getSortedRowIds method. For
2045
- * example, if the query Id is invalid, the method returns an empty array.
2046
- * Similarly, the sorting of the rows is alphanumeric, and you can indicate
2047
- * whether it should be in descending order. The `offset` and `limit`
2048
- * parameters are used to paginate results, but default to `0` and `undefined`
2049
- * to return all available ResultRow Ids if not specified.
2050
- *
2051
- * Note that every call to this method will perform the sorting afresh - there
2052
- * is no caching of the results - and so you are advised to memoize the
2053
- * results yourself, especially when the ResultTable is large. For a
2054
- * performant approach to tracking the sorted ResultRow Ids when they change,
2055
- * use the addResultSortedRowIdsListener method.
2056
- * @param queryId The Id of a query.
2057
- * @param cellId The Id of the ResultCell whose values are used for the
2058
- * sorting, or `undefined` to by sort the ResultRow Id itself.
2059
- * @param descending Whether the sorting should be in descending order.
2060
- * @param offset The number of ResultRow Ids to skip for pagination purposes,
2061
- * if any.
2062
- * @param limit The maximum number of ResultRow Ids to return, or `undefined`
2063
- * for all.
2064
- * @returns An array of the sorted Ids of every ResultRow in the result of the
2065
- * query.
2066
- * @example
2067
- * This example creates a Queries object, a single query definition, and then
2068
- * calls this method on it (as well as a non-existent definition) to get the
2069
- * ResultRow Ids.
2070
- *
2071
- * ```js
2072
- * const store = createStore().setTable('pets', {
2073
- * fido: {species: 'dog', color: 'brown'},
2074
- * felix: {species: 'cat', color: 'black'},
2075
- * cujo: {species: 'dog', color: 'black'},
2076
- * });
2077
- *
2078
- * const queries = createQueries(store).setQueryDefinition(
2079
- * 'dogColors',
2080
- * 'pets',
2081
- * ({select, where}) => {
2082
- * select('color');
2083
- * where('species', 'dog');
2084
- * },
2085
- * );
2086
- *
2087
- * console.log(queries.getResultSortedRowIds('dogColors', 'color'));
2088
- * // -> ['cujo', 'fido']
2089
- *
2090
- * console.log(queries.getResultSortedRowIds('catColors', 'color'));
2091
- * // -> []
2092
- * ```
2093
- * @category Result
2094
- * @since v2.0.0
2095
- */
2096
- getResultSortedRowIds(
2097
- queryId: Id,
2098
- cellId?: Id,
2099
- descending?: boolean,
2100
- offset?: number,
2101
- limit?: number,
2102
- ): Ids;
2103
-
2104
- /**
2105
- * The getResultRow method returns an object containing the entire data of a
2106
- * single ResultRow in the ResultTable of the given query.
2107
- *
2108
- * This has the same behavior as a Store's getRow method. For example, if the
2109
- * query or ResultRow Id is invalid, the method returns an empty object.
2110
- * Similarly, it returns a copy of, rather than a reference to the underlying
2111
- * data, so changes made to the returned object are not made to the query
2112
- * results themselves.
2113
- * @param queryId The Id of a query.
2114
- * @param rowId The Id of the ResultRow in the ResultTable.
2115
- * @returns An object containing the entire data of the ResultRow in the
2116
- * ResultTable of the query.
2117
- * @example
2118
- * This example creates a Queries object, a single query definition, and then
2119
- * calls this method on it (as well as a non-existent ResultRow Id) to get
2120
- * the ResultRow.
2121
- *
2122
- * ```js
2123
- * const store = createStore().setTable('pets', {
2124
- * fido: {species: 'dog', color: 'brown'},
2125
- * felix: {species: 'cat', color: 'black'},
2126
- * cujo: {species: 'dog', color: 'black'},
2127
- * });
2128
- *
2129
- * const queries = createQueries(store).setQueryDefinition(
2130
- * 'dogColors',
2131
- * 'pets',
2132
- * ({select, where}) => {
2133
- * select('color');
2134
- * where('species', 'dog');
2135
- * },
2136
- * );
2137
- *
2138
- * console.log(queries.getResultRow('dogColors', 'fido'));
2139
- * // -> {color: 'brown'}
2140
- *
2141
- * console.log(queries.getResultRow('dogColors', 'felix'));
2142
- * // -> {}
2143
- * ```
2144
- * @category Result
2145
- * @since v2.0.0
2146
- */
2147
- getResultRow(queryId: Id, rowId: Id): ResultRow;
2148
-
2149
- /**
2150
- * The getResultCellIds method returns the Ids of every ResultCell in a given
2151
- * ResultRow, in the ResultTable of the given query.
2152
- *
2153
- * This has the same behavior as a Store's getCellIds method. For example, if
2154
- * the query Id or ResultRow Id is invalid, the method returns an empty array.
2155
- * Similarly, it returns a copy of, rather than a reference to the list of
2156
- * Ids, so changes made to the list object are not made to the query results
2157
- * themselves.
2158
- * @param queryId The Id of a query.
2159
- * @param rowId The Id of the ResultRow in the ResultTable.
2160
- * @returns An array of the Ids of every ResultCell in the ResultRow in the
2161
- * result of the query.
2162
- * @example
2163
- * This example creates a Queries object, a single query definition, and then
2164
- * calls this method on it (as well as a non-existent ResultRow Id) to get the
2165
- * ResultCell Ids.
2166
- *
2167
- * ```js
2168
- * const store = createStore().setTable('pets', {
2169
- * fido: {species: 'dog', color: 'brown'},
2170
- * felix: {species: 'cat', color: 'black'},
2171
- * cujo: {species: 'dog', color: 'black'},
2172
- * });
2173
- *
2174
- * const queries = createQueries(store).setQueryDefinition(
2175
- * 'dogColors',
2176
- * 'pets',
2177
- * ({select, where}) => {
2178
- * select('color');
2179
- * where('species', 'dog');
2180
- * },
2181
- * );
2182
- *
2183
- * console.log(queries.getResultCellIds('dogColors', 'fido'));
2184
- * // -> ['color']
2185
- *
2186
- * console.log(queries.getResultCellIds('dogColors', 'felix'));
2187
- * // -> []
2188
- * ```
2189
- * @category Result
2190
- * @since v2.0.0
2191
- */
2192
- getResultCellIds(queryId: Id, rowId: Id): Ids;
2193
-
2194
- /**
2195
- * The getResultCell method returns the value of a single ResultCell in a
2196
- * given ResultRow, in the ResultTable of the given query.
2197
- *
2198
- * This has the same behavior as a Store's getCell method. For example, if the
2199
- * query, or ResultRow, or ResultCell Id is invalid, the method returns
2200
- * `undefined`.
2201
- * @param queryId The Id of a query.
2202
- * @param rowId The Id of the ResultRow in the ResultTable.
2203
- * @param cellId The Id of the ResultCell in the ResultRow.
2204
- * @returns The value of the ResultCell, or `undefined`.
2205
- * @example
2206
- * This example creates a Queries object, a single query definition, and then
2207
- * calls this method on it (as well as a non-existent ResultCell Id) to get
2208
- * the ResultCell.
2209
- *
2210
- * ```js
2211
- * const store = createStore().setTable('pets', {
2212
- * fido: {species: 'dog', color: 'brown'},
2213
- * felix: {species: 'cat', color: 'black'},
2214
- * cujo: {species: 'dog', color: 'black'},
2215
- * });
2216
- *
2217
- * const queries = createQueries(store).setQueryDefinition(
2218
- * 'dogColors',
2219
- * 'pets',
2220
- * ({select, where}) => {
2221
- * select('color');
2222
- * where('species', 'dog');
2223
- * },
2224
- * );
2225
- *
2226
- * console.log(queries.getResultCell('dogColors', 'fido', 'color'));
2227
- * // -> 'brown'
2228
- *
2229
- * console.log(queries.getResultCell('dogColors', 'fido', 'species'));
2230
- * // -> undefined
2231
- * ```
2232
- * @category Result
2233
- * @since v2.0.0
2234
- */
2235
- getResultCell(queryId: Id, rowId: Id, cellId: Id): ResultCellOrUndefined;
2236
-
2237
- /**
2238
- * The hasResultTable method returns a boolean indicating whether a given
2239
- * ResultTable exists.
2240
- * @param queryId The Id of a possible query.
2241
- * @returns Whether a ResultTable for that query Id exists.
2242
- * @example
2243
- * This example shows two simple ResultTable existence checks.
2244
- *
2245
- * ```js
2246
- * const store = createStore().setTable('pets', {
2247
- * fido: {species: 'dog', color: 'brown'},
2248
- * felix: {species: 'cat', color: 'black'},
2249
- * cujo: {species: 'dog', color: 'black'},
2250
- * });
2251
- *
2252
- * const queries = createQueries(store).setQueryDefinition(
2253
- * 'dogColors',
2254
- * 'pets',
2255
- * ({select, where}) => {
2256
- * select('color');
2257
- * where('species', 'dog');
2258
- * },
2259
- * );
2260
- *
2261
- * console.log(queries.hasResultTable('dogColors'));
2262
- * // -> true
2263
- * console.log(queries.hasResultTable('catColors'));
2264
- * // -> false
2265
- * ```
2266
- * @category Result
2267
- * @since v2.0.0
2268
- */
2269
- hasResultTable(queryId: Id): boolean;
2270
-
2271
- /**
2272
- * The hasResultRow method returns a boolean indicating whether a given
2273
- * ResultRow exists.
2274
- * @param queryId The Id of a possible query.
2275
- * @param rowId The Id of a possible ResultRow.
2276
- * @returns Whether a ResultRow for that Id exists.
2277
- * @example
2278
- * This example shows two simple ResultRow existence checks.
2279
- *
2280
- * ```js
2281
- * const store = createStore().setTable('pets', {
2282
- * fido: {species: 'dog', color: 'brown'},
2283
- * felix: {species: 'cat', color: 'black'},
2284
- * cujo: {species: 'dog', color: 'black'},
2285
- * });
2286
- *
2287
- * const queries = createQueries(store).setQueryDefinition(
2288
- * 'dogColors',
2289
- * 'pets',
2290
- * ({select, where}) => {
2291
- * select('color');
2292
- * where('species', 'dog');
2293
- * },
2294
- * );
2295
- *
2296
- * console.log(queries.hasResultRow('dogColors', 'fido'));
2297
- * // -> true
2298
- * console.log(queries.hasResultRow('dogColors', 'felix'));
2299
- * // -> false
2300
- * ```
2301
- * @category Result
2302
- * @since v2.0.0
2303
- */
2304
- hasResultRow(queryId: Id, rowId: Id): boolean;
2305
-
2306
- /**
2307
- * The hasResultCell method returns a boolean indicating whether a given
2308
- * ResultCell exists.
2309
- * @param queryId The Id of a possible query.
2310
- * @param rowId The Id of a possible ResultRow.
2311
- * @param cellId The Id of a possible ResultCell.
2312
- * @returns Whether a ResultCell for that Id exists.
2313
- * @example
2314
- * This example shows two simple ResultRow existence checks.
2315
- *
2316
- * ```js
2317
- * const store = createStore().setTable('pets', {
2318
- * fido: {species: 'dog', color: 'brown'},
2319
- * felix: {species: 'cat', color: 'black'},
2320
- * cujo: {species: 'dog', color: 'black'},
2321
- * });
2322
- *
2323
- * const queries = createQueries(store).setQueryDefinition(
2324
- * 'dogColors',
2325
- * 'pets',
2326
- * ({select, where}) => {
2327
- * select('color');
2328
- * where('species', 'dog');
2329
- * },
2330
- * );
2331
- *
2332
- * console.log(queries.hasResultCell('dogColors', 'fido', 'color'));
2333
- * // -> true
2334
- * console.log(queries.hasResultCell('dogColors', 'fido', 'species'));
2335
- * // -> false
2336
- * ```
2337
- * @category Result
2338
- * @since v2.0.0
2339
- */
2340
- hasResultCell(queryId: Id, rowId: Id, cellId: Id): boolean;
2341
-
2342
- /**
2343
- * The forEachResultTable method takes a function that it will then call for
2344
- * each ResultTable in the Queries object.
2345
- *
2346
- * This method is useful for iterating over all the ResultTables of the
2347
- * queries in a functional style. The `tableCallback` parameter is a
2348
- * ResultTableCallback function that will be called with the Id of each
2349
- * ResultTable, and with a function that can then be used to iterate over each
2350
- * ResultRow of the ResultTable, should you wish.
2351
- * @param tableCallback The function that should be called for every query's
2352
- * ResultTable.
2353
- * @example
2354
- * This example iterates over each query's ResultTable in a Queries object.
2355
- *
2356
- * ```js
2357
- * const store = createStore().setTable('pets', {
2358
- * fido: {species: 'dog', color: 'brown'},
2359
- * felix: {species: 'cat', color: 'black'},
2360
- * cujo: {species: 'dog', color: 'black'},
2361
- * });
2362
- *
2363
- * const queries = createQueries(store)
2364
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
2365
- * select('color');
2366
- * where('species', 'dog');
2367
- * })
2368
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
2369
- * select('color');
2370
- * where('species', 'cat');
2371
- * });
2372
- *
2373
- * queries.forEachResultTable((queryId, forEachRow) => {
2374
- * console.log(queryId);
2375
- * forEachRow((rowId) => console.log(`- ${rowId}`));
2376
- * });
2377
- * // -> 'dogColors'
2378
- * // -> '- fido'
2379
- * // -> '- cujo'
2380
- * // -> 'catColors'
2381
- * // -> '- felix'
2382
- * ```
2383
- * @category Iterator
2384
- * @since v2.0.0
2385
- */
2386
- forEachResultTable(tableCallback: ResultTableCallback): void;
2387
-
2388
- /**
2389
- * The forEachResultRow method takes a function that it will then call for
2390
- * each ResultRow in the ResultTable of a query.
2391
- *
2392
- * This method is useful for iterating over each ResultRow of the ResultTable
2393
- * of the query in a functional style. The `rowCallback` parameter is a
2394
- * ResultRowCallback function that will be called with the Id of each
2395
- * ResultRow, and with a function that can then be used to iterate over each
2396
- * ResultCell of the ResultRow, should you wish.
2397
- * @param queryId The Id of a query.
2398
- * @param rowCallback The function that should be called for every ResultRow
2399
- * of the query's ResultTable.
2400
- * @example
2401
- * This example iterates over each ResultRow in a query's ResultTable.
2402
- *
2403
- * ```js
2404
- * const store = createStore().setTable('pets', {
2405
- * fido: {species: 'dog', color: 'brown'},
2406
- * felix: {species: 'cat', color: 'black'},
2407
- * cujo: {species: 'dog', color: 'black'},
2408
- * });
2409
- *
2410
- * const queries = createQueries(store).setQueryDefinition(
2411
- * 'dogColors',
2412
- * 'pets',
2413
- * ({select, where}) => {
2414
- * select('color');
2415
- * where('species', 'dog');
2416
- * },
2417
- * );
2418
- *
2419
- * queries.forEachResultRow('dogColors', (rowId, forEachCell) => {
2420
- * console.log(rowId);
2421
- * forEachCell((cellId) => console.log(`- ${cellId}`));
2422
- * });
2423
- * // -> 'fido'
2424
- * // -> '- color'
2425
- * // -> 'cujo'
2426
- * // -> '- color'
2427
- * ```
2428
- * @category Iterator
2429
- * @since v2.0.0
2430
- */
2431
- forEachResultRow(queryId: Id, rowCallback: ResultRowCallback): void;
2432
-
2433
- /**
2434
- * The forEachResultCell method takes a function that it will then call for
2435
- * each ResultCell in the ResultRow of a query.
2436
- *
2437
- * This method is useful for iterating over each ResultCell of the ResultRow
2438
- * of the query in a functional style. The `cellCallback` parameter is a
2439
- * ResultCellCallback function that will be called with the Id and value of
2440
- * each ResultCell.
2441
- * @param queryId The Id of a query.
2442
- * @param rowId The Id of a ResultRow in the query's ResultTable.
2443
- * @param cellCallback The function that should be called for every ResultCell
2444
- * of the query's ResultRow.
2445
- * @example
2446
- * This example iterates over each ResultCell in a query's ResultRow.
2447
- *
2448
- * ```js
2449
- * const store = createStore().setTable('pets', {
2450
- * fido: {species: 'dog', color: 'brown'},
2451
- * felix: {species: 'cat', color: 'black'},
2452
- * cujo: {species: 'dog', color: 'black'},
2453
- * });
2454
- *
2455
- * const queries = createQueries(store).setQueryDefinition(
2456
- * 'dogColors',
2457
- * 'pets',
2458
- * ({select, where}) => {
2459
- * select('species');
2460
- * select('color');
2461
- * where('species', 'dog');
2462
- * },
2463
- * );
2464
- *
2465
- * queries.forEachResultCell('dogColors', 'fido', (cellId, cell) => {
2466
- * console.log(`${cellId}: ${cell}`);
2467
- * });
2468
- * // -> 'species: dog'
2469
- * // -> 'color: brown'
2470
- * ```
2471
- * @category Iterator
2472
- * @since v2.0.0
2473
- */
2474
- forEachResultCell(
2475
- queryId: Id,
2476
- rowId: Id,
2477
- cellCallback: ResultCellCallback,
2478
- ): void;
2479
-
2480
- /**
2481
- * The addQueryIdsListener method registers a listener function with the
2482
- * Queries object that will be called whenever an Query definition is added or
2483
- * removed.
2484
- *
2485
- * The provided listener is a QueryIdsListener function, and will be called
2486
- * with a reference to the Queries object.
2487
- * @param listener The function that will be called whenever a Query
2488
- * definition is added or removed.
2489
- * @example
2490
- * This example creates a Store, a Queries object, and then registers a
2491
- * listener that responds to the addition and the removal of a Query
2492
- * definition.
2493
- *
2494
- * ```js
2495
- * const store = createStore().setTable('pets', {
2496
- * fido: {species: 'dog', color: 'brown'},
2497
- * felix: {species: 'cat', color: 'black'},
2498
- * cujo: {species: 'dog', color: 'black'},
2499
- * });
2500
- *
2501
- * const queries = createQueries(store);
2502
- * const listenerId = queries.addQueryIdsListener((queries) => {
2503
- * console.log(queries.getQueryIds());
2504
- * });
2505
- *
2506
- * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
2507
- * select('color');
2508
- * where('species', 'dog');
2509
- * });
2510
- * // -> ['dogColors']
2511
- * queries.delQueryDefinition('dogColors');
2512
- * // -> []
2513
- *
2514
- * queries.delListener(listenerId);
2515
- * ```
2516
- * @category Listener
2517
- * @since v4.1.0
2518
- */
2519
- addQueryIdsListener(listener: QueryIdsListener): Id;
2520
-
2521
- /**
2522
- * The addResultTableListener method registers a listener function with the
2523
- * Queries object that will be called whenever data in a ResultTable changes.
2524
- *
2525
- * The provided listener is a ResultTableListener function, and will be called
2526
- * with a reference to the Queries object, the Id of the ResultTable that
2527
- * changed (which is also the query Id), and a GetResultCellChange function in
2528
- * case you need to inspect any changes that occurred.
2529
- *
2530
- * You can either listen to a single ResultTable (by specifying a query Id as
2531
- * the method's first parameter) or changes to any ResultTable (by providing a
2532
- * `null` wildcard).
2533
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
2534
- * @param listener The function that will be called whenever data in the
2535
- * matching ResultTable changes.
2536
- * @returns A unique Id for the listener that can later be used to remove it.
2537
- * @example
2538
- * This example registers a listener that responds to any changes to a
2539
- * specific ResultTable.
2540
- *
2541
- * ```js
2542
- * const store = createStore().setTable('pets', {
2543
- * fido: {species: 'dog', color: 'brown'},
2544
- * felix: {species: 'cat', color: 'black'},
2545
- * cujo: {species: 'dog', color: 'black'},
2546
- * });
2547
- *
2548
- * const queries = createQueries(store).setQueryDefinition(
2549
- * 'dogColors',
2550
- * 'pets',
2551
- * ({select, where}) => {
2552
- * select('color');
2553
- * where('species', 'dog');
2554
- * },
2555
- * );
2556
- *
2557
- * const listenerId = queries.addResultTableListener(
2558
- * 'dogColors',
2559
- * (queries, tableId, getCellChange) => {
2560
- * console.log('dogColors result table changed');
2561
- * console.log(getCellChange('dogColors', 'fido', 'color'));
2562
- * },
2563
- * );
2564
- *
2565
- * store.setCell('pets', 'fido', 'color', 'walnut');
2566
- * // -> 'dogColors result table changed'
2567
- * // -> [true, 'brown', 'walnut']
2568
- *
2569
- * store.delListener(listenerId);
2570
- * ```
2571
- * @example
2572
- * This example registers a listener that responds to any changes to any
2573
- * ResultTable.
2574
- *
2575
- * ```js
2576
- * const store = createStore().setTable('pets', {
2577
- * fido: {species: 'dog', color: 'brown'},
2578
- * felix: {species: 'cat', color: 'black'},
2579
- * cujo: {species: 'dog', color: 'black'},
2580
- * });
2581
- *
2582
- * const queries = createQueries(store)
2583
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
2584
- * select('color');
2585
- * where('species', 'dog');
2586
- * })
2587
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
2588
- * select('color');
2589
- * where('species', 'cat');
2590
- * });
2591
- *
2592
- * const listenerId = queries.addResultTableListener(
2593
- * null,
2594
- * (queries, tableId) => {
2595
- * console.log(`${tableId} result table changed`);
2596
- * },
2597
- * );
2598
- *
2599
- * store.setCell('pets', 'fido', 'color', 'walnut');
2600
- * // -> 'dogColors result table changed'
2601
- * store.setCell('pets', 'felix', 'color', 'tortoiseshell');
2602
- * // -> 'catColors result table changed'
2603
- *
2604
- * store.delListener(listenerId);
2605
- * ```
2606
- * @category Listener
2607
- * @since v2.0.0
2608
- */
2609
- addResultTableListener(queryId: IdOrNull, listener: ResultTableListener): Id;
2610
-
2611
- /**
2612
- * The addResultTableCellIdsListener method registers a listener function with
2613
- * the Queries object that will be called whenever the Cell Ids that
2614
- * appear anywhere in a ResultTable change.
2615
- *
2616
- * The provided listener is a ResultTableCellIdsListener function, and will be
2617
- * called with a reference to the Queries object and the Id of the ResultTable
2618
- * that changed (which is also the query Id).
2619
- *
2620
- * By default, such a listener is only called when a Cell Id is added
2621
- * to, or removed from, the ResultTable. To listen to all changes in the
2622
- * ResultTable, use the addResultTableListener method.
2623
- *
2624
- * You can either listen to a single ResultTable (by specifying a query Id as
2625
- * the method's first parameter) or changes to any ResultTable (by providing a
2626
- * `null` wildcard).
2627
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
2628
- * @param listener The function that will be called whenever the Cell
2629
- * Ids that appear anywhere in the ResultTable change.
2630
- * @returns A unique Id for the listener that can later be used to remove it.
2631
- * @example
2632
- * This example registers a listener that responds to any change to the
2633
- * Cell Ids of a specific ResultTable.
2634
- *
2635
- * ```js
2636
- * const store = createStore().setTable('pets', {
2637
- * fido: {species: 'dog', color: 'brown'},
2638
- * felix: {species: 'cat', color: 'black'},
2639
- * cujo: {species: 'dog', color: 'black'},
2640
- * });
2641
- *
2642
- * const queries = createQueries(store).setQueryDefinition(
2643
- * 'dogColorsAndLegs',
2644
- * 'pets',
2645
- * ({select, where}) => {
2646
- * select('color');
2647
- * select('legs');
2648
- * where('species', 'dog');
2649
- * },
2650
- * );
2651
- *
2652
- * const listenerId = queries.addResultTableCellIdsListener(
2653
- * 'dogColorsAndLegs',
2654
- * (queries, tableId) => {
2655
- * console.log(`Cell Ids for dogColorsAndLegs result table changed`);
2656
- * console.log(queries.getResultTableCellIds('dogColorsAndLegs'));
2657
- * },
2658
- * );
2659
- *
2660
- * store.setCell('pets', 'cujo', 'legs', 4);
2661
- * // -> 'Cell Ids for dogColorsAndLegs result table changed'
2662
- * // -> ['color', 'legs']
2663
- *
2664
- * store.delListener(listenerId);
2665
- * ```
2666
- * @example
2667
- * This example registers a listener that responds to any change to the
2668
- * ResultCell Ids of any ResultTable.
2669
- *
2670
- * ```js
2671
- * const store = createStore().setTable('pets', {
2672
- * fido: {species: 'dog', color: 'brown'},
2673
- * felix: {species: 'cat', color: 'black', legs: 4},
2674
- * cujo: {species: 'dog', color: 'black'},
2675
- * });
2676
- *
2677
- * const queries = createQueries(store)
2678
- * .setQueryDefinition('dogColorsAndLegs', 'pets', ({select, where}) => {
2679
- * select('color');
2680
- * select('legs');
2681
- * where('species', 'dog');
2682
- * })
2683
- * .setQueryDefinition('catColorsAndLegs', 'pets', ({select, where}) => {
2684
- * select('color');
2685
- * select('legs');
2686
- * where('species', 'cat');
2687
- * });
2688
- *
2689
- * const listenerId = queries.addResultTableCellIdsListener(
2690
- * null,
2691
- * (queries, tableId) => {
2692
- * console.log(`Cell Ids for ${tableId} result table changed`);
2693
- * },
2694
- * );
2695
- *
2696
- * store.setCell('pets', 'cujo', 'legs', 4);
2697
- * // -> 'Cell Ids for dogColorsAndLegs result table changed'
2698
- * store.delCell('pets', 'felix', 'legs');
2699
- * // -> 'Cell Ids for catColorsAndLegs result table changed'
2700
- *
2701
- * store.delListener(listenerId);
2702
- * ```
2703
- * @category Listener
2704
- * @since v2.0.0
2705
- */
2706
- addResultTableCellIdsListener(
2707
- queryId: IdOrNull,
2708
- listener: ResultTableCellIdsListener,
2709
- ): Id;
2710
-
2711
- /**
2712
- * The addResultRowCountListener method registers a listener function with the
2713
- * Queries object that will be called whenever the count of ResultRow objects
2714
- * in a ResultTable changes.
2715
- *
2716
- * The provided listener is a ResultRowCountListener function, and will be
2717
- * called with a reference to the Queries object, the Id of the ResultTable
2718
- * that changed (which is also the query Id), and the number of ResultRow
2719
- * objects in th ResultTable.
2720
- *
2721
- * You can either listen to a single ResultTable (by specifying a query Id as
2722
- * the method's first parameter) or changes to any ResultTable (by providing a
2723
- * `null` wildcard).
2724
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
2725
- * @param listener The function that will be called whenever the number of
2726
- * ResultRow objects in the ResultTable change.
2727
- * @returns A unique Id for the listener that can later be used to remove it.
2728
- * @example
2729
- * This example registers a listener that responds to a change in the number
2730
- * of ResultRow objects in a specific ResultTable.
2731
- *
2732
- * ```js
2733
- * const store = createStore().setTable('pets', {
2734
- * fido: {species: 'dog', color: 'brown'},
2735
- * felix: {species: 'cat', color: 'black'},
2736
- * cujo: {species: 'dog', color: 'black'},
2737
- * });
2738
- *
2739
- * const queries = createQueries(store).setQueryDefinition(
2740
- * 'dogColors',
2741
- * 'pets',
2742
- * ({select, where}) => {
2743
- * select('color');
2744
- * where('species', 'dog');
2745
- * },
2746
- * );
2747
- *
2748
- * const listenerId = queries.addResultRowCountListener(
2749
- * 'dogColors',
2750
- * (queries, tableId, count) => {
2751
- * console.log(
2752
- * 'Row count for dogColors result table changed to ' + count,
2753
- * );
2754
- * },
2755
- * );
2756
- *
2757
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
2758
- * // -> 'Row count for dogColors result table changed to 3'
2759
- *
2760
- * store.delListener(listenerId);
2761
- * ```
2762
- * @example
2763
- * This example registers a listener that responds to a change in the number
2764
- * of ResultRow objects any ResultTable.
2765
- *
2766
- * ```js
2767
- * const store = createStore().setTable('pets', {
2768
- * fido: {species: 'dog', color: 'brown'},
2769
- * felix: {species: 'cat', color: 'black'},
2770
- * cujo: {species: 'dog', color: 'black'},
2771
- * });
2772
- *
2773
- * const queries = createQueries(store)
2774
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
2775
- * select('color');
2776
- * where('species', 'dog');
2777
- * })
2778
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
2779
- * select('color');
2780
- * where('species', 'cat');
2781
- * });
2782
- *
2783
- * const listenerId = queries.addResultRowCountListener(
2784
- * null,
2785
- * (queries, tableId, count) => {
2786
- * console.log(
2787
- * `Row count for ${tableId} result table changed to ${count}`,
2788
- * );
2789
- * },
2790
- * );
2791
- *
2792
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
2793
- * // -> 'Row count for dogColors result table changed to 3'
2794
- * store.setRow('pets', 'tom', {species: 'cat', color: 'gray'});
2795
- * // -> 'Row count for catColors result table changed to 2'
2796
- *
2797
- * store.delListener(listenerId);
2798
- * ```
2799
- * @category Listener
2800
- * @since v4.1.0
2801
- */
2802
- addResultRowCountListener(
2803
- queryId: IdOrNull,
2804
- listener: ResultRowCountListener,
2805
- ): Id;
2806
-
2807
- /**
2808
- * The addResultRowIdsListener method registers a listener function with the
2809
- * Queries object that will be called whenever the ResultRow Ids in a
2810
- * ResultTable change.
2811
- *
2812
- * The provided listener is a ResultRowIdsListener function, and will be
2813
- * called with a reference to the Queries object and the Id of the ResultTable
2814
- * that changed (which is also the query Id).
2815
- *
2816
- * By default, such a listener is only called when a ResultRow is added to, or
2817
- * removed from, the ResultTable. To listen to all changes in the ResultTable,
2818
- * use the addResultTableListener method.
2819
- *
2820
- * You can either listen to a single ResultTable (by specifying a query Id as
2821
- * the method's first parameter) or changes to any ResultTable (by providing a
2822
- * `null` wildcard).
2823
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
2824
- * @param listener The function that will be called whenever the ResultRow Ids
2825
- * in the ResultTable change.
2826
- * @returns A unique Id for the listener that can later be used to remove it.
2827
- * @example
2828
- * This example registers a listener that responds to any change to the
2829
- * ResultRow Ids of a specific ResultTable.
2830
- *
2831
- * ```js
2832
- * const store = createStore().setTable('pets', {
2833
- * fido: {species: 'dog', color: 'brown'},
2834
- * felix: {species: 'cat', color: 'black'},
2835
- * cujo: {species: 'dog', color: 'black'},
2836
- * });
2837
- *
2838
- * const queries = createQueries(store).setQueryDefinition(
2839
- * 'dogColors',
2840
- * 'pets',
2841
- * ({select, where}) => {
2842
- * select('color');
2843
- * where('species', 'dog');
2844
- * },
2845
- * );
2846
- *
2847
- * const listenerId = queries.addResultRowIdsListener(
2848
- * 'dogColors',
2849
- * (queries, tableId) => {
2850
- * console.log(`Row Ids for dogColors result table changed`);
2851
- * console.log(queries.getResultRowIds('dogColors'));
2852
- * },
2853
- * );
2854
- *
2855
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
2856
- * // -> 'Row Ids for dogColors result table changed'
2857
- * // -> ['fido', 'cujo', 'rex']
2858
- *
2859
- * store.delListener(listenerId);
2860
- * ```
2861
- * @example
2862
- * This example registers a listener that responds to any change to the
2863
- * ResultRow Ids of any ResultTable.
2864
- *
2865
- * ```js
2866
- * const store = createStore().setTable('pets', {
2867
- * fido: {species: 'dog', color: 'brown'},
2868
- * felix: {species: 'cat', color: 'black'},
2869
- * cujo: {species: 'dog', color: 'black'},
2870
- * });
2871
- *
2872
- * const queries = createQueries(store)
2873
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
2874
- * select('color');
2875
- * where('species', 'dog');
2876
- * })
2877
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
2878
- * select('color');
2879
- * where('species', 'cat');
2880
- * });
2881
- *
2882
- * const listenerId = queries.addResultRowIdsListener(
2883
- * null,
2884
- * (queries, tableId) => {
2885
- * console.log(`Row Ids for ${tableId} result table changed`);
2886
- * },
2887
- * );
2888
- *
2889
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
2890
- * // -> 'Row Ids for dogColors result table changed'
2891
- * store.setRow('pets', 'tom', {species: 'cat', color: 'gray'});
2892
- * // -> 'Row Ids for catColors result table changed'
2893
- *
2894
- * store.delListener(listenerId);
2895
- * ```
2896
- * @category Listener
2897
- * @since v2.0.0
2898
- */
2899
- addResultRowIdsListener(
2900
- queryId: IdOrNull,
2901
- listener: ResultRowIdsListener,
2902
- ): Id;
2903
-
2904
- /**
2905
- * The addResultSortedRowIdsListener method registers a listener function with
2906
- * the Queries object that will be called whenever sorted (and optionally,
2907
- * paginated) ResultRow Ids in a ResultTable change.
2908
- *
2909
- * The provided listener is a ResultSortedRowIdsListener function, and will be
2910
- * called with a reference to the Queries object, the Id of the ResultTable
2911
- * whose ResultRow Ids sorting changed (which is also the query Id), the
2912
- * ResultCell Id being used to sort them, whether descending or not, and the
2913
- * offset and limit of the number of Ids returned, for pagination purposes. It
2914
- * also receives the sorted array of Ids itself, so that you can use them in
2915
- * the listener without the additional cost of an explicit call to
2916
- * getResultSortedRowIds
2917
- *
2918
- * Such a listener is called when a ResultRow is added or removed, but also
2919
- * when a value in the specified ResultCell (somewhere in the ResultTable) has
2920
- * changed enough to change the sorting of the ResultRow Ids.
2921
- *
2922
- * Unlike most other listeners, you cannot provide wildcards (due to the cost
2923
- * of detecting changes to the sorting). You can only listen to a single
2924
- * specified ResultTable, sorted by a single specified ResultCell.
2925
- *
2926
- * The sorting of the rows is alphanumeric, and you can indicate whether it
2927
- * should be in descending order. The `offset` and `limit` parameters are used
2928
- * to paginate results, but default to `0` and `undefined` to return all
2929
- * available ResultRow Ids if not specified.
2930
- * @param queryId The Id of the query to listen to.
2931
- * @param cellId The Id of the ResultCell whose values are used for the
2932
- * sorting, or `undefined` to by sort the ResultRow Id itself.
2933
- * @param descending Whether the sorting should be in descending order.
2934
- * @param offset The number of ResultRow Ids to skip for pagination purposes,
2935
- * if any.
2936
- * @param limit The maximum number of ResultRow Ids to return, or `undefined`
2937
- * for all.
2938
- * @param listener The function that will be called whenever the sorted
2939
- * ResultRow Ids in the ResultTable change.
2940
- * @returns A unique Id for the listener that can later be used to remove it.
2941
- * @example
2942
- * This example registers a listener that responds to any change to the sorted
2943
- * ResultRow Ids of a specific ResultTable.
2944
- *
2945
- * ```js
2946
- * const store = createStore().setTable('pets', {
2947
- * fido: {species: 'dog', color: 'brown'},
2948
- * felix: {species: 'cat', color: 'black'},
2949
- * cujo: {species: 'dog', color: 'black'},
2950
- * });
2951
- *
2952
- * const queries = createQueries(store).setQueryDefinition(
2953
- * 'dogColors',
2954
- * 'pets',
2955
- * ({select, where}) => {
2956
- * select('color');
2957
- * where('species', 'dog');
2958
- * },
2959
- * );
2960
- *
2961
- * const listenerId = queries.addResultSortedRowIdsListener(
2962
- * 'dogColors',
2963
- * 'color',
2964
- * false,
2965
- * 0,
2966
- * undefined,
2967
- * (queries, tableId, cellId, descending, offset, limit, sortedRowIds) => {
2968
- * console.log(`Sorted row Ids for dogColors result table changed`);
2969
- * console.log(sortedRowIds);
2970
- * // ^ cheaper than calling getResultSortedRowIds again
2971
- * },
2972
- * );
2973
- *
2974
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
2975
- * // -> 'Sorted row Ids for dogColors result table changed'
2976
- * // -> ['cujo', 'fido', 'rex']
2977
- *
2978
- * store.delListener(listenerId);
2979
- * ```
2980
- * @example
2981
- * This example registers a listener that responds to any change to the sorted
2982
- * ResultRow Ids of a specific ResultTable. The ResultRow Ids are sorted by
2983
- * their own value, since the `cellId` parameter is explicitly undefined.
2984
- *
2985
- * ```js
2986
- * const store = createStore().setTable('pets', {
2987
- * fido: {species: 'dog', color: 'brown'},
2988
- * felix: {species: 'cat', color: 'black'},
2989
- * cujo: {species: 'dog', color: 'black'},
2990
- * });
2991
- *
2992
- * const queries = createQueries(store).setQueryDefinition(
2993
- * 'dogColors',
2994
- * 'pets',
2995
- * ({select, where}) => {
2996
- * select('color');
2997
- * where('species', 'dog');
2998
- * },
2999
- * );
3000
- * console.log(queries.getResultSortedRowIds('dogColors', undefined));
3001
- * // -> ['cujo', 'fido']
3002
- *
3003
- * const listenerId = queries.addResultSortedRowIdsListener(
3004
- * 'dogColors',
3005
- * undefined,
3006
- * false,
3007
- * 0,
3008
- * undefined,
3009
- * (queries, tableId, cellId, descending, offset, limit, sortedRowIds) => {
3010
- * console.log(`Sorted row Ids for dogColors result table changed`);
3011
- * console.log(sortedRowIds);
3012
- * // ^ cheaper than calling getSortedRowIds again
3013
- * },
3014
- * );
3015
- *
3016
- * store.setRow('pets', 'rex', {species: 'dog', color: 'tan'});
3017
- * // -> 'Sorted row Ids for dogColors result table changed'
3018
- * // -> ['cujo', 'fido', 'rex']
3019
- *
3020
- * store.delListener(listenerId);
3021
- * ```
3022
- * @category Listener
3023
- * @since v2.0.0
3024
- */
3025
- addResultSortedRowIdsListener(
3026
- queryId: Id,
3027
- cellId: Id | undefined,
3028
- descending: boolean,
3029
- offset: number,
3030
- limit: number | undefined,
3031
- listener: ResultSortedRowIdsListener,
3032
- ): Id;
3033
-
3034
- /**
3035
- * The addResultRowListener method registers a listener function with the
3036
- * Queries object that will be called whenever data in a ResultRow changes.
3037
- *
3038
- * The provided listener is a ResultRowListener function, and will be called
3039
- * with a reference to the Queries object, the Id of the ResultTable that
3040
- * changed (which is also the query Id), and a GetResultCellChange function in
3041
- * case you need to inspect any changes that occurred.
3042
- *
3043
- * You can either listen to a single ResultRow (by specifying a query Id and
3044
- * ResultRow Id as the method's first two parameters) or changes to any
3045
- * ResultRow (by providing `null` wildcards).
3046
- *
3047
- * Both, either, or neither of the `queryId` and `rowId` parameters can be
3048
- * wildcarded with `null`. You can listen to a specific ResultRow in a
3049
- * specific query, any ResultRow in a specific query, a specific ResultRow in
3050
- * any query, or any ResultRow in any query.
3051
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
3052
- * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
3053
- * @param listener The function that will be called whenever data in the
3054
- * matching ResultRow changes.
3055
- * @returns A unique Id for the listener that can later be used to remove it.
3056
- * @example
3057
- * This example registers a listener that responds to any changes to a
3058
- * specific ResultRow.
3059
- *
3060
- * ```js
3061
- * const store = createStore().setTable('pets', {
3062
- * fido: {species: 'dog', color: 'brown'},
3063
- * felix: {species: 'cat', color: 'black'},
3064
- * cujo: {species: 'dog', color: 'black'},
3065
- * });
3066
- *
3067
- * const queries = createQueries(store).setQueryDefinition(
3068
- * 'dogColors',
3069
- * 'pets',
3070
- * ({select, where}) => {
3071
- * select('color');
3072
- * where('species', 'dog');
3073
- * },
3074
- * );
3075
- *
3076
- * const listenerId = queries.addResultRowListener(
3077
- * 'dogColors',
3078
- * 'fido',
3079
- * (queries, tableId, rowId, getCellChange) => {
3080
- * console.log('fido row in dogColors result table changed');
3081
- * console.log(getCellChange('dogColors', 'fido', 'color'));
3082
- * },
3083
- * );
3084
- *
3085
- * store.setCell('pets', 'fido', 'color', 'walnut');
3086
- * // -> 'fido row in dogColors result table changed'
3087
- * // -> [true, 'brown', 'walnut']
3088
- *
3089
- * store.delListener(listenerId);
3090
- * ```
3091
- * @example
3092
- * This example registers a listener that responds to any changes to any
3093
- * ResultRow.
3094
- *
3095
- * ```js
3096
- * const store = createStore().setTable('pets', {
3097
- * fido: {species: 'dog', color: 'brown'},
3098
- * felix: {species: 'cat', color: 'black'},
3099
- * cujo: {species: 'dog', color: 'black'},
3100
- * });
3101
- *
3102
- * const queries = createQueries(store)
3103
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
3104
- * select('color');
3105
- * where('species', 'dog');
3106
- * })
3107
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
3108
- * select('color');
3109
- * where('species', 'cat');
3110
- * });
3111
- *
3112
- * const listenerId = queries.addResultRowListener(
3113
- * null,
3114
- * null,
3115
- * (queries, tableId, rowId) => {
3116
- * console.log(`${rowId} row in ${tableId} result table changed`);
3117
- * },
3118
- * );
3119
- *
3120
- * store.setCell('pets', 'fido', 'color', 'walnut');
3121
- * // -> 'fido row in dogColors result table changed'
3122
- * store.setCell('pets', 'felix', 'color', 'tortoiseshell');
3123
- * // -> 'felix row in catColors result table changed'
3124
- *
3125
- * store.delListener(listenerId);
3126
- * ```
3127
- * @category Listener
3128
- * @since v2.0.0
3129
- */
3130
- addResultRowListener(
3131
- queryId: IdOrNull,
3132
- rowId: IdOrNull,
3133
- listener: ResultRowListener,
3134
- ): Id;
3135
-
3136
- /**
3137
- * The addResultCellIdsListener method registers a listener function with the
3138
- * Queries object that will be called whenever the ResultCell Ids in a
3139
- * ResultRow change.
3140
- *
3141
- * The provided listener is a ResultCellIdsListener function, and will be
3142
- * called with a reference to the Queries object, the Id of the ResultTable
3143
- * (which is also the query Id), and the Id of the ResultRow that changed.
3144
- *
3145
- * Such a listener is only called when a ResultCell is added to, or removed
3146
- * from, the ResultRow. To listen to all changes in the ResultRow, use the
3147
- * addResultRowListener method.
3148
- *
3149
- * You can either listen to a single ResultRow (by specifying the query Id and
3150
- * ResultRow Id as the method's first two parameters) or changes to any
3151
- * ResultRow (by providing `null` wildcards).
3152
- *
3153
- * Both, either, or neither of the `queryId` and `rowId` parameters can be
3154
- * wildcarded with `null`. You can listen to a specific ResultRow in a
3155
- * specific query, any ResultRow in a specific query, a specific ResultRow in
3156
- * any query, or any ResultRow in any query.
3157
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
3158
- * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
3159
- * @param listener The function that will be called whenever the ResultCell
3160
- * Ids in the ResultRow change.
3161
- * @returns A unique Id for the listener that can later be used to remove it.
3162
- * @example
3163
- * This example registers a listener that responds to any change to the
3164
- * ResultCell Ids of a specific ResultRow.
3165
- *
3166
- * ```js
3167
- * const store = createStore().setTable('pets', {
3168
- * fido: {species: 'dog', color: 'brown'},
3169
- * felix: {species: 'cat', color: 'black'},
3170
- * cujo: {species: 'dog', color: 'black'},
3171
- * });
3172
- *
3173
- * const queries = createQueries(store).setQueryDefinition(
3174
- * 'dogColors',
3175
- * 'pets',
3176
- * ({select, where}) => {
3177
- * select('color');
3178
- * select('price');
3179
- * where('species', 'dog');
3180
- * },
3181
- * );
3182
- *
3183
- * const listenerId = queries.addResultCellIdsListener(
3184
- * 'dogColors',
3185
- * 'fido',
3186
- * (store, tableId, rowId) => {
3187
- * console.log(`Cell Ids for fido row in dogColors result table changed`);
3188
- * console.log(queries.getResultCellIds('dogColors', 'fido'));
3189
- * },
3190
- * );
3191
- *
3192
- * store.setCell('pets', 'fido', 'price', 5);
3193
- * // -> 'Cell Ids for fido row in dogColors result table changed'
3194
- * // -> ['color', 'price']
3195
- *
3196
- * store.delListener(listenerId);
3197
- * ```
3198
- * @example
3199
- * This example registers a listener that responds to any change to the
3200
- * ResultCell Ids of any ResultRow.
3201
- *
3202
- * ```js
3203
- * const store = createStore().setTable('pets', {
3204
- * fido: {species: 'dog', color: 'brown'},
3205
- * felix: {species: 'cat', color: 'black'},
3206
- * cujo: {species: 'dog', color: 'black'},
3207
- * });
3208
- *
3209
- * const queries = createQueries(store)
3210
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
3211
- * select('color');
3212
- * select('price');
3213
- * where('species', 'dog');
3214
- * })
3215
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
3216
- * select('color');
3217
- * select('purrs');
3218
- * where('species', 'cat');
3219
- * });
3220
- *
3221
- * const listenerId = queries.addResultCellIdsListener(
3222
- * null,
3223
- * null,
3224
- * (queries, tableId, rowId) => {
3225
- * console.log(
3226
- * `Cell Ids for ${rowId} row in ${tableId} result table changed`,
3227
- * );
3228
- * },
3229
- * );
3230
- *
3231
- * store.setCell('pets', 'fido', 'price', 5);
3232
- * // -> 'Cell Ids for fido row in dogColors result table changed'
3233
- * store.setCell('pets', 'felix', 'purrs', true);
3234
- * // -> 'Cell Ids for felix row in catColors result table changed'
3235
- *
3236
- * store.delListener(listenerId);
3237
- * ```
3238
- * @category Listener
3239
- * @since v2.0.0
3240
- */
3241
- addResultCellIdsListener(
3242
- queryId: IdOrNull,
3243
- rowId: IdOrNull,
3244
- listener: ResultCellIdsListener,
3245
- ): Id;
3246
-
3247
- /**
3248
- * The addResultCellListener method registers a listener function with the
3249
- * Queries object that will be called whenever data in a ResultCell changes.
3250
- *
3251
- * The provided listener is a ResultCellListener function, and will be called
3252
- * with a reference to the Queries object, the Id of the ResultTable that
3253
- * changed (which is also the query Id), the Id of the ResultRow that changed,
3254
- * the Id of the ResultCell that changed, the new ResultCell value, the old
3255
- * ResultCell value, and a GetResultCellChange function in case you need to
3256
- * inspect any changes that occurred.
3257
- *
3258
- * You can either listen to a single ResultRow (by specifying a query Id,
3259
- * ResultRow Id, and ResultCell Id as the method's first three parameters) or
3260
- * changes to any ResultCell (by providing `null` wildcards).
3261
- *
3262
- * All, some, or none of the `queryId`, `rowId`, and `cellId` parameters can
3263
- * be wildcarded with `null`. You can listen to a specific ResultCell in a
3264
- * specific ResultRow in a specific query, any ResultCell in any ResultRow in
3265
- * any query, for example - or every other combination of wildcards.
3266
- * @param queryId The Id of the query to listen to, or `null` as a wildcard.
3267
- * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
3268
- * @param cellId The Id of the ResultCell to listen to, or `null` as a
3269
- * wildcard.
3270
- * @param listener The function that will be called whenever data in the
3271
- * matching ResultCell changes.
3272
- * @returns A unique Id for the listener that can later be used to remove it.
3273
- * @example
3274
- * This example registers a listener that responds to any changes to a
3275
- * specific ResultCell.
3276
- *
3277
- * ```js
3278
- * const store = createStore().setTable('pets', {
3279
- * fido: {species: 'dog', color: 'brown'},
3280
- * felix: {species: 'cat', color: 'black'},
3281
- * cujo: {species: 'dog', color: 'black'},
3282
- * });
3283
- *
3284
- * const queries = createQueries(store).setQueryDefinition(
3285
- * 'dogColors',
3286
- * 'pets',
3287
- * ({select, where}) => {
3288
- * select('color');
3289
- * where('species', 'dog');
3290
- * },
3291
- * );
3292
- *
3293
- * const listenerId = queries.addResultCellListener(
3294
- * 'dogColors',
3295
- * 'fido',
3296
- * 'color',
3297
- * (queries, tableId, rowId, cellId, newCell, oldCell, getCellChange) => {
3298
- * console.log(
3299
- * 'color cell in fido row in dogColors result table changed',
3300
- * );
3301
- * console.log([oldCell, newCell]);
3302
- * console.log(getCellChange('dogColors', 'fido', 'color'));
3303
- * },
3304
- * );
3305
- *
3306
- * store.setCell('pets', 'fido', 'color', 'walnut');
3307
- * // -> 'color cell in fido row in dogColors result table changed'
3308
- * // -> ['brown', 'walnut']
3309
- * // -> [true, 'brown', 'walnut']
3310
- *
3311
- * store.delListener(listenerId);
3312
- * ```
3313
- * @example
3314
- * This example registers a listener that responds to any changes to any
3315
- * ResultCell.
3316
- *
3317
- * ```js
3318
- * const store = createStore().setTable('pets', {
3319
- * fido: {species: 'dog', color: 'brown', price: 5},
3320
- * felix: {species: 'cat', color: 'black', price: 4},
3321
- * cujo: {species: 'dog', color: 'black', price: 5},
3322
- * });
3323
- *
3324
- * const queries = createQueries(store)
3325
- * .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
3326
- * select('color');
3327
- * where('species', 'dog');
3328
- * })
3329
- * .setQueryDefinition('catColors', 'pets', ({select, where}) => {
3330
- * select('color');
3331
- * select('price');
3332
- * where('species', 'cat');
3333
- * });
3334
- *
3335
- * const listenerId = queries.addResultCellListener(
3336
- * null,
3337
- * null,
3338
- * null,
3339
- * (queries, tableId, rowId, cellId) => {
3340
- * console.log(
3341
- * `${cellId} cell in ${rowId} row in ${tableId} result table changed`,
3342
- * );
3343
- * },
3344
- * );
3345
- *
3346
- * store.setCell('pets', 'fido', 'color', 'walnut');
3347
- * // -> 'color cell in fido row in dogColors result table changed'
3348
- * store.setCell('pets', 'felix', 'price', 3);
3349
- * // -> 'price cell in felix row in catColors result table changed'
3350
- *
3351
- * store.delListener(listenerId);
3352
- * ```
3353
- * @category Listener
3354
- * @since v2.0.0
3355
- */
3356
- addResultCellListener(
3357
- queryId: IdOrNull,
3358
- rowId: IdOrNull,
3359
- cellId: IdOrNull,
3360
- listener: ResultCellListener,
3361
- ): Id;
3362
-
3363
- /**
3364
- * The delListener method removes a listener that was previously added to the
3365
- * Queries object.
3366
- *
3367
- * Use the Id returned by the addMetricListener method. Note that the Queries
3368
- * object may re-use this Id for future listeners added to it.
3369
- * @param listenerId The Id of the listener to remove.
3370
- * @returns A reference to the Queries object.
3371
- * @example
3372
- * This example creates a Store, a Queries object, registers a listener, and
3373
- * then removes it.
3374
- *
3375
- * ```js
3376
- * const store = createStore().setTable('pets', {
3377
- * fido: {species: 'dog'},
3378
- * felix: {species: 'cat'},
3379
- * cujo: {species: 'dog'},
3380
- * });
3381
- *
3382
- * const queries = createQueries(store).setQueryDefinition(
3383
- * 'species',
3384
- * 'pets',
3385
- * ({select}) => {
3386
- * select('species');
3387
- * },
3388
- * );
3389
- *
3390
- * const listenerId = queries.addResultTableListener('species', (queries) =>
3391
- * console.log('species result changed'),
3392
- * );
3393
- *
3394
- * store.setCell('pets', 'ed', 'species', 'horse');
3395
- * // -> 'species result changed'
3396
- *
3397
- * queries.delListener(listenerId);
3398
- *
3399
- * store.setCell('pets', 'molly', 'species', 'cow');
3400
- * // -> undefined
3401
- * // The listener is not called.
3402
- * ```
3403
- * @category Listener
3404
- * @since v2.0.0
3405
- */
3406
- delListener(listenerId: Id): Queries;
3407
-
3408
- /**
3409
- * The destroy method should be called when this Queries object is no longer
3410
- * used.
3411
- *
3412
- * This guarantees that all of the listeners that the object registered with
3413
- * the underlying Store are removed and it can be correctly garbage collected.
3414
- * @example
3415
- * This example creates a Store, adds a Queries object with a definition (that
3416
- * registers a RowListener with the underlying Store), and then destroys it
3417
- * again, removing the listener.
3418
- *
3419
- * ```js
3420
- * const store = createStore().setTable('pets', {
3421
- * fido: {species: 'dog'},
3422
- * felix: {species: 'cat'},
3423
- * cujo: {species: 'dog'},
3424
- * });
3425
- *
3426
- * const queries = createQueries(store);
3427
- * queries.setQueryDefinition('species', 'species', ({select}) => {
3428
- * select('species');
3429
- * });
3430
- * console.log(store.getListenerStats().row);
3431
- * // -> 1
3432
- *
3433
- * queries.destroy();
3434
- *
3435
- * console.log(store.getListenerStats().row);
3436
- * // -> 0
3437
- * ```
3438
- * @category Lifecycle
3439
- * @since v2.0.0
3440
- */
3441
- destroy(): void;
3442
-
3443
- /**
3444
- * The getListenerStats method provides a set of statistics about the
3445
- * listeners registered with the Queries object, and is used for debugging
3446
- * purposes.
3447
- *
3448
- * The statistics are only populated in a debug build: production builds
3449
- * return an empty object. The method is intended to be used during
3450
- * development to ensure your application is not leaking listener
3451
- * registrations, for example.
3452
- * @returns A QueriesListenerStats object containing Queries listener
3453
- * statistics.
3454
- * @example
3455
- * This example gets the listener statistics of a Queries object.
3456
- *
3457
- * ```js
3458
- * const store = createStore();
3459
- * const queries = createQueries(store);
3460
- * queries.addResultTableListener(null, () => console.log('Result changed'));
3461
- *
3462
- * console.log(queries.getListenerStats().table);
3463
- * // -> 1
3464
- * console.log(queries.getListenerStats().row);
3465
- * // -> 0
3466
- * ```
3467
- * @category Development
3468
- * @since v2.0.0
3469
- */
3470
- getListenerStats(): QueriesListenerStats;
3471
- //
3472
- }
3473
-
3474
- /**
3475
- * The createQueries function creates a Queries object, and is the main entry
3476
- * point into the queries module.
3477
- *
3478
- * A given Store can only have one Queries object associated with it. If you
3479
- * call this function twice on the same Store, your second call will return a
3480
- * reference to the Queries object created by the first.
3481
- * @param store The Store for which to register query definitions.
3482
- * @returns A reference to the new Queries object.
3483
- * @example
3484
- * This example creates a Queries object.
3485
- *
3486
- * ```js
3487
- * const store = createStore();
3488
- * const queries = createQueries(store);
3489
- * console.log(queries.getQueryIds());
3490
- * // -> []
3491
- * ```
3492
- * @example
3493
- * This example creates a Queries object, and calls the method a second time
3494
- * for the same Store to return the same object.
3495
- *
3496
- * ```js
3497
- * const store = createStore();
3498
- * const queries1 = createQueries(store);
3499
- * const queries2 = createQueries(store);
3500
- * console.log(queries1 === queries2);
3501
- * // -> true
3502
- * ```
3503
- * @category Creation
3504
- * @since v2.0.0
3505
- */
3506
- export function createQueries(store: Store): Queries;