tinybase 5.0.0-beta.18 → 5.0.0-beta.19

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