@pyric/cli 0.1.0-alpha.20 → 0.1.0-alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (491) hide show
  1. package/README.md +64 -89
  2. package/dist/assurance/.generated/conformance-verdicts.d.ts +68 -1
  3. package/dist/assurance/.generated/conformance-verdicts.d.ts.map +1 -1
  4. package/dist/assurance/.generated/conformance-verdicts.js +68 -1
  5. package/dist/assurance/.generated/conformance-verdicts.js.map +1 -1
  6. package/dist/bridge/client/dispatch.d.ts +25 -19
  7. package/dist/bridge/client/dispatch.d.ts.map +1 -1
  8. package/dist/bridge/client/dispatch.js +41 -48
  9. package/dist/bridge/client/dispatch.js.map +1 -1
  10. package/dist/bridge/client/tool-family-factories.d.ts +26 -0
  11. package/dist/bridge/client/tool-family-factories.d.ts.map +1 -0
  12. package/dist/bridge/client/tool-family-factories.js +10 -0
  13. package/dist/bridge/client/tool-family-factories.js.map +1 -0
  14. package/dist/bridge/server/mcp-contract.d.ts +7 -6
  15. package/dist/bridge/server/mcp-contract.d.ts.map +1 -1
  16. package/dist/bridge/server/mcp-contract.js +9 -48
  17. package/dist/bridge/server/mcp-contract.js.map +1 -1
  18. package/dist/bridge/server/peer.d.ts +11 -1
  19. package/dist/bridge/server/peer.d.ts.map +1 -1
  20. package/dist/bridge/server/peer.js +22 -1
  21. package/dist/bridge/server/peer.js.map +1 -1
  22. package/dist/bridge/server/tool-family-factories.d.ts +30 -0
  23. package/dist/bridge/server/tool-family-factories.d.ts.map +1 -0
  24. package/dist/bridge/server/tool-family-factories.js +22 -0
  25. package/dist/bridge/server/tool-family-factories.js.map +1 -0
  26. package/dist/bridge/server/tool-metadata.d.ts +17 -18
  27. package/dist/bridge/server/tool-metadata.d.ts.map +1 -1
  28. package/dist/bridge/server/tool-metadata.js +24 -59
  29. package/dist/bridge/server/tool-metadata.js.map +1 -1
  30. package/dist/bridge/tool-families.d.ts +48 -0
  31. package/dist/bridge/tool-families.d.ts.map +1 -0
  32. package/dist/bridge/tool-families.generated.d.ts +32 -0
  33. package/dist/bridge/tool-families.generated.d.ts.map +1 -0
  34. package/dist/bridge/tool-families.generated.js +15 -0
  35. package/dist/bridge/tool-families.generated.js.map +1 -0
  36. package/dist/bridge/tool-families.js +51 -0
  37. package/dist/bridge/tool-families.js.map +1 -0
  38. package/dist/bridge/tool-family-records/conformance.d.ts +7 -0
  39. package/dist/bridge/tool-family-records/conformance.d.ts.map +1 -0
  40. package/dist/bridge/tool-family-records/conformance.js +6 -0
  41. package/dist/bridge/tool-family-records/conformance.js.map +1 -0
  42. package/dist/bridge/tool-family-records/firestore-data.d.ts +7 -0
  43. package/dist/bridge/tool-family-records/firestore-data.d.ts.map +1 -0
  44. package/dist/bridge/tool-family-records/firestore-data.js +15 -0
  45. package/dist/bridge/tool-family-records/firestore-data.js.map +1 -0
  46. package/dist/bridge/tool-family-records/firestore-inspect.d.ts +7 -0
  47. package/dist/bridge/tool-family-records/firestore-inspect.d.ts.map +1 -0
  48. package/dist/bridge/tool-family-records/firestore-inspect.js +6 -0
  49. package/dist/bridge/tool-family-records/firestore-inspect.js.map +1 -0
  50. package/dist/bridge/tool-family-records/firestore-rules.d.ts +7 -0
  51. package/dist/bridge/tool-family-records/firestore-rules.d.ts.map +1 -0
  52. package/dist/bridge/tool-family-records/firestore-rules.js +15 -0
  53. package/dist/bridge/tool-family-records/firestore-rules.js.map +1 -0
  54. package/dist/bridge/tool-family-records/firestore-simulator.d.ts +7 -0
  55. package/dist/bridge/tool-family-records/firestore-simulator.d.ts.map +1 -0
  56. package/dist/bridge/tool-family-records/firestore-simulator.js +16 -0
  57. package/dist/bridge/tool-family-records/firestore-simulator.js.map +1 -0
  58. package/dist/bridge/tool-family-records/rtdb-inspection.d.ts +7 -0
  59. package/dist/bridge/tool-family-records/rtdb-inspection.d.ts.map +1 -0
  60. package/dist/bridge/tool-family-records/rtdb-inspection.js +6 -0
  61. package/dist/bridge/tool-family-records/rtdb-inspection.js.map +1 -0
  62. package/dist/bundler/externals.d.ts +37 -0
  63. package/dist/bundler/externals.d.ts.map +1 -0
  64. package/dist/bundler/externals.js +52 -0
  65. package/dist/bundler/externals.js.map +1 -0
  66. package/dist/bundler/index.d.ts +17 -0
  67. package/dist/bundler/index.d.ts.map +1 -0
  68. package/dist/bundler/index.js +17 -0
  69. package/dist/bundler/index.js.map +1 -0
  70. package/dist/cli/inlined-sdk-scanner.d.ts +6 -0
  71. package/dist/cli/inlined-sdk-scanner.d.ts.map +1 -0
  72. package/dist/cli/inlined-sdk-scanner.js +82 -0
  73. package/dist/cli/inlined-sdk-scanner.js.map +1 -0
  74. package/dist/cli/sandbox-interlock.d.ts +97 -0
  75. package/dist/cli/sandbox-interlock.d.ts.map +1 -0
  76. package/dist/cli/sandbox-interlock.js +112 -0
  77. package/dist/cli/sandbox-interlock.js.map +1 -0
  78. package/dist/cli/sandbox-runner.d.ts +20 -12
  79. package/dist/cli/sandbox-runner.d.ts.map +1 -1
  80. package/dist/cli/sandbox-runner.js +24 -21
  81. package/dist/cli/sandbox-runner.js.map +1 -1
  82. package/dist/cli/serve.d.ts +6 -10
  83. package/dist/cli/serve.d.ts.map +1 -1
  84. package/dist/cli/serve.js +57 -77
  85. package/dist/cli/serve.js.map +1 -1
  86. package/dist/cli/unsupported-runtime.d.ts +27 -0
  87. package/dist/cli/unsupported-runtime.d.ts.map +1 -0
  88. package/dist/cli/unsupported-runtime.js +63 -0
  89. package/dist/cli/unsupported-runtime.js.map +1 -0
  90. package/dist/conformance/.generated/can-i-use-browser.d.ts +1 -1
  91. package/dist/conformance/.generated/can-i-use-browser.d.ts.map +1 -1
  92. package/dist/conformance/.generated/can-i-use-browser.js +1 -1
  93. package/dist/conformance/.generated/can-i-use-browser.js.map +1 -1
  94. package/dist/conformance/.generated/can-i-use.d.ts +1 -1
  95. package/dist/conformance/.generated/can-i-use.d.ts.map +1 -1
  96. package/dist/conformance/.generated/can-i-use.js +1 -1
  97. package/dist/conformance/.generated/can-i-use.js.map +1 -1
  98. package/dist/conformance/.generated/conformance-docs.d.ts.map +1 -1
  99. package/dist/conformance/.generated/conformance-docs.js +1 -1
  100. package/dist/conformance/.generated/conformance-docs.js.map +1 -1
  101. package/dist/functions-rtdb/child.d.ts +37 -0
  102. package/dist/functions-rtdb/child.d.ts.map +1 -1
  103. package/dist/functions-rtdb/child.js +90 -21
  104. package/dist/functions-rtdb/child.js.map +1 -1
  105. package/dist/functions-rtdb/development-runtime.d.ts +3 -0
  106. package/dist/functions-rtdb/development-runtime.d.ts.map +1 -1
  107. package/dist/functions-rtdb/development-runtime.js +1 -0
  108. package/dist/functions-rtdb/development-runtime.js.map +1 -1
  109. package/dist/google-endpoints.d.ts +67 -0
  110. package/dist/google-endpoints.d.ts.map +1 -0
  111. package/dist/google-endpoints.js +119 -0
  112. package/dist/google-endpoints.js.map +1 -0
  113. package/dist/next/runtime-env.d.ts.map +1 -1
  114. package/dist/next/runtime-env.js +5 -0
  115. package/dist/next/runtime-env.js.map +1 -1
  116. package/dist/next/with-pyric.d.ts +1 -1
  117. package/dist/next/with-pyric.js +1 -1
  118. package/dist/register/beacon.d.ts +69 -0
  119. package/dist/register/beacon.d.ts.map +1 -0
  120. package/dist/register/beacon.js +199 -0
  121. package/dist/register/beacon.js.map +1 -0
  122. package/dist/register/index.d.ts.map +1 -1
  123. package/dist/register/index.js +65 -6
  124. package/dist/register/index.js.map +1 -1
  125. package/dist/register/net-guard.d.ts +110 -0
  126. package/dist/register/net-guard.d.ts.map +1 -0
  127. package/dist/register/net-guard.js +462 -0
  128. package/dist/register/net-guard.js.map +1 -0
  129. package/dist/serve/ai-diagnostics-relay.d.ts +63 -0
  130. package/dist/serve/ai-diagnostics-relay.d.ts.map +1 -0
  131. package/dist/serve/ai-diagnostics-relay.js +125 -0
  132. package/dist/serve/ai-diagnostics-relay.js.map +1 -0
  133. package/dist/serve/ai-proxy.d.ts +92 -0
  134. package/dist/serve/ai-proxy.d.ts.map +1 -0
  135. package/dist/serve/ai-proxy.js +269 -0
  136. package/dist/serve/ai-proxy.js.map +1 -0
  137. package/dist/serve/ai-status.d.ts +44 -0
  138. package/dist/serve/ai-status.d.ts.map +1 -0
  139. package/dist/serve/ai-status.js +77 -0
  140. package/dist/serve/ai-status.js.map +1 -0
  141. package/dist/serve/ai-terminal-blocks.d.ts +97 -0
  142. package/dist/serve/ai-terminal-blocks.d.ts.map +1 -0
  143. package/dist/serve/ai-terminal-blocks.js +128 -0
  144. package/dist/serve/ai-terminal-blocks.js.map +1 -0
  145. package/dist/serve/ai-terminal-text.d.ts +36 -0
  146. package/dist/serve/ai-terminal-text.d.ts.map +1 -0
  147. package/dist/serve/ai-terminal-text.js +48 -0
  148. package/dist/serve/ai-terminal-text.js.map +1 -0
  149. package/dist/serve/beacon-route.d.ts +53 -0
  150. package/dist/serve/beacon-route.d.ts.map +1 -0
  151. package/dist/serve/beacon-route.js +101 -0
  152. package/dist/serve/beacon-route.js.map +1 -0
  153. package/dist/serve/entries/active-auth-registry.d.ts +16 -0
  154. package/dist/serve/entries/active-auth-registry.d.ts.map +1 -0
  155. package/dist/serve/entries/active-auth-registry.js +48 -0
  156. package/dist/serve/entries/active-auth-registry.js.map +1 -0
  157. package/dist/serve/entries/active-auth.d.ts +18 -0
  158. package/dist/serve/entries/active-auth.d.ts.map +1 -0
  159. package/dist/serve/entries/active-auth.js +84 -0
  160. package/dist/serve/entries/active-auth.js.map +1 -0
  161. package/dist/serve/entries/auth-helper-core.d.ts +1 -0
  162. package/dist/serve/entries/auth-helper-core.d.ts.map +1 -1
  163. package/dist/serve/entries/auth-helper-core.js +4 -0
  164. package/dist/serve/entries/auth-helper-core.js.map +1 -1
  165. package/dist/serve/entries/auth-helper-dom.d.ts.map +1 -1
  166. package/dist/serve/entries/auth-helper-dom.js +28 -2
  167. package/dist/serve/entries/auth-helper-dom.js.map +1 -1
  168. package/dist/serve/entries/auth.d.ts.map +1 -1
  169. package/dist/serve/entries/auth.js +8 -0
  170. package/dist/serve/entries/auth.js.map +1 -1
  171. package/dist/serve/entries/bridge-url.d.ts +1 -1
  172. package/dist/serve/entries/bridge-url.js +1 -1
  173. package/dist/serve/entries/init.d.ts.map +1 -1
  174. package/dist/serve/entries/init.js +70 -4
  175. package/dist/serve/entries/init.js.map +1 -1
  176. package/dist/serve/entries/runtime.d.ts.map +1 -1
  177. package/dist/serve/entries/runtime.js +9 -0
  178. package/dist/serve/entries/runtime.js.map +1 -1
  179. package/dist/serve/namespace.d.ts +14 -5
  180. package/dist/serve/namespace.d.ts.map +1 -1
  181. package/dist/serve/namespace.js +57 -124
  182. package/dist/serve/namespace.js.map +1 -1
  183. package/dist/serve/runtime/chip-config.d.ts.map +1 -1
  184. package/dist/serve/runtime/chip-config.js +16 -2
  185. package/dist/serve/runtime/chip-config.js.map +1 -1
  186. package/dist/serve/runtime/chip-dialog.d.ts +18 -0
  187. package/dist/serve/runtime/chip-dialog.d.ts.map +1 -0
  188. package/dist/serve/runtime/chip-dialog.js +315 -0
  189. package/dist/serve/runtime/chip-dialog.js.map +1 -0
  190. package/dist/serve/runtime/chip-install.d.ts +2 -0
  191. package/dist/serve/runtime/chip-install.d.ts.map +1 -1
  192. package/dist/serve/runtime/chip-install.js +9 -4
  193. package/dist/serve/runtime/chip-install.js.map +1 -1
  194. package/dist/serve/runtime/chip-user-search.d.ts +16 -0
  195. package/dist/serve/runtime/chip-user-search.d.ts.map +1 -0
  196. package/dist/serve/runtime/chip-user-search.js +354 -0
  197. package/dist/serve/runtime/chip-user-search.js.map +1 -0
  198. package/dist/serve/runtime/chip.d.ts +10 -0
  199. package/dist/serve/runtime/chip.d.ts.map +1 -1
  200. package/dist/serve/runtime/chip.js +118 -15
  201. package/dist/serve/runtime/chip.js.map +1 -1
  202. package/dist/serve/runtime/identity.d.ts +17 -0
  203. package/dist/serve/runtime/identity.d.ts.map +1 -0
  204. package/dist/serve/runtime/identity.js +10 -0
  205. package/dist/serve/runtime/identity.js.map +1 -0
  206. package/dist/serve/sandbox-session.d.ts +7 -0
  207. package/dist/serve/sandbox-session.d.ts.map +1 -1
  208. package/dist/serve/sandbox-session.js +2 -0
  209. package/dist/serve/sandbox-session.js.map +1 -1
  210. package/dist/serve/site-ui/_astro/{RulesCodeEditor.XtDmHOlN.js → RulesCodeEditor.DsTAsKIa.js} +1 -1
  211. package/dist/serve/site-ui/_astro/app.BOr2kwae.js +115 -0
  212. package/dist/serve/site-ui/_astro/app.DhAcImFD.js +1 -0
  213. package/dist/serve/site-ui/_astro/{chess-showcase.B72XYeoh.js → chess-showcase.Bn_pP6UJ.js} +2 -2
  214. package/dist/serve/site-ui/_astro/{example-runtime.C25_lx6Z.js → example-runtime.CXopTGv7.js} +1 -1
  215. package/dist/serve/site-ui/_astro/sandbox-controls.rOuZTOUG.js +510 -0
  216. package/dist/serve/site-ui/_astro/{seed.Co0yUJY5.js → seed.03a08f9t.js} +2 -2
  217. package/dist/serve/site-ui/_astro/writes.BsPBG3dp.js +653 -0
  218. package/dist/serve/site-ui/auth/index.html +1 -1
  219. package/dist/serve/site-ui/docs/_rhythm/index.html +1 -1
  220. package/dist/serve/site-ui/docs/agent/set-up-your-agent/index.html +1 -1
  221. package/dist/serve/site-ui/docs/agent/watch-and-review/index.html +1 -1
  222. package/dist/serve/site-ui/docs/agent/work-with-an-agent/index.html +1 -1
  223. package/dist/serve/site-ui/docs/ai-compat/index.html +1 -1
  224. package/dist/serve/site-ui/docs/api-reference/index.html +8 -1
  225. package/dist/serve/site-ui/docs/api-reference.md +7 -0
  226. package/dist/serve/site-ui/docs/app-compat/index.html +1 -1
  227. package/dist/serve/site-ui/docs/auth-compat/index.html +3 -3
  228. package/dist/serve/site-ui/docs/auth-compat.md +2 -2
  229. package/dist/serve/site-ui/docs/build/ai-logic/index.html +6 -1
  230. package/dist/serve/site-ui/docs/build/ai-logic.md +6 -0
  231. package/dist/serve/site-ui/docs/build/authentication/index.html +1 -1
  232. package/dist/serve/site-ui/docs/build/cloud-firestore/index.html +1 -1
  233. package/dist/serve/site-ui/docs/build/cloud-messaging/index.html +1 -1
  234. package/dist/serve/site-ui/docs/build/cloud-storage/index.html +1 -1
  235. package/dist/serve/site-ui/docs/build/realtime-database/index.html +1 -1
  236. package/dist/serve/site-ui/docs/conformance-scores/index.html +6 -2
  237. package/dist/serve/site-ui/docs/conformance-scores.md +5 -1
  238. package/dist/serve/site-ui/docs/create-pyric-reference-api/index.html +1 -1
  239. package/dist/serve/site-ui/docs/database-compat/index.html +44 -44
  240. package/dist/serve/site-ui/docs/database-compat.md +43 -43
  241. package/dist/serve/site-ui/docs/examples/chess/index.html +1 -1
  242. package/dist/serve/site-ui/docs/examples/index.html +1 -1
  243. package/dist/serve/site-ui/docs/firestore-compat/index.html +4 -4
  244. package/dist/serve/site-ui/docs/firestore-compat.md +3 -3
  245. package/dist/serve/site-ui/docs/firestore-flutter-compat/index.html +319 -0
  246. package/dist/serve/site-ui/docs/firestore-flutter-compat.md +344 -0
  247. package/dist/serve/site-ui/docs/functions-rtdb-compat/index.html +1 -1
  248. package/dist/serve/site-ui/docs/get-started/backend-bundlers/index.html +105 -0
  249. package/dist/serve/site-ui/docs/get-started/backend-bundlers.md +165 -0
  250. package/dist/serve/site-ui/docs/get-started/how-the-swap-works/index.html +1 -1
  251. package/dist/serve/site-ui/docs/get-started/nextjs/index.html +1 -1
  252. package/dist/serve/site-ui/docs/get-started/start-building/index.html +1 -1
  253. package/dist/serve/site-ui/docs/get-started/vite/index.html +1 -1
  254. package/dist/serve/site-ui/docs/index.json +2967 -1482
  255. package/dist/serve/site-ui/docs/messaging-compat/index.html +1 -1
  256. package/dist/serve/site-ui/docs/observe/resolve-runtime-status/index.html +1 -1
  257. package/dist/serve/site-ui/docs/observe/see-whats-happening/index.html +1 -1
  258. package/dist/serve/site-ui/docs/observe/shape-your-data/index.html +1 -1
  259. package/dist/serve/site-ui/docs/overview/index.html +1 -1
  260. package/dist/serve/site-ui/docs/pyric-admin-app-reference-api/index.html +1 -1
  261. package/dist/serve/site-ui/docs/pyric-admin-auth-reference-api/index.html +1 -1
  262. package/dist/serve/site-ui/docs/pyric-admin-database-reference-api/index.html +1 -1
  263. package/dist/serve/site-ui/docs/pyric-admin-firestore-reference-api/index.html +1 -1
  264. package/dist/serve/site-ui/docs/pyric-admin-messaging-reference-api/index.html +1 -1
  265. package/dist/serve/site-ui/docs/pyric-admin-reference-api/index.html +1 -1
  266. package/dist/serve/site-ui/docs/pyric-admin-storage-reference-api/index.html +1 -1
  267. package/dist/serve/site-ui/docs/pyric-ai-reference-api/index.html +1 -1
  268. package/dist/serve/site-ui/docs/pyric-ai-scripting-reference-api/index.html +1 -1
  269. package/dist/serve/site-ui/docs/pyric-analytics-reference-api/index.html +124 -0
  270. package/dist/serve/site-ui/docs/pyric-analytics-reference-api.md +287 -0
  271. package/dist/serve/site-ui/docs/pyric-app-check-reference-api/index.html +87 -0
  272. package/dist/serve/site-ui/docs/pyric-app-check-reference-api.md +199 -0
  273. package/dist/serve/site-ui/docs/pyric-app-reference-api/index.html +1 -1
  274. package/dist/serve/site-ui/docs/pyric-auth-reference-api/index.html +6 -2
  275. package/dist/serve/site-ui/docs/pyric-auth-reference-api.md +2 -1
  276. package/dist/serve/site-ui/docs/pyric-cli-assurance-browser-reference-api/index.html +1 -1
  277. package/dist/serve/site-ui/docs/pyric-cli-assurance-reference-api/index.html +1 -1
  278. package/dist/serve/site-ui/docs/pyric-cli-bridge-client-reference-api/index.html +2 -2
  279. package/dist/serve/site-ui/docs/pyric-cli-bridge-client-reference-api.md +1 -1
  280. package/dist/serve/site-ui/docs/pyric-cli-bridge-reference-api/index.html +1 -1
  281. package/dist/serve/site-ui/docs/pyric-cli-bundler-reference-api/index.html +56 -0
  282. package/dist/serve/site-ui/docs/pyric-cli-bundler-reference-api.md +72 -0
  283. package/dist/serve/site-ui/docs/pyric-cli-conformance-browser-reference-api/index.html +2 -1
  284. package/dist/serve/site-ui/docs/pyric-cli-conformance-browser-reference-api.md +1 -0
  285. package/dist/serve/site-ui/docs/pyric-cli-conformance-docs-reference-api/index.html +1 -1
  286. package/dist/serve/site-ui/docs/pyric-cli-conformance-reference-api/index.html +2 -1
  287. package/dist/serve/site-ui/docs/pyric-cli-conformance-reference-api.md +1 -0
  288. package/dist/serve/site-ui/docs/pyric-cli-credentials-node-reference-api/index.html +1 -1
  289. package/dist/serve/site-ui/docs/pyric-cli-discover-reference-api/index.html +1 -1
  290. package/dist/serve/site-ui/docs/pyric-cli-next-reference-api/index.html +2 -2
  291. package/dist/serve/site-ui/docs/pyric-cli-next-reference-api.md +1 -1
  292. package/dist/serve/site-ui/docs/pyric-cli-register-app-bridge-reference-api/index.html +1 -1
  293. package/dist/serve/site-ui/docs/pyric-cli-register-reference-api/index.html +1 -1
  294. package/dist/serve/site-ui/docs/pyric-cli-remote-reference-api/index.html +34 -9
  295. package/dist/serve/site-ui/docs/pyric-cli-remote-reference-api.md +16 -8
  296. package/dist/serve/site-ui/docs/pyric-cli-serve-worker-reference-api/index.html +133 -93
  297. package/dist/serve/site-ui/docs/pyric-cli-serve-worker-reference-api.md +61 -1
  298. package/dist/serve/site-ui/docs/pyric-cli-verify-reference-api/index.html +2 -2
  299. package/dist/serve/site-ui/docs/pyric-cli-verify-reference-api.md +1 -1
  300. package/dist/serve/site-ui/docs/pyric-cli-vite-reference-api/index.html +2 -2
  301. package/dist/serve/site-ui/docs/pyric-cli-vite-reference-api.md +2 -2
  302. package/dist/serve/site-ui/docs/pyric-database-reference-api/index.html +2 -2
  303. package/dist/serve/site-ui/docs/pyric-database-reference-api.md +1 -1
  304. package/dist/serve/site-ui/docs/pyric-firestore-lite-reference-api/index.html +559 -0
  305. package/dist/serve/site-ui/docs/pyric-firestore-lite-reference-api.md +1240 -0
  306. package/dist/serve/site-ui/docs/pyric-firestore-reference-api/index.html +40 -11
  307. package/dist/serve/site-ui/docs/pyric-firestore-reference-api.md +18 -8
  308. package/dist/serve/site-ui/docs/pyric-functions-reference-api/index.html +67 -0
  309. package/dist/serve/site-ui/docs/pyric-functions-reference-api.md +149 -0
  310. package/dist/serve/site-ui/docs/pyric-messaging-reference-api/index.html +1 -1
  311. package/dist/serve/site-ui/docs/pyric-messaging-sw-reference-api/index.html +1 -1
  312. package/dist/serve/site-ui/docs/pyric-performance-reference-api/index.html +35 -0
  313. package/dist/serve/site-ui/docs/pyric-performance-reference-api.md +69 -0
  314. package/dist/serve/site-ui/docs/pyric-remote-config-reference-api/index.html +132 -0
  315. package/dist/serve/site-ui/docs/pyric-remote-config-reference-api.md +307 -0
  316. package/dist/serve/site-ui/docs/pyric-rules-reference-api/index.html +1 -1
  317. package/dist/serve/site-ui/docs/pyric-sandbox-database-reference-api/index.html +52 -17
  318. package/dist/serve/site-ui/docs/pyric-sandbox-database-reference-api.md +48 -9
  319. package/dist/serve/site-ui/docs/pyric-sandbox-firestore-reference-api/index.html +1 -1
  320. package/dist/serve/site-ui/docs/pyric-sandbox-reference-api/index.html +239 -49
  321. package/dist/serve/site-ui/docs/pyric-sandbox-reference-api.md +148 -31
  322. package/dist/serve/site-ui/docs/pyric-storage-reference-api/index.html +22 -4
  323. package/dist/serve/site-ui/docs/pyric-storage-reference-api.md +24 -2
  324. package/dist/serve/site-ui/docs/pyric-ui-agents-reference-api/index.html +26 -96
  325. package/dist/serve/site-ui/docs/pyric-ui-agents-reference-api.md +20 -51
  326. package/dist/serve/site-ui/docs/pyric-ui-auth-hooks-reference-api/index.html +1 -1
  327. package/dist/serve/site-ui/docs/pyric-ui-auth-reference-api/index.html +2 -2
  328. package/dist/serve/site-ui/docs/pyric-ui-auth-reference-api.md +1 -1
  329. package/dist/serve/site-ui/docs/pyric-ui-events-hooks-reference-api/index.html +1 -1
  330. package/dist/serve/site-ui/docs/pyric-ui-events-reference-api/index.html +1 -1
  331. package/dist/serve/site-ui/docs/pyric-ui-firestore-hooks-reference-api/index.html +1 -1
  332. package/dist/serve/site-ui/docs/pyric-ui-firestore-reference-api/index.html +2 -2
  333. package/dist/serve/site-ui/docs/pyric-ui-firestore-reference-api.md +1 -1
  334. package/dist/serve/site-ui/docs/pyric-ui-primitives-reference-api/index.html +124 -26
  335. package/dist/serve/site-ui/docs/pyric-ui-primitives-reference-api.md +58 -5
  336. package/dist/serve/site-ui/docs/pyric-ui-rtdb-reference-api/index.html +1 -1
  337. package/dist/serve/site-ui/docs/pyric-ui-rules-hooks-reference-api/index.html +1 -1
  338. package/dist/serve/site-ui/docs/pyric-ui-rules-reference-api/index.html +1 -1
  339. package/dist/serve/site-ui/docs/pyric-ui-storage-hooks-reference-api/index.html +1 -1
  340. package/dist/serve/site-ui/docs/pyric-ui-storage-reference-api/index.html +4 -5
  341. package/dist/serve/site-ui/docs/pyric-ui-storage-reference-api.md +3 -4
  342. package/dist/serve/site-ui/docs/pyric-ui-traffic-hooks-reference-api/index.html +1 -1
  343. package/dist/serve/site-ui/docs/pyric-ui-traffic-reference-api/index.html +1 -1
  344. package/dist/serve/site-ui/docs/reference/cli/index.html +6 -3
  345. package/dist/serve/site-ui/docs/reference/cli.md +8 -2
  346. package/dist/serve/site-ui/docs/rules-compat/index.html +10 -2
  347. package/dist/serve/site-ui/docs/rules-compat.md +9 -1
  348. package/dist/serve/site-ui/docs/secure/audit-your-rules/index.html +1 -1
  349. package/dist/serve/site-ui/docs/secure/firestore-rules-limits/index.html +1 -1
  350. package/dist/serve/site-ui/docs/secure/read-a-denial/index.html +1 -1
  351. package/dist/serve/site-ui/docs/secure/rtdb-rules-in-typescript/index.html +1 -1
  352. package/dist/serve/site-ui/docs/secure/rules-standard-library/index.html +1 -1
  353. package/dist/serve/site-ui/docs/secure/secure-it-with-rules/index.html +1 -1
  354. package/dist/serve/site-ui/docs/secure/simulate-and-lint/index.html +1 -1
  355. package/dist/serve/site-ui/docs/secure/write-a-rules-test-suite/index.html +1 -1
  356. package/dist/serve/site-ui/docs/ship/ship-to-production/index.html +1 -1
  357. package/dist/serve/site-ui/docs/ship/test-in-node/index.html +1 -1
  358. package/dist/serve/site-ui/docs/storage-compat/index.html +13 -13
  359. package/dist/serve/site-ui/docs/storage-compat.md +12 -12
  360. package/dist/serve/site-ui/docs/trust/how-we-know-it-matches-firebase/index.html +1 -1
  361. package/dist/serve/site-ui/docs/trust/rules-standard-library/index.html +1 -1
  362. package/dist/serve/site-ui/docs/trust/versioning-and-compatibility/index.html +1 -1
  363. package/dist/serve/site-ui/docs/tutorial/index.html +1 -1
  364. package/dist/serve/site-ui/examples/chess/index.html +1 -1
  365. package/dist/serve/site-ui/firestore/index.html +1 -1
  366. package/dist/serve/site-ui/llms.txt +9 -0
  367. package/dist/serve/site-ui/rtdb/index.html +1 -1
  368. package/dist/serve/site-ui/settings/index.html +1 -1
  369. package/dist/serve/site-ui/storage/index.html +1 -1
  370. package/dist/serve/site-ui/studio/index.html +1 -1
  371. package/dist/serve/site-ui/traffic/index.html +1 -1
  372. package/dist/serve/studio/disk-workspace.d.ts.map +1 -1
  373. package/dist/serve/studio/disk-workspace.js +64 -2
  374. package/dist/serve/studio/disk-workspace.js.map +1 -1
  375. package/dist/serve/vite-plugin.d.ts +7 -7
  376. package/dist/serve/vite-plugin.js +1 -1
  377. package/dist/serve/vite-plugin.js.map +1 -1
  378. package/dist/serve/vite-sandbox-generation.d.ts.map +1 -1
  379. package/dist/serve/vite-sandbox-generation.js +12 -0
  380. package/dist/serve/vite-sandbox-generation.js.map +1 -1
  381. package/dist/serve/worker/client/auth.js +1 -2
  382. package/dist/serve/worker/client/auth.js.map +1 -1
  383. package/dist/serve/worker/client/core.d.ts +21 -1
  384. package/dist/serve/worker/client/core.d.ts.map +1 -1
  385. package/dist/serve/worker/client/core.js +79 -3
  386. package/dist/serve/worker/client/core.js.map +1 -1
  387. package/dist/serve/worker/client.d.ts +1 -1
  388. package/dist/serve/worker/client.d.ts.map +1 -1
  389. package/dist/serve/worker/client.js +1 -1
  390. package/dist/serve/worker/client.js.map +1 -1
  391. package/dist/serve/worker/context-resolver.d.ts +30 -0
  392. package/dist/serve/worker/context-resolver.d.ts.map +1 -0
  393. package/dist/serve/worker/context-resolver.js +44 -0
  394. package/dist/serve/worker/context-resolver.js.map +1 -0
  395. package/dist/serve/worker/entry.js +23 -19
  396. package/dist/serve/worker/entry.js.map +1 -1
  397. package/dist/serve/worker/host/core.d.ts +1 -0
  398. package/dist/serve/worker/host/core.d.ts.map +1 -1
  399. package/dist/serve/worker/host/core.js +12 -6
  400. package/dist/serve/worker/host/core.js.map +1 -1
  401. package/dist/serve/worker/host/storage.js +2 -2
  402. package/dist/serve/worker/host-auth.js +1 -2
  403. package/dist/serve/worker/host-auth.js.map +1 -1
  404. package/dist/serve/worker/index.d.ts +1 -1
  405. package/dist/serve/worker/index.d.ts.map +1 -1
  406. package/dist/serve/worker/index.js +2 -2
  407. package/dist/serve/worker/index.js.map +1 -1
  408. package/dist/serve/worker/port-lifecycle.d.ts +18 -0
  409. package/dist/serve/worker/port-lifecycle.d.ts.map +1 -0
  410. package/dist/serve/worker/port-lifecycle.js +28 -0
  411. package/dist/serve/worker/port-lifecycle.js.map +1 -0
  412. package/dist/serve/worker/serve-init.d.ts.map +1 -1
  413. package/dist/serve/worker/serve-init.js +8 -2
  414. package/dist/serve/worker/serve-init.js.map +1 -1
  415. package/dist/verify/fixture.d.ts +1 -1
  416. package/package.json +16 -5
  417. package/src/assurance/.generated/conformance-verdicts.ts +68 -1
  418. package/src/bridge/client/dispatch.ts +52 -56
  419. package/src/bridge/client/tool-family-factories.ts +34 -0
  420. package/src/bridge/server/mcp-contract.ts +15 -59
  421. package/src/bridge/server/peer.ts +24 -1
  422. package/src/bridge/server/tool-family-factories.ts +40 -0
  423. package/src/bridge/server/tool-metadata.ts +29 -61
  424. package/src/bridge/tool-families.generated.ts +17 -0
  425. package/src/bridge/tool-families.ts +87 -0
  426. package/src/bridge/tool-family-records/conformance.ts +6 -0
  427. package/src/bridge/tool-family-records/firestore-data.ts +15 -0
  428. package/src/bridge/tool-family-records/firestore-inspect.ts +6 -0
  429. package/src/bridge/tool-family-records/firestore-rules.ts +15 -0
  430. package/src/bridge/tool-family-records/firestore-simulator.ts +16 -0
  431. package/src/bridge/tool-family-records/rtdb-inspection.ts +6 -0
  432. package/src/bundler/externals.ts +55 -0
  433. package/src/bundler/index.ts +21 -0
  434. package/src/cli/cli.test.ts +0 -44
  435. package/src/cli/inlined-sdk-scanner.ts +77 -0
  436. package/src/cli/sandbox-interlock.ts +167 -0
  437. package/src/cli/sandbox-runner.ts +37 -26
  438. package/src/cli/serve.ts +68 -69
  439. package/src/cli/unsupported-runtime.ts +68 -0
  440. package/src/conformance/.generated/can-i-use-browser.ts +2 -2
  441. package/src/conformance/.generated/can-i-use.ts +2 -2
  442. package/src/conformance/.generated/conformance-docs.ts +1 -1
  443. package/src/functions-rtdb/child.ts +115 -21
  444. package/src/functions-rtdb/development-runtime.ts +4 -0
  445. package/src/google-endpoints.ts +155 -0
  446. package/src/next/runtime-env.ts +5 -0
  447. package/src/next/with-pyric.ts +1 -1
  448. package/src/register/beacon.ts +232 -0
  449. package/src/register/index.ts +68 -6
  450. package/src/register/net-guard.ts +567 -0
  451. package/src/serve/ai-diagnostics-relay.ts +243 -0
  452. package/src/serve/ai-proxy.ts +327 -0
  453. package/src/serve/ai-status.ts +109 -0
  454. package/src/serve/ai-terminal-blocks.ts +210 -0
  455. package/src/serve/ai-terminal-text.ts +52 -0
  456. package/src/serve/beacon-route.ts +141 -0
  457. package/src/serve/entries/active-auth-registry.ts +56 -0
  458. package/src/serve/entries/active-auth.ts +100 -0
  459. package/src/serve/entries/auth-helper-core.ts +5 -0
  460. package/src/serve/entries/auth-helper-dom.ts +26 -2
  461. package/src/serve/entries/auth.ts +8 -0
  462. package/src/serve/entries/bridge-url.ts +1 -1
  463. package/src/serve/entries/init.ts +78 -3
  464. package/src/serve/entries/runtime.ts +10 -0
  465. package/src/serve/namespace.ts +73 -140
  466. package/src/serve/runtime/chip-config.ts +16 -2
  467. package/src/serve/runtime/chip-dialog.ts +366 -0
  468. package/src/serve/runtime/chip-install.ts +10 -4
  469. package/src/serve/runtime/chip-user-search.ts +391 -0
  470. package/src/serve/runtime/chip.ts +140 -15
  471. package/src/serve/runtime/identity.ts +26 -0
  472. package/src/serve/sandbox-session.ts +9 -0
  473. package/src/serve/studio/disk-workspace.ts +76 -2
  474. package/src/serve/vite-plugin.ts +8 -8
  475. package/src/serve/vite-sandbox-generation.ts +15 -0
  476. package/src/serve/worker/client/auth.ts +1 -1
  477. package/src/serve/worker/client/core.ts +80 -3
  478. package/src/serve/worker/client.ts +1 -1
  479. package/src/serve/worker/context-resolver.ts +60 -0
  480. package/src/serve/worker/entry.ts +22 -18
  481. package/src/serve/worker/host/core.ts +9 -7
  482. package/src/serve/worker/host/storage.ts +2 -2
  483. package/src/serve/worker/host-auth.ts +1 -1
  484. package/src/serve/worker/index.ts +4 -1
  485. package/src/serve/worker/port-lifecycle.ts +45 -0
  486. package/src/serve/worker/serve-init.ts +9 -2
  487. package/src/verify/fixture.ts +1 -1
  488. package/dist/serve/site-ui/_astro/app.B52xr-DK.js +0 -1
  489. package/dist/serve/site-ui/_astro/app.DWBraPUw.js +0 -12
  490. package/dist/serve/site-ui/_astro/sandbox-controls.DEpnKg-O.js +0 -1169
  491. package/dist/serve/site-ui/_astro/writes.rpjrFzmu.js +0 -102
@@ -0,0 +1,559 @@
1
+ <!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover"><title>API reference: pyric/firestore/lite · Pyric Studio</title><meta name="description" content="Published declarations for pyric/firestore/lite."><link rel="icon" type="image/svg+xml" href="/__pyric/ui/pyric-logo.svg"><link rel="preconnect" href="https://use.typekit.net" crossorigin><link rel="stylesheet" href="https://use.typekit.net/jwb3ycu.css"><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/__pyric/ui/_astro/index.UkCBr-_0.css">
2
+ <link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.Da5VLhW1.css">
3
+ <style>:root{--rhythm-para: .875rem;--rhythm-group: 1.5rem;--rhythm-subsection: 2.25rem;--rhythm-section: 3.25rem;--rhythm-list: calc(var(--rhythm-para) * .75)}.prose>*,.prose blockquote>*,.prose li>*,.prose .compat-stat>*{margin-block:0}.prose>*+*{margin-block-start:var(--rhythm-group)}.prose>*+h2{margin-block-start:var(--rhythm-section)}.prose>*+h3,.prose>*+h4{margin-block-start:var(--rhythm-subsection)}.prose>h1+*,.prose>h2+*,.prose>h3+*,.prose>h4+*{margin-block-start:var(--rhythm-para)}.prose>p+p{margin-block-start:var(--rhythm-para)}.prose>p+ul,.prose>p+ol,.prose>p+blockquote{margin-block-start:var(--rhythm-para)}.prose li+li{margin-block-start:var(--rhythm-list)}.prose li>ul,.prose li>ol{margin-block-start:var(--rhythm-list)}.prose li>*+*,.prose blockquote>*+*{margin-block-start:var(--rhythm-para)}
4
+ html{scrollbar-gutter:stable}
5
+ </style></head> <body> <header class="studio__chrome"> <div class="studio__bar"> <div class="studio__chrome-inner"> <nav class="studio__nav" aria-label="Site"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric">pyric</a> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a><a class="studio__nav-tab" href="/__pyric/ui/studio"> Studio </a> </nav> </div> </div> </header> <div class="docs-shell" data-astro-cid-mw7aashj> <details class="docs-nav-drawer" data-astro-cid-mw7aashj> <summary data-astro-cid-mw7aashj>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <details class="docs-nav-group"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/backend-bundlers/"> Backend bundlers </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Secure &amp; debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Observe &amp; shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship &amp; test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/firestore-flutter-compat/"> Firestore · Flutter </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-lite-reference-api/" aria-current="page"> pyric/firestore/lite </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-check-reference-api/"> pyric/app-check </a> </li><li> <a href="/__pyric/ui/docs/pyric-functions-reference-api/"> pyric/functions </a> </li><li> <a href="/__pyric/ui/docs/pyric-analytics-reference-api/"> pyric/analytics </a> </li><li> <a href="/__pyric/ui/docs/pyric-performance-reference-api/"> pyric/performance </a> </li><li> <a href="/__pyric/ui/docs/pyric-remote-config-reference-api/"> pyric/remote-config </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bundler-reference-api/"> @pyric/cli/bundler </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <details class="docs-nav-group" id="nav-group-overview"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-get-started"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/backend-bundlers/"> Backend bundlers </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-build"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-secure-debug"> <summary>Secure &amp; debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-secure-debug-examples"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-observe-shape"> <summary>Observe &amp; shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-test"> <summary>Ship &amp; test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-work-with-an-agent"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-trust"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/firestore-flutter-compat/"> Firestore · Flutter </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-lite-reference-api/" aria-current="page"> pyric/firestore/lite </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-check-reference-api/"> pyric/app-check </a> </li><li> <a href="/__pyric/ui/docs/pyric-functions-reference-api/"> pyric/functions </a> </li><li> <a href="/__pyric/ui/docs/pyric-analytics-reference-api/"> pyric/analytics </a> </li><li> <a href="/__pyric/ui/docs/pyric-performance-reference-api/"> pyric/performance </a> </li><li> <a href="/__pyric/ui/docs/pyric-remote-config-reference-api/"> pyric/remote-config </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bundler-reference-api/"> @pyric/cli/bundler </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main" data-astro-cid-mw7aashj> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li> <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>pyric</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">pyric/firestore/lite</span> </li> </ol> </nav> <header class="api-reference-header" data-astro-cid-mw7aashj> <p class="api-reference-kicker" data-astro-cid-mw7aashj>API reference</p> <h1 data-astro-cid-mw7aashj><code data-astro-cid-mw7aashj>pyric/firestore/lite</code></h1> <p class="api-reference-meta" data-astro-cid-mw7aashj> 120 published symbols from <code data-astro-cid-mw7aashj>pyric</code> </p> <p class="api-reference-source" data-astro-cid-mw7aashj>
6
+ Generated from the TypeScript declarations shipped at this import path.
7
+ </p> </header> <article class="prose api-reference-body" data-astro-cid-mw7aashj> <!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
8
+ <h2 id="classes">Classes</h2>
9
+ <p><a id="pyricdeferredapierror"></a></p>
10
+ <h3 id="pyricdeferredapierror">PyricDeferredApiError</h3>
11
+ <p>The error thrown by every deferred Firebase entry. Carries the subpath and
12
+ the symbol that was touched so tooling can group these without parsing the
13
+ message.</p>
14
+ <h4 id="extends">Extends</h4>
15
+ <ul>
16
+ <li><code>Error</code></li>
17
+ </ul>
18
+ <h4 id="constructors">Constructors</h4>
19
+ <p><a id="constructor"></a></p>
20
+ <h5 id="constructor">Constructor</h5>
21
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">new</span><span style="color:#61AFEF"> PyricDeferredApiError</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">subpath</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">symbol</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">PyricDeferredApiError</span><span style="color:#ABB2BF">;</span></span></code></pre>
22
+ <h6 id="parameters">Parameters</h6>
23
+ <div class="table-scroll">
24
+
25
+
26
+
27
+
28
+
29
+
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+ <table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>subpath</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>symbol</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
41
+ <h6 id="returns">Returns</h6>
42
+ <p><a href="#pyricdeferredapierror"><code>PyricDeferredApiError</code></a></p>
43
+ <h6 id="overrides">Overrides</h6>
44
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#E5C07B">Error</span><span style="color:#ABB2BF">.</span><span style="color:#E06C75">constructor</span></span></code></pre>
45
+ <h4 id="properties">Properties</h4>
46
+ <div class="table-scroll">
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+ <table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th><th align="left">Default value</th><th align="left">Description</th><th align="left">Overrides</th></tr></thead><tbody><tr><td align="left"><a id="name"></a> <code>name</code></td><td align="left"><code>readonly</code></td><td align="left"><code>"PyricDeferredApiError"</code></td><td align="left"><code>"PyricDeferredApiError"</code></td><td align="left">-</td><td align="left"><code>Error.name</code></td></tr><tr><td align="left"><a id="subpath"></a> <code>subpath</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td><td align="left"><code>undefined</code></td><td align="left">The Firebase subpath, without the <code>firebase/</code> prefix (e.g. <code>functions</code>).</td><td align="left">-</td></tr><tr><td align="left"><a id="symbol"></a> <code>symbol</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td><td align="left"><code>undefined</code></td><td align="left">The exported symbol whose use triggered this error (e.g. <code>getFunctions</code>).</td><td align="left">-</td></tr></tbody></table></div>
84
+ <h2 id="type-aliases">Type Aliases</h2>
85
+ <p><a id="addprefixtokeys"></a></p>
86
+ <h3 id="addprefixtokeys">AddPrefixToKeys</h3>
87
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AddPrefixToKeys</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
88
+ <hr>
89
+ <p><a id="aggregatefield"></a></p>
90
+ <h3 id="aggregatefield">AggregateField</h3>
91
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateField</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
92
+ <hr>
93
+ <p><a id="aggregatefieldtype"></a></p>
94
+ <h3 id="aggregatefieldtype">AggregateFieldType</h3>
95
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateFieldType</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
96
+ <hr>
97
+ <p><a id="aggregatequerysnapshot"></a></p>
98
+ <h3 id="aggregatequerysnapshot">AggregateQuerySnapshot</h3>
99
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateQuerySnapshot</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
100
+ <hr>
101
+ <p><a id="aggregatespec"></a></p>
102
+ <h3 id="aggregatespec">AggregateSpec</h3>
103
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateSpec</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
104
+ <hr>
105
+ <p><a id="aggregatespecdata"></a></p>
106
+ <h3 id="aggregatespecdata">AggregateSpecData</h3>
107
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateSpecData</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
108
+ <hr>
109
+ <p><a id="aggregatetype"></a></p>
110
+ <h3 id="aggregatetype">AggregateType</h3>
111
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> AggregateType</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
112
+ <hr>
113
+ <p><a id="bytes"></a></p>
114
+ <h3 id="bytes">Bytes</h3>
115
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Bytes</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
116
+ <hr>
117
+ <p><a id="childupdatefields"></a></p>
118
+ <h3 id="childupdatefields">ChildUpdateFields</h3>
119
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> ChildUpdateFields</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
120
+ <hr>
121
+ <p><a id="collectionreference"></a></p>
122
+ <h3 id="collectionreference">CollectionReference</h3>
123
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> CollectionReference</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
124
+ <hr>
125
+ <p><a id="documentdata"></a></p>
126
+ <h3 id="documentdata">DocumentData</h3>
127
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> DocumentData</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
128
+ <hr>
129
+ <p><a id="documentreference"></a></p>
130
+ <h3 id="documentreference">DocumentReference</h3>
131
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> DocumentReference</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
132
+ <hr>
133
+ <p><a id="documentsnapshot"></a></p>
134
+ <h3 id="documentsnapshot">DocumentSnapshot</h3>
135
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> DocumentSnapshot</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
136
+ <hr>
137
+ <p><a id="emulatormocktokenoptions"></a></p>
138
+ <h3 id="emulatormocktokenoptions">EmulatorMockTokenOptions</h3>
139
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> EmulatorMockTokenOptions</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
140
+ <hr>
141
+ <p><a id="fieldpath"></a></p>
142
+ <h3 id="fieldpath">FieldPath</h3>
143
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> FieldPath</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
144
+ <hr>
145
+ <p><a id="fieldvalue"></a></p>
146
+ <h3 id="fieldvalue">FieldValue</h3>
147
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> FieldValue</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
148
+ <hr>
149
+ <p><a id="firestore"></a></p>
150
+ <h3 id="firestore">Firestore</h3>
151
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Firestore</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
152
+ <hr>
153
+ <p><a id="firestoredataconverter"></a></p>
154
+ <h3 id="firestoredataconverter">FirestoreDataConverter</h3>
155
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> FirestoreDataConverter</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
156
+ <hr>
157
+ <p><a id="firestoreerror"></a></p>
158
+ <h3 id="firestoreerror">FirestoreError</h3>
159
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> FirestoreError</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
160
+ <hr>
161
+ <p><a id="firestoreerrorcode"></a></p>
162
+ <h3 id="firestoreerrorcode">FirestoreErrorCode</h3>
163
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> FirestoreErrorCode</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
164
+ <hr>
165
+ <p><a id="geopoint"></a></p>
166
+ <h3 id="geopoint">GeoPoint</h3>
167
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> GeoPoint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
168
+ <hr>
169
+ <p><a id="loglevel"></a></p>
170
+ <h3 id="loglevel">LogLevel</h3>
171
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> LogLevel</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
172
+ <hr>
173
+ <p><a id="nestedupdatefields"></a></p>
174
+ <h3 id="nestedupdatefields">NestedUpdateFields</h3>
175
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> NestedUpdateFields</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
176
+ <hr>
177
+ <p><a id="orderbydirection"></a></p>
178
+ <h3 id="orderbydirection">OrderByDirection</h3>
179
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> OrderByDirection</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
180
+ <hr>
181
+ <p><a id="partialwithfieldvalue"></a></p>
182
+ <h3 id="partialwithfieldvalue">PartialWithFieldValue</h3>
183
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> PartialWithFieldValue</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
184
+ <hr>
185
+ <p><a id="primitive"></a></p>
186
+ <h3 id="primitive">Primitive</h3>
187
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Primitive</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
188
+ <hr>
189
+ <p><a id="query"></a></p>
190
+ <h3 id="query">Query</h3>
191
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Query</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
192
+ <hr>
193
+ <p><a id="querycompositefilterconstraint"></a></p>
194
+ <h3 id="querycompositefilterconstraint">QueryCompositeFilterConstraint</h3>
195
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryCompositeFilterConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
196
+ <hr>
197
+ <p><a id="queryconstraint"></a></p>
198
+ <h3 id="queryconstraint">QueryConstraint</h3>
199
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
200
+ <hr>
201
+ <p><a id="queryconstrainttype"></a></p>
202
+ <h3 id="queryconstrainttype">QueryConstraintType</h3>
203
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryConstraintType</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
204
+ <hr>
205
+ <p><a id="querydocumentsnapshot"></a></p>
206
+ <h3 id="querydocumentsnapshot">QueryDocumentSnapshot</h3>
207
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryDocumentSnapshot</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
208
+ <hr>
209
+ <p><a id="queryendatconstraint"></a></p>
210
+ <h3 id="queryendatconstraint">QueryEndAtConstraint</h3>
211
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryEndAtConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
212
+ <hr>
213
+ <p><a id="queryfieldfilterconstraint"></a></p>
214
+ <h3 id="queryfieldfilterconstraint">QueryFieldFilterConstraint</h3>
215
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryFieldFilterConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
216
+ <hr>
217
+ <p><a id="queryfilterconstraint"></a></p>
218
+ <h3 id="queryfilterconstraint">QueryFilterConstraint</h3>
219
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryFilterConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
220
+ <hr>
221
+ <p><a id="querylimitconstraint"></a></p>
222
+ <h3 id="querylimitconstraint">QueryLimitConstraint</h3>
223
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryLimitConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
224
+ <hr>
225
+ <p><a id="querynonfilterconstraint"></a></p>
226
+ <h3 id="querynonfilterconstraint">QueryNonFilterConstraint</h3>
227
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryNonFilterConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
228
+ <hr>
229
+ <p><a id="queryorderbyconstraint"></a></p>
230
+ <h3 id="queryorderbyconstraint">QueryOrderByConstraint</h3>
231
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryOrderByConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
232
+ <hr>
233
+ <p><a id="querysnapshot"></a></p>
234
+ <h3 id="querysnapshot">QuerySnapshot</h3>
235
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QuerySnapshot</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
236
+ <hr>
237
+ <p><a id="querystartatconstraint"></a></p>
238
+ <h3 id="querystartatconstraint">QueryStartAtConstraint</h3>
239
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> QueryStartAtConstraint</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
240
+ <hr>
241
+ <p><a id="setoptions"></a></p>
242
+ <h3 id="setoptions">SetOptions</h3>
243
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> SetOptions</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
244
+ <hr>
245
+ <p><a id="settings"></a></p>
246
+ <h3 id="settings">Settings</h3>
247
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Settings</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
248
+ <hr>
249
+ <p><a id="timestamp"></a></p>
250
+ <h3 id="timestamp">Timestamp</h3>
251
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Timestamp</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
252
+ <hr>
253
+ <p><a id="transaction"></a></p>
254
+ <h3 id="transaction">Transaction</h3>
255
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Transaction</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
256
+ <hr>
257
+ <p><a id="transactionoptions"></a></p>
258
+ <h3 id="transactionoptions">TransactionOptions</h3>
259
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> TransactionOptions</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
260
+ <hr>
261
+ <p><a id="uniontointersection"></a></p>
262
+ <h3 id="uniontointersection">UnionToIntersection</h3>
263
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> UnionToIntersection</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
264
+ <hr>
265
+ <p><a id="updatedata"></a></p>
266
+ <h3 id="updatedata">UpdateData</h3>
267
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> UpdateData</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
268
+ <hr>
269
+ <p><a id="vectorvalue"></a></p>
270
+ <h3 id="vectorvalue">VectorValue</h3>
271
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> VectorValue</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
272
+ <hr>
273
+ <p><a id="wherefilterop"></a></p>
274
+ <h3 id="wherefilterop">WhereFilterOp</h3>
275
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> WhereFilterOp</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
276
+ <hr>
277
+ <p><a id="withfieldvalue"></a></p>
278
+ <h3 id="withfieldvalue">WithFieldValue</h3>
279
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> WithFieldValue</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
280
+ <hr>
281
+ <p><a id="writebatch"></a></p>
282
+ <h3 id="writebatch">WriteBatch</h3>
283
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> WriteBatch</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
284
+ <h2 id="variables">Variables</h2>
285
+ <p><a id="adddoc"></a></p>
286
+ <h3 id="adddoc">addDoc</h3>
287
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> addDoc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
288
+ <hr>
289
+ <p><a id="aggregatefield-1"></a></p>
290
+ <h3 id="aggregatefield-1">AggregateField</h3>
291
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> AggregateField</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
292
+ <hr>
293
+ <p><a id="aggregatefieldequal"></a></p>
294
+ <h3 id="aggregatefieldequal">aggregateFieldEqual</h3>
295
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> aggregateFieldEqual</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
296
+ <hr>
297
+ <p><a id="aggregatequerysnapshot-1"></a></p>
298
+ <h3 id="aggregatequerysnapshot-1">AggregateQuerySnapshot</h3>
299
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> AggregateQuerySnapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
300
+ <hr>
301
+ <p><a id="aggregatequerysnapshotequal"></a></p>
302
+ <h3 id="aggregatequerysnapshotequal">aggregateQuerySnapshotEqual</h3>
303
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> aggregateQuerySnapshotEqual</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
304
+ <hr>
305
+ <p><a id="and"></a></p>
306
+ <h3 id="and">and</h3>
307
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> and</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
308
+ <hr>
309
+ <p><a id="arrayremove"></a></p>
310
+ <h3 id="arrayremove">arrayRemove</h3>
311
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> arrayRemove</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
312
+ <hr>
313
+ <p><a id="arrayunion"></a></p>
314
+ <h3 id="arrayunion">arrayUnion</h3>
315
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> arrayUnion</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
316
+ <hr>
317
+ <p><a id="average"></a></p>
318
+ <h3 id="average">average</h3>
319
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> average</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
320
+ <hr>
321
+ <p><a id="bytes-1"></a></p>
322
+ <h3 id="bytes-1">Bytes</h3>
323
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> Bytes</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
324
+ <hr>
325
+ <p><a id="collection"></a></p>
326
+ <h3 id="collection">collection</h3>
327
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> collection</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
328
+ <hr>
329
+ <p><a id="collectiongroup"></a></p>
330
+ <h3 id="collectiongroup">collectionGroup</h3>
331
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> collectionGroup</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
332
+ <hr>
333
+ <p><a id="collectionreference-1"></a></p>
334
+ <h3 id="collectionreference-1">CollectionReference</h3>
335
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> CollectionReference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
336
+ <hr>
337
+ <p><a id="connectfirestoreemulator"></a></p>
338
+ <h3 id="connectfirestoreemulator">connectFirestoreEmulator</h3>
339
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> connectFirestoreEmulator</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
340
+ <hr>
341
+ <p><a id="count"></a></p>
342
+ <h3 id="count">count</h3>
343
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> count</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
344
+ <hr>
345
+ <p><a id="deletedoc"></a></p>
346
+ <h3 id="deletedoc">deleteDoc</h3>
347
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> deleteDoc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
348
+ <hr>
349
+ <p><a id="deletefield"></a></p>
350
+ <h3 id="deletefield">deleteField</h3>
351
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> deleteField</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
352
+ <hr>
353
+ <p><a id="doc"></a></p>
354
+ <h3 id="doc">doc</h3>
355
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> doc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
356
+ <hr>
357
+ <p><a id="documentid"></a></p>
358
+ <h3 id="documentid">documentId</h3>
359
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> documentId</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
360
+ <hr>
361
+ <p><a id="documentreference-1"></a></p>
362
+ <h3 id="documentreference-1">DocumentReference</h3>
363
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> DocumentReference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
364
+ <hr>
365
+ <p><a id="documentsnapshot-1"></a></p>
366
+ <h3 id="documentsnapshot-1">DocumentSnapshot</h3>
367
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> DocumentSnapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
368
+ <hr>
369
+ <p><a id="endat"></a></p>
370
+ <h3 id="endat">endAt</h3>
371
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> endAt</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
372
+ <hr>
373
+ <p><a id="endbefore"></a></p>
374
+ <h3 id="endbefore">endBefore</h3>
375
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> endBefore</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
376
+ <hr>
377
+ <p><a id="fieldpath-1"></a></p>
378
+ <h3 id="fieldpath-1">FieldPath</h3>
379
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> FieldPath</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
380
+ <hr>
381
+ <p><a id="fieldvalue-1"></a></p>
382
+ <h3 id="fieldvalue-1">FieldValue</h3>
383
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> FieldValue</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
384
+ <hr>
385
+ <p><a id="firestore-1"></a></p>
386
+ <h3 id="firestore-1">Firestore</h3>
387
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> Firestore</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
388
+ <hr>
389
+ <p><a id="firestoreerror-1"></a></p>
390
+ <h3 id="firestoreerror-1">FirestoreError</h3>
391
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> FirestoreError</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
392
+ <hr>
393
+ <p><a id="geopoint-1"></a></p>
394
+ <h3 id="geopoint-1">GeoPoint</h3>
395
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> GeoPoint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
396
+ <hr>
397
+ <p><a id="getaggregate"></a></p>
398
+ <h3 id="getaggregate">getAggregate</h3>
399
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> getAggregate</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
400
+ <hr>
401
+ <p><a id="getcount"></a></p>
402
+ <h3 id="getcount">getCount</h3>
403
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> getCount</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
404
+ <hr>
405
+ <p><a id="getdoc"></a></p>
406
+ <h3 id="getdoc">getDoc</h3>
407
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> getDoc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
408
+ <hr>
409
+ <p><a id="getdocs"></a></p>
410
+ <h3 id="getdocs">getDocs</h3>
411
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> getDocs</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
412
+ <hr>
413
+ <p><a id="getfirestore"></a></p>
414
+ <h3 id="getfirestore">getFirestore</h3>
415
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> getFirestore</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
416
+ <hr>
417
+ <p><a id="increment"></a></p>
418
+ <h3 id="increment">increment</h3>
419
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> increment</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
420
+ <hr>
421
+ <p><a id="initializefirestore"></a></p>
422
+ <h3 id="initializefirestore">initializeFirestore</h3>
423
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> initializeFirestore</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
424
+ <hr>
425
+ <p><a id="limit"></a></p>
426
+ <h3 id="limit">limit</h3>
427
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> limit</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
428
+ <hr>
429
+ <p><a id="limittolast"></a></p>
430
+ <h3 id="limittolast">limitToLast</h3>
431
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> limitToLast</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
432
+ <hr>
433
+ <p><a id="or"></a></p>
434
+ <h3 id="or">or</h3>
435
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> or</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
436
+ <hr>
437
+ <p><a id="orderby"></a></p>
438
+ <h3 id="orderby">orderBy</h3>
439
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> orderBy</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
440
+ <hr>
441
+ <p><a id="query-1"></a></p>
442
+ <h3 id="query-1">query</h3>
443
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> query</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
444
+ <hr>
445
+ <p><a id="query-2"></a></p>
446
+ <h3 id="query-2">Query</h3>
447
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> Query</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
448
+ <hr>
449
+ <p><a id="querycompositefilterconstraint-1"></a></p>
450
+ <h3 id="querycompositefilterconstraint-1">QueryCompositeFilterConstraint</h3>
451
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryCompositeFilterConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
452
+ <hr>
453
+ <p><a id="queryconstraint-1"></a></p>
454
+ <h3 id="queryconstraint-1">QueryConstraint</h3>
455
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
456
+ <hr>
457
+ <p><a id="querydocumentsnapshot-1"></a></p>
458
+ <h3 id="querydocumentsnapshot-1">QueryDocumentSnapshot</h3>
459
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryDocumentSnapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
460
+ <hr>
461
+ <p><a id="queryendatconstraint-1"></a></p>
462
+ <h3 id="queryendatconstraint-1">QueryEndAtConstraint</h3>
463
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryEndAtConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
464
+ <hr>
465
+ <p><a id="queryequal"></a></p>
466
+ <h3 id="queryequal">queryEqual</h3>
467
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> queryEqual</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
468
+ <hr>
469
+ <p><a id="queryfieldfilterconstraint-1"></a></p>
470
+ <h3 id="queryfieldfilterconstraint-1">QueryFieldFilterConstraint</h3>
471
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryFieldFilterConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
472
+ <hr>
473
+ <p><a id="querylimitconstraint-1"></a></p>
474
+ <h3 id="querylimitconstraint-1">QueryLimitConstraint</h3>
475
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryLimitConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
476
+ <hr>
477
+ <p><a id="queryorderbyconstraint-1"></a></p>
478
+ <h3 id="queryorderbyconstraint-1">QueryOrderByConstraint</h3>
479
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryOrderByConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
480
+ <hr>
481
+ <p><a id="querysnapshot-1"></a></p>
482
+ <h3 id="querysnapshot-1">QuerySnapshot</h3>
483
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QuerySnapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
484
+ <hr>
485
+ <p><a id="querystartatconstraint-1"></a></p>
486
+ <h3 id="querystartatconstraint-1">QueryStartAtConstraint</h3>
487
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> QueryStartAtConstraint</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
488
+ <hr>
489
+ <p><a id="refequal"></a></p>
490
+ <h3 id="refequal">refEqual</h3>
491
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> refEqual</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
492
+ <hr>
493
+ <p><a id="runtransaction"></a></p>
494
+ <h3 id="runtransaction">runTransaction</h3>
495
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> runTransaction</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
496
+ <hr>
497
+ <p><a id="servertimestamp"></a></p>
498
+ <h3 id="servertimestamp">serverTimestamp</h3>
499
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> serverTimestamp</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
500
+ <hr>
501
+ <p><a id="setdoc"></a></p>
502
+ <h3 id="setdoc">setDoc</h3>
503
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> setDoc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
504
+ <hr>
505
+ <p><a id="setloglevel"></a></p>
506
+ <h3 id="setloglevel">setLogLevel</h3>
507
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> setLogLevel</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
508
+ <hr>
509
+ <p><a id="snapshotequal"></a></p>
510
+ <h3 id="snapshotequal">snapshotEqual</h3>
511
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> snapshotEqual</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
512
+ <hr>
513
+ <p><a id="startafter"></a></p>
514
+ <h3 id="startafter">startAfter</h3>
515
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> startAfter</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
516
+ <hr>
517
+ <p><a id="startat"></a></p>
518
+ <h3 id="startat">startAt</h3>
519
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> startAt</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
520
+ <hr>
521
+ <p><a id="sum"></a></p>
522
+ <h3 id="sum">sum</h3>
523
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> sum</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
524
+ <hr>
525
+ <p><a id="terminate"></a></p>
526
+ <h3 id="terminate">terminate</h3>
527
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> terminate</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
528
+ <hr>
529
+ <p><a id="timestamp-1"></a></p>
530
+ <h3 id="timestamp-1">Timestamp</h3>
531
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> Timestamp</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
532
+ <hr>
533
+ <p><a id="transaction-1"></a></p>
534
+ <h3 id="transaction-1">Transaction</h3>
535
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> Transaction</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
536
+ <hr>
537
+ <p><a id="updatedoc"></a></p>
538
+ <h3 id="updatedoc">updateDoc</h3>
539
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> updateDoc</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
540
+ <hr>
541
+ <p><a id="vector"></a></p>
542
+ <h3 id="vector">vector</h3>
543
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> vector</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
544
+ <hr>
545
+ <p><a id="vectorvalue-1"></a></p>
546
+ <h3 id="vectorvalue-1">VectorValue</h3>
547
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> VectorValue</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
548
+ <hr>
549
+ <p><a id="where"></a></p>
550
+ <h3 id="where">where</h3>
551
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> where</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
552
+ <hr>
553
+ <p><a id="writebatch-1"></a></p>
554
+ <h3 id="writebatch-1">writeBatch</h3>
555
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> writeBatch</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre>
556
+ <hr>
557
+ <p><a id="writebatch-2"></a></p>
558
+ <h3 id="writebatch-2">WriteBatch</h3>
559
+ <pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> WriteBatch</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DeferredApi</span><span style="color:#ABB2BF">;</span></span></code></pre> </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols" data-astro-cid-mw7aashj> <h2 class="doc-toc-heading" data-astro-cid-mw7aashj>Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter data-astro-cid-mw7aashj> <div class="api-symbol-groups" data-api-symbol-groups data-astro-cid-mw7aashj> <section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#classes" data-astro-cid-mw7aashj> Classes </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="pyricdeferredapierror" data-astro-cid-mw7aashj> <a href="#pyricdeferredapierror" data-astro-cid-mw7aashj>PyricDeferredApiError</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#type-aliases" data-astro-cid-mw7aashj> Type Aliases </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="addprefixtokeys" data-astro-cid-mw7aashj> <a href="#addprefixtokeys" data-astro-cid-mw7aashj>AddPrefixToKeys</a> </li><li data-api-symbol="aggregatefield" data-astro-cid-mw7aashj> <a href="#aggregatefield" data-astro-cid-mw7aashj>AggregateField</a> </li><li data-api-symbol="aggregatefieldtype" data-astro-cid-mw7aashj> <a href="#aggregatefieldtype" data-astro-cid-mw7aashj>AggregateFieldType</a> </li><li data-api-symbol="aggregatequerysnapshot" data-astro-cid-mw7aashj> <a href="#aggregatequerysnapshot" data-astro-cid-mw7aashj>AggregateQuerySnapshot</a> </li><li data-api-symbol="aggregatespec" data-astro-cid-mw7aashj> <a href="#aggregatespec" data-astro-cid-mw7aashj>AggregateSpec</a> </li><li data-api-symbol="aggregatespecdata" data-astro-cid-mw7aashj> <a href="#aggregatespecdata" data-astro-cid-mw7aashj>AggregateSpecData</a> </li><li data-api-symbol="aggregatetype" data-astro-cid-mw7aashj> <a href="#aggregatetype" data-astro-cid-mw7aashj>AggregateType</a> </li><li data-api-symbol="bytes" data-astro-cid-mw7aashj> <a href="#bytes" data-astro-cid-mw7aashj>Bytes</a> </li><li data-api-symbol="childupdatefields" data-astro-cid-mw7aashj> <a href="#childupdatefields" data-astro-cid-mw7aashj>ChildUpdateFields</a> </li><li data-api-symbol="collectionreference" data-astro-cid-mw7aashj> <a href="#collectionreference" data-astro-cid-mw7aashj>CollectionReference</a> </li><li data-api-symbol="documentdata" data-astro-cid-mw7aashj> <a href="#documentdata" data-astro-cid-mw7aashj>DocumentData</a> </li><li data-api-symbol="documentreference" data-astro-cid-mw7aashj> <a href="#documentreference" data-astro-cid-mw7aashj>DocumentReference</a> </li><li data-api-symbol="documentsnapshot" data-astro-cid-mw7aashj> <a href="#documentsnapshot" data-astro-cid-mw7aashj>DocumentSnapshot</a> </li><li data-api-symbol="emulatormocktokenoptions" data-astro-cid-mw7aashj> <a href="#emulatormocktokenoptions" data-astro-cid-mw7aashj>EmulatorMockTokenOptions</a> </li><li data-api-symbol="fieldpath" data-astro-cid-mw7aashj> <a href="#fieldpath" data-astro-cid-mw7aashj>FieldPath</a> </li><li data-api-symbol="fieldvalue" data-astro-cid-mw7aashj> <a href="#fieldvalue" data-astro-cid-mw7aashj>FieldValue</a> </li><li data-api-symbol="firestore" data-astro-cid-mw7aashj> <a href="#firestore" data-astro-cid-mw7aashj>Firestore</a> </li><li data-api-symbol="firestoredataconverter" data-astro-cid-mw7aashj> <a href="#firestoredataconverter" data-astro-cid-mw7aashj>FirestoreDataConverter</a> </li><li data-api-symbol="firestoreerror" data-astro-cid-mw7aashj> <a href="#firestoreerror" data-astro-cid-mw7aashj>FirestoreError</a> </li><li data-api-symbol="firestoreerrorcode" data-astro-cid-mw7aashj> <a href="#firestoreerrorcode" data-astro-cid-mw7aashj>FirestoreErrorCode</a> </li><li data-api-symbol="geopoint" data-astro-cid-mw7aashj> <a href="#geopoint" data-astro-cid-mw7aashj>GeoPoint</a> </li><li data-api-symbol="loglevel" data-astro-cid-mw7aashj> <a href="#loglevel" data-astro-cid-mw7aashj>LogLevel</a> </li><li data-api-symbol="nestedupdatefields" data-astro-cid-mw7aashj> <a href="#nestedupdatefields" data-astro-cid-mw7aashj>NestedUpdateFields</a> </li><li data-api-symbol="orderbydirection" data-astro-cid-mw7aashj> <a href="#orderbydirection" data-astro-cid-mw7aashj>OrderByDirection</a> </li><li data-api-symbol="partialwithfieldvalue" data-astro-cid-mw7aashj> <a href="#partialwithfieldvalue" data-astro-cid-mw7aashj>PartialWithFieldValue</a> </li><li data-api-symbol="primitive" data-astro-cid-mw7aashj> <a href="#primitive" data-astro-cid-mw7aashj>Primitive</a> </li><li data-api-symbol="query" data-astro-cid-mw7aashj> <a href="#query" data-astro-cid-mw7aashj>Query</a> </li><li data-api-symbol="querycompositefilterconstraint" data-astro-cid-mw7aashj> <a href="#querycompositefilterconstraint" data-astro-cid-mw7aashj>QueryCompositeFilterConstraint</a> </li><li data-api-symbol="queryconstraint" data-astro-cid-mw7aashj> <a href="#queryconstraint" data-astro-cid-mw7aashj>QueryConstraint</a> </li><li data-api-symbol="queryconstrainttype" data-astro-cid-mw7aashj> <a href="#queryconstrainttype" data-astro-cid-mw7aashj>QueryConstraintType</a> </li><li data-api-symbol="querydocumentsnapshot" data-astro-cid-mw7aashj> <a href="#querydocumentsnapshot" data-astro-cid-mw7aashj>QueryDocumentSnapshot</a> </li><li data-api-symbol="queryendatconstraint" data-astro-cid-mw7aashj> <a href="#queryendatconstraint" data-astro-cid-mw7aashj>QueryEndAtConstraint</a> </li><li data-api-symbol="queryfieldfilterconstraint" data-astro-cid-mw7aashj> <a href="#queryfieldfilterconstraint" data-astro-cid-mw7aashj>QueryFieldFilterConstraint</a> </li><li data-api-symbol="queryfilterconstraint" data-astro-cid-mw7aashj> <a href="#queryfilterconstraint" data-astro-cid-mw7aashj>QueryFilterConstraint</a> </li><li data-api-symbol="querylimitconstraint" data-astro-cid-mw7aashj> <a href="#querylimitconstraint" data-astro-cid-mw7aashj>QueryLimitConstraint</a> </li><li data-api-symbol="querynonfilterconstraint" data-astro-cid-mw7aashj> <a href="#querynonfilterconstraint" data-astro-cid-mw7aashj>QueryNonFilterConstraint</a> </li><li data-api-symbol="queryorderbyconstraint" data-astro-cid-mw7aashj> <a href="#queryorderbyconstraint" data-astro-cid-mw7aashj>QueryOrderByConstraint</a> </li><li data-api-symbol="querysnapshot" data-astro-cid-mw7aashj> <a href="#querysnapshot" data-astro-cid-mw7aashj>QuerySnapshot</a> </li><li data-api-symbol="querystartatconstraint" data-astro-cid-mw7aashj> <a href="#querystartatconstraint" data-astro-cid-mw7aashj>QueryStartAtConstraint</a> </li><li data-api-symbol="setoptions" data-astro-cid-mw7aashj> <a href="#setoptions" data-astro-cid-mw7aashj>SetOptions</a> </li><li data-api-symbol="settings" data-astro-cid-mw7aashj> <a href="#settings" data-astro-cid-mw7aashj>Settings</a> </li><li data-api-symbol="timestamp" data-astro-cid-mw7aashj> <a href="#timestamp" data-astro-cid-mw7aashj>Timestamp</a> </li><li data-api-symbol="transaction" data-astro-cid-mw7aashj> <a href="#transaction" data-astro-cid-mw7aashj>Transaction</a> </li><li data-api-symbol="transactionoptions" data-astro-cid-mw7aashj> <a href="#transactionoptions" data-astro-cid-mw7aashj>TransactionOptions</a> </li><li data-api-symbol="uniontointersection" data-astro-cid-mw7aashj> <a href="#uniontointersection" data-astro-cid-mw7aashj>UnionToIntersection</a> </li><li data-api-symbol="updatedata" data-astro-cid-mw7aashj> <a href="#updatedata" data-astro-cid-mw7aashj>UpdateData</a> </li><li data-api-symbol="vectorvalue" data-astro-cid-mw7aashj> <a href="#vectorvalue" data-astro-cid-mw7aashj>VectorValue</a> </li><li data-api-symbol="wherefilterop" data-astro-cid-mw7aashj> <a href="#wherefilterop" data-astro-cid-mw7aashj>WhereFilterOp</a> </li><li data-api-symbol="withfieldvalue" data-astro-cid-mw7aashj> <a href="#withfieldvalue" data-astro-cid-mw7aashj>WithFieldValue</a> </li><li data-api-symbol="writebatch" data-astro-cid-mw7aashj> <a href="#writebatch" data-astro-cid-mw7aashj>WriteBatch</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#variables" data-astro-cid-mw7aashj> Variables </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="adddoc" data-astro-cid-mw7aashj> <a href="#adddoc" data-astro-cid-mw7aashj>addDoc</a> </li><li data-api-symbol="aggregatefield" data-astro-cid-mw7aashj> <a href="#aggregatefield-1" data-astro-cid-mw7aashj>AggregateField</a> </li><li data-api-symbol="aggregatefieldequal" data-astro-cid-mw7aashj> <a href="#aggregatefieldequal" data-astro-cid-mw7aashj>aggregateFieldEqual</a> </li><li data-api-symbol="aggregatequerysnapshot" data-astro-cid-mw7aashj> <a href="#aggregatequerysnapshot-1" data-astro-cid-mw7aashj>AggregateQuerySnapshot</a> </li><li data-api-symbol="aggregatequerysnapshotequal" data-astro-cid-mw7aashj> <a href="#aggregatequerysnapshotequal" data-astro-cid-mw7aashj>aggregateQuerySnapshotEqual</a> </li><li data-api-symbol="and" data-astro-cid-mw7aashj> <a href="#and" data-astro-cid-mw7aashj>and</a> </li><li data-api-symbol="arrayremove" data-astro-cid-mw7aashj> <a href="#arrayremove" data-astro-cid-mw7aashj>arrayRemove</a> </li><li data-api-symbol="arrayunion" data-astro-cid-mw7aashj> <a href="#arrayunion" data-astro-cid-mw7aashj>arrayUnion</a> </li><li data-api-symbol="average" data-astro-cid-mw7aashj> <a href="#average" data-astro-cid-mw7aashj>average</a> </li><li data-api-symbol="bytes" data-astro-cid-mw7aashj> <a href="#bytes-1" data-astro-cid-mw7aashj>Bytes</a> </li><li data-api-symbol="collection" data-astro-cid-mw7aashj> <a href="#collection" data-astro-cid-mw7aashj>collection</a> </li><li data-api-symbol="collectiongroup" data-astro-cid-mw7aashj> <a href="#collectiongroup" data-astro-cid-mw7aashj>collectionGroup</a> </li><li data-api-symbol="collectionreference" data-astro-cid-mw7aashj> <a href="#collectionreference-1" data-astro-cid-mw7aashj>CollectionReference</a> </li><li data-api-symbol="connectfirestoreemulator" data-astro-cid-mw7aashj> <a href="#connectfirestoreemulator" data-astro-cid-mw7aashj>connectFirestoreEmulator</a> </li><li data-api-symbol="count" data-astro-cid-mw7aashj> <a href="#count" data-astro-cid-mw7aashj>count</a> </li><li data-api-symbol="deletedoc" data-astro-cid-mw7aashj> <a href="#deletedoc" data-astro-cid-mw7aashj>deleteDoc</a> </li><li data-api-symbol="deletefield" data-astro-cid-mw7aashj> <a href="#deletefield" data-astro-cid-mw7aashj>deleteField</a> </li><li data-api-symbol="doc" data-astro-cid-mw7aashj> <a href="#doc" data-astro-cid-mw7aashj>doc</a> </li><li data-api-symbol="documentid" data-astro-cid-mw7aashj> <a href="#documentid" data-astro-cid-mw7aashj>documentId</a> </li><li data-api-symbol="documentreference" data-astro-cid-mw7aashj> <a href="#documentreference-1" data-astro-cid-mw7aashj>DocumentReference</a> </li><li data-api-symbol="documentsnapshot" data-astro-cid-mw7aashj> <a href="#documentsnapshot-1" data-astro-cid-mw7aashj>DocumentSnapshot</a> </li><li data-api-symbol="endat" data-astro-cid-mw7aashj> <a href="#endat" data-astro-cid-mw7aashj>endAt</a> </li><li data-api-symbol="endbefore" data-astro-cid-mw7aashj> <a href="#endbefore" data-astro-cid-mw7aashj>endBefore</a> </li><li data-api-symbol="fieldpath" data-astro-cid-mw7aashj> <a href="#fieldpath-1" data-astro-cid-mw7aashj>FieldPath</a> </li><li data-api-symbol="fieldvalue" data-astro-cid-mw7aashj> <a href="#fieldvalue-1" data-astro-cid-mw7aashj>FieldValue</a> </li><li data-api-symbol="firestore" data-astro-cid-mw7aashj> <a href="#firestore-1" data-astro-cid-mw7aashj>Firestore</a> </li><li data-api-symbol="firestoreerror" data-astro-cid-mw7aashj> <a href="#firestoreerror-1" data-astro-cid-mw7aashj>FirestoreError</a> </li><li data-api-symbol="geopoint" data-astro-cid-mw7aashj> <a href="#geopoint-1" data-astro-cid-mw7aashj>GeoPoint</a> </li><li data-api-symbol="getaggregate" data-astro-cid-mw7aashj> <a href="#getaggregate" data-astro-cid-mw7aashj>getAggregate</a> </li><li data-api-symbol="getcount" data-astro-cid-mw7aashj> <a href="#getcount" data-astro-cid-mw7aashj>getCount</a> </li><li data-api-symbol="getdoc" data-astro-cid-mw7aashj> <a href="#getdoc" data-astro-cid-mw7aashj>getDoc</a> </li><li data-api-symbol="getdocs" data-astro-cid-mw7aashj> <a href="#getdocs" data-astro-cid-mw7aashj>getDocs</a> </li><li data-api-symbol="getfirestore" data-astro-cid-mw7aashj> <a href="#getfirestore" data-astro-cid-mw7aashj>getFirestore</a> </li><li data-api-symbol="increment" data-astro-cid-mw7aashj> <a href="#increment" data-astro-cid-mw7aashj>increment</a> </li><li data-api-symbol="initializefirestore" data-astro-cid-mw7aashj> <a href="#initializefirestore" data-astro-cid-mw7aashj>initializeFirestore</a> </li><li data-api-symbol="limit" data-astro-cid-mw7aashj> <a href="#limit" data-astro-cid-mw7aashj>limit</a> </li><li data-api-symbol="limittolast" data-astro-cid-mw7aashj> <a href="#limittolast" data-astro-cid-mw7aashj>limitToLast</a> </li><li data-api-symbol="or" data-astro-cid-mw7aashj> <a href="#or" data-astro-cid-mw7aashj>or</a> </li><li data-api-symbol="orderby" data-astro-cid-mw7aashj> <a href="#orderby" data-astro-cid-mw7aashj>orderBy</a> </li><li data-api-symbol="query" data-astro-cid-mw7aashj> <a href="#query-1" data-astro-cid-mw7aashj>query</a> </li><li data-api-symbol="query" data-astro-cid-mw7aashj> <a href="#query-2" data-astro-cid-mw7aashj>Query</a> </li><li data-api-symbol="querycompositefilterconstraint" data-astro-cid-mw7aashj> <a href="#querycompositefilterconstraint-1" data-astro-cid-mw7aashj>QueryCompositeFilterConstraint</a> </li><li data-api-symbol="queryconstraint" data-astro-cid-mw7aashj> <a href="#queryconstraint-1" data-astro-cid-mw7aashj>QueryConstraint</a> </li><li data-api-symbol="querydocumentsnapshot" data-astro-cid-mw7aashj> <a href="#querydocumentsnapshot-1" data-astro-cid-mw7aashj>QueryDocumentSnapshot</a> </li><li data-api-symbol="queryendatconstraint" data-astro-cid-mw7aashj> <a href="#queryendatconstraint-1" data-astro-cid-mw7aashj>QueryEndAtConstraint</a> </li><li data-api-symbol="queryequal" data-astro-cid-mw7aashj> <a href="#queryequal" data-astro-cid-mw7aashj>queryEqual</a> </li><li data-api-symbol="queryfieldfilterconstraint" data-astro-cid-mw7aashj> <a href="#queryfieldfilterconstraint-1" data-astro-cid-mw7aashj>QueryFieldFilterConstraint</a> </li><li data-api-symbol="querylimitconstraint" data-astro-cid-mw7aashj> <a href="#querylimitconstraint-1" data-astro-cid-mw7aashj>QueryLimitConstraint</a> </li><li data-api-symbol="queryorderbyconstraint" data-astro-cid-mw7aashj> <a href="#queryorderbyconstraint-1" data-astro-cid-mw7aashj>QueryOrderByConstraint</a> </li><li data-api-symbol="querysnapshot" data-astro-cid-mw7aashj> <a href="#querysnapshot-1" data-astro-cid-mw7aashj>QuerySnapshot</a> </li><li data-api-symbol="querystartatconstraint" data-astro-cid-mw7aashj> <a href="#querystartatconstraint-1" data-astro-cid-mw7aashj>QueryStartAtConstraint</a> </li><li data-api-symbol="refequal" data-astro-cid-mw7aashj> <a href="#refequal" data-astro-cid-mw7aashj>refEqual</a> </li><li data-api-symbol="runtransaction" data-astro-cid-mw7aashj> <a href="#runtransaction" data-astro-cid-mw7aashj>runTransaction</a> </li><li data-api-symbol="servertimestamp" data-astro-cid-mw7aashj> <a href="#servertimestamp" data-astro-cid-mw7aashj>serverTimestamp</a> </li><li data-api-symbol="setdoc" data-astro-cid-mw7aashj> <a href="#setdoc" data-astro-cid-mw7aashj>setDoc</a> </li><li data-api-symbol="setloglevel" data-astro-cid-mw7aashj> <a href="#setloglevel" data-astro-cid-mw7aashj>setLogLevel</a> </li><li data-api-symbol="snapshotequal" data-astro-cid-mw7aashj> <a href="#snapshotequal" data-astro-cid-mw7aashj>snapshotEqual</a> </li><li data-api-symbol="startafter" data-astro-cid-mw7aashj> <a href="#startafter" data-astro-cid-mw7aashj>startAfter</a> </li><li data-api-symbol="startat" data-astro-cid-mw7aashj> <a href="#startat" data-astro-cid-mw7aashj>startAt</a> </li><li data-api-symbol="sum" data-astro-cid-mw7aashj> <a href="#sum" data-astro-cid-mw7aashj>sum</a> </li><li data-api-symbol="terminate" data-astro-cid-mw7aashj> <a href="#terminate" data-astro-cid-mw7aashj>terminate</a> </li><li data-api-symbol="timestamp" data-astro-cid-mw7aashj> <a href="#timestamp-1" data-astro-cid-mw7aashj>Timestamp</a> </li><li data-api-symbol="transaction" data-astro-cid-mw7aashj> <a href="#transaction-1" data-astro-cid-mw7aashj>Transaction</a> </li><li data-api-symbol="updatedoc" data-astro-cid-mw7aashj> <a href="#updatedoc" data-astro-cid-mw7aashj>updateDoc</a> </li><li data-api-symbol="vector" data-astro-cid-mw7aashj> <a href="#vector" data-astro-cid-mw7aashj>vector</a> </li><li data-api-symbol="vectorvalue" data-astro-cid-mw7aashj> <a href="#vectorvalue-1" data-astro-cid-mw7aashj>VectorValue</a> </li><li data-api-symbol="where" data-astro-cid-mw7aashj> <a href="#where" data-astro-cid-mw7aashj>where</a> </li><li data-api-symbol="writebatch" data-astro-cid-mw7aashj> <a href="#writebatch-1" data-astro-cid-mw7aashj>writeBatch</a> </li><li data-api-symbol="writebatch" data-astro-cid-mw7aashj> <a href="#writebatch-2" data-astro-cid-mw7aashj>WriteBatch</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden data-astro-cid-mw7aashj>No matching symbols</p> </div> </aside> </div> <script type="module">const a=document.querySelector("[data-api-symbol-filter]"),d=[...document.querySelectorAll("[data-api-symbol-group]")],n=document.querySelector("[data-api-symbol-empty]");a?.addEventListener("input",()=>{const t=a.value.trim().toLowerCase();let o=0;for(const i of d){let e=0;i.querySelectorAll("[data-api-symbol]").forEach(l=>{const r=!t||(l.dataset.apiSymbol??"").includes(t);l.hidden=!r,r&&e++}),i.hidden=e===0,o+=e}n&&(n.hidden=o>0)});</script> <script type="module">const s=new Map;document.querySelectorAll('.doc-toc a[href^="#"]').forEach(t=>s.set(decodeURIComponent(t.hash.slice(1)),t));if(s.size>0){const t=new Set,n=()=>{let o=null;for(const e of s.keys())if(t.has(e)){o=e;break}s.forEach((e,c)=>e.classList.toggle("active",c===o))},r=new IntersectionObserver(o=>{for(const e of o)e.isIntersecting?t.add(e.target.id):t.delete(e.target.id);n()},{rootMargin:"-72px 0px -60% 0px"});s.forEach((o,e)=>{const c=document.getElementById(e);c&&r.observe(c)})}</script> <script type="module">document.querySelector('.studio__nav [aria-current="page"]')?.scrollIntoView({block:"nearest",inline:"center"});</script> </body></html>