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