@pyric/cli 0.1.0-alpha.9

package/dist/serve/docs-ui/docs/pyric-database-tutorials-01-author-rtdb-rules-with-constraints.md

@@ -0,0 +1,171 @@
+# Author your first RTDB rules with constraints
+
+This tutorial creates a small Realtime Database rules document in memory, checks
+it, and simulates one write before you hand the generated JSON to deploy
+tooling.
+
+You will build rules for room messages:
+
+- nobody can read or write at the root
+- signed-in room members can write messages
+- each message must include `author`, `text`, and `createdAt`
+- `createdAt` cannot change after creation
+
+## Create the rules document
+
+Create `database.rules.ts`:
+
+```ts
+import { z } from 'zod';
+import {
+  AUTH_UID,
+  all,
+  authenticated,
+  defineRtdbRules,
+  deny,
+  eq,
+  immutable,
+  newDataVal,
+  rootExists,
+} from 'pyric/rules';
+
+const isRoomMember = rootExists(['members', { $: '$roomId' }, { $: 'auth.uid' }]);
+
+export const rules = defineRtdbRules({
+  paths: {
+    '/': { read: deny(), write: deny() },
+    '/rooms/$roomId/messages/$messageId': {
+      read: isRoomMember,
+      write: all(
+        authenticated(),
+        isRoomMember,
+        eq(newDataVal('author'), AUTH_UID),
+        immutable('createdAt'),
+      ),
+      schema: z.object({
+        author: z.string(),
+        text: z.string(),
+        createdAt: z.number(),
+      }),
+      indexOn: ['createdAt'],
+    },
+  },
+});
+```
+
+## Check the document
+
+Save a small check script as `database.rules.check.ts`:
+
+```ts
+import { rtdbRules } from 'pyric/rules';
+import { rules } from './database.rules.js';
+
+const ruleset = rtdbRules(rules);
+const issues = ruleset.lint();
+
+if (issues.some((i) => i.severity === 'error')) {
+  console.error(issues);
+  process.exit(1);
+}
+
+console.log(ruleset.toJSON());
+```
+
+Run it:
+
+```bash
+bun database.rules.check.ts
+```
+
+You will see a complete Firebase RTDB rules JSON object. The `lint()` call
+returns warnings alongside errors (one flat `RuleIssue[]`), so you can decide
+whether to fail your own workflow on warnings.
+
+## Simulate a write
+
+Save one simulation as `database.rules.simulate.ts`:
+
+```ts
+import { rtdbRules } from 'pyric/rules';
+import { rules } from './database.rules.js';
+
+const result = rtdbRules(rules).explain({
+  expectation: 'ALLOW',
+  operation: 'write',
+  path: '/rooms/r1/messages/m1',
+  auth: 'alice',
+  data: {
+    members: {
+      r1: { alice: true },
+    },
+  },
+  newData: {
+    author: 'alice',
+    text: 'hello',
+    createdAt: 1,
+  },
+});
+
+console.log(result);
+```
+
+Run it:
+
+```bash
+bun database.rules.simulate.ts
+```
+
+The result is allowed. Change `auth` to `'bob'` or change `newData.author` to a
+different uid and run it again; the same rule document now denies the write.
+
+## Generate JSON for deployment
+
+Write the compiled JSON with the Node helper:
+
+```ts
+import { writeRtdbRulesFile } from 'pyric/rules/internal/node';
+import { rules } from './database.rules.js';
+
+await writeRtdbRulesFile(rules, 'database.rules.json');
+```
+
+or from the CLI, without writing a script at all:
+
+```sh
+pyric database rules generate --config database.rules.ts --out database.rules.json
+```
+
+Both routes run the same compilation `rtdbRules(rules).toJSON()` performs. See
+[RTDB rules tooling](../pyric-database-reference-rules-tooling/#generating-databaserulesjson)
+for the full reference, including the `rtdb_generate_rules` MCP tool.
+
+You have built an in-memory rules document, checked it, simulated it, and
+generated the JSON expected by Firebase Realtime Database.
+
+## Verify a captured app journey
+
+After running `pyric dev` and exercising the app, the latest session is saved
+to `.pyric/last-session.json`. You can verify that capture against the in-memory
+rules document before generating JSON:
+
+```ts
+import { verifyFixture } from '@pyric/cli/verify';
+import { rules } from './database.rules.js';
+
+const fixture = JSON.parse(await Bun.file('.pyric/last-session.json').text());
+const result = await verifyFixture(fixture, {
+  rules: { rtdb: rules },
+});
+
+if (!result.ok) {
+  console.error(result.services.rtdb?.divergences);
+  process.exit(1);
+}
+```
+
+For the CLI path, use the JSON file from the previous step:
+
+```bash
+pyric verify --service rtdb --rules rtdb=database.rules.json
+```

package/dist/serve/docs-ui/docs/pyric-database.md

@@ -0,0 +1,26 @@
+# Realtime Database
+
+Pyric's Realtime Database surface has three deliberately separate parts:
+
+- `pyric/database` is the sandbox-only mirror of the Firebase Database modular
+  SDK. Production builds keep resolving the unchanged `firebase/database`
+  package; the mirror never dispatches to it at runtime.
+- `pyric/sandbox/database` exposes owner controls for installing rules,
+  seeding data, and reading detached snapshots.
+- `pyric/rules` exposes the RTDB rules constraints DSL (`defineRtdbRules`
+  and the combinators) plus `rtdbRules(...)`, the deep handle for linting
+  and simulating a ruleset. The engine underneath (rule JSON mapping,
+  expression parsing and linting, local simulation, and rules-focused agent
+  tools) is internal, on `pyric/rules/internal/rtdb`.
+
+Simulation and structure crawling for agents belong to the sandbox and CLI
+tooling, not to the Firebase-shaped `pyric/database` mirror.
+
+## Where to go next
+
+| If you want to | Read |
+|---|---|
+| Learn the constraints authoring workflow | [Author your first RTDB rules with constraints](../pyric-database-tutorials-01-author-rtdb-rules-with-constraints/) |
+| Look up the RTDB rules tooling API | [RTDB rules tooling reference](../pyric-database-reference-rules-tooling/) |
+| Understand package boundaries for authoring vs shipping | [Why RTDB rules authoring and deploy are separate](../pyric-database-explanation-rules-authoring-and-deploy-are-separate/) |
+| Check Firebase Database compatibility status | [Compatibility matrix](../pyric-database-compat/) |

package/dist/serve/docs-ui/docs/pyric-explanation-versioning-and-compatibility/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>The versioning and compatibility policy · Pyric Studio</title><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_.CQYSemvw.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>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/" aria-current="true"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/"> API reference </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-run-locally"> <summary>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-develop-with-firebase-apis"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-inspect-and-correct"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-inspect-the-sandbox"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-correct-security-rules"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-work-with-an-agent"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-verify-the-boundary"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-unchanged"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </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"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/" aria-current="true"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/"> API reference </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/pyric-explanation-versioning-and-compatibility/">pyric</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>Explanation</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">The versioning and compatibility policy</span> </li> </ol> </nav>  <article class="prose">  <h1 id="the-versioning-and-compatibility-policy">The versioning and compatibility policy</h1>
+<p>Pyric mirrors Firebase’s observable behavior. Users need one honest way to ask “which Firebase does this pyric behave like,” and pyric needs one honest way to answer. This document is that answer. It defines what the claim means, where it appears, and what has to be true before it can move.</p>
+<h2 id="pyric-keeps-its-own-version-and-never-borrows-firebases">Pyric keeps its own version and never borrows Firebase’s</h2>
+<p>Pyric versions itself with its own semver, independent of Firebase. It does not adopt Firebase’s version number.</p>
+<p>Pyric ships a large surface that Firebase does not have: the sandbox runtime, the rules tooling, the CLI. Breaking changes in that surface need their own major and minor releases. A pyric that renamed itself <code>12.16.0</code> to match Firebase would be making a promise of parity that the conformance numbers do not support. Pyric’s version tracks pyric. Firebase compatibility is stated separately, below.</p>
+<h2 id="firebase-compatibility-ships-as-a-dist-tag">Firebase compatibility ships as a dist-tag</h2>
+<p>The compatibility claim is an npm dist-tag of the form <code>fb&#x3C;major>.&#x3C;minor></code>.</p>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="plaintext"><code><span class="line"><span>npm install pyric@fb12.16</span></span></code></pre>
+<p>A <code>fb&#x3C;major>.&#x3C;minor></code> tag points at the newest pyric release whose conformance gates pass against that line of Firebase. Installing <code>pyric@fb12.16</code> gets you the pyric that has been conformance-tested against Firebase 12.16.</p>
+<p>The tag means “conformance-tested against Firebase 12.16.” It does not mean “equal to Firebase 12.16” and it does not mean “full parity with Firebase 12.16.” Those are claims pyric does not make and the conformance numbers do not back. The tag is a statement about what was tested, not a statement about how much matched.</p>
+<h2 id="patch-releases-are-not-tagged">Patch releases are not tagged</h2>
+<p>Pyric tags Firebase’s major and minor lines and never its patch level, so there is no <code>fb12.16.1</code>; a Firebase patch triggers a pyric release only when the upstream surface snapshot diff for that patch is non-empty, which it usually is not.</p>
+<h2 id="the-tag-is-a-certificate-not-an-opinion">The tag is a certificate, not an opinion</h2>
+<p>A <code>fb</code> tag moves only through the release script, and only when the conformance gate suite <code>compat:check</code> is green against the pinned Firebase version.</p>
+<p>Nobody moves a tag by hand because they believe pyric is ready. The tag moves because the gates passed. It is a machine-issued certificate. A green <code>compat:check</code> is the only thing that issues it, and a red one withholds it. This removes optimism from the claim: the tag says what the tests found, and the tests ran before it moved.</p>
+<h2 id="the-certificate-appears-wherever-a-user-forms-an-impression">The certificate appears wherever a user forms an impression</h2>
+<p>The tested-against version is not only an npm tag. It is stated everywhere a user decides whether to trust pyric:</p>
+<ul>
+<li>The README carries a badge naming the Firebase version pyric is tested against.</li>
+<li>The npm package description names it.</li>
+<li><code>pyric --version</code> prints both numbers: the pyric version and the Firebase version it was tested against.</li>
+<li>The docs header names it.</li>
+</ul>
+<p>A user who never runs <code>npm dist-tag ls</code> still sees the claim, and sees the same claim in every place.</p>
+<h2 id="the-claim-links-to-numbers-anyone-can-read">The claim links to numbers anyone can read</h2>
+<p>“Tested against Firebase 12.16” is only honest if the result of that testing is inspectable. Pyric publishes three numbers openly, per service and overall, on the <a href="../pyric-conformance-scores/">conformance scoreboard</a> and each COMPAT matrix:</p>
+<ul>
+<li><strong>Public runtime surface</strong> — mirrored public runtime exports / Firebase public runtime exports.</li>
+<li><strong>Public type surface</strong> — mirrored public exported type names / Firebase public exported type names.</li>
+<li><strong>Fidelity</strong> — of the discrete claims in the matrix, how many match production.</li>
+</ul>
+<p>They are different questions. Public surface is about whether an export name exists. Leading-underscore Firebase implementation exports are private and excluded by rule. Every public export stays in the denominator, including deprecated, unsupported, and deferred APIs. Type-name presence does not prove structural assignability or signature equivalence. Fidelity is about whether each tracked interaction matches Firebase. It is not “percent of Firebase that works,” and missing exports do not move it. The scoreboard explains the statuses behind the fidelity percentage in full. A reader following the tag reaches those numbers, not a slogan. “Tested against” is a link, never a vibe.</p>
+<h2 id="where-the-numbers-stand-today">Where the numbers stand today</h2>
+<p>Firebase’s latest npm release is 12.16.0. Pyric’s pinned oracle and conformance version is 12.13.0, so the first real tag will be <code>fb12.13</code>, the line pyric is actually tested against, not <code>fb12.16</code>. Pyric’s own packages are at <code>0.1.0-alpha.8</code>, in lockstep across <code>pyric</code>, <code>pyric-admin</code>, <code>@pyric/cli</code>, and <code>@pyric/ui</code>. A <code>fb</code> tag can point at an alpha release; the compatibility claim and the stability claim are separate, and the <code>fb</code> tag speaks only to the first.</p>
+<hr>
+<h2 id="mechanics-for-maintainers">Mechanics, for maintainers</h2>
+<p><strong>How the tag is computed and moved.</strong> At publish time, after packages are packed and published, the release step reads the currently pinned Firebase version and runs <code>compat:check</code> against it. <code>compat:check</code> is the composite gate: registry validation, the surface census gate, a docs freshness check, and the coverage regression check. If it is green, the release script moves <code>fb&#x3C;major>.&#x3C;minor></code> for the pinned line to the version being published, using the same <code>npm dist-tag add</code> mechanism the script already uses for <code>latest</code>. If it is red, the <code>fb</code> tag does not move and the release does not carry a compatibility claim. The minor is derived from the pinned version; the patch component of the pin is discarded when forming the tag.</p>
+<p><strong>What happens on a Firebase pin bump.</strong> Raising the pinned Firebase version starts by re-snapshotting the upstream surface. The diff between the old snapshot and the new one is the worklist: new exports, changed signatures, removed surface. Bumping the pin does not create the new <code>fb</code> tag. The tag for the new line, for example <code>fb12.16</code>, appears only after the worklist is closed enough that <code>compat:check</code> passes against the new pin. Until then, no release claims the new line.</p>
+<p><strong>What happens to old tags.</strong> A <code>fb</code> tag for a line pyric no longer pins keeps pointing at the last pyric release that was certified against that line. Old <code>fb</code> tags are never deleted and never moved backward. <code>pyric@fb12.13</code> continues to resolve to a real, once-certified release even after the pin moves to 12.16, so an install pinned to an older Firebase line stays reproducible.</p>
+<p><strong>Interaction with <code>alpha</code> and <code>latest</code>.</strong> The <code>alpha</code> and <code>latest</code> tags are about pyric’s own release stream and move on every publish, <code>alpha</code> to each publish and <code>latest</code> to the same version by the explicit dist-tag step. The <code>fb</code> tags are orthogonal: they move only when gates pass against their line, and only the line matching the current pin moves on a given release. Several tags can point at the same version. A single publish can leave <code>alpha</code>, <code>latest</code>, and <code>fb12.13</code> all resolving to <code>0.1.0-alpha.9</code>, each making its own separate claim: newest, default, and tested-against-Firebase-12.13.</p>  </article> </main> <aside class="doc-toc" aria-label="On this page"> <h2 class="doc-toc-heading">On this page</h2> <ul> <li data-depth="2"> <a href="#pyric-keeps-its-own-version-and-never-borrows-firebases">Pyric keeps its own version and never borrows Firebase’s</a> </li><li data-depth="2"> <a href="#firebase-compatibility-ships-as-a-dist-tag">Firebase compatibility ships as a dist-tag</a> </li><li data-depth="2"> <a href="#patch-releases-are-not-tagged">Patch releases are not tagged</a> </li><li data-depth="2"> <a href="#the-tag-is-a-certificate-not-an-opinion">The tag is a certificate, not an opinion</a> </li><li data-depth="2"> <a href="#the-certificate-appears-wherever-a-user-forms-an-impression">The certificate appears wherever a user forms an impression</a> </li><li data-depth="2"> <a href="#the-claim-links-to-numbers-anyone-can-read">The claim links to numbers anyone can read</a> </li><li data-depth="2"> <a href="#where-the-numbers-stand-today">Where the numbers stand today</a> </li><li data-depth="2"> <a href="#mechanics-for-maintainers">Mechanics, for maintainers</a> </li> </ul> </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>

package/dist/serve/docs-ui/docs/pyric-explanation-versioning-and-compatibility.md

@@ -0,0 +1,68 @@
+# The versioning and compatibility policy
+
+Pyric mirrors Firebase's observable behavior. Users need one honest way to ask "which Firebase does this pyric behave like," and pyric needs one honest way to answer. This document is that answer. It defines what the claim means, where it appears, and what has to be true before it can move.
+
+## Pyric keeps its own version and never borrows Firebase's
+
+Pyric versions itself with its own semver, independent of Firebase. It does not adopt Firebase's version number.
+
+Pyric ships a large surface that Firebase does not have: the sandbox runtime, the rules tooling, the CLI. Breaking changes in that surface need their own major and minor releases. A pyric that renamed itself `12.16.0` to match Firebase would be making a promise of parity that the conformance numbers do not support. Pyric's version tracks pyric. Firebase compatibility is stated separately, below.
+
+## Firebase compatibility ships as a dist-tag
+
+The compatibility claim is an npm dist-tag of the form `fb<major>.<minor>`.
+
+```
+npm install pyric@fb12.16
+```
+
+A `fb<major>.<minor>` tag points at the newest pyric release whose conformance gates pass against that line of Firebase. Installing `pyric@fb12.16` gets you the pyric that has been conformance-tested against Firebase 12.16.
+
+The tag means "conformance-tested against Firebase 12.16." It does not mean "equal to Firebase 12.16" and it does not mean "full parity with Firebase 12.16." Those are claims pyric does not make and the conformance numbers do not back. The tag is a statement about what was tested, not a statement about how much matched.
+
+## Patch releases are not tagged
+
+Pyric tags Firebase's major and minor lines and never its patch level, so there is no `fb12.16.1`; a Firebase patch triggers a pyric release only when the upstream surface snapshot diff for that patch is non-empty, which it usually is not.
+
+## The tag is a certificate, not an opinion
+
+A `fb` tag moves only through the release script, and only when the conformance gate suite `compat:check` is green against the pinned Firebase version.
+
+Nobody moves a tag by hand because they believe pyric is ready. The tag moves because the gates passed. It is a machine-issued certificate. A green `compat:check` is the only thing that issues it, and a red one withholds it. This removes optimism from the claim: the tag says what the tests found, and the tests ran before it moved.
+
+## The certificate appears wherever a user forms an impression
+
+The tested-against version is not only an npm tag. It is stated everywhere a user decides whether to trust pyric:
+
+- The README carries a badge naming the Firebase version pyric is tested against.
+- The npm package description names it.
+- `pyric --version` prints both numbers: the pyric version and the Firebase version it was tested against.
+- The docs header names it.
+
+A user who never runs `npm dist-tag ls` still sees the claim, and sees the same claim in every place.
+
+## The claim links to numbers anyone can read
+
+"Tested against Firebase 12.16" is only honest if the result of that testing is inspectable. Pyric publishes three numbers openly, per service and overall, on the [conformance scoreboard](../pyric-conformance-scores/) and each COMPAT matrix:
+
+- **Public runtime surface** — mirrored public runtime exports / Firebase public runtime exports.
+- **Public type surface** — mirrored public exported type names / Firebase public exported type names.
+- **Fidelity** — of the discrete claims in the matrix, how many match production.
+
+They are different questions. Public surface is about whether an export name exists. Leading-underscore Firebase implementation exports are private and excluded by rule. Every public export stays in the denominator, including deprecated, unsupported, and deferred APIs. Type-name presence does not prove structural assignability or signature equivalence. Fidelity is about whether each tracked interaction matches Firebase. It is not "percent of Firebase that works," and missing exports do not move it. The scoreboard explains the statuses behind the fidelity percentage in full. A reader following the tag reaches those numbers, not a slogan. "Tested against" is a link, never a vibe.
+
+## Where the numbers stand today
+
+Firebase's latest npm release is 12.16.0. Pyric's pinned oracle and conformance version is 12.13.0, so the first real tag will be `fb12.13`, the line pyric is actually tested against, not `fb12.16`. Pyric's own packages are at `0.1.0-alpha.8`, in lockstep across `pyric`, `pyric-admin`, `@pyric/cli`, and `@pyric/ui`. A `fb` tag can point at an alpha release; the compatibility claim and the stability claim are separate, and the `fb` tag speaks only to the first.
+
+---
+
+## Mechanics, for maintainers
+
+**How the tag is computed and moved.** At publish time, after packages are packed and published, the release step reads the currently pinned Firebase version and runs `compat:check` against it. `compat:check` is the composite gate: registry validation, the surface census gate, a docs freshness check, and the coverage regression check. If it is green, the release script moves `fb<major>.<minor>` for the pinned line to the version being published, using the same `npm dist-tag add` mechanism the script already uses for `latest`. If it is red, the `fb` tag does not move and the release does not carry a compatibility claim. The minor is derived from the pinned version; the patch component of the pin is discarded when forming the tag.
+
+**What happens on a Firebase pin bump.** Raising the pinned Firebase version starts by re-snapshotting the upstream surface. The diff between the old snapshot and the new one is the worklist: new exports, changed signatures, removed surface. Bumping the pin does not create the new `fb` tag. The tag for the new line, for example `fb12.16`, appears only after the worklist is closed enough that `compat:check` passes against the new pin. Until then, no release claims the new line.
+
+**What happens to old tags.** A `fb` tag for a line pyric no longer pins keeps pointing at the last pyric release that was certified against that line. Old `fb` tags are never deleted and never moved backward. `pyric@fb12.13` continues to resolve to a real, once-certified release even after the pin moves to 12.16, so an install pinned to an older Firebase line stays reproducible.
+
+**Interaction with `alpha` and `latest`.** The `alpha` and `latest` tags are about pyric's own release stream and move on every publish, `alpha` to each publish and `latest` to the same version by the explicit dist-tag step. The `fb` tags are orthogonal: they move only when gates pass against their line, and only the line matching the current pin moves on a given release. Several tags can point at the same version. A single publish can leave `alpha`, `latest`, and `fb12.13` all resolving to `0.1.0-alpha.9`, each making its own separate claim: newest, default, and tested-against-Firebase-12.13.

package/dist/serve/docs-ui/docs/pyric-firestore/index.html

@@ -0,0 +1,48 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>pyric/firestore · Pyric Studio</title><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_.CQYSemvw.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>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/" aria-current="true"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/"> API reference </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-run-locally"> <summary>Run locally</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/how-the-swap-works/"> How the swap works </a> </li><li> <a href="/__pyric/ui/docs/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-develop-with-firebase-apis"> <summary>Develop with Firebase APIs</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/sign-in-and-manage-users/"> Sign in and manage users </a> </li><li> <a href="/__pyric/ui/docs/store-and-query-data/"> Store and query data </a> </li><li> <a href="/__pyric/ui/docs/sync-realtime-data/"> Sync realtime data </a> </li><li> <a href="/__pyric/ui/docs/store-files/"> Store files </a> </li><li> <a href="/__pyric/ui/docs/receive-messages/"> Receive messages </a> </li><li> <a href="/__pyric/ui/docs/run-ai-logic-locally/"> Run AI Logic locally </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-how-to-run-rtdb-onvaluecreated/"> Run an RTDB function locally </a> </li><li> <a href="/__pyric/ui/docs/which-data-service/"> Which data service? </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-inspect-and-correct"> <summary>Inspect and correct</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-inspect-the-sandbox"> Inspect the sandbox </h2> <ul> <li> <a href="/__pyric/ui/docs/see-whats-happening/"> Traffic &amp; rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/shape-your-data/"> Seed, snapshot, replay </a> </li><li> <a href="/__pyric/ui/docs/watch-and-review/"> Review agent activity </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-correct-security-rules"> Correct Security Rules </h2> <ul> <li> <a href="/__pyric/ui/docs/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/rules-patterns/"> Rules patterns </a> </li><li> <a href="/__pyric/ui/docs/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/whats-possible/"> Case studies </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-inspect-and-correct-work-with-an-agent"> Work with an agent </h2> <ul> <li> <a href="/__pyric/ui/docs/what-your-agent-can-do/"> Work through an agent </a> </li><li> <a href="/__pyric/ui/docs/skills/"> Agent skills </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-verify-the-boundary"> <summary>Verify the boundary</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-how-to-verify-against-a-captured-session/"> Verify a captured session </a> </li><li> <a href="/__pyric/ui/docs/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-unchanged"> <summary>Ship unchanged</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/set-up-the-project/"> Set up the Firebase project </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section">  <ul> <li> <a href="/__pyric/ui/docs/how-we-know-it-matches-firebase/"> Conformance </a> </li><li> <a href="/__pyric/ui/docs/whats-experimental/"> What&#39;s experimental </a> </li><li> <a href="/__pyric/ui/docs/pyric-conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-functions-rtdb-compat/"> Functions · RTDB </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"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli/"> @pyric/cli </a> </li><li> <a href="/__pyric/ui/docs/pyric-explanation-versioning-and-compatibility/"> pyric </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore/" aria-current="true"> pyric / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules/"> pyric / rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox/"> pyric / sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage/"> pyric / storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth/"> pyric / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-database/"> pyric / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app/"> pyric-admin / app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore/"> pyric-admin / firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth/"> pyric-admin / auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database/"> pyric-admin / database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage/"> pyric-admin / storage </a> </li><li> <a href="/__pyric/ui/docs/ui/"> @pyric/ui </a> </li><li> <a href="/__pyric/ui/docs/api-reference/"> API reference </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/pyric-firestore/">pyric / firestore</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">Overview</span> </li> </ol> </nav>  <article class="prose">  <h1 id="pyricfirestore"><code>pyric/firestore</code></h1>
+<p><code>pyric/firestore</code> is the sandbox implementation of Firebase’s modular
+Firestore surface. It provides reads, writes, queries, listeners,
+transactions, batches, converters, aggregates, sentinels, and local scalar
+value classes without loading the production Firebase SDK.</p>
+<p>Backend selection belongs to package resolution:</p>
+<ul>
+<li>Without Pyric activation, <code>firebase/firestore</code> is Firebase.</li>
+<li>With <code>pyric dev</code>, the Vite plugin, or <code>@pyric/cli/register</code> active,
+<code>firebase/firestore</code> resolves to the Pyric sandbox mirror.</li>
+<li>A direct <code>pyric/firestore</code> import is always sandbox-only.</li>
+</ul>
+<h2 id="canonical-application-code">Canonical application code</h2>
+<p>Keep Firebase imports in application code:</p>
+<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">initializeApp</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'firebase/app'</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">doc</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">getDoc</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">getFirestore</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">setDoc</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'firebase/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"> app</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> initializeApp</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">projectId</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'demo-project'</span><span style="color:#ABB2BF"> });</span></span>
+<span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> db</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> getFirestore</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">app</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> ref</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> doc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">db</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'notes/n1'</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> setDoc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">, { </span><span style="color:#E06C75">title</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'hello'</span><span style="color:#ABB2BF"> });</span></span>
+<span class="line"><span style="color:#E5C07B">console</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">log</span><span style="color:#ABB2BF">((</span><span style="color:#C678DD">await</span><span style="color:#61AFEF"> getDoc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">ref</span><span style="color:#ABB2BF">)).</span><span style="color:#61AFEF">data</span><span style="color:#ABB2BF">());</span></span></code></pre>
+<p>Run the same source in a Node sandbox:</p>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#E06C75">PYRIC_SANDBOX</span><span style="color:#56B6C2">=</span><span style="color:#98C379">local</span><span style="color:#61AFEF"> node</span><span style="color:#D19A66"> --import</span><span style="color:#98C379"> @pyric/cli/register</span><span style="color:#98C379"> app.mjs</span></span></code></pre>
+<p>Or activate the Vite integration:</p>
+<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">defineConfig</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'vite'</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">pyricSandbox</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> '@pyric/cli/vite'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">export</span><span style="color:#C678DD"> default</span><span style="color:#61AFEF"> defineConfig</span><span style="color:#ABB2BF">({ </span><span style="color:#E06C75">plugins</span><span style="color:#ABB2BF">: [</span><span style="color:#61AFEF">pyricSandbox</span><span style="color:#ABB2BF">()] });</span></span></code></pre>
+<p>With neither activation seam present, the imports remain Firebase and use the
+real project configured by <code>initializeApp</code>.</p>
+<h2 id="direct-sandbox-construction">Direct sandbox construction</h2>
+<p>Tests and sandbox tooling may construct a handle explicitly:</p>
+<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">getFirestore</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">doc</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">setDoc</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric/firestore'</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">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>
+<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:#C678DD">const</span><span style="color:#E5C07B"> db</span><span style="color:#56B6C2"> =</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:#C678DD">await</span><span style="color:#61AFEF"> setDoc</span><span style="color:#ABB2BF">(</span><span style="color:#61AFEF">doc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">db</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'notes/n1'</span><span style="color:#ABB2BF">), { </span><span style="color:#E06C75">title</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'hello'</span><span style="color:#ABB2BF"> });</span></span></code></pre>
+<p>Passing a real <code>FirebaseApp</code> to this direct mirror is an error. Production code
+must load <code>firebase/firestore</code> without sandbox activation.</p>
+<h2 id="position-in-the-pyric-stack">Position in the Pyric stack</h2>
+<p><code>pyric/firestore</code> is the modular client data plane. Firestore sandbox controls
+live under <code>pyric/sandbox/firestore</code>; rules evaluation lives under
+<code>pyric/rules</code>; and production deployment is a separate tooling concern.</p>
+<p>See the how-to guides, reference, and
+explanations for the next level of detail.</p>  </article> </main> <aside class="doc-toc" aria-label="On this page"> <h2 class="doc-toc-heading">On this page</h2> <ul> <li data-depth="2"> <a href="#canonical-application-code">Canonical application code</a> </li><li data-depth="2"> <a href="#direct-sandbox-construction">Direct sandbox construction</a> </li><li data-depth="2"> <a href="#position-in-the-pyric-stack">Position in the Pyric stack</a> </li> </ul> </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>