npm - @pyric/cli - Versions diffs - 0.1.0-alpha.10 → 0.1.0-alpha.11 - Mend

@pyric/cli 0.1.0-alpha.10 → 0.1.0-alpha.11

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 (304) hide show

package/dist/serve/docs-ui/docs/pyric-admin-firestore-reference-api/index.html CHANGED Viewed

@@ -1,19 +1,2450 @@
-<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>API reference: pyric-admin/firestore · Pyric Studio</title><meta name="description" content="Published declarations for pyric-admin/firestore."><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/_slug_.DPUwShm2.css"></head> <body>  <header class="studio__bar"> <div class="studio__bar-inner"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric Studio">Pyric</a> <nav class="studio__nav" aria-label="Studio tabs"> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/firestore"> Firestore </a><a class="studio__nav-tab" href="/__pyric/ui/auth"> Auth </a><a class="studio__nav-tab" href="/__pyric/ui/rtdb"> RTDB </a><a class="studio__nav-tab" href="/__pyric/ui/storage"> Storage </a><a class="studio__nav-tab" href="/__pyric/ui/traffic"> Traffic </a><a class="studio__nav-tab" href="/__pyric/ui/settings"> Settings </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a> </nav> </div> </header> <div class="docs-shell">  <details class="docs-nav-drawer"> <summary>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> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/"> Overview </a><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/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> </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/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><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Trust </a><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/"> Public API coverage </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> </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-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-firestore-values-reference-api/"> pyric/firestore-values </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> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <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/" aria-current="page"> 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> </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-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-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> </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> </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>  <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/" id="nav-group-overview"> Overview </a><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/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> </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/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><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/" id="nav-group-trust"> Trust </a><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/"> Public API coverage </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> </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-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-firestore-values-reference-api/"> pyric/firestore-values </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> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <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/" aria-current="page"> 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> </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-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-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> </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> </details> </nav> <main class="doc-main"> <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-admin</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">pyric-admin/firestore</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>pyric-admin/firestore</code></h1> <p class="api-reference-meta"> 1 published symbols from <code>pyric-admin</code> </p> <p class="api-reference-source">
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>API reference: pyric-admin/firestore · Pyric Studio</title><meta name="description" content="Published declarations for pyric-admin/firestore."><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/_slug_.CXh9yTP1.css">
+<link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.DUci-duz.css"></head> <body>  <header class="studio__bar"> <div class="studio__bar-inner"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric Studio">Pyric</a> <nav class="studio__nav" aria-label="Studio tabs"> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/firestore"> Firestore </a><a class="studio__nav-tab" href="/__pyric/ui/auth"> Auth </a><a class="studio__nav-tab" href="/__pyric/ui/rtdb"> RTDB </a><a class="studio__nav-tab" href="/__pyric/ui/storage"> Storage </a><a class="studio__nav-tab" href="/__pyric/ui/traffic"> Traffic </a><a class="studio__nav-tab" href="/__pyric/ui/settings"> Settings </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a> </nav> </div> </header> <div class="docs-shell">  <details class="docs-nav-drawer"> <summary>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> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/"> Overview </a><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/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> </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/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><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Trust </a><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/"> Public API coverage </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> </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-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-firestore-values-reference-api/"> pyric/firestore-values </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> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <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/" aria-current="page"> 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> </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-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> </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> </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>  <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/" id="nav-group-overview"> Overview </a><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/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> </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/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><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/" id="nav-group-trust"> Trust </a><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/"> Public API coverage </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> </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-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-firestore-values-reference-api/"> pyric/firestore-values </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> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <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/" aria-current="page"> 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> </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-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> </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> </details> </nav> <main class="doc-main"> <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-admin</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">pyric-admin/firestore</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>pyric-admin/firestore</code></h1> <p class="api-reference-meta"> 41 published symbols from <code>pyric-admin</code> </p> <p class="api-reference-source">
 Generated from the TypeScript declarations shipped at this import path.
-</p>  </header> <article class="prose api-reference-body">  <!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+</p>  </header> <article class="prose api-reference-body">  <!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
+<h2 id="interfaces">Interfaces</h2>
+<p><a id="admindocumentsnapshot"></a></p>
+<h3 id="admindocumentsnapshot">AdminDocumentSnapshot</h3>
+<h4 id="extended-by">Extended by</h4>
+<ul>
+<li><a href="#adminquerydocumentsnapshot"><code>AdminQueryDocumentSnapshot</code></a></li>
+</ul>
+<h4 id="properties">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="exists"></a> <code>exists</code></td><td align="left"><code>readonly</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><a id="id"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="ref"></a> <code>ref</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr></tbody></table></div>
+<h4 id="methods">Methods</h4>
+<p><a id="data"></a></p>
+<h5 id="data">data()</h5>
+<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:#61AFEF">data</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns">Returns</h6>
+<p><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></p>
+<hr>
+<p><a id="adminquerydocumentsnapshot"></a></p>
+<h3 id="adminquerydocumentsnapshot">AdminQueryDocumentSnapshot</h3>
+<h4 id="extends">Extends</h4>
+<ul>
+<li><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a></li>
+</ul>
+<h4 id="properties-1">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="exists-1"></a> <code>exists</code></td><td align="left"><code>readonly</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><a id="id-1"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="ref-1"></a> <code>ref</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr></tbody></table></div>
+<h4 id="methods-1">Methods</h4>
+<p><a id="data-2"></a></p>
+<h5 id="data-1">data()</h5>
+<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:#61AFEF">data</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-1">Returns</h6>
+<p><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></p>
+<h6 id="overrides">Overrides</h6>
+<p><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a>.<a href="#data"><code>data</code></a></p>
+<hr>
+<p><a id="adminquerysnapshot"></a></p>
+<h3 id="adminquerysnapshot">AdminQuerySnapshot</h3>
+<h4 id="properties-2">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="docs"></a> <code>docs</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#adminquerydocumentsnapshot"><code>AdminQueryDocumentSnapshot</code></a>[]</td></tr><tr><td align="left"><a id="empty"></a> <code>empty</code></td><td align="left"><code>readonly</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><a id="size"></a> <code>size</code></td><td align="left"><code>readonly</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h4 id="methods-2">Methods</h4>
+<p><a id="foreach"></a></p>
+<h5 id="foreach">forEach()</h5>
+<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:#61AFEF">forEach</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">callback</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snap</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AdminQueryDocumentSnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#C678DD"> void</span><span style="color:#ABB2BF">): </span><span style="color:#C678DD">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>callback</code></td><td align="left">(<code>snap</code>: <a href="#adminquerydocumentsnapshot"><code>AdminQueryDocumentSnapshot</code></a>) => <code>void</code></td></tr></tbody></table></div>
+<h6 id="returns-2">Returns</h6>
+<p><code>void</code></p>
+<hr>
+<p><a id="aggregatequerysnapshot"></a></p>
+<h3 id="aggregatequerysnapshot">AggregateQuerySnapshot</h3>
+<p>Result of <code>Query.aggregate(spec).get()</code>. <code>.data()</code> returns the
+computed numbers under the spec’s aliases. Empty-input averages
+resolve to <code>null</code> to mirror Firestore production behavior
+(averaging over zero documents has no meaningful number).</p>
+<h4 id="methods-3">Methods</h4>
+<p><a id="data-4"></a></p>
+<h5 id="data-2">data()</h5>
+<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:#61AFEF">data</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">Record</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">number</span><span style="color:#56B6C2"> |</span><span style="color:#D19A66"> null</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-3">Returns</h6>
+<p><code>Record</code>&#x3C;<code>string</code>, <code>number</code> | <code>null</code>></p>
+<hr>
+<p><a id="collectionreference"></a></p>
+<h3 id="collectionreference">CollectionReference</h3>
+<h4 id="extends-1">Extends</h4>
+<ul>
+<li><a href="#query"><code>Query</code></a></li>
+</ul>
+<h4 id="properties-3">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="id-2"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="path"></a> <code>path</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h4 id="methods-4">Methods</h4>
+<p><a id="add"></a></p>
+<h5 id="add">add()</h5>
+<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:#61AFEF">add</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">DocumentReference</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-1">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-4">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#documentreference"><code>DocumentReference</code></a>></p>
+<p><a id="aggregate"></a></p>
+<h5 id="aggregate">aggregate()</h5>
+<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:#61AFEF">aggregate</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">spec</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AggregateSpec</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AggregateQuerySnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Compute one or more aggregates over the documents matching this
+query. Mirrors the Admin SDK’s <code>query.aggregate({ … }).get()</code>
+pattern, collapsed into one call for the simulator (no need to
+build an <code>AggregateQuery</code> reference type when there’s no remote
+dispatch).</p>
+<p>Each entry in <code>spec</code> is keyed by a caller-chosen alias and
+resolves to an <code>AggregateField</code>. The returned snapshot exposes
+the computed numbers under the same aliases via <code>.data()</code>.</p>
+<p>Where / orderBy clauses ARE applied before aggregation (they
+narrow the candidate doc set). <code>limit</code> is honored — the aggregate
+computes against the limited set, matching production semantics.</p>
+<h6 id="parameters-2">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>spec</code></td><td align="left"><a href="#aggregatespec"><code>AggregateSpec</code></a></td></tr></tbody></table></div>
+<h6 id="returns-5">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#aggregatequerysnapshot"><code>AggregateQuerySnapshot</code></a>></p>
+<h6 id="inherited-from">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#aggregate-2"><code>aggregate</code></a></p>
+<p><a id="applyfilter"></a></p>
+<h5 id="applyfilter">applyFilter()</h5>
+<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:#61AFEF">applyFilter</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">filter</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">Filter</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Add a composite filter (leaf, AND, or OR) to the query’s filter
+stack. Each <code>applyFilter</code> call AND-s with whatever filters are
+already on the query — same implicit-AND semantics as multiple
+<code>where()</code> calls. To OR multiple predicates, wrap them with
+<code>{ kind: 'or', filters: [...] }</code> before calling. Backs the
+modular <code>or()</code> / <code>and()</code> constraints in <code>pyric/firestore</code>.</p>
+<h6 id="parameters-3">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>filter</code></td><td align="left"><a href="#filter"><code>Filter</code></a></td></tr></tbody></table></div>
+<h6 id="returns-6">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-1">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#applyfilter-2"><code>applyFilter</code></a></p>
+<p><a id="doc"></a></p>
+<h5 id="doc">doc()</h5>
+<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:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">id</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-4">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>id?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-7">Returns</h6>
+<p><a href="#documentreference"><code>DocumentReference</code></a></p>
+<p><a id="endcursor"></a></p>
+<h5 id="endcursor">endCursor()</h5>
+<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:#61AFEF">endCursor</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">values</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">[], </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Set the end position of the query relative to the orderBy fields.
+<code>inclusive</code> controls <code>endAt</code> (true) vs <code>endBefore</code> (false).</p>
+<h6 id="parameters-5">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>values</code></td><td align="left"><code>unknown</code>[]</td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-8">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-2">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#endcursor-2"><code>endCursor</code></a></p>
+<p><a id="endcursorfromsnapshot"></a></p>
+<h5 id="endcursorfromsnapshot">endCursorFromSnapshot()</h5>
+<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:#61AFEF">endCursorFromSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Snapshot-based variant of <a href="#endcursor-2">endCursor</a>.</p>
+<h6 id="parameters-6">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>snapshot</code></td><td align="left"><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a></td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-9">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-3">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#endcursorfromsnapshot-2"><code>endCursorFromSnapshot</code></a></p>
+<p><a id="get"></a></p>
+<h5 id="get">get()</h5>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AdminQuerySnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-7">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-10">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#adminquerysnapshot"><code>AdminQuerySnapshot</code></a>></p>
+<h6 id="inherited-from-4">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#get-6"><code>get</code></a></p>
+<p><a id="limit"></a></p>
+<h5 id="limit">limit()</h5>
+<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:#61AFEF">limit</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">n</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">number</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-8">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h6 id="returns-11">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-5">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#limit-2"><code>limit</code></a></p>
+<p><a id="limittolast"></a></p>
+<h5 id="limittolast">limitToLast()</h5>
+<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:#61AFEF">limitToLast</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">n</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">number</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Limit from the END of the ordered result. Equivalent to reversing
+the orderBy, taking <code>n</code>, then re-reversing — the simulator
+implements it that way. Requires at least one <code>orderBy</code> clause on
+the query (matches the JS SDK’s runtime contract).</p>
+<h6 id="parameters-9">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h6 id="returns-12">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-6">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#limittolast-2"><code>limitToLast</code></a></p>
+<p><a id="orderby"></a></p>
+<h5 id="orderby">orderBy()</h5>
+<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:#61AFEF">orderBy</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">field</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">direction</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OrderDirection</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-10">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>direction?</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#orderdirection"><code>OrderDirection</code></a></td></tr></tbody></table></div>
+<h6 id="returns-13">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-7">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#orderby-2"><code>orderBy</code></a></p>
+<p><a id="startcursor"></a></p>
+<h5 id="startcursor">startCursor()</h5>
+<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:#61AFEF">startCursor</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">values</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">[], </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Set the start position of the query relative to the orderBy
+fields. <code>values</code> corresponds 1:1 with the orderBy clauses on the
+query (one value per clause); <code>inclusive</code> controls <code>startAt</code> (true)
+vs <code>startAfter</code> (false). Repeated calls replace the previous
+cursor — matches production.</p>
+<h6 id="parameters-11">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>values</code></td><td align="left"><code>unknown</code>[]</td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-14">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-8">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#startcursor-2"><code>startCursor</code></a></p>
+<p><a id="startcursorfromsnapshot"></a></p>
+<h5 id="startcursorfromsnapshot">startCursorFromSnapshot()</h5>
+<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:#61AFEF">startCursorFromSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Variant of <a href="#startcursor-2">startCursor</a> that takes a <code>DocumentSnapshot</code>
+and extracts the cursor values from the snapshot’s data at each
+orderBy field. Mirrors the JS SDK’s <code>startAt(snapshot)</code> overload
+and shines for cursor-based pagination (“hand me the next page
+after this one”). Requires at least one <code>orderBy</code> clause —
+thrown at call time, not at get-time, so the failure surfaces
+close to the bug.</p>
+<h6 id="parameters-12">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>snapshot</code></td><td align="left"><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a></td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-15">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-9">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#startcursorfromsnapshot-2"><code>startCursorFromSnapshot</code></a></p>
+<p><a id="where"></a></p>
+<h5 id="where">where()</h5>
+<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:#61AFEF">where</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75">   field</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75">   op</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">WhereFilterOp</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75">   value</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-13">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>op</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#wherefilterop"><code>WhereFilterOp</code></a></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
+<h6 id="returns-16">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-10">Inherited from</h6>
+<p><a href="#query"><code>Query</code></a>.<a href="#where-2"><code>where</code></a></p>
+<hr>
+<p><a id="docchangesoptions"></a></p>
+<h3 id="docchangesoptions">DocChangesOptions</h3>
+<p>Options for <code>QuerySnapshot.docChanges</code>. Mirrors Web SDK shape.</p>
+<h4 id="properties-4">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="includemetadatachanges"></a> <code>includeMetadataChanges?</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="documentchange"></a></p>
+<h3 id="documentchange">DocumentChange</h3>
+<h4 id="properties-5">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><a id="doc-2"></a> <code>doc</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#querydocumentsnapshot"><code>QueryDocumentSnapshot</code></a></td><td align="left">-</td></tr><tr><td align="left"><a id="newindex"></a> <code>newIndex</code></td><td align="left"><code>readonly</code></td><td align="left"><code>number</code></td><td align="left">-1 for <code>removed</code>.</td></tr><tr><td align="left"><a id="oldindex"></a> <code>oldIndex</code></td><td align="left"><code>readonly</code></td><td align="left"><code>number</code></td><td align="left">-1 for <code>added</code>.</td></tr><tr><td align="left"><a id="type"></a> <code>type</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#documentchangetype-1"><code>DocumentChangeType</code></a></td><td align="left">-</td></tr></tbody></table></div>
+<hr>
+<p><a id="documentreference"></a></p>
+<h3 id="documentreference">DocumentReference</h3>
+<h4 id="properties-6">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="id-3"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="parent"></a> <code>parent</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#collectionreference"><code>CollectionReference</code></a></td></tr><tr><td align="left"><a id="path-1"></a> <code>path</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h4 id="methods-5">Methods</h4>
+<p><a id="collection"></a></p>
+<h5 id="collection">collection()</h5>
+<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:#61AFEF">collection</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">name</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">CollectionReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-14">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>name</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-17">Returns</h6>
+<p><a href="#collectionreference"><code>CollectionReference</code></a></p>
+<p><a id="delete"></a></p>
+<h5 id="delete">delete()</h5>
+<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">delete</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-15">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-18">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>void</code>></p>
+<p><a id="get-2"></a></p>
+<h5 id="get-1">get()</h5>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-16">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-19">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a>></p>
+<p><a id="set"></a></p>
+<h5 id="set">set()</h5>
+<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:#61AFEF">set</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">options</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> SetOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-17">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><a href="#setoptions"><code>SetOptions</code></a></td></tr></tbody></table></div>
+<h6 id="returns-20">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>void</code>></p>
+<p><a id="update"></a></p>
+<h5 id="update">update()</h5>
+<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:#61AFEF">update</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-18">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-21">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>void</code>></p>
+<hr>
+<p><a id="documentsnapshot"></a></p>
+<h3 id="documentsnapshot">DocumentSnapshot</h3>
+<h4 id="extended-by-1">Extended by</h4>
+<ul>
+<li><a href="#querydocumentsnapshot"><code>QueryDocumentSnapshot</code></a></li>
+</ul>
+<h4 id="properties-7">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="id-4"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="metadata"></a> <code>metadata</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#snapshotmetadata"><code>SnapshotMetadata</code></a></td></tr><tr><td align="left"><a id="ref-2"></a> <code>ref</code></td><td align="left"><code>readonly</code></td><td align="left"><code>SnapshotDocRef</code></td></tr></tbody></table></div>
+<h4 id="methods-6">Methods</h4>
+<p><a id="data-6"></a></p>
+<h5 id="data-3">data()</h5>
+<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:#61AFEF">data</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-22">Returns</h6>
+<p><code>DocumentData</code></p>
+<p><a id="exists-2"></a></p>
+<h5 id="exists">exists()</h5>
+<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:#61AFEF">exists</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-23">Returns</h6>
+<p><code>boolean</code></p>
+<p><a id="get-4"></a></p>
+<h5 id="get-2">get()</h5>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">fieldPath</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Field accessor mirroring <code>firebase/firestore</code>’s <code>DocumentSnapshot.get(fieldPath)</code>.
+Dotted paths supported. Missing intermediate keys yield <code>undefined</code>
+— production behavior; agents commonly chain optional reads.</p>
+<h6 id="parameters-19">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>fieldPath</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-24">Returns</h6>
+<p><code>unknown</code></p>
+<hr>
+<p><a id="firestore"></a></p>
+<h3 id="firestore">Firestore</h3>
+<h4 id="extended-by-2">Extended by</h4>
+<ul>
+<li><a href="#sandboxfirestore"><code>SandboxFirestore</code></a></li>
+</ul>
+<h4 id="methods-7">Methods</h4>
+<p><a id="batch"></a></p>
+<h5 id="batch">batch()</h5>
+<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:#61AFEF">batch</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">WriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-25">Returns</h6>
+<p><a href="#writebatch"><code>WriteBatch</code></a></p>
+<p><a id="collection-2"></a></p>
+<h5 id="collection-1">collection()</h5>
+<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:#61AFEF">collection</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">path</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">CollectionReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-20">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>path</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-26">Returns</h6>
+<p><a href="#collectionreference"><code>CollectionReference</code></a></p>
+<p><a id="collectiongroup"></a></p>
+<h5 id="collectiongroup">collectionGroup()</h5>
+<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:#61AFEF">collectionGroup</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">collectionId</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Cross-collection query — returns a <code>Query</code> that scans every
+document under every collection whose final segment matches
+<code>collectionId</code>, regardless of position in the path. Matches the
+Admin SDK’s <code>Firestore.collectionGroup(id)</code> shape.</p>
+<p>The returned <code>Query</code> accepts <code>where</code> / <code>orderBy</code> / <code>limit</code> like
+any other; the simulator gathers all candidate docs first, then
+applies the constraints in-memory.</p>
+<h6 id="parameters-21">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>collectionId</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-27">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="doc-3"></a></p>
+<h5 id="doc-1">doc()</h5>
+<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:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">path</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-22">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>path</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-28">Returns</h6>
+<p><a href="#documentreference"><code>DocumentReference</code></a></p>
+<p><a id="runtransaction"></a></p>
+<h5 id="runtransaction">runTransaction()</h5>
+<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:#61AFEF">runTransaction</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#ABB2BF">>(</span><span style="color:#E06C75">fn</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">tx</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Transaction</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> R</span><span style="color:#56B6C2"> |</span><span style="color:#E5C07B"> Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="type-parameters">Type Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Type Parameter</th></tr></thead><tbody><tr><td align="left"><code>R</code></td></tr></tbody></table></div>
+<h6 id="parameters-23">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>fn</code></td><td align="left">(<code>tx</code>: <a href="#transaction"><code>Transaction</code></a>) => <code>R</code> | <code>Promise</code>&#x3C;<code>R</code>></td></tr><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-29">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>R</code>></p>
+<hr>
+<p><a id="lintwarning"></a></p>
+<h3 id="lintwarning">LintWarning</h3>
+<h4 id="properties-8">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><a id="fix"></a> <code>fix?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="location"></a> <code>location?</code></td><td align="left">{ <code>functionName?</code>: <code>string</code>; <code>matchPath?</code>: <code>string</code>; <code>ruleIndex?</code>: <code>number</code>; <code>testCaseDescription?</code>: <code>string</code>; }</td><td align="left">-</td></tr><tr><td align="left"><code>location.functionName?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><code>location.matchPath?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><code>location.ruleIndex?</code></td><td align="left"><code>number</code></td><td align="left">-</td></tr><tr><td align="left"><code>location.testCaseDescription?</code></td><td align="left"><code>string</code></td><td align="left">Test-case description from <code>TestCase.description</code>. Set only by rules that operate on the optional test suite (e.g. REQUEST_TIME_NOT_PINNED).</td></tr><tr><td align="left"><a id="message"></a> <code>message</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="rule"></a> <code>rule</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="severity"></a> <code>severity</code></td><td align="left"><code>"error"</code> | <code>"warning"</code></td><td align="left">-</td></tr></tbody></table></div>
+<hr>
+<p><a id="query"></a></p>
+<h3 id="query">Query</h3>
+<h4 id="extended-by-3">Extended by</h4>
+<ul>
+<li><a href="#collectionreference"><code>CollectionReference</code></a></li>
+</ul>
+<h4 id="methods-8">Methods</h4>
+<p><a id="aggregate-2"></a></p>
+<h5 id="aggregate-1">aggregate()</h5>
+<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:#61AFEF">aggregate</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">spec</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AggregateSpec</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AggregateQuerySnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Compute one or more aggregates over the documents matching this
+query. Mirrors the Admin SDK’s <code>query.aggregate({ … }).get()</code>
+pattern, collapsed into one call for the simulator (no need to
+build an <code>AggregateQuery</code> reference type when there’s no remote
+dispatch).</p>
+<p>Each entry in <code>spec</code> is keyed by a caller-chosen alias and
+resolves to an <code>AggregateField</code>. The returned snapshot exposes
+the computed numbers under the same aliases via <code>.data()</code>.</p>
+<p>Where / orderBy clauses ARE applied before aggregation (they
+narrow the candidate doc set). <code>limit</code> is honored — the aggregate
+computes against the limited set, matching production semantics.</p>
+<h6 id="parameters-24">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>spec</code></td><td align="left"><a href="#aggregatespec"><code>AggregateSpec</code></a></td></tr></tbody></table></div>
+<h6 id="returns-30">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#aggregatequerysnapshot"><code>AggregateQuerySnapshot</code></a>></p>
+<p><a id="applyfilter-2"></a></p>
+<h5 id="applyfilter-1">applyFilter()</h5>
+<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:#61AFEF">applyFilter</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">filter</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">Filter</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Add a composite filter (leaf, AND, or OR) to the query’s filter
+stack. Each <code>applyFilter</code> call AND-s with whatever filters are
+already on the query — same implicit-AND semantics as multiple
+<code>where()</code> calls. To OR multiple predicates, wrap them with
+<code>{ kind: 'or', filters: [...] }</code> before calling. Backs the
+modular <code>or()</code> / <code>and()</code> constraints in <code>pyric/firestore</code>.</p>
+<h6 id="parameters-25">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>filter</code></td><td align="left"><a href="#filter"><code>Filter</code></a></td></tr></tbody></table></div>
+<h6 id="returns-31">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="endcursor-2"></a></p>
+<h5 id="endcursor-1">endCursor()</h5>
+<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:#61AFEF">endCursor</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">values</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">[], </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Set the end position of the query relative to the orderBy fields.
+<code>inclusive</code> controls <code>endAt</code> (true) vs <code>endBefore</code> (false).</p>
+<h6 id="parameters-26">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>values</code></td><td align="left"><code>unknown</code>[]</td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-32">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="endcursorfromsnapshot-2"></a></p>
+<h5 id="endcursorfromsnapshot-1">endCursorFromSnapshot()</h5>
+<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:#61AFEF">endCursorFromSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Snapshot-based variant of <a href="#endcursor-2">endCursor</a>.</p>
+<h6 id="parameters-27">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>snapshot</code></td><td align="left"><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a></td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-33">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="get-6"></a></p>
+<h5 id="get-3">get()</h5>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AdminQuerySnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-28">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-34">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#adminquerysnapshot"><code>AdminQuerySnapshot</code></a>></p>
+<p><a id="limit-2"></a></p>
+<h5 id="limit-1">limit()</h5>
+<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:#61AFEF">limit</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">n</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">number</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-29">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h6 id="returns-35">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="limittolast-2"></a></p>
+<h5 id="limittolast-1">limitToLast()</h5>
+<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:#61AFEF">limitToLast</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">n</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">number</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Limit from the END of the ordered result. Equivalent to reversing
+the orderBy, taking <code>n</code>, then re-reversing — the simulator
+implements it that way. Requires at least one <code>orderBy</code> clause on
+the query (matches the JS SDK’s runtime contract).</p>
+<h6 id="parameters-30">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h6 id="returns-36">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="orderby-2"></a></p>
+<h5 id="orderby-1">orderBy()</h5>
+<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:#61AFEF">orderBy</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">field</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">direction</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OrderDirection</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-31">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>direction?</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#orderdirection"><code>OrderDirection</code></a></td></tr></tbody></table></div>
+<h6 id="returns-37">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="startcursor-2"></a></p>
+<h5 id="startcursor-1">startCursor()</h5>
+<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:#61AFEF">startCursor</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">values</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">[], </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Set the start position of the query relative to the orderBy
+fields. <code>values</code> corresponds 1:1 with the orderBy clauses on the
+query (one value per clause); <code>inclusive</code> controls <code>startAt</code> (true)
+vs <code>startAfter</code> (false). Repeated calls replace the previous
+cursor — matches production.</p>
+<h6 id="parameters-32">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>values</code></td><td align="left"><code>unknown</code>[]</td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-38">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="startcursorfromsnapshot-2"></a></p>
+<h5 id="startcursorfromsnapshot-1">startCursorFromSnapshot()</h5>
+<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:#61AFEF">startCursorFromSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">inclusive</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Variant of <a href="#startcursor-2">startCursor</a> that takes a <code>DocumentSnapshot</code>
+and extracts the cursor values from the snapshot’s data at each
+orderBy field. Mirrors the JS SDK’s <code>startAt(snapshot)</code> overload
+and shines for cursor-based pagination (“hand me the next page
+after this one”). Requires at least one <code>orderBy</code> clause —
+thrown at call time, not at get-time, so the failure surfaces
+close to the bug.</p>
+<h6 id="parameters-33">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>snapshot</code></td><td align="left"><a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a></td></tr><tr><td align="left"><code>inclusive</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<h6 id="returns-39">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<p><a id="where-2"></a></p>
+<h5 id="where-1">where()</h5>
+<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:#61AFEF">where</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75">   field</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75">   op</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">WhereFilterOp</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75">   value</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-34">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>op</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#wherefilterop"><code>WhereFilterOp</code></a></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
+<h6 id="returns-40">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<hr>
+<p><a id="querydocumentsnapshot"></a></p>
+<h3 id="querydocumentsnapshot">QueryDocumentSnapshot</h3>
+<p>Production narrows <code>data()</code> to non-undefined here. We follow suit so
+that agent code calling <code>snap.data().foo</code> doesn’t need a guard for
+the items inside a <code>QuerySnapshot.docs</code> array.</p>
+<h4 id="extends-2">Extends</h4>
+<ul>
+<li><a href="#documentsnapshot"><code>DocumentSnapshot</code></a></li>
+</ul>
+<h4 id="properties-9">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="id-5"></a> <code>id</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="metadata-1"></a> <code>metadata</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#snapshotmetadata"><code>SnapshotMetadata</code></a></td></tr><tr><td align="left"><a id="ref-3"></a> <code>ref</code></td><td align="left"><code>readonly</code></td><td align="left"><code>SnapshotDocRef</code></td></tr></tbody></table></div>
+<h4 id="methods-9">Methods</h4>
+<p><a id="data-8"></a></p>
+<h5 id="data-4">data()</h5>
+<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:#61AFEF">data</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-41">Returns</h6>
+<p><code>DocumentData</code></p>
+<h6 id="overrides-1">Overrides</h6>
+<p><a href="#documentsnapshot"><code>DocumentSnapshot</code></a>.<a href="#data-6"><code>data</code></a></p>
+<p><a id="exists-4"></a></p>
+<h5 id="exists-1">exists()</h5>
+<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:#61AFEF">exists</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-42">Returns</h6>
+<p><code>boolean</code></p>
+<h6 id="inherited-from-11">Inherited from</h6>
+<p><a href="#documentsnapshot"><code>DocumentSnapshot</code></a>.<a href="#exists-2"><code>exists</code></a></p>
+<p><a id="get-8"></a></p>
+<h5 id="get-4">get()</h5>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">fieldPath</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">unknown</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Field accessor mirroring <code>firebase/firestore</code>’s <code>DocumentSnapshot.get(fieldPath)</code>.
+Dotted paths supported. Missing intermediate keys yield <code>undefined</code>
+— production behavior; agents commonly chain optional reads.</p>
+<h6 id="parameters-35">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>fieldPath</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-43">Returns</h6>
+<p><code>unknown</code></p>
+<h6 id="inherited-from-12">Inherited from</h6>
+<p><a href="#documentsnapshot"><code>DocumentSnapshot</code></a>.<a href="#get-4"><code>get</code></a></p>
+<hr>
+<p><a id="querysnapshot"></a></p>
+<h3 id="querysnapshot">QuerySnapshot</h3>
+<h4 id="properties-10">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="docs-1"></a> <code>docs</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#querydocumentsnapshot"><code>QueryDocumentSnapshot</code></a>[]</td></tr><tr><td align="left"><a id="empty-1"></a> <code>empty</code></td><td align="left"><code>readonly</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><a id="metadata-2"></a> <code>metadata</code></td><td align="left"><code>readonly</code></td><td align="left"><a href="#snapshotmetadata"><code>SnapshotMetadata</code></a></td></tr><tr><td align="left"><a id="query-1"></a> <code>query</code></td><td align="left"><code>readonly</code></td><td align="left"><code>SnapshotQueryRef</code></td></tr><tr><td align="left"><a id="size-1"></a> <code>size</code></td><td align="left"><code>readonly</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<h4 id="methods-10">Methods</h4>
+<p><a id="docchanges"></a></p>
+<h5 id="docchanges">docChanges()</h5>
+<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:#61AFEF">docChanges</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">options</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> DocChangesOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">DocumentChange</span><span style="color:#ABB2BF">[];</span></span></code></pre>
+<p>Per findings section 4: cached by <code>includeMetadataChanges</code> value; throws if
+called with <code>true</code> when the listener did not subscribe with
+<code>includeMetadataChanges: true</code>. The Slice 2 implementation produces
+“all docs added” on the first fire — Slice 3 supplies real diffs.</p>
+<h6 id="parameters-36">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options?</code></td><td align="left"><a href="#docchangesoptions"><code>DocChangesOptions</code></a></td></tr></tbody></table></div>
+<h6 id="returns-44">Returns</h6>
+<p><a href="#documentchange"><code>DocumentChange</code></a>[]</p>
+<p><a id="foreach-2"></a></p>
+<h5 id="foreach-1">forEach()</h5>
+<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:#61AFEF">forEach</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">callback</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snap</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">QueryDocumentSnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#C678DD"> void</span><span style="color:#ABB2BF">): </span><span style="color:#C678DD">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-37">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>callback</code></td><td align="left">(<code>snap</code>: <a href="#querydocumentsnapshot"><code>QueryDocumentSnapshot</code></a>) => <code>void</code></td></tr></tbody></table></div>
+<h6 id="returns-45">Returns</h6>
+<p><code>void</code></p>
+<hr>
+<p><a id="rulesmetrics"></a></p>
+<h3 id="rulesmetrics">RulesMetrics</h3>
+<h4 id="properties-11">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="allowrulecount"></a> <code>allowRuleCount</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="functioncount"></a> <code>functionCount</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="getcallcount"></a> <code>getCallCount</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="maxcalldepth"></a> <code>maxCallDepth</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="maxchaindepth"></a> <code>maxChainDepth</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="maxchainop"></a> <code>maxChainOp</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="maxestimatedexpressions"></a> <code>maxEstimatedExpressions</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="maxletbindings"></a> <code>maxLetBindings</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><a id="maxletbindingsfunction"></a> <code>maxLetBindingsFunction</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="sourcesize"></a> <code>sourceSize</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="sandboxfirestore"></a></p>
+<h3 id="sandboxfirestore">SandboxFirestore</h3>
+<p>Sandbox-extended Firestore handle. Adds three sandbox-only methods
+on top of the production-shaped <a href="#firestore">Firestore</a> surface:</p>
+<ul>
+<li><a href="#setrules">SandboxFirestore.setRules</a> — replace the active ruleset
+for subsequent operations.</li>
+<li><a href="#seed">SandboxFirestore.seed</a> — replace stored documents with a
+fresh seed map (rules are preserved).</li>
+<li><a href="#snapshot">SandboxFirestore.snapshot</a> — capture all stored documents
+as a path-keyed map.</li>
+</ul>
+<p>These have no production analog. They use sandbox vocabulary
+(<code>setRules</code>, <code>seed</code>, <code>snapshot</code>) deliberately so a reader can’t
+confuse them with Firebase deployment semantics.</p>
+<h4 id="extends-3">Extends</h4>
+<ul>
+<li><a href="#firestore"><code>Firestore</code></a></li>
+</ul>
+<h4 id="methods-11">Methods</h4>
+<p><a id="batch-2"></a></p>
+<h5 id="batch-1">batch()</h5>
+<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:#61AFEF">batch</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">WriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="returns-46">Returns</h6>
+<p><a href="#writebatch"><code>WriteBatch</code></a></p>
+<h6 id="inherited-from-13">Inherited from</h6>
+<p><a href="#firestore"><code>Firestore</code></a>.<a href="#batch"><code>batch</code></a></p>
+<p><a id="collection-4"></a></p>
+<h5 id="collection-2">collection()</h5>
+<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:#61AFEF">collection</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">path</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">CollectionReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-38">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>path</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-47">Returns</h6>
+<p><a href="#collectionreference"><code>CollectionReference</code></a></p>
+<h6 id="inherited-from-14">Inherited from</h6>
+<p><a href="#firestore"><code>Firestore</code></a>.<a href="#collection-2"><code>collection</code></a></p>
+<p><a id="collectiongroup-2"></a></p>
+<h5 id="collectiongroup-1">collectionGroup()</h5>
+<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:#61AFEF">collectionGroup</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">collectionId</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Cross-collection query — returns a <code>Query</code> that scans every
+document under every collection whose final segment matches
+<code>collectionId</code>, regardless of position in the path. Matches the
+Admin SDK’s <code>Firestore.collectionGroup(id)</code> shape.</p>
+<p>The returned <code>Query</code> accepts <code>where</code> / <code>orderBy</code> / <code>limit</code> like
+any other; the simulator gathers all candidate docs first, then
+applies the constraints in-memory.</p>
+<h6 id="parameters-39">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>collectionId</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-48">Returns</h6>
+<p><a href="#query"><code>Query</code></a></p>
+<h6 id="inherited-from-15">Inherited from</h6>
+<p><a href="#firestore"><code>Firestore</code></a>.<a href="#collectiongroup"><code>collectionGroup</code></a></p>
+<p><a id="doc-5"></a></p>
+<h5 id="doc-2">doc()</h5>
+<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:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">path</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-40">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>path</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-49">Returns</h6>
+<p><a href="#documentreference"><code>DocumentReference</code></a></p>
+<h6 id="inherited-from-16">Inherited from</h6>
+<p><a href="#firestore"><code>Firestore</code></a>.<a href="#doc-3"><code>doc</code></a></p>
+<p><a id="runtransaction-2"></a></p>
+<h5 id="runtransaction-1">runTransaction()</h5>
+<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:#61AFEF">runTransaction</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#ABB2BF">>(</span><span style="color:#E06C75">fn</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">tx</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Transaction</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> R</span><span style="color:#56B6C2"> |</span><span style="color:#E5C07B"> Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E5C07B">R</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="type-parameters-1">Type Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Type Parameter</th></tr></thead><tbody><tr><td align="left"><code>R</code></td></tr></tbody></table></div>
+<h6 id="parameters-41">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>fn</code></td><td align="left">(<code>tx</code>: <a href="#transaction"><code>Transaction</code></a>) => <code>R</code> | <code>Promise</code>&#x3C;<code>R</code>></td></tr><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-50">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>R</code>></p>
+<h6 id="inherited-from-17">Inherited from</h6>
+<p><a href="#firestore"><code>Firestore</code></a>.<a href="#runtransaction"><code>runTransaction</code></a></p>
+<p><a id="seed"></a></p>
+<h5 id="seed">seed()</h5>
+<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:#61AFEF">seed</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">options</span><span style="color:#C678DD">?:</span><span style="color:#ABB2BF"> {</span></span>
+<span class="line"><span style="color:#ABB2BF">  documents?: </span><span style="color:#E06C75">Record</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, DocumentData>;</span></span>
+<span class="line"><span style="color:#ABB2BF">}): </span><span style="color:#E06C75">LintResult</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Replace stored documents with a new seed map. Active rules are
+preserved. Pass an empty <code>documents</code> map (or omit it) to clear
+state without touching rules.</p>
+<h6 id="parameters-42">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options?</code></td><td align="left">{ <code>documents?</code>: <code>Record</code>&#x3C;<code>string</code>, <a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a>>; }</td></tr><tr><td align="left"><code>options.documents?</code></td><td align="left"><code>Record</code>&#x3C;<code>string</code>, <a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a>></td></tr></tbody></table></div>
+<h6 id="returns-51">Returns</h6>
+<p><a href="/docs/pyric-firestore-reference-api/#lintresult"><code>LintResult</code></a></p>
+<p><a id="setrules"></a></p>
+<h5 id="setrules">setRules()</h5>
+<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:#61AFEF">setRules</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">rules</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">LintResult</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Replace the active ruleset. Returns the lint result so callers can
+surface warnings; if the source has parse-level errors, the rules
+are not swapped (consistent with <code>LocalEnvironment.deployRules</code>).</p>
+<h6 id="parameters-43">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>rules</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h6 id="returns-52">Returns</h6>
+<p><a href="/docs/pyric-firestore-reference-api/#lintresult"><code>LintResult</code></a></p>
+<p><a id="snapshot"></a></p>
+<h5 id="snapshot">snapshot()</h5>
+<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:#61AFEF">snapshot</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">Record</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">DocumentData</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Capture every stored document as a <code>{ [path]: data }</code> map. Reads
+from the live state and is independent of rules.</p>
+<h6 id="returns-53">Returns</h6>
+<p><code>Record</code>&#x3C;<code>string</code>, <a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a>></p>
+<hr>
+<p><a id="setoptions"></a></p>
+<h3 id="setoptions">SetOptions</h3>
+<p>Options for <code>DocumentReference.set</code>. Mirrors the modular Web-SDK’s
+<code>SetOptions</code> shape with pyric’s <code>auth</code> per-op override layered on.</p>
+<ul>
+<li>default (neither flag set) → REPLACE the existing document
+entirely. Firestore default for <code>set()</code>.</li>
+<li><code>{ merge: true }</code> → shallow-merge every top-level field in
+<code>data</code> into the existing document. Fields not in <code>data</code> are
+preserved. Rule eval still runs the <code>update</code> clause when the
+doc exists.</li>
+<li><code>{ mergeFields: [...] }</code> → project <code>data</code> down to just the
+listed top-level fields, then merge. Other fields in <code>data</code> are
+ignored; other fields in the existing doc are preserved.</li>
+</ul>
+<p><code>merge</code> and <code>mergeFields</code> are mutually exclusive at the JS-SDK
+level. We don’t currently enforce the constraint — if both are
+provided, <code>mergeFields</code> wins (matches the JS SDK’s effective
+behavior).</p>
+<h4 id="extends-4">Extends</h4>
+<ul>
+<li><code>OperationOptions</code></li>
+</ul>
+<h4 id="properties-12">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="auth"></a> <code>auth?</code></td><td align="left">{ <code>token?</code>: <code>Record</code>&#x3C;<code>string</code>, <code>unknown</code>>; <code>uid</code>: <code>string</code>; }</td></tr><tr><td align="left"><code>auth.token?</code></td><td align="left"><code>Record</code>&#x3C;<code>string</code>, <code>unknown</code>></td></tr><tr><td align="left"><code>auth.uid</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="merge"></a> <code>merge?</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><a id="mergefields"></a> <code>mergeFields?</code></td><td align="left">readonly <code>string</code>[]</td></tr></tbody></table></div>
+<hr>
+<p><a id="snapshotmetadata"></a></p>
+<h3 id="snapshotmetadata">SnapshotMetadata</h3>
+<p>Mirrors <code>firebase/firestore</code>’s <code>SnapshotMetadata</code>. <code>fromCache</code> is always
+<code>false</code> (the sandbox has no offline cache). <code>hasPendingWrites</code> transitions
+(item 3): a local write’s optimistic echo carries <code>true</code>, and the server
+ack carries <code>false</code> — so <code>includeMetadataChanges</code> has an observable effect
+matching prod (COMPAT firestore#85).</p>
+<h4 id="properties-13">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="fromcache"></a> <code>fromCache</code></td><td align="left"><code>readonly</code></td><td align="left"><code>false</code></td></tr><tr><td align="left"><a id="haspendingwrites"></a> <code>hasPendingWrites</code></td><td align="left"><code>readonly</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="snapshotobserver"></a></p>
+<h3 id="snapshotobserver">SnapshotObserver</h3>
+<p>Observer form accepted by <code>onSnapshot</code>. Mirrors <code>firebase/firestore</code>’s
+<code>PartialObserver&#x3C;T></code> shape — any subset of the three handlers. <code>complete</code>
+is accepted for shape parity but never fires in the sandbox: the local
+listener stream has no terminal state.</p>
+<h4 id="type-parameters-2">Type Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Type Parameter</th></tr></thead><tbody><tr><td align="left"><code>T</code></td></tr></tbody></table></div>
+<h4 id="properties-14">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="complete"></a> <code>complete?</code></td><td align="left">() => <code>void</code></td></tr><tr><td align="left"><a id="error"></a> <code>error?</code></td><td align="left">(<code>error</code>: <code>unknown</code>) => <code>void</code></td></tr><tr><td align="left"><a id="next"></a> <code>next?</code></td><td align="left">(<code>snapshot</code>: <code>T</code>) => <code>void</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="transaction"></a></p>
+<h3 id="transaction">Transaction</h3>
+<h4 id="methods-12">Methods</h4>
+<p><a id="delete-2"></a></p>
+<h5 id="delete-1">delete()</h5>
+<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">delete</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Transaction</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-44">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr></tbody></table></div>
+<h6 id="returns-54">Returns</h6>
+<p><a href="#transaction"><code>Transaction</code></a></p>
+<p><a id="get-10"></a></p>
+<h5 id="get-5">get()</h5>
+<h6 id="call-signature">Call Signature</h6>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AdminDocumentSnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-45">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr></tbody></table></div>
+<h6 id="returns-55">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#admindocumentsnapshot"><code>AdminDocumentSnapshot</code></a>></p>
+<h6 id="call-signature-1">Call Signature</h6>
+<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:#61AFEF">get</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">query</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">Query</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">AdminQuerySnapshot</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-46">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>query</code></td><td align="left"><a href="#query"><code>Query</code></a></td></tr></tbody></table></div>
+<h6 id="returns-56">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#adminquerysnapshot"><code>AdminQuerySnapshot</code></a>></p>
+<p><a id="set-2"></a></p>
+<h5 id="set-1">set()</h5>
+<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:#61AFEF">set</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Transaction</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-47">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr></tbody></table></div>
+<h6 id="returns-57">Returns</h6>
+<p><a href="#transaction"><code>Transaction</code></a></p>
+<p><a id="update-2"></a></p>
+<h5 id="update-1">update()</h5>
+<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:#61AFEF">update</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">Transaction</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-48">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr></tbody></table></div>
+<h6 id="returns-58">Returns</h6>
+<p><a href="#transaction"><code>Transaction</code></a></p>
+<hr>
+<p><a id="writebatch"></a></p>
+<h3 id="writebatch">WriteBatch</h3>
+<h4 id="methods-13">Methods</h4>
+<p><a id="commit"></a></p>
+<h5 id="commit">commit()</h5>
+<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:#61AFEF">commit</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">opts</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> OperationOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-49">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts?</code></td><td align="left"><code>OperationOptions</code></td></tr></tbody></table></div>
+<h6 id="returns-59">Returns</h6>
+<p><code>Promise</code>&#x3C;<code>void</code>></p>
+<p><a id="delete-4"></a></p>
+<h5 id="delete-2">delete()</h5>
+<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">delete</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">WriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-50">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr></tbody></table></div>
+<h6 id="returns-60">Returns</h6>
+<p><a href="#writebatch"><code>WriteBatch</code></a></p>
+<p><a id="set-4"></a></p>
+<h5 id="set-2">set()</h5>
+<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:#61AFEF">set</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">WriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-51">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr></tbody></table></div>
+<h6 id="returns-61">Returns</h6>
+<p><a href="#writebatch"><code>WriteBatch</code></a></p>
+<p><a id="update-4"></a></p>
+<h5 id="update-2">update()</h5>
+<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:#61AFEF">update</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">data</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DocumentData</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">WriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h6 id="parameters-52">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#documentdata"><code>DocumentData</code></a></td></tr></tbody></table></div>
+<h6 id="returns-62">Returns</h6>
+<p><a href="#writebatch"><code>WriteBatch</code></a></p>
+<h2 id="type-aliases">Type Aliases</h2>
+<p><a id="aggregatefield"></a></p>
+<h3 id="aggregatefield">AggregateField</h3>
+<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>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"count"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">}</span></span>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  field</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"sum"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">}</span></span>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  field</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"average"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">};</span></span></code></pre>
+<p>Single aggregate definition. Field is required for sum / average,
+forbidden for count (no field has any meaning when you’re
+counting rows). Encoded as discriminated union so type errors
+surface at the call site, not at runtime.</p>
+<hr>
+<p><a id="aggregatespec"></a></p>
+<h3 id="aggregatespec">AggregateSpec</h3>
+<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"> Record</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">, </span><span style="color:#E5C07B">AggregateField</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Spec passed to <code>Query.aggregate(...)</code>. Aliases become the keys in
+the returned snapshot’s <code>.data()</code> object.</p>
+<hr>
+<p><a id="documentchangetype-1"></a></p>
+<h3 id="documentchangetype">DocumentChangeType</h3>
+<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"> DocumentChangeType</span><span style="color:#56B6C2"> =</span><span style="color:#98C379"> "added"</span><span style="color:#ABB2BF"> | </span><span style="color:#98C379">"modified"</span><span style="color:#ABB2BF"> | </span><span style="color:#98C379">"removed"</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<hr>
+<p><a id="filter"></a></p>
+<h3 id="filter">Filter</h3>
+<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"> Filter</span><span style="color:#56B6C2"> =</span></span>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  field</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"where"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  op</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">WhereFilterOp</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  value</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">}</span></span>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  filters</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Filter</span><span style="color:#ABB2BF">[];</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"and"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">}</span></span>
+<span class="line"><span style="color:#ABB2BF">  | {</span></span>
+<span class="line"><span style="color:#E06C75">  filters</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Filter</span><span style="color:#ABB2BF">[];</span></span>
+<span class="line"><span style="color:#E06C75">  kind</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"or"</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">};</span></span></code></pre>
+<p>Composite filter tree for <code>Query.applyFilter</code>. Recursive — <code>and</code> /
+<code>or</code> carry their own <code>filters</code> array of nested <code>Filter</code>s; the
+leaves are field/op/value triples (<code>kind: 'where'</code>).</p>
+<p>Mirrors <code>firebase/firestore</code>’s <code>QueryFilterConstraint</code> shape, just
+as a tagged-union value type (the SDK’s classes carry an <code>_op</code>
+field; ours is the <code>kind</code> discriminant).</p>
+<hr>
+<p><a id="snapshotlistenoptions"></a></p>
+<h3 id="snapshotlistenoptions">SnapshotListenOptions</h3>
+<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"> SnapshotListenOptions</span><span style="color:#56B6C2"> =</span><span style="color:#E5C07B"> SnapshotListenerOptions</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Mirrors <code>firebase/firestore</code>’s <code>SnapshotListenOptions</code>. The
+<code>includeMetadataChanges</code> flag is accepted for API parity but has no
+observable effect in the sandbox: there’s no offline cache and no
+pending-writes window, so <code>metadata.fromCache</code> and
+<code>metadata.hasPendingWrites</code> are always <code>false</code> (snapshot-listeners.ts section 6).</p>
+<hr>
+<p><a id="unsubscribe"></a></p>
+<h3 id="unsubscribe">Unsubscribe()</h3>
+<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"> Unsubscribe</span><span style="color:#56B6C2"> =</span><span style="color:#ABB2BF"> () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Returned from <code>onSnapshot</code>. Calling it deregisters the listener and
+stops further callback invocations. Idempotent.</p>
+<h4 id="returns-63">Returns</h4>
+<p><code>void</code></p>
 <h2 id="functions">Functions</h2>
+<p><a id="getadminfirestore"></a></p>
+<h3 id="getadminfirestore">getAdminFirestore()</h3>
+<h4 id="call-signature-2">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> getAdminFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">ctx</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SandboxContext</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">SandboxFirestore</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Resolve a <strong>rules-bypassing</strong> Firestore handle for a context — the
+Pyric Studio admin lens (Gap #2). Same chainable <code>SandboxFirestore</code>
+surface as <code>getFirestore</code>, but every operation it issues (reads,
+writes, queries, batches, transactions) SKIPS security-rule evaluation
+and is treated as ALLOW. This is the modular/chainable-shaped sibling of
+the path-string <code>sandbox.admin.*</code> bypass — it reuses the exact same
+<code>LocalEnvironment</code> bypass execution path (<code>bypassRules</code> on the op),
+rather than reimplementing it.</p>
+<p>Storage preconditions still apply (a <code>create</code> on an existing doc still
+fails <code>already-exists</code>, matching real Firestore admin), and the same
+<code>request</code>/<code>write</code> events fire + listeners wake, so the change shows up
+live and on the traffic log (stamped as an admin-bypass read/write).</p>
+<p>Use for “edit anything as admin” surfaces (Studio F2). For rules-applied
+impersonation (“act as this user”), use <code>getFirestore(sandbox.withAuth({ uid }))</code> instead — that path is unchanged.</p>
+<h5 id="parameters-53">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ctx</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#sandboxcontext"><code>SandboxContext</code></a></td></tr></tbody></table></div>
+<h5 id="returns-64">Returns</h5>
+<p><a href="#sandboxfirestore"><code>SandboxFirestore</code></a></p>
+<h5 id="example">Example</h5>
+<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">import</span><span style="color:#ABB2BF"> { </span><span style="color:#E06C75">initializeSandbox</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric/sandbox'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#C678DD">import</span><span style="color:#ABB2BF"> { </span><span style="color:#E06C75">getFirestore</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">getAdminFirestore</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric-admin/firestore'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> sandbox</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> initializeSandbox</span><span style="color:#ABB2BF">();</span></span>
+<span class="line"><span style="color:#61AFEF">getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E5C07B">sandbox</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">withAuth</span><span style="color:#ABB2BF">(</span><span style="color:#D19A66">null</span><span style="color:#ABB2BF">)).</span><span style="color:#61AFEF">setRules</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'...deny everything...'</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#7F848E;font-style:italic">// Denied under rules:</span></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E5C07B">sandbox</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">withAuth</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">uid</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'alice'</span><span style="color:#ABB2BF"> }))</span></span>
+<span class="line"><span style="color:#ABB2BF">  .</span><span style="color:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'locked/x'</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">set</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">a</span><span style="color:#ABB2BF">: </span><span style="color:#D19A66">1</span><span style="color:#ABB2BF"> }); </span><span style="color:#7F848E;font-style:italic">// throws permission-denied</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#7F848E;font-style:italic">// Bypasses rules:</span></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> getAdminFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">sandbox</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'locked/x'</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">set</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">a</span><span style="color:#ABB2BF">: </span><span style="color:#D19A66">1</span><span style="color:#ABB2BF"> }); </span><span style="color:#7F848E;font-style:italic">// ok</span></span></code></pre>
+<h4 id="call-signature-3">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> getAdminFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">sandbox</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Sandbox</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">SandboxFirestore</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Resolve a <strong>rules-bypassing</strong> Firestore handle for a context — the
+Pyric Studio admin lens (Gap #2). Same chainable <code>SandboxFirestore</code>
+surface as <code>getFirestore</code>, but every operation it issues (reads,
+writes, queries, batches, transactions) SKIPS security-rule evaluation
+and is treated as ALLOW. This is the modular/chainable-shaped sibling of
+the path-string <code>sandbox.admin.*</code> bypass — it reuses the exact same
+<code>LocalEnvironment</code> bypass execution path (<code>bypassRules</code> on the op),
+rather than reimplementing it.</p>
+<p>Storage preconditions still apply (a <code>create</code> on an existing doc still
+fails <code>already-exists</code>, matching real Firestore admin), and the same
+<code>request</code>/<code>write</code> events fire + listeners wake, so the change shows up
+live and on the traffic log (stamped as an admin-bypass read/write).</p>
+<p>Use for “edit anything as admin” surfaces (Studio F2). For rules-applied
+impersonation (“act as this user”), use <code>getFirestore(sandbox.withAuth({ uid }))</code> instead — that path is unchanged.</p>
+<h5 id="parameters-54">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>sandbox</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#sandbox"><code>Sandbox</code></a></td></tr></tbody></table></div>
+<h5 id="returns-65">Returns</h5>
+<p><a href="#sandboxfirestore"><code>SandboxFirestore</code></a></p>
+<h5 id="example-1">Example</h5>
+<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">import</span><span style="color:#ABB2BF"> { </span><span style="color:#E06C75">initializeSandbox</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric/sandbox'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#C678DD">import</span><span style="color:#ABB2BF"> { </span><span style="color:#E06C75">getFirestore</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">getAdminFirestore</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric-admin/firestore'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> sandbox</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> initializeSandbox</span><span style="color:#ABB2BF">();</span></span>
+<span class="line"><span style="color:#61AFEF">getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E5C07B">sandbox</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">withAuth</span><span style="color:#ABB2BF">(</span><span style="color:#D19A66">null</span><span style="color:#ABB2BF">)).</span><span style="color:#61AFEF">setRules</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'...deny everything...'</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#7F848E;font-style:italic">// Denied under rules:</span></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E5C07B">sandbox</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">withAuth</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">uid</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'alice'</span><span style="color:#ABB2BF"> }))</span></span>
+<span class="line"><span style="color:#ABB2BF">  .</span><span style="color:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'locked/x'</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">set</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">a</span><span style="color:#ABB2BF">: </span><span style="color:#D19A66">1</span><span style="color:#ABB2BF"> }); </span><span style="color:#7F848E;font-style:italic">// throws permission-denied</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#7F848E;font-style:italic">// Bypasses rules:</span></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> getAdminFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">sandbox</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#98C379">'locked/x'</span><span style="color:#ABB2BF">).</span><span style="color:#61AFEF">set</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">a</span><span style="color:#ABB2BF">: </span><span style="color:#D19A66">1</span><span style="color:#ABB2BF"> }); </span><span style="color:#7F848E;font-style:italic">// ok</span></span></code></pre>
+<hr>
 <p><a id="getfirestore"></a></p>
 <h3 id="getfirestore">getFirestore()</h3>
-<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">function</span><span style="color:#61AFEF"> getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">target</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">any</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">SandboxFirestore</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<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">function</span><span style="color:#61AFEF"> getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">target</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">:</span></span>
+<span class="line"><span style="color:#ABB2BF">  | </span><span style="color:#E5C07B">SandboxAdminApp</span></span>
+<span class="line"><span style="color:#ABB2BF">  | </span><span style="color:#E5C07B">SandboxContext</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">SandboxFirestore</span><span style="color:#ABB2BF">;</span></span></code></pre>
 <p>Return the admin Firestore handle.</p>
 <ul>
-<li><code>getFirestore(ctx)</code> — the original context form (rules-applied for the
-ctx’s captured identity). Unchanged; idempotent per <code>SandboxContext</code>.</li>
-<li><code>getFirestore(app)</code> — resolves a PyricAdminApp’s sandbox.</li>
-<li><code>getFirestore()</code> — resolves the default app; throws <code>app/no-app</code> when
-nothing is initialized.</li>
+<li><code>getFirestore(ctx)</code> — the original context form (rules-APPLIED for the
+ctx’s captured identity). Unchanged; idempotent per <code>SandboxContext</code>.
+This is the pyric-internal rules-simulation shape, not a firebase-admin
+shape, so it keeps rule evaluation.</li>
+<li><code>getFirestore(app)</code> — resolves a <a href="/docs/pyric-admin-app-reference-api/#pyricadminapp">PyricAdminApp</a>’s sandbox to the
+rules-BYPASS admin lens (firebase-admin parity, #394).</li>
+<li><code>getFirestore()</code> — resolves the default app to the rules-BYPASS admin
+lens; throws <code>app/no-app</code> when nothing is initialized.</li>
 </ul>
-<h4 id="parameters">Parameters</h4>
+<p>The app forms mirror <code>firebase-admin/firestore</code>’s <code>getFirestore(app?)</code>,
+which bypasses security rules — so a Cloud Function’s admin write lands the
+same way it does in production, instead of being denied as <code>request.auth == null</code> by the sandbox’s anon lens (the #394 deny-direction divergence).</p>
+<h4 id="parameters-55">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target?</code></td><td align="left">| <a href="/docs/pyric-admin-app-reference-api/#sandboxadminapp"><code>SandboxAdminApp</code></a> | <a href="/docs/pyric-firestore-reference-api/#sandboxcontext"><code>SandboxContext</code></a></td></tr></tbody></table></div>
+<h4 id="returns-66">Returns</h4>
+<p><a href="#sandboxfirestore"><code>SandboxFirestore</code></a></p>
+<hr>
+<p><a id="onsnapshot"></a></p>
+<h3 id="onsnapshot">onSnapshot()</h3>
+<h4 id="call-signature-4">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">observer</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotObserver</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">DocumentSnapshot</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-56">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>observer</code></td><td align="left"><a href="#snapshotobserver"><code>SnapshotObserver</code></a>&#x3C;<a href="#documentsnapshot"><code>DocumentSnapshot</code></a>></td></tr></tbody></table></div>
+<h5 id="returns-67">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-5">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   options</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotListenerOptions</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   observer</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotObserver</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">DocumentSnapshot</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-57">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>options</code></td><td align="left"><code>SnapshotListenerOptions</code></td></tr><tr><td align="left"><code>observer</code></td><td align="left"><a href="#snapshotobserver"><code>SnapshotObserver</code></a>&#x3C;<a href="#documentsnapshot"><code>DocumentSnapshot</code></a>></td></tr></tbody></table></div>
+<h5 id="returns-68">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-6">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onNext</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentSnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onError</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">error</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onCompletion</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-58">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>onNext</code></td><td align="left">(<code>snapshot</code>: <a href="#documentsnapshot"><code>DocumentSnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>onError?</code></td><td align="left">(<code>error</code>: <code>unknown</code>) => <code>void</code></td></tr><tr><td align="left"><code>onCompletion?</code></td><td align="left">() => <code>void</code></td></tr></tbody></table></div>
+<h5 id="returns-69">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-7">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   options</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotListenerOptions</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onNext</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocumentSnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onError</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">error</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onCompletion</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-59">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#documentreference"><code>DocumentReference</code></a></td></tr><tr><td align="left"><code>options</code></td><td align="left"><code>SnapshotListenerOptions</code></td></tr><tr><td align="left"><code>onNext</code></td><td align="left">(<code>snapshot</code>: <a href="#documentsnapshot"><code>DocumentSnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>onError?</code></td><td align="left">(<code>error</code>: <code>unknown</code>) => <code>void</code></td></tr><tr><td align="left"><code>onCompletion?</code></td><td align="left">() => <code>void</code></td></tr></tbody></table></div>
+<h5 id="returns-70">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-8">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Query</span><span style="color:#ABB2BF"> | </span><span style="color:#E5C07B">CollectionReference</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">observer</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotObserver</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">QuerySnapshot</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-60">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#query"><code>Query</code></a> | <a href="#collectionreference"><code>CollectionReference</code></a></td></tr><tr><td align="left"><code>observer</code></td><td align="left"><a href="#snapshotobserver"><code>SnapshotObserver</code></a>&#x3C;<a href="#querysnapshot"><code>QuerySnapshot</code></a>></td></tr></tbody></table></div>
+<h5 id="returns-71">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-9">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Query</span><span style="color:#ABB2BF"> | </span><span style="color:#E5C07B">CollectionReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   options</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotListenerOptions</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   observer</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotObserver</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">QuerySnapshot</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-61">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#query"><code>Query</code></a> | <a href="#collectionreference"><code>CollectionReference</code></a></td></tr><tr><td align="left"><code>options</code></td><td align="left"><code>SnapshotListenerOptions</code></td></tr><tr><td align="left"><code>observer</code></td><td align="left"><a href="#snapshotobserver"><code>SnapshotObserver</code></a>&#x3C;<a href="#querysnapshot"><code>QuerySnapshot</code></a>></td></tr></tbody></table></div>
+<h5 id="returns-72">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-10">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Query</span><span style="color:#ABB2BF"> | </span><span style="color:#E5C07B">CollectionReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onNext</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">QuerySnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onError</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">error</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onCompletion</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-62">Parameters</h5>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#query"><code>Query</code></a> | <a href="#collectionreference"><code>CollectionReference</code></a></td></tr><tr><td align="left"><code>onNext</code></td><td align="left">(<code>snapshot</code>: <a href="#querysnapshot"><code>QuerySnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>onError?</code></td><td align="left">(<code>error</code>: <code>unknown</code>) => <code>void</code></td></tr><tr><td align="left"><code>onCompletion?</code></td><td align="left">() => <code>void</code></td></tr></tbody></table></div>
+<h5 id="returns-73">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h4 id="call-signature-11">Call Signature</h4>
+<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">function</span><span style="color:#61AFEF"> onSnapshot</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Query</span><span style="color:#ABB2BF"> | </span><span style="color:#E5C07B">CollectionReference</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">   options</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SnapshotListenerOptions</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onNext</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">QuerySnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onError</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">error</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">,</span></span>
+<span class="line"><span style="color:#61AFEF">   onCompletion</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h5 id="parameters-63">Parameters</h5>
 <div class="table-scroll">
@@ -27,6 +2458,66 @@ nothing is initialized.</li>
-<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target?</code></td><td align="left"><code>any</code></td></tr></tbody></table></div>
-<h4 id="returns">Returns</h4>
-<p><code>SandboxFirestore</code></p>  </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols"> <h2 class="doc-toc-heading">Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter> <div class="api-symbol-groups" data-api-symbol-groups> <section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#functions"> Functions </a> <ul> <li data-api-symbol="getfirestore()"> <a href="#getfirestore">getFirestore()</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden>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>
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#query"><code>Query</code></a> | <a href="#collectionreference"><code>CollectionReference</code></a></td></tr><tr><td align="left"><code>options</code></td><td align="left"><code>SnapshotListenerOptions</code></td></tr><tr><td align="left"><code>onNext</code></td><td align="left">(<code>snapshot</code>: <a href="#querysnapshot"><code>QuerySnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>onError?</code></td><td align="left">(<code>error</code>: <code>unknown</code>) => <code>void</code></td></tr><tr><td align="left"><code>onCompletion?</code></td><td align="left">() => <code>void</code></td></tr></tbody></table></div>
+<h5 id="returns-74">Returns</h5>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
+<h2 id="references">References</h2>
+<p><a id="authstate"></a></p>
+<h3 id="authstate">AuthState</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#authstate">AuthState</a></p>
+<hr>
+<p><a id="documentdata"></a></p>
+<h3 id="documentdata">DocumentData</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#documentdata">DocumentData</a></p>
+<hr>
+<p><a id="fieldvalue"></a></p>
+<h3 id="fieldvalue">FieldValue</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#fieldvalue">FieldValue</a></p>
+<hr>
+<p><a id="fieldvaluesentinel"></a></p>
+<h3 id="fieldvaluesentinel">FieldValueSentinel</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#fieldvaluesentinel">FieldValueSentinel</a></p>
+<hr>
+<p><a id="lintresult"></a></p>
+<h3 id="lintresult">LintResult</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#lintresult">LintResult</a></p>
+<hr>
+<p><a id="orderdirection"></a></p>
+<h3 id="orderdirection">OrderDirection</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#orderdirection">OrderDirection</a></p>
+<hr>
+<p><a id="sandbox"></a></p>
+<h3 id="sandbox">Sandbox</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#sandbox">Sandbox</a></p>
+<hr>
+<p><a id="sandboxcontext"></a></p>
+<h3 id="sandboxcontext">SandboxContext</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#sandboxcontext">SandboxContext</a></p>
+<hr>
+<p><a id="sandboxerror"></a></p>
+<h3 id="sandboxerror">SandboxError</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#sandboxerror">SandboxError</a></p>
+<hr>
+<p><a id="timestamp"></a></p>
+<h3 id="timestamp">Timestamp</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#timestamp">Timestamp</a></p>
+<hr>
+<p><a id="wherefilterop"></a></p>
+<h3 id="wherefilterop">WhereFilterOp</h3>
+<p>Re-exports <a href="/docs/pyric-firestore-reference-api/#wherefilterop">WhereFilterOp</a></p>  </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols"> <h2 class="doc-toc-heading">Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter> <div class="api-symbol-groups" data-api-symbol-groups> <section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#interfaces"> Interfaces </a> <ul> <li data-api-symbol="admindocumentsnapshot"> <a href="#admindocumentsnapshot">AdminDocumentSnapshot</a> </li><li data-api-symbol="adminquerydocumentsnapshot"> <a href="#adminquerydocumentsnapshot">AdminQueryDocumentSnapshot</a> </li><li data-api-symbol="adminquerysnapshot"> <a href="#adminquerysnapshot">AdminQuerySnapshot</a> </li><li data-api-symbol="aggregatequerysnapshot"> <a href="#aggregatequerysnapshot">AggregateQuerySnapshot</a> </li><li data-api-symbol="collectionreference"> <a href="#collectionreference">CollectionReference</a> </li><li data-api-symbol="docchangesoptions"> <a href="#docchangesoptions">DocChangesOptions</a> </li><li data-api-symbol="documentchange"> <a href="#documentchange">DocumentChange</a> </li><li data-api-symbol="documentreference"> <a href="#documentreference">DocumentReference</a> </li><li data-api-symbol="documentsnapshot"> <a href="#documentsnapshot">DocumentSnapshot</a> </li><li data-api-symbol="firestore"> <a href="#firestore">Firestore</a> </li><li data-api-symbol="lintwarning"> <a href="#lintwarning">LintWarning</a> </li><li data-api-symbol="query"> <a href="#query">Query</a> </li><li data-api-symbol="querydocumentsnapshot"> <a href="#querydocumentsnapshot">QueryDocumentSnapshot</a> </li><li data-api-symbol="querysnapshot"> <a href="#querysnapshot">QuerySnapshot</a> </li><li data-api-symbol="rulesmetrics"> <a href="#rulesmetrics">RulesMetrics</a> </li><li data-api-symbol="sandboxfirestore"> <a href="#sandboxfirestore">SandboxFirestore</a> </li><li data-api-symbol="setoptions"> <a href="#setoptions">SetOptions</a> </li><li data-api-symbol="snapshotmetadata"> <a href="#snapshotmetadata">SnapshotMetadata</a> </li><li data-api-symbol="snapshotobserver"> <a href="#snapshotobserver">SnapshotObserver</a> </li><li data-api-symbol="transaction"> <a href="#transaction">Transaction</a> </li><li data-api-symbol="writebatch"> <a href="#writebatch">WriteBatch</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#type-aliases"> Type Aliases </a> <ul> <li data-api-symbol="aggregatefield"> <a href="#aggregatefield">AggregateField</a> </li><li data-api-symbol="aggregatespec"> <a href="#aggregatespec">AggregateSpec</a> </li><li data-api-symbol="documentchangetype"> <a href="#documentchangetype">DocumentChangeType</a> </li><li data-api-symbol="filter"> <a href="#filter">Filter</a> </li><li data-api-symbol="snapshotlistenoptions"> <a href="#snapshotlistenoptions">SnapshotListenOptions</a> </li><li data-api-symbol="unsubscribe()"> <a href="#unsubscribe">Unsubscribe()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#functions"> Functions </a> <ul> <li data-api-symbol="getadminfirestore()"> <a href="#getadminfirestore">getAdminFirestore()</a> </li><li data-api-symbol="getfirestore()"> <a href="#getfirestore">getFirestore()</a> </li><li data-api-symbol="onsnapshot()"> <a href="#onsnapshot">onSnapshot()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#references"> References </a> <ul> <li data-api-symbol="authstate"> <a href="#authstate">AuthState</a> </li><li data-api-symbol="documentdata"> <a href="#documentdata">DocumentData</a> </li><li data-api-symbol="fieldvalue"> <a href="#fieldvalue">FieldValue</a> </li><li data-api-symbol="fieldvaluesentinel"> <a href="#fieldvaluesentinel">FieldValueSentinel</a> </li><li data-api-symbol="lintresult"> <a href="#lintresult">LintResult</a> </li><li data-api-symbol="orderdirection"> <a href="#orderdirection">OrderDirection</a> </li><li data-api-symbol="sandbox"> <a href="#sandbox">Sandbox</a> </li><li data-api-symbol="sandboxcontext"> <a href="#sandboxcontext">SandboxContext</a> </li><li data-api-symbol="sandboxerror"> <a href="#sandboxerror">SandboxError</a> </li><li data-api-symbol="timestamp"> <a href="#timestamp">Timestamp</a> </li><li data-api-symbol="wherefilterop"> <a href="#wherefilterop">WhereFilterOp</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden>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>