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-messaging-reference-api/index.html ADDED Viewed

@@ -0,0 +1,508 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>API reference: pyric/messaging · Pyric Studio</title><meta name="description" content="Published declarations for pyric/messaging."><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/"> 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/" aria-current="true"> 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/"> 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/" aria-current="true"> 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/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>pyric</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">pyric/messaging</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>pyric/messaging</code></h1> <p class="api-reference-meta"> 17 published symbols from <code>pyric</code> </p> <p class="api-reference-source">
+Generated from the TypeScript declarations shipped at this import path.
+</p> <a class="api-reference-evidence" href="/__pyric/ui/docs/pyric-messaging-compat/">
+Check behavioral conformance
+</a> </header> <article class="prose api-reference-body">  <!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+<h2 id="interfaces">Interfaces</h2>
+<p><a id="deliverspec"></a></p>
+<h3 id="deliverspec">DeliverSpec</h3>
+<h4 id="properties">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><a id="data"></a> <code>data?</code></td><td align="left"><code>Record</code>&#x3C;<code>string</code>, <code>string</code>></td><td align="left">-</td></tr><tr><td align="left"><a id="from"></a> <code>from?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="messageid"></a> <code>messageId?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="notification"></a> <code>notification?</code></td><td align="left">{ <code>body?</code>: <code>string</code>; <code>image?</code>: <code>string</code>; <code>title?</code>: <code>string</code>; }</td><td align="left">-</td></tr><tr><td align="left"><code>notification.body?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><code>notification.image?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><code>notification.title?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr><tr><td align="left"><a id="visibilitystate"></a> <code>visibilityState?</code></td><td align="left"><code>"visible"</code> | <code>"hidden"</code></td><td align="left">Simulated visibility of the (single) window client at delivery time.</td></tr></tbody></table></div>
+<hr>
+<p><a id="deliveryresult"></a></p>
+<h3 id="deliveryresult">DeliveryResult</h3>
+<h4 id="properties-1">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><a id="handlercount"></a> <code>handlerCount</code></td><td align="left"><code>number</code></td><td align="left">Handlers actually invoked on the chosen route.</td></tr><tr><td align="left"><a id="payload"></a> <code>payload</code></td><td align="left"><code>DeliveredPayload</code></td><td align="left">-</td></tr><tr><td align="left"><a id="route"></a> <code>route</code></td><td align="left"><code>DeliveryRoute</code></td><td align="left">-</td></tr></tbody></table></div>
+<hr>
+<p><a id="fcmoptions"></a></p>
+<h3 id="fcmoptions">FcmOptions</h3>
+<p>Options carried on a client <a href="#messagepayload">MessagePayload</a>.</p>
+<h4 id="properties-2">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="analyticslabel"></a> <code>analyticsLabel?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="link"></a> <code>link?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="gettokenoptions"></a></p>
+<h3 id="gettokenoptions">GetTokenOptions</h3>
+<p>Options for <a href="#gettoken">getToken</a>.</p>
+<h4 id="properties-3">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><a id="serviceworkerregistration"></a> <code>serviceWorkerRegistration?</code></td><td align="left"><code>object</code></td><td align="left">A (simulated) service-worker registration; token stability keys on its identity.</td></tr><tr><td align="left"><a id="vapidkey"></a> <code>vapidKey?</code></td><td align="left"><code>string</code></td><td align="left">-</td></tr></tbody></table></div>
+<hr>
+<p><a id="messagepayload"></a></p>
+<h3 id="messagepayload">MessagePayload</h3>
+<p>Received message envelope delivered to <code>onMessage</code> / <code>onBackgroundMessage</code>.
+<code>from</code> / <code>collapseKey</code> / <code>messageId</code> are typed required (upstream parity);
+captured production deliveries carry top-level keys
+<code>data</code> / <code>from</code> / <code>messageId</code> (+ <code>notification</code>) — <code>collapseKey</code> was not
+observed on the wire and the sandbox likewise omits it at runtime.</p>
+<h4 id="properties-4">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="collapsekey"></a> <code>collapseKey</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="data-1"></a> <code>data?</code></td><td align="left">{ [<code>key</code>: <code>string</code>]: <code>string</code>; }</td></tr><tr><td align="left"><a id="fcmoptions-1"></a> <code>fcmOptions?</code></td><td align="left"><a href="#fcmoptions"><code>FcmOptions</code></a></td></tr><tr><td align="left"><a id="from-1"></a> <code>from</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="messageid-1"></a> <code>messageId</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="notification-1"></a> <code>notification?</code></td><td align="left"><a href="#notificationpayload"><code>NotificationPayload</code></a></td></tr></tbody></table></div>
+<hr>
+<p><a id="messaging"></a></p>
+<h3 id="messaging">Messaging</h3>
+<p>The FCM <code>Messaging</code> instance mirror — exposes the bound app as <code>app</code>
+(upstream <code>@firebase/messaging</code> public-types parity).</p>
+<h4 id="properties-5">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="app"></a> <code>app</code></td><td align="left"><code>readonly</code></td><td align="left"><code>FirebaseApp</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="notificationpayload"></a></p>
+<h3 id="notificationpayload">NotificationPayload</h3>
+<p>Display-notification block inside a <a href="#messagepayload">MessagePayload</a>.</p>
+<h4 id="properties-6">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="body"></a> <code>body?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="icon"></a> <code>icon?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="image"></a> <code>image?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="title"></a> <code>title?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<hr>
+<p><a id="observer"></a></p>
+<h3 id="observer">Observer</h3>
+<h4 id="type-parameters">Type Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Type Parameter</th></tr></thead><tbody><tr><td align="left"><code>T</code></td></tr></tbody></table></div>
+<h4 id="properties-7">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="complete"></a> <code>complete</code></td><td align="left">() => <code>void</code></td></tr><tr><td align="left"><a id="error"></a> <code>error</code></td><td align="left">(<code>error</code>: <code>Error</code>) => <code>void</code></td></tr><tr><td align="left"><a id="next"></a> <code>next</code></td><td align="left"><a href="#nextfn"><code>NextFn</code></a>&#x3C;<code>T</code>></td></tr></tbody></table></div>
+<hr>
+<p><a id="simulatedserviceworkerregistration"></a></p>
+<h3 id="simulatedserviceworkerregistration">SimulatedServiceWorkerRegistration</h3>
+<p>Minimal structural stand-in for a <code>ServiceWorkerRegistration</code> in the
+headless sandbox (bun has no DOM lib). Identity is what matters: token
+stability is keyed per registration object.</p>
+<h4 id="properties-8">Properties</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Property</th><th align="left">Modifier</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="active"></a> <code>active</code></td><td align="left"><code>readonly</code></td><td align="left">{ <code>state</code>: <code>"activated"</code>; }</td></tr><tr><td align="left"><code>active.state</code></td><td align="left"><code>readonly</code></td><td align="left"><code>"activated"</code></td></tr><tr><td align="left"><a id="scope"></a> <code>scope</code></td><td align="left"><code>readonly</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
+<h2 id="type-aliases">Type Aliases</h2>
+<p><a id="nextfn"></a></p>
+<h3 id="nextfn">NextFn()</h3>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> NextFn</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">T</span><span style="color:#ABB2BF">> </span><span style="color:#56B6C2">=</span><span style="color:#ABB2BF"> (</span><span style="color:#E06C75;font-style:italic">value</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">T</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Callback / observer / teardown shapes — structurally identical to the
+<code>@firebase/util</code> types the upstream entry re-exports (declared locally
+because <code>@firebase/util</code> is not a direct dependency of <code>pyric</code>; the
+tier-2 assignability census closes exact type parity).</p>
+<h4 id="type-parameters-1">Type Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Type Parameter</th></tr></thead><tbody><tr><td align="left"><code>T</code></td></tr></tbody></table></div>
+<h4 id="parameters">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>value</code></td><td align="left"><code>T</code></td></tr></tbody></table></div>
+<h4 id="returns">Returns</h4>
+<p><code>void</code></p>
+<hr>
+<p><a id="unsubscribe"></a></p>
+<h3 id="unsubscribe">Unsubscribe()</h3>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">type</span><span style="color:#E5C07B"> Unsubscribe</span><span style="color:#56B6C2"> =</span><span style="color:#ABB2BF"> () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<h4 id="returns-1">Returns</h4>
+<p><code>void</code></p>
+<h2 id="variables">Variables</h2>
+<p><a id="sandbox"></a></p>
+<h3 id="sandbox">sandbox</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">const</span><span style="color:#E5C07B"> sandbox</span><span style="color:#ABB2BF">: {</span></span>
+<span class="line"><span style="color:#E06C75">  deliver</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">DeliveryResult</span><span style="color:#ABB2BF">>;</span></span>
+<span class="line"><span style="color:#E06C75">  registration</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">SimulatedServiceWorkerRegistration</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#ABB2BF">};</span></span></code></pre>
+<h4 id="type-declaration">Type Declaration</h4>
+<p><a id="deliver"></a></p>
+<h5 id="deliver">deliver()</h5>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#61AFEF">deliver</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">messaging</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">Messaging</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">spec</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">DeliverSpec</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2">&#x3C;</span><span style="color:#E06C75">DeliveryResult</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Inject a delivery into the client plane, optionally setting the
+simulated window client’s visibility first. Routes through the broker’s
+captured visibility rule, so a <code>visible</code> spec lands on <code>onMessage</code>
+handlers and a <code>hidden</code> spec on <code>onBackgroundMessage</code> handlers.</p>
+<h6 id="parameters-1">Parameters</h6>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>messaging</code></td><td align="left"><a href="#messaging"><code>Messaging</code></a></td></tr><tr><td align="left"><code>spec</code></td><td align="left"><a href="#deliverspec"><code>DeliverSpec</code></a></td></tr></tbody></table></div>
+<h6 id="returns-2">Returns</h6>
+<p><code>Promise</code>&#x3C;<a href="#deliveryresult"><code>DeliveryResult</code></a>></p>
+<p><a id="registration"></a></p>
+<h5 id="registration">registration()</h5>
+<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#61AFEF">registration</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">SimulatedServiceWorkerRegistration</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>The module-default simulated service-worker registration.</p>
+<h6 id="returns-3">Returns</h6>
+<p><a href="#simulatedserviceworkerregistration"><code>SimulatedServiceWorkerRegistration</code></a></p>
+<h2 id="functions">Functions</h2>
+<p><a id="deletetoken"></a></p>
+<h3 id="deletetoken">deleteToken()</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"> deleteToken</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">messaging</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Messaging</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">boolean</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Delete the active registration token. Resolves truthy; afterwards no
+message reaches the client on either route and a send to the dead token
+surfaces the captured UNREGISTERED envelope on the send plane
+(oracle: <code>messaging-web-deletetoken-unregistered</code>).</p>
+<h4 id="parameters-2">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>messaging</code></td><td align="left"><a href="#messaging"><code>Messaging</code></a></td></tr></tbody></table></div>
+<h4 id="returns-4">Returns</h4>
+<p><code>Promise</code>&#x3C;<code>boolean</code>></p>
+<hr>
+<p><a id="getmessaging"></a></p>
+<h3 id="getmessaging">getMessaging()</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"> getMessaging</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">app</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">FirebaseApp</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Messaging</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Return the FCM <code>Messaging</code> instance for the given (or default) app —
+window-client plane (upstream component name <code>messaging</code>).</p>
+<h4 id="parameters-3">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>app?</code></td><td align="left"><code>FirebaseApp</code></td></tr></tbody></table></div>
+<h4 id="returns-5">Returns</h4>
+<p><a href="#messaging"><code>Messaging</code></a></p>
+<hr>
+<p><a id="gettoken"></a></p>
+<h3 id="gettoken">getToken()</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"> getToken</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">messaging</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Messaging</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">options</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">GetTokenOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Subscribe the instance to push and resolve its registration token.
+Sandbox semantics per the captured contract: the minted token matches the
+production shape class (142 chars, colon-separated, URL-safe, <code>APA91b</code>
+suffix class) and is STABLE across repeated calls on the same
+(simulated) service-worker registration — no per-call rotation.
+Notification permission is modeled as granted in the sandbox.</p>
+<h4 id="parameters-4">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>messaging</code></td><td align="left"><a href="#messaging"><code>Messaging</code></a></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><a href="#gettokenoptions"><code>GetTokenOptions</code></a></td></tr></tbody></table></div>
+<h4 id="returns-6">Returns</h4>
+<p><code>Promise</code>&#x3C;<code>string</code>></p>
+<hr>
+<p><a id="issupported"></a></p>
+<h3 id="issupported">isSupported()</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"> isSupported</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">boolean</span><span style="color:#ABB2BF">>;</span></span></code></pre>
+<p>Whether every API FCM requires exists here — always true in the sandbox.</p>
+<h4 id="returns-7">Returns</h4>
+<p><code>Promise</code>&#x3C;<code>boolean</code>></p>
+<hr>
+<p><a id="onmessage"></a></p>
+<h3 id="onmessage">onMessage()</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"> onMessage</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">messaging</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Messaging</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">nextOrObserver</span><span style="color:#ABB2BF">:</span></span>
+<span class="line"><span style="color:#ABB2BF">  | </span><span style="color:#E5C07B">NextFn</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">MessagePayload</span><span style="color:#ABB2BF">></span></span>
+<span class="line"><span style="color:#ABB2BF">  | </span><span style="color:#E5C07B">Observer</span><span style="color:#ABB2BF">&#x3C;</span><span style="color:#E5C07B">MessagePayload</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
+<p>Listen for messages delivered while a window client is VISIBLE — routing
+keys on visibility, never focus (oracle: <code>messaging-web-visibility-routing</code>).</p>
+<h4 id="parameters-5">Parameters</h4>
+<div class="table-scroll">
+<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>messaging</code></td><td align="left"><a href="#messaging"><code>Messaging</code></a></td></tr><tr><td align="left"><code>nextOrObserver</code></td><td align="left">| <a href="#nextfn"><code>NextFn</code></a>&#x3C;<a href="#messagepayload"><code>MessagePayload</code></a>> | <a href="#observer"><code>Observer</code></a>&#x3C;<a href="#messagepayload"><code>MessagePayload</code></a>></td></tr></tbody></table></div>
+<h4 id="returns-8">Returns</h4>
+<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>  </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols"> <h2 class="doc-toc-heading">Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter> <div class="api-symbol-groups" data-api-symbol-groups> <section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#interfaces"> Interfaces </a> <ul> <li data-api-symbol="deliverspec"> <a href="#deliverspec">DeliverSpec</a> </li><li data-api-symbol="deliveryresult"> <a href="#deliveryresult">DeliveryResult</a> </li><li data-api-symbol="fcmoptions"> <a href="#fcmoptions">FcmOptions</a> </li><li data-api-symbol="gettokenoptions"> <a href="#gettokenoptions">GetTokenOptions</a> </li><li data-api-symbol="messagepayload"> <a href="#messagepayload">MessagePayload</a> </li><li data-api-symbol="messaging"> <a href="#messaging">Messaging</a> </li><li data-api-symbol="notificationpayload"> <a href="#notificationpayload">NotificationPayload</a> </li><li data-api-symbol="observer"> <a href="#observer">Observer</a> </li><li data-api-symbol="simulatedserviceworkerregistration"> <a href="#simulatedserviceworkerregistration">SimulatedServiceWorkerRegistration</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#type-aliases"> Type Aliases </a> <ul> <li data-api-symbol="nextfn()"> <a href="#nextfn">NextFn()</a> </li><li data-api-symbol="unsubscribe()"> <a href="#unsubscribe">Unsubscribe()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#variables"> Variables </a> <ul> <li data-api-symbol="sandbox"> <a href="#sandbox">sandbox</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#functions"> Functions </a> <ul> <li data-api-symbol="deletetoken()"> <a href="#deletetoken">deleteToken()</a> </li><li data-api-symbol="getmessaging()"> <a href="#getmessaging">getMessaging()</a> </li><li data-api-symbol="gettoken()"> <a href="#gettoken">getToken()</a> </li><li data-api-symbol="issupported()"> <a href="#issupported">isSupported()</a> </li><li data-api-symbol="onmessage()"> <a href="#onmessage">onMessage()</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden>No matching symbols</p> </div> </aside> </div> <script type="module">const a=document.querySelector("[data-api-symbol-filter]"),d=[...document.querySelectorAll("[data-api-symbol-group]")],n=document.querySelector("[data-api-symbol-empty]");a?.addEventListener("input",()=>{const t=a.value.trim().toLowerCase();let o=0;for(const i of d){let e=0;i.querySelectorAll("[data-api-symbol]").forEach(l=>{const r=!t||(l.dataset.apiSymbol??"").includes(t);l.hidden=!r,r&&e++}),i.hidden=e===0,o+=e}n&&(n.hidden=o>0)});</script> <script type="module">const s=new Map;document.querySelectorAll('.doc-toc a[href^="#"]').forEach(t=>s.set(decodeURIComponent(t.hash.slice(1)),t));if(s.size>0){const t=new Set,n=()=>{let o=null;for(const e of s.keys())if(t.has(e)){o=e;break}s.forEach((e,c)=>e.classList.toggle("active",c===o))},r=new IntersectionObserver(o=>{for(const e of o)e.isIntersecting?t.add(e.target.id):t.delete(e.target.id);n()},{rootMargin:"-72px 0px -60% 0px"});s.forEach((o,e)=>{const c=document.getElementById(e);c&&r.observe(c)})}</script> <script type="module">document.querySelector('.studio__nav [aria-current="page"]')?.scrollIntoView({block:"nearest",inline:"center"});</script> </body> </html>