npm - @pyric/cli - Versions diffs - 0.1.0-alpha.9 - Mend

@pyric/cli 0.1.0-alpha.9

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

package/dist/serve/docs-ui/docs/pyric-database-reference-constraints/index.html ADDED Viewed

@@ -0,0 +1,381 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>API reference: RTDB rules constraints · 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/"> 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/" aria-current="true"> 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/"> 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/" aria-current="true"> 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-database/">pyric / database</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>Reference</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">API reference</span> </li> </ol> </nav>  <article class="prose">  <h1 id="api-reference-rtdb-rules-constraints">API reference: RTDB rules constraints</h1>
+<p>Typed builders that produce Realtime Database security-rule expressions, plus the assembly layer that places them in a path tree and compiles the tree to Firebase rules JSON. Everything on this page is importable directly from <code>pyric/rules</code>, the public front door. The dedicated constraints-only subpaths that used to exist (<code>pyric/rules/rtdb/constraints</code>, <code>pyric/rules/rtdb-constraints</code>) no longer do; there is one place to import the DSL from now. The engine that compiles and simulates against it (the parser, linter, simulator, and tool factories) lives on the internal <code>pyric/rules/internal/rtdb</code> subpath instead.</p>
+<p>Every builder returns an <code>Expr</code>, which is a plain string of RTDB rules language. The produced expressions below are pinned by spec tests, so they are safe to rely on byte for byte.</p>
+<p>Realtime Database support is experimental. The behaviors here are verified in-process; see the <a href="../pyric-database-compat/">compatibility matrix</a> for what is pinned against production.</p>
+<h2 id="combinators">Combinators</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Produces</th></tr></thead><tbody><tr><td><code>expr(raw)</code></td><td><code>(raw: string) => Expr</code></td><td>the raw string, unchanged</td></tr><tr><td><code>all(...exprs)</code></td><td><code>(...exprs: Expr[]) => Expr</code></td><td><code>(a) &#x26;&#x26; (b) &#x26;&#x26; ...</code> (each operand parenthesized)</td></tr><tr><td><code>any(...exprs)</code></td><td><code>(...exprs: Expr[]) => Expr</code></td><td><code>(a) || (b) || ...</code></td></tr><tr><td><code>not(e)</code></td><td><code>(e: Expr) => Expr</code></td><td><code>!(e)</code></td></tr><tr><td><code>deny()</code></td><td><code>() => Expr</code></td><td><code>false</code></td></tr><tr><td><code>always()</code></td><td><code>() => Expr</code></td><td><code>true</code></td></tr><tr><td><code>allow()</code></td><td>alias of <code>always</code></td><td><code>true</code></td></tr></tbody></table></div>
+<h2 id="atoms">Atoms</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Produces</th></tr></thead><tbody><tr><td><code>authenticated()</code></td><td><code>() => Expr</code></td><td><code>auth !== null</code></td></tr><tr><td><code>ownPath(pathVar)</code></td><td><code>(pathVar: string) => Expr</code></td><td><code>auth.uid === $pathVar</code></td></tr><tr><td><code>ownField(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>auth.uid === data.child("field").val()</code></td></tr><tr><td><code>isNew()</code></td><td><code>() => Expr</code></td><td><code>!data.exists()</code></td></tr><tr><td><code>hasChildren()</code></td><td><code>() => Expr</code></td><td><code>newData.hasChildren()</code></td></tr><tr><td><code>hasChild(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>newData.hasChild("field")</code></td></tr><tr><td><code>fieldIsString(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>newData.child("field").isString()</code></td></tr><tr><td><code>fieldIsNumber(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>newData.child("field").isNumber()</code></td></tr><tr><td><code>fieldIsBoolean(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>newData.child("field").isBoolean()</code></td></tr><tr><td><code>fieldEnum(field, values)</code></td><td><code>(field: string, values: string[]) => Expr</code></td><td><code>newData.child("f").val() === "a" || ... === "b"</code></td></tr><tr><td><code>immutable(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>!data.exists() || newData.child("f").val() === data.child("f").val()</code></td></tr><tr><td><code>immutableSelf()</code></td><td><code>() => Expr</code></td><td><code>!data.exists() || newData.val() === data.val()</code></td></tr><tr><td><code>rootExists(segments)</code></td><td><code>(segments: Segment[]) => Expr</code></td><td><code>root.child("a").child($var).exists()</code></td></tr><tr><td><code>rootEquals(segments, value)</code></td><td><code>(segments: Segment[], value: string) => Expr</code></td><td><code>root.child(...).val() === "value"</code></td></tr></tbody></table></div>
+<p><code>Segment = string | { $: string }</code>. A string segment is quoted (<code>child("members")</code>); a <code>{ $: name }</code> segment is inserted unquoted, which is how path variables (<code>{ $: '$roomId' }</code>) and runtime references (<code>{ $: 'auth.uid' }</code>) enter a path chain. <code>fieldEnum</code>’s branches are not individually parenthesized; compose it through <code>all()</code>/<code>any()</code>, which wrap it.</p>
+<h2 id="policies-composed-atoms">Policies (composed atoms)</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Produces</th></tr></thead><tbody><tr><td><code>pathOwnerOnly(pathVar)</code></td><td><code>(pathVar: string) => Expr</code></td><td><code>(auth !== null) &#x26;&#x26; (auth.uid === $var)</code></td></tr><tr><td><code>fieldOwnerOnly(field)</code></td><td><code>(field: string) => Expr</code></td><td><code>(auth !== null) &#x26;&#x26; (auth.uid === data.child("f").val())</code></td></tr><tr><td><code>ownerOrNew(field)</code></td><td><code>(field: string) => Expr</code></td><td>signed in, and the record is new or owned by the caller</td></tr><tr><td><code>hasRole(segments, role)</code></td><td><code>(segments: Segment[], role: string) => Expr</code></td><td><code>rootEquals(segments, role)</code></td></tr><tr><td><code>isMember(listName, pathVarName)</code></td><td><code>(listName: string, pathVarName: string) => Expr</code></td><td><code>root.child("list").child($var).child(auth.uid).exists()</code> (prepends <code>$</code> to <code>pathVarName</code> itself)</td></tr><tr><td><code>required(...fields)</code></td><td><code>(...fields: string[]) => Expr</code></td><td>AND of <code>newData.hasChild(...)</code> per field</td></tr><tr><td><code>transition(field, allowed)</code></td><td><code>(field: string, allowed: Array&#x3C;[from, to]>) => Expr</code></td><td>OR of <code>(data.child("f").val() === "from") &#x26;&#x26; (newData.child("f").val() === "to")</code> pairs</td></tr></tbody></table></div>
+<h2 id="data-helpers">Data helpers</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Produces</th></tr></thead><tbody><tr><td><code>dataVal(path?)</code></td><td><code>(path?: string) => Expr</code></td><td><code>data.val()</code> or <code>data.child("p").val()</code></td></tr><tr><td><code>newDataVal(path?)</code></td><td><code>(path?: string) => Expr</code></td><td>same on <code>newData</code></td></tr><tr><td><code>dataExists(path?)</code> / <code>newDataExists(path?)</code></td><td><code>(path?: string) => Expr</code></td><td><code>.exists()</code> variants</td></tr><tr><td><code>newDataIs(type)</code></td><td><code>('String' | 'Number' | 'Boolean') => Expr</code></td><td><code>newData.isString()</code> and friends</td></tr><tr><td><code>dataParentVal(depth, field)</code></td><td><code>(depth: number, field: string) => Expr</code></td><td><code>data.parent()...child("f").val()</code>, <code>depth</code> parent hops</td></tr><tr><td><code>newDataParentVal(depth, field)</code></td><td><code>(depth: number, field: string) => Expr</code></td><td>same on <code>newData</code></td></tr><tr><td><code>newDataParentExists(depth, field)</code></td><td><code>(depth: number, field: string) => Expr</code></td><td><code>newData.parent()...child("f").exists()</code></td></tr><tr><td><code>eq(left, right)</code></td><td><code>(left: Expr, right: CompareValue) => Expr</code></td><td><code>left === right</code></td></tr><tr><td><code>neq(left, right)</code></td><td><code>(left: Expr, right: CompareValue) => Expr</code></td><td><code>left !== right</code></td></tr><tr><td><code>gt(left, n)</code></td><td><code>(left: Expr, n: number) => Expr</code></td><td><code>left > n</code></td></tr><tr><td><code>lte(left, n)</code></td><td><code>(left: Expr, n: number) => Expr</code></td><td><code>left &#x3C;= n</code></td></tr><tr><td><code>AUTH_UID</code></td><td><code>Segment</code> constant <code>{ $: 'auth.uid' }</code></td><td>an unquoted comparison value or path segment</td></tr></tbody></table></div>
+<p><code>eq</code>/<code>neq</code> format the right side by type: strings are quoted, numbers and booleans are literal, <code>null</code> is <code>null</code>, and a <code>{ $: ... }</code> segment is inserted unquoted (so <code>eq(newDataVal('host'), AUTH_UID)</code> produces <code>newData.child("host").val() === auth.uid</code>).</p>
+<h2 id="game-primitives">Game primitives</h2>
+<p>These are first-class exports, pinned by spec tests, and the deployed tic-tac-toe ruleset is built on them.</p>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Semantics</th></tr></thead><tbody><tr><td><code>turnGuard(turnField, players, statusField?, playingValue?)</code></td><td><code>(turnField: string, players: Record&#x3C;string, string>, statusField?: string, playingValue?: string) => Expr</code></td><td>write guard: for each mark, the stored turn equals the mark AND the stored player field equals <code>auth.uid</code>; optionally AND-ed with a status check. Reads <code>data</code> (pre-write state) throughout, never <code>newData</code>, so a writer cannot hand themselves the turn</td></tr><tr><td><code>flip(marks)</code></td><td><code>(marks: string[]) => Expr</code></td><td>validate for the turn field: creation sets the first mark, then circular rotation (X to O to X; supports 2 or more marks)</td></tr><tr><td><code>winCheckHelper(mark, lines, boardPath?)</code></td><td><code>(mark: string, lines: number[][], boardPath = 'board') => Expr</code></td><td>validate for a boolean claim field: <code>true</code> requires some line of board cells to all equal the mark, <code>false</code> requires no such line. The client claims, the rules verify</td></tr></tbody></table></div>
+<h2 id="schema">Schema</h2>
+<div class="table-scroll">
+<table><thead><tr><th>Export</th><th>Signature</th><th>Semantics</th></tr></thead><tbody><tr><td><code>schemaRules(schema, fieldConstraints?)</code></td><td><code>(schema: z.ZodObject, fieldConstraints?: Record&#x3C;string, Expr[]>) => SchemaRulesResult</code></td><td>parent <code>.validate</code> requires children plus every non-optional key; each field gets a child <code>.validate</code> from its Zod type; <code>fieldConstraints[key]</code> is AND-merged with the type check</td></tr></tbody></table></div>
+<p>Supported Zod types: <code>string</code>, <code>number</code>, <code>boolean</code>, <code>enum</code>, <code>literal</code> (string, number, boolean), unions of supported types, nested objects (recursive), and <code>.optional()</code> (unwrapped, excluded from required). Anything else (arrays, dates, records) throws <code>Unsupported Zod type</code>, which <code>check()</code> surfaces as a <code>COMPILE_ERROR</code> finding.</p>
+<h2 id="assembly">Assembly</h2>
+<h3 id="definertdbrulesdefinition"><code>defineRtdbRules(definition)</code></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"> defineRtdbRules</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">definition</span><span style="color:#ABB2BF">: {</span></span>
+<span class="line"><span style="color:#E06C75">  paths</span><span style="color:#ABB2BF">: </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">PathDef</span><span style="color:#ABB2BF">> | ((</span><span style="color:#E06C75;font-style:italic">ctx</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">RulesetContext</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:#ABB2BF">}): </span><span style="color:#E5C07B">RtdbRulesDocument</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>The authoring entry, and the one to reach for first. The returned
+<code>RtdbRulesDocument</code> is an inert authored artifact: on the public surface it
+exposes no methods. Pass it to <code>rtdbRules()</code> for everything analytical:</p>
+<div class="table-scroll">
+<table><thead><tr><th>Call</th><th>Returns</th><th>Notes</th></tr></thead><tbody><tr><td><code>rtdbRules(doc).lint()</code></td><td><code>RuleIssue[]</code></td><td>parser errors and lint warnings (for example <code>LOOSE_EQUALITY</code> for <code>==</code>), per node and rule; a compile throw surfaces as one <code>COMPILE_ERROR</code> issue</td></tr><tr><td><code>rtdbRules(doc).simulate(cases)</code></td><td><code>{ passed, failed, unsupported, cases }</code></td><td>in-process verdicts for a list of <code>RtdbCase</code>s</td></tr><tr><td><code>rtdbRules(doc).explain(oneCase)</code></td><td><code>RtdbExplanation</code></td><td>the structured account of one case</td></tr><tr><td><code>rtdbRules(doc).toJSON()</code></td><td><code>{ rules: {...} }</code></td><td>Firebase rules JSON; raw <code>'true'</code>/<code>'false'</code> become JSON booleans</td></tr></tbody></table></div>
+<p>Case conveniences: <code>auth: 'alice'</code> normalizes to <code>{ uid: 'alice', token: {} }</code>.</p>
+<p>There is no <code>databaseUrl</code> on the definition — compilation is
+environment-independent. The method-bearing document interface (with
+<code>compile</code>/<code>check</code>/<code>simulate</code> on the document itself) is internal, on
+<code>pyric/rules/internal/rtdb</code>.</p>
+<h3 id="rulesetinput"><code>ruleset(input)</code></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"> ruleset</span><span style="color:#ABB2BF">(</span></span>
+<span class="line"><span style="color:#E06C75;font-style:italic">  input</span><span style="color:#ABB2BF">: </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">PathDef</span><span style="color:#ABB2BF">> | ((</span><span style="color:#E06C75;font-style:italic">ctx</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">RulesetContext</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:#ABB2BF">): </span><span style="color:#E5C07B">CompiledRtdbRules</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>The raw compiled-tree builder underneath <code>defineRtdbRules</code>. Same path inputs,
+no document wrapper. Returns <code>CompiledRtdbRules</code> (the <code>RtdbNode</code> root), not a
+project-scoped IR.</p>
+<h3 id="pathdef"><code>PathDef</code></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">interface</span><span style="color:#E5C07B"> PathDef</span><span style="color:#ABB2BF"> {</span></span>
+<span class="line"><span style="color:#E06C75">  read</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Expr</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  write</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Expr</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  validate</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Expr</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#E06C75">  schema</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">z</span><span style="color:#ABB2BF">.</span><span style="color:#E5C07B">ZodObject</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">z</span><span style="color:#ABB2BF">.</span><span style="color:#E5C07B">ZodRawShape</span><span style="color:#ABB2BF">>;</span></span>
+<span class="line"><span style="color:#E06C75">  fieldConstraints</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </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">Expr</span><span style="color:#ABB2BF">[]>;</span></span>
+<span class="line"><span style="color:#E06C75">  indexOn</span><span style="color:#C678DD">?</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">  children</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </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">PathDef</span><span style="color:#ABB2BF">>;</span></span>
+<span class="line"><span style="color:#ABB2BF">}</span></span></code></pre>
+<p>Placement semantics worth knowing:</p>
+<ul>
+<li>Path keys are literal strings with <code>$wildcards</code> as segments (<code>'/games/$gameId'</code>); every <code>$segment</code> becomes a path variable in scope for expression validation.</li>
+<li><code>children</code> keys are path suffixes (<code>'/comments/$commentId'</code>) concatenated onto the parent path.</li>
+<li>An explicit <code>validate</code> wins over the schema-derived parent validate; the schema’s per-field validates still apply.</li>
+<li><code>indexOn</code> on a path that ends in a <code>$wildcard</code> is hoisted to the parent container node (<code>'/posts/$postId'</code> places <code>.indexOn</code> on <code>posts</code>). On a non-wildcard path it is silently dropped, so put it on the wildcard path.</li>
+<li>Every expression is parsed, validated, and linted at build time; findings attach to the compiled tree and surface through <code>rtdbRules(doc).lint()</code>.</li>
+</ul>
+<h2 id="deployment-boundary">Deployment boundary</h2>
+<p>Constraint helpers compile locally and never contact production. Ship the
+result with <code>firebase-tools</code> / Console (<code>firebase deploy --only database</code>).</p>
+<h2 id="exported-types">Exported types</h2>
+<p><code>Expr</code>, <code>Segment</code>, <code>PathDef</code>, <code>RulesetContext</code>, <code>SchemaRulesResult</code>, <code>RtdbRulesDocument</code>, <code>RtdbRulesDefinition</code>, <code>RtdbRulesCheckResult</code>, <code>RtdbRulesFinding</code>, <code>RtdbRulesFindingRule</code> (<code>'.read' | '.write' | '.validate' | 'ruleset'</code>), <code>RtdbRulesJson</code>, <code>RtdbRulesSimulationAuth</code>, <code>RtdbRulesSimulationInput</code>, <code>CompiledRtdbRules</code>.</p>
+<h2 id="boundaries">Boundaries</h2>
+<ul>
+<li><code>winCheckHelper</code>’s full expression is verified by parse and substring checks rather than a byte-level snapshot.</li>
+<li>A <code>PathDef</code> whose node cannot be found during assembly is skipped without error.</li>
+<li><code>schemaRules</code> with nested optional objects is untested territory.</li>
+</ul>
+<p>See <a href="../pyric-database-reference-rules-tooling/">rules-tooling.md</a> for the parser, linter, simulator internals, and tool factories, and the <a href="../pyric-database-tutorials-01-author-rtdb-rules-with-constraints/">authoring tutorial</a> for the guided path.</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="#combinators">Combinators</a> </li><li data-depth="2"> <a href="#atoms">Atoms</a> </li><li data-depth="2"> <a href="#policies-composed-atoms">Policies (composed atoms)</a> </li><li data-depth="2"> <a href="#data-helpers">Data helpers</a> </li><li data-depth="2"> <a href="#game-primitives">Game primitives</a> </li><li data-depth="2"> <a href="#schema">Schema</a> </li><li data-depth="2"> <a href="#assembly">Assembly</a> </li><li data-depth="3"> <a href="#definertdbrulesdefinition">defineRtdbRules(definition)</a> </li><li data-depth="3"> <a href="#rulesetinput">ruleset(input)</a> </li><li data-depth="3"> <a href="#pathdef">PathDef</a> </li><li data-depth="2"> <a href="#deployment-boundary">Deployment boundary</a> </li><li data-depth="2"> <a href="#exported-types">Exported types</a> </li><li data-depth="2"> <a href="#boundaries">Boundaries</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>