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