@pyric/cli 0.1.0-alpha.9

package/dist/serve/docs-ui/docs/pyric-app-reference-api.md

@@ -0,0 +1,326 @@
+
+<!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+
+## Classes
+
+<a id="firebaseerror"></a>
+
+### FirebaseError
+
+Firebase-shaped error primitive shared by the sandbox client mirrors.
+
+It lives below every service surface so mirrors can preserve cross-service
+`instanceof FirebaseError` identity without depending on the app composition
+root or loading the production SDK.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+<a id="constructor"></a>
+
+##### Constructor
+
+```ts
+new FirebaseError(
+   code: string,
+   message: string,
+   customData?: Record<string, unknown>): FirebaseError;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `code` | `string` |
+| `message` | `string` |
+| `customData?` | `Record`\<`string`, `unknown`\> |
+
+###### Returns
+
+[`FirebaseError`](#firebaseerror)
+
+###### Overrides
+
+```ts
+Error.constructor
+```
+
+#### Properties
+
+| Property | Modifier | Type | Default value | Overrides |
+| :------ | :------ | :------ | :------ | :------ |
+| <a id="code"></a> `code` | `readonly` | `string` | `undefined` | - |
+| <a id="customdata"></a> `customData?` | `readonly` | `Record`\<`string`, `unknown`\> | `undefined` | - |
+| <a id="name"></a> `name` | `readonly` | `"FirebaseError"` | `"FirebaseError"` | `Error.name` |
+
+## Interfaces
+
+<a id="firebaseapp"></a>
+
+### FirebaseApp
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="automaticdatacollectionenabled"></a> `automaticDataCollectionEnabled` | `public` | `boolean` |
+| <a id="name-1"></a> `name` | `readonly` | `string` |
+| <a id="options"></a> `options` | `readonly` | [`FirebaseOptions`](#firebaseoptions) |
+
+***
+
+<a id="firebaseappsettings"></a>
+
+### FirebaseAppSettings
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="automaticdatacollectionenabled-1"></a> `automaticDataCollectionEnabled?` | `boolean` |
+| <a id="name-2"></a> `name?` | `string` |
+
+***
+
+<a id="firebaseoptions"></a>
+
+### FirebaseOptions
+
+Firebase-compatible public value types for `pyric/app`.
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="apikey"></a> `apiKey?` | `string` |
+| <a id="appid"></a> `appId?` | `string` |
+| <a id="authdomain"></a> `authDomain?` | `string` |
+| <a id="databaseurl"></a> `databaseURL?` | `string` |
+| <a id="measurementid"></a> `measurementId?` | `string` |
+| <a id="messagingsenderid"></a> `messagingSenderId?` | `string` |
+| <a id="projectid"></a> `projectId?` | `string` |
+| <a id="storagebucket"></a> `storageBucket?` | `string` |
+
+***
+
+<a id="logentry"></a>
+
+### LogEntry
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="args"></a> `args` | `unknown`[] |
+| <a id="level"></a> `level` | [`LogLevel`](#loglevel) |
+| <a id="message"></a> `message` | `string` |
+| <a id="type"></a> `type` | `string` |
+
+***
+
+<a id="logoptions"></a>
+
+### LogOptions
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="level-1"></a> `level` | [`LogLevel`](#loglevel) |
+
+## Type Aliases
+
+<a id="logcallback"></a>
+
+### LogCallback()
+
+```ts
+type LogCallback = (entry: LogEntry) => void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `entry` | [`LogEntry`](#logentry) |
+
+#### Returns
+
+`void`
+
+***
+
+<a id="loglevel"></a>
+
+### LogLevel
+
+```ts
+type LogLevel = "debug" | "verbose" | "info" | "warn" | "error" | "silent";
+```
+
+## Variables
+
+<a id="sdk_version"></a>
+
+### SDK\_VERSION
+
+```ts
+const SDK_VERSION: "12.13.0" = "12.13.0";
+```
+
+Firebase JS SDK version whose public app behavior the current oracle records.
+The app conformance replay makes this pin fail visibly when observations move.
+
+## Functions
+
+<a id="deleteapp"></a>
+
+### deleteApp()
+
+```ts
+function deleteApp(app: FirebaseApp): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app` | [`FirebaseApp`](#firebaseapp) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+<a id="getapp"></a>
+
+### getApp()
+
+```ts
+function getApp(name?: string): FirebaseApp;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `name?` | `string` |
+
+#### Returns
+
+[`FirebaseApp`](#firebaseapp)
+
+***
+
+<a id="getapps"></a>
+
+### getApps()
+
+```ts
+function getApps(): FirebaseApp[];
+```
+
+#### Returns
+
+[`FirebaseApp`](#firebaseapp)[]
+
+***
+
+<a id="initializeapp"></a>
+
+### initializeApp()
+
+```ts
+function initializeApp(options?: FirebaseOptions, rawSettings?: string | FirebaseAppSettings): FirebaseApp;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `options?` | [`FirebaseOptions`](#firebaseoptions) |
+| `rawSettings?` | `string` \| [`FirebaseAppSettings`](#firebaseappsettings) |
+
+#### Returns
+
+[`FirebaseApp`](#firebaseapp)
+
+***
+
+<a id="onlog"></a>
+
+### onLog()
+
+```ts
+function onLog(callback: LogCallback, options?: LogOptions): void;
+```
+
+Register or clear the process-wide app diagnostic handler.
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `callback` | [`LogCallback`](#logcallback) |
+| `options?` | [`LogOptions`](#logoptions) |
+
+#### Returns
+
+`void`
+
+***
+
+<a id="registerversion"></a>
+
+### registerVersion()
+
+```ts
+function registerVersion(
+   libraryKeyOrName: string,
+   version: string,
+   variant?: string): void;
+```
+
+Validate a platform-logger version registration.
+
+A sandbox has no production component container, so valid registrations
+need no retained component. Invalid registrations still emit the exact
+diagnostic warning consumers can observe from Firebase.
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `libraryKeyOrName` | `string` |
+| `version` | `string` |
+| `variant?` | `string` |
+
+#### Returns
+
+`void`
+
+***
+
+<a id="setloglevel"></a>
+
+### setLogLevel()
+
+```ts
+function setLogLevel(level: LogLevel): void;
+```
+
+Set the threshold used by the app diagnostics logger.
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `level` | [`LogLevel`](#loglevel) |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,59 @@
+<!DOCTYPE html><html lang="en"> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>pyric/auth · 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/" aria-current="true"> 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/"> 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/" aria-current="true"> 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-auth/">pyric / auth</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="pyricauth"><code>pyric/auth</code></h1>
+<p>Sandbox-only modular Web SDK Auth mirror. It implements <code>firebase/auth</code>’s tree-shakable shape (<code>getAuth</code>, <code>signInAnonymously</code>, <code>signInWithEmailAndPassword</code>, <code>onAuthStateChanged</code>, <code>signInWithPopup</code>, <code>GoogleAuthProvider</code>) in process, with no network.</p>
+<p>Application code keeps canonical <code>firebase/auth</code> imports. Pyric’s Vite/import-map or Node register boundary swaps those imports to this mirror in sandbox mode; production installs no swap and continues loading Firebase itself. Direct <code>pyric/auth</code> imports always select sandbox behavior.</p>
+<h2 id="install">Install</h2>
+<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:#61AFEF">bun</span><span style="color:#98C379"> add</span><span style="color:#98C379"> pyric</span><span style="color:#98C379"> firebase</span></span></code></pre>
+<p><code>firebase</code> supplies the canonical production package. It is not a runtime dependency of the <code>pyric/auth</code> mirror.</p>
+<h2 id="a-30-second-example">A 30-second example</h2>
+<p>Sandbox backend:</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">initializeSandbox</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric/sandbox'</span><span style="color:#ABB2BF">;</span></span>
+<span class="line"><span style="color:#C678DD">import</span><span style="color:#ABB2BF"> { </span><span style="color:#E06C75">getAuth</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">signInWithEmailAndPassword</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">onAuthStateChanged</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">sandbox</span><span style="color:#C678DD"> as</span><span style="color:#E06C75"> authSandbox</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'pyric/auth'</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"> auth</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> getAuth</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">sandbox</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#E5C07B">authSandbox</span><span style="color:#ABB2BF">.</span><span style="color:#61AFEF">seedUsers</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">auth</span><span style="color:#ABB2BF">, [</span></span>
+<span class="line"><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 style="color:#E06C75">email</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'alice@example.com'</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">password</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'pw'</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">customClaims</span><span style="color:#ABB2BF">: { </span><span style="color:#E06C75">role</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">'admin'</span><span style="color:#ABB2BF"> } },</span></span>
+<span class="line"><span style="color:#ABB2BF">]);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#61AFEF">onAuthStateChanged</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">auth</span><span style="color:#ABB2BF">, (</span><span style="color:#E06C75;font-style:italic">user</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></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:#98C379">'current user:'</span><span style="color:#ABB2BF">, </span><span style="color:#E5C07B">user</span><span style="color:#ABB2BF">?.</span><span style="color:#E06C75">uid</span><span style="color:#56B6C2"> ??</span><span style="color:#98C379"> '(signed out)'</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"><span style="color:#ABB2BF">});</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> signInWithEmailAndPassword</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">auth</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'alice@example.com'</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'pw'</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:#E5C07B">auth</span><span style="color:#ABB2BF">.</span><span style="color:#E5C07B">currentUser</span><span style="color:#ABB2BF">?.</span><span style="color:#E06C75">uid</span><span style="color:#ABB2BF">); </span><span style="color:#7F848E;font-style:italic">// 'alice'</span></span></code></pre>
+<p>Production uses the canonical package without a Pyric swap:</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">getAuth</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">signInWithEmailAndPassword</span><span style="color:#ABB2BF"> } </span><span style="color:#C678DD">from</span><span style="color:#98C379"> 'firebase/auth'</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:#7F848E;font-style:italic">/* your Firebase config */</span><span style="color:#ABB2BF"> });</span></span>
+<span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> auth</span><span style="color:#56B6C2"> =</span><span style="color:#61AFEF"> getAuth</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">app</span><span style="color:#ABB2BF">);</span></span>
+<span class="line"></span>
+<span class="line"><span style="color:#C678DD">await</span><span style="color:#61AFEF"> signInWithEmailAndPassword</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">auth</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'alice@example.com'</span><span style="color:#ABB2BF">, </span><span style="color:#98C379">'pw'</span><span style="color:#ABB2BF">);</span></span></code></pre>
+<h2 id="whats-in-v0">What’s in v0</h2>
+<p>The deliberately-minimal surface covers everything an <code>appSource</code> likely needs:</p>
+<ul>
+<li><code>getAuth(target)</code>: default <code>FirebaseApp</code>, explicit <code>FirebaseApp</code>, and direct <code>Sandbox</code> overloads</li>
+<li><code>connectAuthEmulator(auth, url, options?)</code>: accepted no-op because the mirror is already a sandbox</li>
+<li><code>signInAnonymously</code> / <code>signInWithEmailAndPassword</code> / <code>createUserWithEmailAndPassword</code> / <code>signOut</code></li>
+<li><code>signInWithPopup(auth, provider)</code> / <code>signInWithCredential(auth, credential)</code>: sandbox returns pre-staged mock results</li>
+<li><code>setPersistence</code> + <code>inMemoryPersistence</code> / <code>browserSessionPersistence</code> / <code>browserLocalPersistence</code></li>
+<li><code>onAuthStateChanged</code> / <code>onIdTokenChanged</code></li>
+<li>Provider classes: <code>GoogleAuthProvider</code>, <code>EmailAuthProvider</code>, <code>FacebookAuthProvider</code>, <code>GithubAuthProvider</code>, <code>OAuthProvider</code></li>
+<li>Sandbox-only test driver: <code>sandbox.setUser</code>, <code>sandbox.mockSignInResult</code>, <code>sandbox.seedUsers</code></li>
+</ul>
+<p>See <a href="../pyric-auth-reference-feature-matrix/"><code>docs/reference/feature-matrix.md</code></a> for the full feature matrix and the explicit v0 deny-list.</p>
+<h2 id="whats-out-v0">What’s out (v0)</h2>
+<p>Unsupported symbols fail to resolve only in sandbox builds where package resolution selects this mirror. Production remains on the complete <code>firebase/auth</code> package. The current list is maintained in the feature matrix.</p>
+<h2 id="state-model-sandbox-wide-currentuser">State model: sandbox-wide <code>currentUser</code></h2>
+<p><code>pyric/auth</code>’s sandbox backend writes through to <code>sandbox.currentUser</code>. Every sandbox now carries that field plus an <code>onCurrentUserChanged</code> event. This is the integration seam: a future <code>getFirestore(sandbox)</code> overload reads <code>sandbox.currentUser</code> per-call so Firestore rules evaluate against the live auth state without re-binding handles.</p>
+<p>Today, <code>pyric/auth</code> writes to the field; reading from other service handles is the next follow-up.</p>
+<h2 id="whats-next-deferred-follow-ups">What’s next (deferred follow-ups)</h2>
+<ul>
+<li><strong><code>getFirestore(sandbox)</code> per-call identity read.</strong> Add a <code>(sandbox)</code> overload on <code>pyric/firestore</code>’s <code>getFirestore</code> that reads <code>sandbox.currentUser</code> for each op. Lets agent code call <code>getFirestore(sandbox)</code> once and have Firestore see auth changes from <code>pyric/auth</code>’s sign-in flows automatically.</li>
+<li><strong>Agent system-prompt update.</strong> Drop the “no <code>firebase/auth</code> in <code>appSource</code>” rule and document the v0 deny-list as the new boundary.</li>
+</ul>
+<h2 id="position-in-the-pyric-stack">Position in the Pyric stack</h2>
+<p><code>pyric/auth</code> is the <strong>modular-shape auth adapter</strong>, sibling to <code>pyric/firestore</code>. Both run on top of <code>pyric/sandbox</code> and share the same <code>currentUser</code> bridge.</p>
+<h2 id="licence">Licence</h2>
+<p>Same as the parent workspace.</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="#install">Install</a> </li><li data-depth="2"> <a href="#a-30-second-example">A 30-second example</a> </li><li data-depth="2"> <a href="#whats-in-v0">What’s in v0</a> </li><li data-depth="2"> <a href="#whats-out-v0">What’s out (v0)</a> </li><li data-depth="2"> <a href="#state-model-sandbox-wide-currentuser">State model: sandbox-wide currentUser</a> </li><li data-depth="2"> <a href="#whats-next-deferred-follow-ups">What’s next (deferred follow-ups)</a> </li><li data-depth="2"> <a href="#position-in-the-pyric-stack">Position in the Pyric stack</a> </li><li data-depth="2"> <a href="#licence">Licence</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>