@pyric/cli 0.1.0-alpha.10 → 0.1.0-alpha.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md.orig +2 -2
- package/dist/assurance/.generated/conformance-verdicts.d.ts +16 -0
- package/dist/assurance/.generated/conformance-verdicts.d.ts.map +1 -1
- package/dist/assurance/.generated/conformance-verdicts.js +16 -0
- package/dist/assurance/.generated/conformance-verdicts.js.map +1 -1
- package/dist/bridge/server/peer.d.ts +1 -1
- package/dist/bridge/server.d.ts +1 -1
- package/dist/bridge/server.js +1 -1
- package/dist/cli/index.d.ts +11 -0
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +13 -1
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/init.d.ts +3 -3
- package/dist/cli/init.d.ts.map +1 -1
- package/dist/cli/init.js +5 -5
- package/dist/cli/init.js.map +1 -1
- package/dist/cli/serve.d.ts.map +1 -1
- package/dist/cli/serve.js +8 -2
- package/dist/cli/serve.js.map +1 -1
- package/dist/conformance/.generated/can-i-use-browser.d.ts.map +1 -1
- package/dist/conformance/.generated/can-i-use-browser.js +1 -1
- package/dist/conformance/.generated/can-i-use-browser.js.map +1 -1
- package/dist/conformance/.generated/can-i-use.d.ts.map +1 -1
- package/dist/conformance/.generated/can-i-use.js +1 -1
- package/dist/conformance/.generated/can-i-use.js.map +1 -1
- package/dist/conformance/.generated/conformance-docs.d.ts +12 -0
- package/dist/conformance/.generated/conformance-docs.d.ts.map +1 -0
- package/dist/conformance/.generated/conformance-docs.js +2 -0
- package/dist/conformance/.generated/conformance-docs.js.map +1 -0
- package/dist/conformance/docs.d.ts +6 -0
- package/dist/conformance/docs.d.ts.map +1 -0
- package/dist/conformance/docs.js +6 -0
- package/dist/conformance/docs.js.map +1 -0
- package/dist/remote/index.d.ts.map +1 -1
- package/dist/remote/index.js +1 -0
- package/dist/remote/index.js.map +1 -1
- package/dist/serve/activity-guard.d.ts +4 -0
- package/dist/serve/activity-guard.d.ts.map +1 -0
- package/dist/serve/activity-guard.js +22 -0
- package/dist/serve/activity-guard.js.map +1 -0
- package/dist/serve/activity-route.d.ts +4 -0
- package/dist/serve/activity-route.d.ts.map +1 -0
- package/dist/serve/activity-route.js +157 -0
- package/dist/serve/activity-route.js.map +1 -0
- package/dist/serve/activity-warning.d.ts +4 -0
- package/dist/serve/activity-warning.d.ts.map +1 -0
- package/dist/serve/activity-warning.js +21 -0
- package/dist/serve/activity-warning.js.map +1 -0
- package/dist/serve/bridge-mount.d.ts +5 -0
- package/dist/serve/bridge-mount.d.ts.map +1 -1
- package/dist/serve/bridge-mount.js +1 -0
- package/dist/serve/bridge-mount.js.map +1 -1
- package/dist/serve/docs-ui/404.html +3 -0
- package/dist/serve/docs-ui/_astro/{_slug_.DPUwShm2.css → _slug_.CXh9yTP1.css} +1 -1
- package/dist/serve/docs-ui/_astro/_slug_.DUci-duz.css +1 -0
- package/dist/serve/docs-ui/docs/_rhythm/index.html +2 -1
- package/dist/serve/docs-ui/docs/agent/set-up-your-agent/index.html +3 -2
- package/dist/serve/docs-ui/docs/agent/set-up-your-agent.md +1 -1
- package/dist/serve/docs-ui/docs/agent/watch-and-review/index.html +2 -1
- package/dist/serve/docs-ui/docs/agent/work-with-an-agent/index.html +2 -1
- package/dist/serve/docs-ui/docs/ai-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/api-reference/index.html +51 -49
- package/dist/serve/docs-ui/docs/api-reference.md +2 -2
- package/dist/serve/docs-ui/docs/app-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/auth-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/build/ai-logic/index.html +18 -3
- package/dist/serve/docs-ui/docs/build/ai-logic.md +30 -2
- package/dist/serve/docs-ui/docs/build/authentication/index.html +2 -1
- package/dist/serve/docs-ui/docs/build/authentication.md +1 -1
- package/dist/serve/docs-ui/docs/build/cloud-firestore/index.html +2 -1
- package/dist/serve/docs-ui/docs/build/cloud-messaging/index.html +46 -2
- package/dist/serve/docs-ui/docs/build/cloud-messaging.md +56 -1
- package/dist/serve/docs-ui/docs/build/cloud-storage/index.html +2 -1
- package/dist/serve/docs-ui/docs/build/cloud-storage.md +1 -1
- package/dist/serve/docs-ui/docs/build/realtime-database/index.html +21 -3
- package/dist/serve/docs-ui/docs/build/realtime-database.md +25 -1
- package/dist/serve/docs-ui/docs/conformance-scores/index.html +2 -1
- package/dist/serve/docs-ui/docs/create-pyric-reference-api/index.html +61 -28
- package/dist/serve/docs-ui/docs/create-pyric-reference-api.md +65 -20
- package/dist/serve/docs-ui/docs/database-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/firestore-compat/index.html +6 -5
- package/dist/serve/docs-ui/docs/firestore-compat.md +4 -4
- package/dist/serve/docs-ui/docs/functions-rtdb-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/get-started/how-the-swap-works/index.html +2 -1
- package/dist/serve/docs-ui/docs/get-started/start-building/index.html +4 -3
- package/dist/serve/docs-ui/docs/get-started/start-building.md +2 -2
- package/dist/serve/docs-ui/docs/index.json +800 -575
- package/dist/serve/docs-ui/docs/messaging-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/observe/see-whats-happening/index.html +2 -1
- package/dist/serve/docs-ui/docs/observe/shape-your-data/index.html +2 -1
- package/dist/serve/docs-ui/docs/overview/index.html +2 -1
- package/dist/serve/docs-ui/docs/pyric-admin-app-reference-api/index.html +5 -4
- package/dist/serve/docs-ui/docs/pyric-admin-app-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/pyric-admin-auth-reference-api/index.html +5 -4
- package/dist/serve/docs-ui/docs/pyric-admin-auth-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/pyric-admin-database-reference-api/index.html +5 -4
- package/dist/serve/docs-ui/docs/pyric-admin-database-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/pyric-admin-firestore-reference-api/index.html +2503 -12
- package/dist/serve/docs-ui/docs/pyric-admin-firestore-reference-api.md +2219 -8
- package/dist/serve/docs-ui/docs/pyric-admin-storage-reference-api/index.html +4 -3
- package/dist/serve/docs-ui/docs/pyric-admin-storage-reference-api.md +2 -3
- package/dist/serve/docs-ui/docs/pyric-ai-reference-api/index.html +16 -11
- package/dist/serve/docs-ui/docs/pyric-ai-reference-api.md +14 -13
- package/dist/serve/docs-ui/docs/pyric-ai-scripting-reference-api/index.html +4 -3
- package/dist/serve/docs-ui/docs/pyric-ai-scripting-reference-api.md +2 -3
- package/dist/serve/docs-ui/docs/pyric-app-reference-api/index.html +7 -2
- package/dist/serve/docs-ui/docs/pyric-app-reference-api.md +5 -2
- package/dist/serve/docs-ui/docs/pyric-auth-reference-api/index.html +23 -12
- package/dist/serve/docs-ui/docs/pyric-auth-reference-api.md +15 -12
- package/dist/serve/docs-ui/docs/pyric-cli-assurance-browser-reference-api/index.html +10 -48
- package/dist/serve/docs-ui/docs/pyric-cli-assurance-browser-reference-api.md +11 -24
- package/dist/serve/docs-ui/docs/pyric-cli-assurance-reference-api/index.html +87 -97
- package/dist/serve/docs-ui/docs/pyric-cli-assurance-reference-api.md +53 -65
- package/dist/serve/docs-ui/docs/pyric-cli-bridge-client-reference-api/index.html +14 -15
- package/dist/serve/docs-ui/docs/pyric-cli-bridge-client-reference-api.md +19 -28
- package/dist/serve/docs-ui/docs/pyric-cli-bridge-reference-api/index.html +4 -3
- package/dist/serve/docs-ui/docs/pyric-cli-bridge-reference-api.md +2 -3
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-browser-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-browser-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-docs-reference-api/index.html +51 -0
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-docs-reference-api.md +36 -0
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-cli-conformance-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-cli-credentials-node-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-cli-credentials-node-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-cli-discover-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-cli-discover-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-cli-register-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-cli-register-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-cli-remote-reference-api/index.html +1067 -83
- package/dist/serve/docs-ui/docs/pyric-cli-remote-reference-api.md +1291 -160
- package/dist/serve/docs-ui/docs/pyric-cli-serve-worker-reference-api/index.html +123 -92
- package/dist/serve/docs-ui/docs/pyric-cli-serve-worker-reference-api.md +49 -20
- package/dist/serve/docs-ui/docs/pyric-cli-verify-reference-api/index.html +72 -7
- package/dist/serve/docs-ui/docs/pyric-cli-verify-reference-api.md +22 -7
- package/dist/serve/docs-ui/docs/pyric-cli-vite-reference-api/index.html +33 -12
- package/dist/serve/docs-ui/docs/pyric-cli-vite-reference-api.md +15 -12
- package/dist/serve/docs-ui/docs/pyric-database-reference-api/index.html +18 -17
- package/dist/serve/docs-ui/docs/pyric-database-reference-api.md +19 -22
- package/dist/serve/docs-ui/docs/pyric-firestore-reference-api/index.html +1512 -545
- package/dist/serve/docs-ui/docs/pyric-firestore-reference-api.md +1311 -316
- package/dist/serve/docs-ui/docs/pyric-firestore-values-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-firestore-values-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-messaging-reference-api/index.html +5 -4
- package/dist/serve/docs-ui/docs/pyric-messaging-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/pyric-messaging-sw-reference-api/index.html +69 -369
- package/dist/serve/docs-ui/docs/pyric-messaging-sw-reference-api.md +103 -216
- package/dist/serve/docs-ui/docs/pyric-rules-reference-api/index.html +10 -9
- package/dist/serve/docs-ui/docs/pyric-rules-reference-api.md +9 -10
- package/dist/serve/docs-ui/docs/pyric-sandbox-database-reference-api/index.html +8 -7
- package/dist/serve/docs-ui/docs/pyric-sandbox-database-reference-api.md +6 -7
- package/dist/serve/docs-ui/docs/pyric-sandbox-firestore-reference-api/index.html +10 -9
- package/dist/serve/docs-ui/docs/pyric-sandbox-firestore-reference-api.md +9 -10
- package/dist/serve/docs-ui/docs/pyric-sandbox-reference-api/index.html +374 -910
- package/dist/serve/docs-ui/docs/pyric-sandbox-reference-api.md +377 -911
- package/dist/serve/docs-ui/docs/pyric-storage-reference-api/index.html +25 -17
- package/dist/serve/docs-ui/docs/pyric-storage-reference-api.md +21 -19
- package/dist/serve/docs-ui/docs/pyric-ui-agents-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-ui-agents-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-ui-auth-hooks-reference-api/index.html +63 -776
- package/dist/serve/docs-ui/docs/pyric-ui-auth-hooks-reference-api.md +69 -510
- package/dist/serve/docs-ui/docs/pyric-ui-auth-reference-api/index.html +22 -21
- package/dist/serve/docs-ui/docs/pyric-ui-auth-reference-api.md +29 -30
- package/dist/serve/docs-ui/docs/pyric-ui-events-hooks-reference-api/index.html +15 -168
- package/dist/serve/docs-ui/docs/pyric-ui-events-hooks-reference-api.md +17 -87
- package/dist/serve/docs-ui/docs/pyric-ui-events-reference-api/index.html +6 -5
- package/dist/serve/docs-ui/docs/pyric-ui-events-reference-api.md +5 -6
- package/dist/serve/docs-ui/docs/pyric-ui-firestore-hooks-reference-api/index.html +82 -970
- package/dist/serve/docs-ui/docs/pyric-ui-firestore-hooks-reference-api.md +104 -479
- package/dist/serve/docs-ui/docs/pyric-ui-firestore-reference-api/index.html +30 -29
- package/dist/serve/docs-ui/docs/pyric-ui-firestore-reference-api.md +54 -55
- package/dist/serve/docs-ui/docs/pyric-ui-primitives-reference-api/index.html +3 -2
- package/dist/serve/docs-ui/docs/pyric-ui-primitives-reference-api.md +1 -2
- package/dist/serve/docs-ui/docs/pyric-ui-rtdb-reference-api/index.html +5 -4
- package/dist/serve/docs-ui/docs/pyric-ui-rtdb-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/pyric-ui-rules-hooks-reference-api/index.html +9 -124
- package/dist/serve/docs-ui/docs/pyric-ui-rules-hooks-reference-api.md +7 -58
- package/dist/serve/docs-ui/docs/pyric-ui-rules-reference-api/index.html +24 -23
- package/dist/serve/docs-ui/docs/pyric-ui-rules-reference-api.md +31 -34
- package/dist/serve/docs-ui/docs/pyric-ui-storage-hooks-reference-api/index.html +104 -1385
- package/dist/serve/docs-ui/docs/pyric-ui-storage-hooks-reference-api.md +133 -817
- package/dist/serve/docs-ui/docs/pyric-ui-storage-reference-api/index.html +34 -33
- package/dist/serve/docs-ui/docs/pyric-ui-storage-reference-api.md +37 -38
- package/dist/serve/docs-ui/docs/pyric-ui-traffic-hooks-reference-api/index.html +116 -1169
- package/dist/serve/docs-ui/docs/pyric-ui-traffic-hooks-reference-api.md +142 -590
- package/dist/serve/docs-ui/docs/pyric-ui-traffic-reference-api/index.html +4 -3
- package/dist/serve/docs-ui/docs/pyric-ui-traffic-reference-api.md +3 -4
- package/dist/serve/docs-ui/docs/rules-compat/index.html +34 -1
- package/dist/serve/docs-ui/docs/rules-compat.md +32 -0
- package/dist/serve/docs-ui/docs/secure/audit-your-rules/index.html +19 -2
- package/dist/serve/docs-ui/docs/secure/audit-your-rules.md +32 -0
- package/dist/serve/docs-ui/docs/secure/firestore-rules-limits/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/read-a-denial/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/rtdb-rules-in-typescript/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/rtdb-rules-in-typescript.md +1 -1
- package/dist/serve/docs-ui/docs/secure/rules-standard-library/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/secure-it-with-rules/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/simulate-and-lint/index.html +2 -1
- package/dist/serve/docs-ui/docs/secure/write-a-rules-test-suite/index.html +2 -1
- package/dist/serve/docs-ui/docs/ship/ship-to-production/index.html +2 -1
- package/dist/serve/docs-ui/docs/ship/test-in-node/index.html +2 -1
- package/dist/serve/docs-ui/docs/storage-compat/index.html +2 -1
- package/dist/serve/docs-ui/docs/trust/how-we-know-it-matches-firebase/index.html +2 -1
- package/dist/serve/docs-ui/docs/trust/versioning-and-compatibility/index.html +2 -1
- package/dist/serve/docs-ui/llms.txt +1 -0
- package/dist/serve/entries/ai.d.ts.map +1 -1
- package/dist/serve/entries/ai.js +39 -1
- package/dist/serve/entries/ai.js.map +1 -1
- package/dist/serve/entries/messaging-sw.d.ts.map +1 -1
- package/dist/serve/entries/messaging-sw.js +5 -1
- package/dist/serve/entries/messaging-sw.js.map +1 -1
- package/dist/serve/entries/messaging.d.ts.map +1 -1
- package/dist/serve/entries/messaging.js +7 -1
- package/dist/serve/entries/messaging.js.map +1 -1
- package/dist/serve/entries/runtime.d.ts.map +1 -1
- package/dist/serve/entries/runtime.js +20 -1
- package/dist/serve/entries/runtime.js.map +1 -1
- package/dist/serve/init-payload.d.ts +25 -0
- package/dist/serve/init-payload.d.ts.map +1 -1
- package/dist/serve/namespace.d.ts +39 -0
- package/dist/serve/namespace.d.ts.map +1 -1
- package/dist/serve/namespace.js +80 -1
- package/dist/serve/namespace.js.map +1 -1
- package/dist/serve/standalone-assets.d.ts +11 -9
- package/dist/serve/standalone-assets.d.ts.map +1 -1
- package/dist/serve/standalone-assets.js +6 -5
- package/dist/serve/standalone-assets.js.map +1 -1
- package/dist/serve/studio-ui/assets/{RulesCodeEditor-CXdSLKhO.js → RulesCodeEditor-CxVYcZXw.js} +1 -1
- package/dist/serve/studio-ui/assets/index-cpSfgQ7H.js +1218 -0
- package/dist/serve/studio-ui/assets/seed-DeuFKi4J.js +20 -0
- package/dist/serve/studio-ui/index.html +1 -1
- package/dist/serve/vite-plugin.d.ts +92 -15
- package/dist/serve/vite-plugin.d.ts.map +1 -1
- package/dist/serve/vite-plugin.js +281 -11
- package/dist/serve/vite-plugin.js.map +1 -1
- package/dist/serve/worker/activity-bootstrap.d.ts +8 -0
- package/dist/serve/worker/activity-bootstrap.d.ts.map +1 -0
- package/dist/serve/worker/activity-bootstrap.js +11 -0
- package/dist/serve/worker/activity-bootstrap.js.map +1 -0
- package/dist/serve/worker/client/connection.d.ts.map +1 -1
- package/dist/serve/worker/client/connection.js +17 -5
- package/dist/serve/worker/client/connection.js.map +1 -1
- package/dist/serve/worker/client/core.d.ts +2 -2
- package/dist/serve/worker/client/core.d.ts.map +1 -1
- package/dist/serve/worker/client/core.js +33 -5
- package/dist/serve/worker/client/core.js.map +1 -1
- package/dist/serve/worker/client/firestore-writes.d.ts.map +1 -1
- package/dist/serve/worker/client/firestore-writes.js +1 -0
- package/dist/serve/worker/client/firestore-writes.js.map +1 -1
- package/dist/serve/worker/client/messaging.d.ts +9 -1
- package/dist/serve/worker/client/messaging.d.ts.map +1 -1
- package/dist/serve/worker/client/messaging.js +15 -0
- package/dist/serve/worker/client/messaging.js.map +1 -1
- package/dist/serve/worker/client/studio.d.ts +10 -0
- package/dist/serve/worker/client/studio.d.ts.map +1 -1
- package/dist/serve/worker/client/studio.js +11 -0
- package/dist/serve/worker/client/studio.js.map +1 -1
- package/dist/serve/worker/durable-persistence.d.ts +12 -0
- package/dist/serve/worker/durable-persistence.d.ts.map +1 -0
- package/dist/serve/worker/durable-persistence.js +118 -0
- package/dist/serve/worker/durable-persistence.js.map +1 -0
- package/dist/serve/worker/entry.d.ts +7 -3
- package/dist/serve/worker/entry.d.ts.map +1 -1
- package/dist/serve/worker/entry.js +7 -3
- package/dist/serve/worker/entry.js.map +1 -1
- package/dist/serve/worker/host/core.d.ts +9 -5
- package/dist/serve/worker/host/core.d.ts.map +1 -1
- package/dist/serve/worker/host/core.js +33 -8
- package/dist/serve/worker/host/core.js.map +1 -1
- package/dist/serve/worker/host/dispatch.d.ts.map +1 -1
- package/dist/serve/worker/host/dispatch.js +9 -2
- package/dist/serve/worker/host/dispatch.js.map +1 -1
- package/dist/serve/worker/host/studio.d.ts +1 -1
- package/dist/serve/worker/host/studio.d.ts.map +1 -1
- package/dist/serve/worker/host/studio.js +36 -1
- package/dist/serve/worker/host/studio.js.map +1 -1
- package/dist/serve/worker/host/subscriptions.d.ts.map +1 -1
- package/dist/serve/worker/host/subscriptions.js +27 -7
- package/dist/serve/worker/host/subscriptions.js.map +1 -1
- package/dist/serve/worker/host-context.d.ts +15 -0
- package/dist/serve/worker/host-context.d.ts.map +1 -1
- package/dist/serve/worker/host-context.js +10 -0
- package/dist/serve/worker/host-context.js.map +1 -1
- package/dist/serve/worker/host-messaging.d.ts.map +1 -1
- package/dist/serve/worker/host-messaging.js +9 -2
- package/dist/serve/worker/host-messaging.js.map +1 -1
- package/dist/serve/worker/index.d.ts +1 -1
- package/dist/serve/worker/index.d.ts.map +1 -1
- package/dist/serve/worker/index.js +2 -0
- package/dist/serve/worker/index.js.map +1 -1
- package/dist/serve/worker/protocol.d.ts +25 -3
- package/dist/serve/worker/protocol.d.ts.map +1 -1
- package/dist/serve/worker/protocol.js.map +1 -1
- package/dist/serve/worker/serve-init.d.ts +23 -37
- package/dist/serve/worker/serve-init.d.ts.map +1 -1
- package/dist/serve/worker/serve-init.js +95 -172
- package/dist/serve/worker/serve-init.js.map +1 -1
- package/dist/vite.d.ts +4 -4
- package/dist/vite.d.ts.map +1 -1
- package/dist/vite.js +3 -3
- package/dist/vite.js.map +1 -1
- package/package.json +8 -4
- package/dist/serve/studio-ui/assets/index-BvtQIpGn.js +0 -1211
- package/dist/serve/studio-ui/assets/seed-3DMedLL3.js +0 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
<!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/cli/assurance · Pyric Studio</title><meta name="description" content="Published declarations for @pyric/cli/assurance."><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.DPUwShm2.css"></head> <body> <header class="studio__bar"> <div class="studio__bar-inner"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric Studio">Pyric</a> <nav class="studio__nav" aria-label="Studio tabs"> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/firestore"> Firestore </a><a class="studio__nav-tab" href="/__pyric/ui/auth"> Auth </a><a class="studio__nav-tab" href="/__pyric/ui/rtdb"> RTDB </a><a class="studio__nav-tab" href="/__pyric/ui/storage"> Storage </a><a class="studio__nav-tab" href="/__pyric/ui/traffic"> Traffic </a><a class="studio__nav-tab" href="/__pyric/ui/settings"> Settings </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a> </nav> </div> </header> <div class="docs-shell"> <details class="docs-nav-drawer"> <summary>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/"> Overview </a><details class="docs-nav-group"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Trust </a><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Public API coverage </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-values-reference-api/"> pyric/firestore-values </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/" aria-current="page"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/" id="nav-group-overview"> Overview </a><details class="docs-nav-group" id="nav-group-get-started"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-build"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-secure-debug"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-observe-shape"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-test"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-work-with-an-agent"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/" id="nav-group-trust"> Trust </a><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Public API coverage </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-values-reference-api/"> pyric/firestore-values </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/" aria-current="page"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main"> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li> <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>@pyric/cli</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">@pyric/cli/assurance</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>@pyric/cli/assurance</code></h1> <p class="api-reference-meta"> 62 published symbols from <code>@pyric/cli</code> </p> <p class="api-reference-source">
|
|
1
|
+
<!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/cli/assurance · Pyric Studio</title><meta name="description" content="Published declarations for @pyric/cli/assurance."><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.CXh9yTP1.css">
|
|
2
|
+
<link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.DUci-duz.css"></head> <body> <header class="studio__bar"> <div class="studio__bar-inner"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric Studio">Pyric</a> <nav class="studio__nav" aria-label="Studio tabs"> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/firestore"> Firestore </a><a class="studio__nav-tab" href="/__pyric/ui/auth"> Auth </a><a class="studio__nav-tab" href="/__pyric/ui/rtdb"> RTDB </a><a class="studio__nav-tab" href="/__pyric/ui/storage"> Storage </a><a class="studio__nav-tab" href="/__pyric/ui/traffic"> Traffic </a><a class="studio__nav-tab" href="/__pyric/ui/settings"> Settings </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a> </nav> </div> </header> <div class="docs-shell"> <details class="docs-nav-drawer"> <summary>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/"> Overview </a><details class="docs-nav-group"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Trust </a><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Public API coverage </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-values-reference-api/"> pyric/firestore-values </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/" aria-current="page"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <a class="docs-nav-toplink" href="/__pyric/ui/docs/overview/" id="nav-group-overview"> Overview </a><details class="docs-nav-group" id="nav-group-get-started"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-build"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-secure-debug"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-observe-shape"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-test"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-work-with-an-agent"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><a class="docs-nav-toplink" href="/__pyric/ui/docs/trust/versioning-and-compatibility/" id="nav-group-trust"> Trust </a><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Public API coverage </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-values-reference-api/"> pyric/firestore-values </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/" aria-current="page"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main"> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li> <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>@pyric/cli</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">@pyric/cli/assurance</span> </li> </ol> </nav> <header class="api-reference-header"> <p class="api-reference-kicker">API reference</p> <h1><code>@pyric/cli/assurance</code></h1> <p class="api-reference-meta"> 62 published symbols from <code>@pyric/cli</code> </p> <p class="api-reference-source">
|
|
2
3
|
Generated from the TypeScript declarations shipped at this import path.
|
|
3
|
-
</p> </header> <article class="prose api-reference-body"> <!-- Generated from published package declarations via TypeDoc.
|
|
4
|
+
</p> </header> <article class="prose api-reference-body"> <!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
|
|
4
5
|
<h2 id="classes">Classes</h2>
|
|
5
6
|
<p><a id="assurancecampaignstore"></a></p>
|
|
6
7
|
<h3 id="assurancecampaignstore">AssuranceCampaignStore</h3>
|
|
@@ -148,6 +149,31 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
148
149
|
<p><a href="#assuranceinputerror"><code>AssuranceInputError</code></a></p>
|
|
149
150
|
<h6 id="inherited-from-1">Inherited from</h6>
|
|
150
151
|
<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:#E5C07B">Error</span><span style="color:#ABB2BF">.</span><span style="color:#E06C75">constructor</span></span></code></pre>
|
|
152
|
+
<h5 id="constructor-3">Constructor</h5>
|
|
153
|
+
<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">new</span><span style="color:#61AFEF"> AssuranceInputError</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">message</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> string</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75">options</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> ErrorOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceInputError</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
154
|
+
<h6 id="parameters-6">Parameters</h6>
|
|
155
|
+
<div class="table-scroll">
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>message?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>ErrorOptions</code></td></tr></tbody></table></div>
|
|
173
|
+
<h6 id="returns-8">Returns</h6>
|
|
174
|
+
<p><a href="#assuranceinputerror"><code>AssuranceInputError</code></a></p>
|
|
175
|
+
<h6 id="inherited-from-2">Inherited from</h6>
|
|
176
|
+
<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:#E5C07B">Error</span><span style="color:#ABB2BF">.</span><span style="color:#E06C75">constructor</span></span></code></pre>
|
|
151
177
|
<h4 id="properties">Properties</h4>
|
|
152
178
|
<div class="table-scroll">
|
|
153
179
|
|
|
@@ -172,9 +198,9 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
172
198
|
<h3 id="authorizationcampaign">AuthorizationCampaign</h3>
|
|
173
199
|
<h4 id="constructors-2">Constructors</h4>
|
|
174
200
|
<p><a id="constructor-2"></a></p>
|
|
175
|
-
<h5 id="constructor-
|
|
201
|
+
<h5 id="constructor-4">Constructor</h5>
|
|
176
202
|
<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">new</span><span style="color:#61AFEF"> AuthorizationCampaign</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">options</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">CreateAuthorizationCampaignOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AuthorizationCampaign</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
177
|
-
<h6 id="parameters-
|
|
203
|
+
<h6 id="parameters-7">Parameters</h6>
|
|
178
204
|
<div class="table-scroll">
|
|
179
205
|
|
|
180
206
|
|
|
@@ -189,7 +215,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
189
215
|
|
|
190
216
|
|
|
191
217
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options</code></td><td align="left"><a href="#createauthorizationcampaignoptions"><code>CreateAuthorizationCampaignOptions</code></a></td></tr></tbody></table></div>
|
|
192
|
-
<h6 id="returns-
|
|
218
|
+
<h6 id="returns-9">Returns</h6>
|
|
193
219
|
<p><a href="#authorizationcampaign"><code>AuthorizationCampaign</code></a></p>
|
|
194
220
|
<h4 id="properties-1">Properties</h4>
|
|
195
221
|
<div class="table-scroll">
|
|
@@ -228,19 +254,19 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
228
254
|
<h5 id="observations">observations</h5>
|
|
229
255
|
<h6 id="get-signature">Get Signature</h6>
|
|
230
256
|
<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:#E06C75">get</span><span style="color:#61AFEF"> observations</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">AssuranceObservation</span><span style="color:#ABB2BF">[];</span></span></code></pre>
|
|
231
|
-
<h6 id="returns-
|
|
257
|
+
<h6 id="returns-10">Returns</h6>
|
|
232
258
|
<p><a href="#assuranceobservation"><code>AssuranceObservation</code></a>[]</p>
|
|
233
259
|
<p><a id="report"></a></p>
|
|
234
260
|
<h5 id="report">report</h5>
|
|
235
261
|
<h6 id="get-signature-1">Get Signature</h6>
|
|
236
262
|
<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:#E06C75">get</span><span style="color:#61AFEF"> report</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">AuthorizationCampaignReport</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
237
|
-
<h6 id="returns-
|
|
263
|
+
<h6 id="returns-11">Returns</h6>
|
|
238
264
|
<p><a href="#authorizationcampaignreport-1"><code>AuthorizationCampaignReport</code></a></p>
|
|
239
265
|
<h4 id="methods-1">Methods</h4>
|
|
240
266
|
<p><a id="addactor"></a></p>
|
|
241
267
|
<h5 id="addactor">addActor()</h5>
|
|
242
268
|
<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">addActor</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">actor</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AssuranceActor</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceActor</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
243
|
-
<h6 id="parameters-
|
|
269
|
+
<h6 id="parameters-8">Parameters</h6>
|
|
244
270
|
<div class="table-scroll">
|
|
245
271
|
|
|
246
272
|
|
|
@@ -255,12 +281,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
255
281
|
|
|
256
282
|
|
|
257
283
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>actor</code></td><td align="left"><a href="#assuranceactor"><code>AssuranceActor</code></a></td></tr></tbody></table></div>
|
|
258
|
-
<h6 id="returns-
|
|
284
|
+
<h6 id="returns-12">Returns</h6>
|
|
259
285
|
<p><a href="#assuranceactor"><code>AssuranceActor</code></a></p>
|
|
260
286
|
<p><a id="addinvariant"></a></p>
|
|
261
287
|
<h5 id="addinvariant">addInvariant()</h5>
|
|
262
288
|
<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">addInvariant</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">invariant</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">SecurityInvariant</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">SecurityInvariant</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
263
|
-
<h6 id="parameters-
|
|
289
|
+
<h6 id="parameters-9">Parameters</h6>
|
|
264
290
|
<div class="table-scroll">
|
|
265
291
|
|
|
266
292
|
|
|
@@ -275,12 +301,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
275
301
|
|
|
276
302
|
|
|
277
303
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>invariant</code></td><td align="left"><a href="#securityinvariant"><code>SecurityInvariant</code></a></td></tr></tbody></table></div>
|
|
278
|
-
<h6 id="returns-
|
|
304
|
+
<h6 id="returns-13">Returns</h6>
|
|
279
305
|
<p><a href="#securityinvariant"><code>SecurityInvariant</code></a></p>
|
|
280
306
|
<p><a id="addobservation"></a></p>
|
|
281
307
|
<h5 id="addobservation">addObservation()</h5>
|
|
282
308
|
<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">addObservation</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">observation</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AssuranceObservation</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceObservation</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
283
|
-
<h6 id="parameters-
|
|
309
|
+
<h6 id="parameters-10">Parameters</h6>
|
|
284
310
|
<div class="table-scroll">
|
|
285
311
|
|
|
286
312
|
|
|
@@ -295,12 +321,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
295
321
|
|
|
296
322
|
|
|
297
323
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>observation</code></td><td align="left"><a href="#assuranceobservation"><code>AssuranceObservation</code></a></td></tr></tbody></table></div>
|
|
298
|
-
<h6 id="returns-
|
|
324
|
+
<h6 id="returns-14">Returns</h6>
|
|
299
325
|
<p><a href="#assuranceobservation"><code>AssuranceObservation</code></a></p>
|
|
300
326
|
<p><a id="addprobe"></a></p>
|
|
301
327
|
<h5 id="addprobe">addProbe()</h5>
|
|
302
328
|
<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">addProbe</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">probe</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">AssuranceProbe</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceProbe</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
303
|
-
<h6 id="parameters-
|
|
329
|
+
<h6 id="parameters-11">Parameters</h6>
|
|
304
330
|
<div class="table-scroll">
|
|
305
331
|
|
|
306
332
|
|
|
@@ -315,19 +341,19 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
315
341
|
|
|
316
342
|
|
|
317
343
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>probe</code></td><td align="left"><a href="#assuranceprobe"><code>AssuranceProbe</code></a></td></tr></tbody></table></div>
|
|
318
|
-
<h6 id="returns-
|
|
344
|
+
<h6 id="returns-15">Returns</h6>
|
|
319
345
|
<p><a href="#assuranceprobe"><code>AssuranceProbe</code></a></p>
|
|
320
346
|
<p><a id="export"></a></p>
|
|
321
347
|
<h5 id="export">export()</h5>
|
|
322
348
|
<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">export</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">CampaignExport</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
323
|
-
<h6 id="returns-
|
|
349
|
+
<h6 id="returns-16">Returns</h6>
|
|
324
350
|
<p><a href="#campaignexport"><code>CampaignExport</code></a></p>
|
|
325
351
|
<p><a id="exportsecuritycases"></a></p>
|
|
326
352
|
<h5 id="exportsecuritycases">exportSecurityCases()</h5>
|
|
327
353
|
<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">exportSecurityCases</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">options</span><span style="color:#C678DD">?:</span><span style="color:#ABB2BF"> {</span></span>
|
|
328
354
|
<span class="line"><span style="color:#ABB2BF"> includeCandidates?: </span><span style="color:#E06C75">boolean</span><span style="color:#ABB2BF">;</span></span>
|
|
329
355
|
<span class="line"><span style="color:#ABB2BF">}): </span><span style="color:#E06C75">SecurityCase</span><span style="color:#ABB2BF">[];</span></span></code></pre>
|
|
330
|
-
<h6 id="parameters-
|
|
356
|
+
<h6 id="parameters-12">Parameters</h6>
|
|
331
357
|
<div class="table-scroll">
|
|
332
358
|
|
|
333
359
|
|
|
@@ -346,12 +372,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
346
372
|
|
|
347
373
|
|
|
348
374
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options?</code></td><td align="left">{ <code>includeCandidates?</code>: <code>boolean</code>; }</td></tr><tr><td align="left"><code>options.includeCandidates?</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
|
|
349
|
-
<h6 id="returns-
|
|
375
|
+
<h6 id="returns-17">Returns</h6>
|
|
350
376
|
<p><a href="#securitycase"><code>SecurityCase</code></a>[]</p>
|
|
351
377
|
<p><a id="inspect"></a></p>
|
|
352
378
|
<h5 id="inspect">inspect()</h5>
|
|
353
379
|
<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">inspect</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">probeId</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceProbeResult</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
354
|
-
<h6 id="parameters-
|
|
380
|
+
<h6 id="parameters-13">Parameters</h6>
|
|
355
381
|
<div class="table-scroll">
|
|
356
382
|
|
|
357
383
|
|
|
@@ -366,12 +392,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
366
392
|
|
|
367
393
|
|
|
368
394
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>probeId</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
369
|
-
<h6 id="returns-
|
|
395
|
+
<h6 id="returns-18">Returns</h6>
|
|
370
396
|
<p><a href="#assuranceproberesult"><code>AssuranceProbeResult</code></a></p>
|
|
371
397
|
<p><a id="minimize"></a></p>
|
|
372
398
|
<h5 id="minimize">minimize()</h5>
|
|
373
399
|
<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">minimize</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">probeId</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2"><</span><span style="color:#E06C75">MinimizationResult</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
374
|
-
<h6 id="parameters-
|
|
400
|
+
<h6 id="parameters-14">Parameters</h6>
|
|
375
401
|
<div class="table-scroll">
|
|
376
402
|
|
|
377
403
|
|
|
@@ -386,12 +412,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
386
412
|
|
|
387
413
|
|
|
388
414
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>probeId</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
389
|
-
<h6 id="returns-
|
|
415
|
+
<h6 id="returns-19">Returns</h6>
|
|
390
416
|
<p><code>Promise</code><<a href="#minimizationresult"><code>MinimizationResult</code></a>></p>
|
|
391
417
|
<p><a id="propose"></a></p>
|
|
392
418
|
<h5 id="propose">propose()</h5>
|
|
393
419
|
<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">propose</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">input</span><span style="color:#ABB2BF">: </span><span style="color:#E06C75">ProposalInput</span><span style="color:#ABB2BF">): </span><span style="color:#E06C75">AssuranceProbe</span><span style="color:#ABB2BF">[];</span></span></code></pre>
|
|
394
|
-
<h6 id="parameters-
|
|
420
|
+
<h6 id="parameters-15">Parameters</h6>
|
|
395
421
|
<div class="table-scroll">
|
|
396
422
|
|
|
397
423
|
|
|
@@ -406,12 +432,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
406
432
|
|
|
407
433
|
|
|
408
434
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>input</code></td><td align="left"><a href="#proposalinput"><code>ProposalInput</code></a></td></tr></tbody></table></div>
|
|
409
|
-
<h6 id="returns-
|
|
435
|
+
<h6 id="returns-20">Returns</h6>
|
|
410
436
|
<p><a href="#assuranceprobe"><code>AssuranceProbe</code></a>[]</p>
|
|
411
437
|
<p><a id="run"></a></p>
|
|
412
438
|
<h5 id="run">run()</h5>
|
|
413
439
|
<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">run</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">probeIds</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> string</span><span style="color:#ABB2BF">[]): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2"><</span><span style="color:#E06C75">AuthorizationCampaignReport</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
414
|
-
<h6 id="parameters-
|
|
440
|
+
<h6 id="parameters-16">Parameters</h6>
|
|
415
441
|
<div class="table-scroll">
|
|
416
442
|
|
|
417
443
|
|
|
@@ -426,12 +452,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
426
452
|
|
|
427
453
|
|
|
428
454
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>probeIds?</code></td><td align="left"><code>string</code>[]</td></tr></tbody></table></div>
|
|
429
|
-
<h6 id="returns-
|
|
455
|
+
<h6 id="returns-21">Returns</h6>
|
|
430
456
|
<p><code>Promise</code><<a href="#authorizationcampaignreport-1"><code>AuthorizationCampaignReport</code></a>></p>
|
|
431
457
|
<p><a id="spec"></a></p>
|
|
432
458
|
<h5 id="spec">spec()</h5>
|
|
433
459
|
<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">spec</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75">probeIds</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> string</span><span style="color:#ABB2BF">[]): </span><span style="color:#E06C75">AuthorizationCampaignSpec</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
434
|
-
<h6 id="parameters-
|
|
460
|
+
<h6 id="parameters-17">Parameters</h6>
|
|
435
461
|
<div class="table-scroll">
|
|
436
462
|
|
|
437
463
|
|
|
@@ -446,7 +472,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
446
472
|
|
|
447
473
|
|
|
448
474
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>probeIds?</code></td><td align="left"><code>string</code>[]</td></tr></tbody></table></div>
|
|
449
|
-
<h6 id="returns-
|
|
475
|
+
<h6 id="returns-22">Returns</h6>
|
|
450
476
|
<p><a href="#authorizationcampaignspec-2"><code>AuthorizationCampaignSpec</code></a></p>
|
|
451
477
|
<p><a id="verifyrules"></a></p>
|
|
452
478
|
<h5 id="verifyrules">verifyRules()</h5>
|
|
@@ -461,7 +487,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
461
487
|
<span class="line"><span style="color:#E06C75"> storage</span><span style="color:#C678DD">?:</span><span style="color:#E06C75"> string</span><span style="color:#ABB2BF">;</span></span>
|
|
462
488
|
<span class="line"><span style="color:#ABB2BF"> };</span></span>
|
|
463
489
|
<span class="line"><span style="color:#ABB2BF">}): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2"><</span><span style="color:#E06C75">AuthorizationCampaignReport</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
464
|
-
<h6 id="parameters-
|
|
490
|
+
<h6 id="parameters-18">Parameters</h6>
|
|
465
491
|
<div class="table-scroll">
|
|
466
492
|
|
|
467
493
|
|
|
@@ -504,12 +530,12 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
504
530
|
|
|
505
531
|
|
|
506
532
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options</code></td><td align="left">{ <code>id?</code>: <code>string</code>; <code>includeCandidates?</code>: <code>boolean</code>; <code>rules</code>: { <code>firestore?</code>: <code>string</code>; <code>rtdb?</code>: { <code>rules</code>: <code>Record</code><<code>string</code>, <code>unknown</code>>; }; <code>storage?</code>: <code>string</code>; }; }</td></tr><tr><td align="left"><code>options.id?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>options.includeCandidates?</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><code>options.rules</code></td><td align="left">{ <code>firestore?</code>: <code>string</code>; <code>rtdb?</code>: { <code>rules</code>: <code>Record</code><<code>string</code>, <code>unknown</code>>; }; <code>storage?</code>: <code>string</code>; }</td></tr><tr><td align="left"><code>options.rules.firestore?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>options.rules.rtdb?</code></td><td align="left">{ <code>rules</code>: <code>Record</code><<code>string</code>, <code>unknown</code>>; }</td></tr><tr><td align="left"><code>options.rules.rtdb.rules</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr><tr><td align="left"><code>options.rules.storage?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
507
|
-
<h6 id="returns-
|
|
533
|
+
<h6 id="returns-23">Returns</h6>
|
|
508
534
|
<p><code>Promise</code><<a href="#authorizationcampaignreport-1"><code>AuthorizationCampaignReport</code></a>></p>
|
|
509
535
|
<p><a id="visualization"></a></p>
|
|
510
536
|
<h5 id="visualization">visualization()</h5>
|
|
511
537
|
<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">visualization</span><span style="color:#ABB2BF">(): </span><span style="color:#E06C75">AssuranceVisualizationSnapshot</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
512
|
-
<h6 id="returns-
|
|
538
|
+
<h6 id="returns-24">Returns</h6>
|
|
513
539
|
<p><a href="#assurancevisualizationsnapshot"><code>AssuranceVisualizationSnapshot</code></a></p>
|
|
514
540
|
<h2 id="interfaces">Interfaces</h2>
|
|
515
541
|
<p><a id="actorevidence"></a></p>
|
|
@@ -544,7 +570,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
544
570
|
|
|
545
571
|
|
|
546
572
|
|
|
547
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="acquisition"></a> <code>acquisition</code></td><td align="left">| <code>"
|
|
573
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="acquisition"></a> <code>acquisition</code></td><td align="left">| <code>"password"</code> | <code>"anonymous-request"</code> | <code>"anonymous-account"</code> | <code>"fixture-user"</code> | <code>"synthetic"</code></td></tr><tr><td align="left"><a id="actorid"></a> <code>actorId</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="error"></a> <code>error?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="reachability"></a> <code>reachability</code></td><td align="left"><code>"synthetic"</code> | <code>"reachable"</code> | <code>"unreachable"</code></td></tr><tr><td align="left"><a id="uid"></a> <code>uid?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
548
574
|
<hr>
|
|
549
575
|
<p><a id="assuranceactor"></a></p>
|
|
550
576
|
<h3 id="assuranceactor">AssuranceActor</h3>
|
|
@@ -734,7 +760,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
734
760
|
|
|
735
761
|
|
|
736
762
|
|
|
737
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="code-1"></a> <code>code</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="reason"></a> <code>reason</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="service"></a> <code>service</code></td><td align="left"><a href="#assuranceservice"><code>AssuranceService</code></a> | <code>"
|
|
763
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="code-1"></a> <code>code</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="reason"></a> <code>reason</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="service"></a> <code>service</code></td><td align="left"><code>"auth"</code> | <a href="#assuranceservice"><code>AssuranceService</code></a> | <code>"attachment"</code></td></tr></tbody></table></div>
|
|
738
764
|
<hr>
|
|
739
765
|
<p><a id="assuranceeventevidence"></a></p>
|
|
740
766
|
<h3 id="assuranceeventevidence">AssuranceEventEvidence</h3>
|
|
@@ -1381,7 +1407,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
1381
1407
|
|
|
1382
1408
|
|
|
1383
1409
|
|
|
1384
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="data"></a> <code>data?</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr><tr><td align="left"><a id="method-1"></a> <code>method</code></td><td align="left"><code>"
|
|
1410
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="data"></a> <code>data?</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr><tr><td align="left"><a id="method-1"></a> <code>method</code></td><td align="left"><code>"delete"</code> | <code>"get"</code> | <code>"list"</code> | <code>"create"</code> | <code>"update"</code> | <code>"set"</code> | <code>"merge"</code></td></tr><tr><td align="left"><a id="path-1"></a> <code>path</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="query"></a> <code>query?</code></td><td align="left">{ <code>limit?</code>: <code>number</code>; <code>orderBy?</code>: { <code>direction?</code>: <code>"asc"</code> | <code>"desc"</code>; <code>field</code>: <code>string</code>; }[]; <code>where?</code>: <a href="#firestorequeryconstraint"><code>FirestoreQueryConstraint</code></a>[]; }</td></tr><tr><td align="left"><code>query.limit?</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><code>query.orderBy?</code></td><td align="left">{ <code>direction?</code>: <code>"asc"</code> | <code>"desc"</code>; <code>field</code>: <code>string</code>; }[]</td></tr><tr><td align="left"><code>query.where?</code></td><td align="left"><a href="#firestorequeryconstraint"><code>FirestoreQueryConstraint</code></a>[]</td></tr><tr><td align="left"><a id="service-2"></a> <code>service</code></td><td align="left"><code>"firestore"</code></td></tr></tbody></table></div>
|
|
1385
1411
|
<hr>
|
|
1386
1412
|
<p><a id="firestorequeryconstraint"></a></p>
|
|
1387
1413
|
<h3 id="firestorequeryconstraint">FirestoreQueryConstraint</h3>
|
|
@@ -1407,7 +1433,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
1407
1433
|
|
|
1408
1434
|
|
|
1409
1435
|
|
|
1410
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="field"></a> <code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="op-1"></a> <code>op</code></td><td align="left">| <code>"<"</code> | <code>"<="</code> | <code>"=="</code> | <code>"!="</code> | <code>">="</code> | <code>">"</code> | <code>"
|
|
1436
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="field"></a> <code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="op-1"></a> <code>op</code></td><td align="left">| <code>"<"</code> | <code>"<="</code> | <code>"=="</code> | <code>"!="</code> | <code>">="</code> | <code>">"</code> | <code>"in"</code> | <code>"not-in"</code> | <code>"array-contains"</code> | <code>"array-contains-any"</code></td></tr><tr><td align="left"><a id="value"></a> <code>value</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
|
|
1411
1437
|
<hr>
|
|
1412
1438
|
<p><a id="localfirebasetarget"></a></p>
|
|
1413
1439
|
<h3 id="localfirebasetarget">LocalFirebaseTarget</h3>
|
|
@@ -1745,7 +1771,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
1745
1771
|
|
|
1746
1772
|
|
|
1747
1773
|
|
|
1748
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="data-1"></a> <code>data?</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><a id="method-2"></a> <code>method</code></td><td align="left"><code>"get"</code> | <code>"
|
|
1774
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="data-1"></a> <code>data?</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><a id="method-2"></a> <code>method</code></td><td align="left"><code>"get"</code> | <code>"update"</code> | <code>"set"</code> | <code>"remove"</code></td></tr><tr><td align="left"><a id="path-2"></a> <code>path</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="query-1"></a> <code>query?</code></td><td align="left">{ <code>endAt?</code>: { <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }; <code>endBefore?</code>: { <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }; <code>equalTo?</code>: { <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }; <code>limitToFirst?</code>: <code>number</code>; <code>limitToLast?</code>: <code>number</code>; <code>orderBy?</code>: | { <code>kind</code>: <code>"child"</code>; <code>path</code>: <code>string</code>; } | { <code>kind</code>: <code>"key"</code>; } | { <code>kind</code>: <code>"value"</code>; }; <code>startAfter?</code>: { <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }; <code>startAt?</code>: { <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }; }</td></tr><tr><td align="left"><code>query.endAt?</code></td><td align="left">{ <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }</td></tr><tr><td align="left"><code>query.endAt.key?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>query.endAt.value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><code>query.endBefore?</code></td><td align="left">{ <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }</td></tr><tr><td align="left"><code>query.endBefore.key?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>query.endBefore.value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><code>query.equalTo?</code></td><td align="left">{ <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }</td></tr><tr><td align="left"><code>query.equalTo.key?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>query.equalTo.value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><code>query.limitToFirst?</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><code>query.limitToLast?</code></td><td align="left"><code>number</code></td></tr><tr><td align="left"><code>query.orderBy?</code></td><td align="left">| { <code>kind</code>: <code>"child"</code>; <code>path</code>: <code>string</code>; } | { <code>kind</code>: <code>"key"</code>; } | { <code>kind</code>: <code>"value"</code>; }</td></tr><tr><td align="left"><code>query.startAfter?</code></td><td align="left">{ <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }</td></tr><tr><td align="left"><code>query.startAfter.key?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>query.startAfter.value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><code>query.startAt?</code></td><td align="left">{ <code>key?</code>: <code>string</code>; <code>value</code>: <code>unknown</code>; }</td></tr><tr><td align="left"><code>query.startAt.key?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>query.startAt.value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><a id="service-3"></a> <code>service</code></td><td align="left"><code>"rtdb"</code></td></tr></tbody></table></div>
|
|
1749
1775
|
<hr>
|
|
1750
1776
|
<p><a id="runsecuritycasesinput"></a></p>
|
|
1751
1777
|
<h3 id="runsecuritycasesinput">RunSecurityCasesInput</h3>
|
|
@@ -1885,7 +1911,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
1885
1911
|
|
|
1886
1912
|
|
|
1887
1913
|
|
|
1888
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="confidence"></a> <code>confidence</code></td><td align="left"><code>"authoritative"</code> | <code>"strong"</code> | <code>"tentative"</code></td></tr><tr><td align="left"><a id="expected"></a> <code>expected</code></td><td align="left"><code>"ALLOW"</code> | <code>"DENY"</code></td></tr><tr><td align="left"><a id="id-10"></a> <code>id</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="service-4"></a> <code>service</code></td><td align="left"><a href="#assuranceservice"><code>AssuranceService</code></a> | <code>"cross-service"</code></td></tr><tr><td align="left"><a id="source-2"></a> <code>source</code></td><td align="left"><code>"
|
|
1914
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="confidence"></a> <code>confidence</code></td><td align="left"><code>"authoritative"</code> | <code>"strong"</code> | <code>"tentative"</code></td></tr><tr><td align="left"><a id="expected"></a> <code>expected</code></td><td align="left"><code>"ALLOW"</code> | <code>"DENY"</code></td></tr><tr><td align="left"><a id="id-10"></a> <code>id</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="service-4"></a> <code>service</code></td><td align="left"><a href="#assuranceservice"><code>AssuranceService</code></a> | <code>"cross-service"</code></td></tr><tr><td align="left"><a id="source-2"></a> <code>source</code></td><td align="left"><code>"agent"</code> | <code>"captured"</code> | <code>"declared"</code> | <code>"authored-test"</code> | <code>"derived"</code></td></tr><tr><td align="left"><a id="statement"></a> <code>statement</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
1889
1915
|
<hr>
|
|
1890
1916
|
<p><a id="statediff-1"></a></p>
|
|
1891
1917
|
<h3 id="statediff">StateDiff</h3>
|
|
@@ -1979,7 +2005,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
1979
2005
|
|
|
1980
2006
|
|
|
1981
2007
|
|
|
1982
|
-
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="contenttype-1"></a> <code>contentType?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="custommetadata-1"></a> <code>customMetadata?</code></td><td align="left"><code>Record</code><<code>string</code>, <code>string</code>></td></tr><tr><td align="left"><a id="database64-1"></a> <code>dataBase64?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="method-3"></a> <code>method</code></td><td align="left"><code>"
|
|
2008
|
+
<table><thead><tr><th align="left">Property</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><a id="contenttype-1"></a> <code>contentType?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="custommetadata-1"></a> <code>customMetadata?</code></td><td align="left"><code>Record</code><<code>string</code>, <code>string</code>></td></tr><tr><td align="left"><a id="database64-1"></a> <code>dataBase64?</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="method-3"></a> <code>method</code></td><td align="left"><code>"delete"</code> | <code>"get"</code> | <code>"list"</code> | <code>"upload"</code> | <code>"updateMetadata"</code></td></tr><tr><td align="left"><a id="path-4"></a> <code>path</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><a id="service-5"></a> <code>service</code></td><td align="left"><code>"storage"</code></td></tr></tbody></table></div>
|
|
1983
2009
|
<h2 id="type-aliases">Type Aliases</h2>
|
|
1984
2010
|
<p><a id="actoracquisition"></a></p>
|
|
1985
2011
|
<h3 id="actoracquisition">ActorAcquisition</h3>
|
|
@@ -2008,7 +2034,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2008
2034
|
<p><a id="assuranceattachmentprovider"></a></p>
|
|
2009
2035
|
<h3 id="assuranceattachmentprovider">AssuranceAttachmentProvider()</h3>
|
|
2010
2036
|
<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"> AssuranceAttachmentProvider</span><span style="color:#56B6C2"> =</span><span style="color:#ABB2BF"> (</span><span style="color:#E06C75;font-style:italic">input</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AssuranceAttachmentInput</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> Promise</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">AssuranceAttachment</span><span style="color:#ABB2BF">>;</span></span></code></pre>
|
|
2011
|
-
<h4 id="parameters-
|
|
2037
|
+
<h4 id="parameters-19">Parameters</h4>
|
|
2012
2038
|
<div class="table-scroll">
|
|
2013
2039
|
|
|
2014
2040
|
|
|
@@ -2023,7 +2049,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2023
2049
|
|
|
2024
2050
|
|
|
2025
2051
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>input</code></td><td align="left"><a href="#assuranceattachmentinput"><code>AssuranceAttachmentInput</code></a></td></tr></tbody></table></div>
|
|
2026
|
-
<h4 id="returns-
|
|
2052
|
+
<h4 id="returns-25">Returns</h4>
|
|
2027
2053
|
<p><code>Promise</code><<a href="#assuranceattachment"><code>AssuranceAttachment</code></a>></p>
|
|
2028
2054
|
<hr>
|
|
2029
2055
|
<p><a id="assurancedecision"></a></p>
|
|
@@ -2054,14 +2080,6 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2054
2080
|
<span class="line"><span style="color:#ABB2BF"> | </span><span style="color:#98C379">"engine-gap"</span></span>
|
|
2055
2081
|
<span class="line"><span style="color:#ABB2BF"> | </span><span style="color:#98C379">"invalid-probe"</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2056
2082
|
<h2 id="variables">Variables</h2>
|
|
2057
|
-
<p><a id="assurance_broadcast_channel"></a></p>
|
|
2058
|
-
<h3 id="assurance_broadcast_channel">ASSURANCE_BROADCAST_CHANNEL</h3>
|
|
2059
|
-
<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"> ASSURANCE_BROADCAST_CHANNEL</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"pyric-assurance-v1"</span><span style="color:#56B6C2"> =</span><span style="color:#98C379"> "pyric-assurance-v1"</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2060
|
-
<hr>
|
|
2061
|
-
<p><a id="assurance_browser_event"></a></p>
|
|
2062
|
-
<h3 id="assurance_browser_event">ASSURANCE_BROWSER_EVENT</h3>
|
|
2063
|
-
<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"> ASSURANCE_BROWSER_EVENT</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"pyric:assurance-campaign"</span><span style="color:#56B6C2"> =</span><span style="color:#98C379"> "pyric:assurance-campaign"</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2064
|
-
<hr>
|
|
2065
2083
|
<p><a id="assurance_campaign_schema"></a></p>
|
|
2066
2084
|
<h3 id="assurance_campaign_schema">ASSURANCE_CAMPAIGN_SCHEMA</h3>
|
|
2067
2085
|
<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"> ASSURANCE_CAMPAIGN_SCHEMA</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"pyric.assurance.campaign.v1"</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
@@ -2081,7 +2099,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2081
2099
|
<p><a id="createassurancetools"></a></p>
|
|
2082
2100
|
<h3 id="createassurancetools">createAssuranceTools()</h3>
|
|
2083
2101
|
<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"> createAssuranceTools</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">deps</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AssuranceToolDeps</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">ToolHandler</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">, </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">>[];</span></span></code></pre>
|
|
2084
|
-
<h4 id="parameters-
|
|
2102
|
+
<h4 id="parameters-20">Parameters</h4>
|
|
2085
2103
|
<div class="table-scroll">
|
|
2086
2104
|
|
|
2087
2105
|
|
|
@@ -2096,13 +2114,13 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2096
2114
|
|
|
2097
2115
|
|
|
2098
2116
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>deps?</code></td><td align="left"><a href="#assurancetooldeps"><code>AssuranceToolDeps</code></a></td></tr></tbody></table></div>
|
|
2099
|
-
<h4 id="returns-
|
|
2117
|
+
<h4 id="returns-26">Returns</h4>
|
|
2100
2118
|
<p><code>ToolHandler</code><<code>unknown</code>, <code>unknown</code>>[]</p>
|
|
2101
2119
|
<hr>
|
|
2102
2120
|
<p><a id="createauthorizationcampaign"></a></p>
|
|
2103
2121
|
<h3 id="createauthorizationcampaign">createAuthorizationCampaign()</h3>
|
|
2104
2122
|
<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"> createAuthorizationCampaign</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">options</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">CreateAuthorizationCampaignOptions</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">AuthorizationCampaign</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2105
|
-
<h4 id="parameters-
|
|
2123
|
+
<h4 id="parameters-21">Parameters</h4>
|
|
2106
2124
|
<div class="table-scroll">
|
|
2107
2125
|
|
|
2108
2126
|
|
|
@@ -2117,7 +2135,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2117
2135
|
|
|
2118
2136
|
|
|
2119
2137
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>options</code></td><td align="left"><a href="#createauthorizationcampaignoptions"><code>CreateAuthorizationCampaignOptions</code></a></td></tr></tbody></table></div>
|
|
2120
|
-
<h4 id="returns-
|
|
2138
|
+
<h4 id="returns-27">Returns</h4>
|
|
2121
2139
|
<p><a href="#authorizationcampaign"><code>AuthorizationCampaign</code></a></p>
|
|
2122
2140
|
<hr>
|
|
2123
2141
|
<p><a id="createsandboxattachmentprovider"></a></p>
|
|
@@ -2126,7 +2144,7 @@ Generated from the TypeScript declarations shipped at this import path.
|
|
|
2126
2144
|
<p>Clone the sandbox currently hosting the connected bridge peer. The URL is an
|
|
2127
2145
|
origin assertion and source for explicit rules metadata; no arbitrary host is
|
|
2128
2146
|
contacted and the returned campaign target itself keeps networking forbidden.</p>
|
|
2129
|
-
<h4 id="parameters-
|
|
2147
|
+
<h4 id="parameters-22">Parameters</h4>
|
|
2130
2148
|
<div class="table-scroll">
|
|
2131
2149
|
|
|
2132
2150
|
|
|
@@ -2144,30 +2162,9 @@ contacted and the returned campaign target itself keeps networking forbidden.</p
|
|
|
2144
2162
|
|
|
2145
2163
|
|
|
2146
2164
|
|
|
2147
|
-
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>sandbox</code></td><td align="left"><code>Sandbox</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><a href="#sandboxattachmentprovideroptions"><code>SandboxAttachmentProviderOptions</code></a></td></tr></tbody></table></div>
|
|
2148
|
-
<h4 id="returns-27">Returns</h4>
|
|
2149
|
-
<p><a href="#assuranceattachmentprovider"><code>AssuranceAttachmentProvider</code></a></p>
|
|
2150
|
-
<hr>
|
|
2151
|
-
<p><a id="publishassurancevisualization"></a></p>
|
|
2152
|
-
<h3 id="publishassurancevisualization">publishAssuranceVisualization()</h3>
|
|
2153
|
-
<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"> publishAssuranceVisualization</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AssuranceVisualizationSnapshot</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2154
|
-
<h4 id="parameters-22">Parameters</h4>
|
|
2155
|
-
<div class="table-scroll">
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>snapshot</code></td><td align="left"><a href="#assurancevisualizationsnapshot"><code>AssuranceVisualizationSnapshot</code></a></td></tr></tbody></table></div>
|
|
2165
|
+
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>sandbox</code></td><td align="left"><a href="/docs/pyric-firestore-reference-api/#sandbox"><code>Sandbox</code></a></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><a href="#sandboxattachmentprovideroptions"><code>SandboxAttachmentProviderOptions</code></a></td></tr></tbody></table></div>
|
|
2169
2166
|
<h4 id="returns-28">Returns</h4>
|
|
2170
|
-
<p><code>
|
|
2167
|
+
<p><a href="#assuranceattachmentprovider"><code>AssuranceAttachmentProvider</code></a></p>
|
|
2171
2168
|
<hr>
|
|
2172
2169
|
<p><a id="qualifyprobe"></a></p>
|
|
2173
2170
|
<h3 id="qualifyprobe">qualifyProbe()</h3>
|
|
@@ -2238,26 +2235,19 @@ change must preserve the application workflow and reject the boundary case.</p>
|
|
|
2238
2235
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>input</code></td><td align="left"><a href="#runsecuritycasesinput"><code>RunSecurityCasesInput</code></a></td></tr></tbody></table></div>
|
|
2239
2236
|
<h4 id="returns-31">Returns</h4>
|
|
2240
2237
|
<p><code>Promise</code><<a href="#authorizationcampaignreport-1"><code>AuthorizationCampaignReport</code></a>></p>
|
|
2238
|
+
<h2 id="references">References</h2>
|
|
2239
|
+
<p><a id="assurance_broadcast_channel"></a></p>
|
|
2240
|
+
<h3 id="assurance_broadcast_channel">ASSURANCE_BROADCAST_CHANNEL</h3>
|
|
2241
|
+
<p>Re-exports <a href="/docs/pyric-cli-assurance-browser-reference-api/#assurance_broadcast_channel">ASSURANCE_BROADCAST_CHANNEL</a></p>
|
|
2242
|
+
<hr>
|
|
2243
|
+
<p><a id="assurance_browser_event"></a></p>
|
|
2244
|
+
<h3 id="assurance_browser_event">ASSURANCE_BROWSER_EVENT</h3>
|
|
2245
|
+
<p>Re-exports <a href="/docs/pyric-cli-assurance-browser-reference-api/#assurance_browser_event">ASSURANCE_BROWSER_EVENT</a></p>
|
|
2246
|
+
<hr>
|
|
2247
|
+
<p><a id="publishassurancevisualization"></a></p>
|
|
2248
|
+
<h3 id="publishassurancevisualization">publishAssuranceVisualization</h3>
|
|
2249
|
+
<p>Re-exports <a href="/docs/pyric-cli-assurance-browser-reference-api/#publishassurancevisualization">publishAssuranceVisualization</a></p>
|
|
2241
2250
|
<hr>
|
|
2242
2251
|
<p><a id="subscribeassurancevisualizations"></a></p>
|
|
2243
|
-
<h3 id="subscribeassurancevisualizations">subscribeAssuranceVisualizations
|
|
2244
|
-
<
|
|
2245
|
-
<h4 id="parameters-26">Parameters</h4>
|
|
2246
|
-
<div class="table-scroll">
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>listener</code></td><td align="left">(<code>snapshot</code>: <a href="#assurancevisualizationsnapshot"><code>AssuranceVisualizationSnapshot</code></a>) => <code>void</code></td></tr></tbody></table></div>
|
|
2260
|
-
<h4 id="returns-32">Returns</h4>
|
|
2261
|
-
<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:#ABB2BF">(): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
2262
|
-
<h5 id="returns-33">Returns</h5>
|
|
2263
|
-
<p><code>void</code></p> </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols"> <h2 class="doc-toc-heading">Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter> <div class="api-symbol-groups" data-api-symbol-groups> <section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#classes"> Classes </a> <ul> <li data-api-symbol="assurancecampaignstore"> <a href="#assurancecampaignstore">AssuranceCampaignStore</a> </li><li data-api-symbol="assuranceinputerror"> <a href="#assuranceinputerror">AssuranceInputError</a> </li><li data-api-symbol="authorizationcampaign"> <a href="#authorizationcampaign">AuthorizationCampaign</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#interfaces"> Interfaces </a> <ul> <li data-api-symbol="actorevidence"> <a href="#actorevidence">ActorEvidence</a> </li><li data-api-symbol="assuranceactor"> <a href="#assuranceactor">AssuranceActor</a> </li><li data-api-symbol="assuranceattachment"> <a href="#assuranceattachment">AssuranceAttachment</a> </li><li data-api-symbol="assuranceattachmentinput"> <a href="#assuranceattachmentinput">AssuranceAttachmentInput</a> </li><li data-api-symbol="assuranceattachmentinventory"> <a href="#assuranceattachmentinventory">AssuranceAttachmentInventory</a> </li><li data-api-symbol="assuranceattachmentsource"> <a href="#assuranceattachmentsource">AssuranceAttachmentSource</a> </li><li data-api-symbol="assurancecampaigncontext"> <a href="#assurancecampaigncontext">AssuranceCampaignContext</a> </li><li data-api-symbol="assurancecoveragegap"> <a href="#assurancecoveragegap">AssuranceCoverageGap</a> </li><li data-api-symbol="assuranceeventevidence"> <a href="#assuranceeventevidence">AssuranceEventEvidence</a> </li><li data-api-symbol="assuranceobservation"> <a href="#assuranceobservation">AssuranceObservation</a> </li><li data-api-symbol="assuranceprobe"> <a href="#assuranceprobe">AssuranceProbe</a> </li><li data-api-symbol="assuranceproberesult"> <a href="#assuranceproberesult">AssuranceProbeResult</a> </li><li data-api-symbol="assurancereportsummary"> <a href="#assurancereportsummary">AssuranceReportSummary</a> </li><li data-api-symbol="assurancetooldeps"> <a href="#assurancetooldeps">AssuranceToolDeps</a> </li><li data-api-symbol="assurancevisualizationsnapshot"> <a href="#assurancevisualizationsnapshot">AssuranceVisualizationSnapshot</a> </li><li data-api-symbol="authfixtureuser"> <a href="#authfixtureuser">AuthFixtureUser</a> </li><li data-api-symbol="authorizationcampaignreport"> <a href="#authorizationcampaignreport">AuthorizationCampaignReport</a> </li><li data-api-symbol="authorizationcampaignspec"> <a href="#authorizationcampaignspec">AuthorizationCampaignSpec</a> </li><li data-api-symbol="campaignexport"> <a href="#campaignexport">CampaignExport</a> </li><li data-api-symbol="capabilityrequirement"> <a href="#capabilityrequirement">CapabilityRequirement</a> </li><li data-api-symbol="createauthorizationcampaignoptions"> <a href="#createauthorizationcampaignoptions">CreateAuthorizationCampaignOptions</a> </li><li data-api-symbol="enginequalification"> <a href="#enginequalification">EngineQualification</a> </li><li data-api-symbol="firestoreoperation"> <a href="#firestoreoperation">FirestoreOperation</a> </li><li data-api-symbol="firestorequeryconstraint"> <a href="#firestorequeryconstraint">FirestoreQueryConstraint</a> </li><li data-api-symbol="localfirebasetarget"> <a href="#localfirebasetarget">LocalFirebaseTarget</a> </li><li data-api-symbol="minimizationresult"> <a href="#minimizationresult">MinimizationResult</a> </li><li data-api-symbol="mutationcandidate"> <a href="#mutationcandidate">MutationCandidate</a> </li><li data-api-symbol="operationevidence"> <a href="#operationevidence">OperationEvidence</a> </li><li data-api-symbol="probemutation"> <a href="#probemutation">ProbeMutation</a> </li><li data-api-symbol="proposalinput"> <a href="#proposalinput">ProposalInput</a> </li><li data-api-symbol="rtdboperation"> <a href="#rtdboperation">RtdbOperation</a> </li><li data-api-symbol="runsecuritycasesinput"> <a href="#runsecuritycasesinput">RunSecurityCasesInput</a> </li><li data-api-symbol="sandboxattachmentprovideroptions"> <a href="#sandboxattachmentprovideroptions">SandboxAttachmentProviderOptions</a> </li><li data-api-symbol="securitycase"> <a href="#securitycase">SecurityCase</a> </li><li data-api-symbol="securityinvariant"> <a href="#securityinvariant">SecurityInvariant</a> </li><li data-api-symbol="statediff"> <a href="#statediff">StateDiff</a> </li><li data-api-symbol="storageobjectfixture"> <a href="#storageobjectfixture">StorageObjectFixture</a> </li><li data-api-symbol="storageoperation"> <a href="#storageoperation">StorageOperation</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="actoracquisition"> <a href="#actoracquisition">ActorAcquisition</a> </li><li data-api-symbol="assuranceattachmentprovider()"> <a href="#assuranceattachmentprovider">AssuranceAttachmentProvider()</a> </li><li data-api-symbol="assurancedecision"> <a href="#assurancedecision">AssuranceDecision</a> </li><li data-api-symbol="assuranceservice"> <a href="#assuranceservice">AssuranceService</a> </li><li data-api-symbol="firebaseoperation"> <a href="#firebaseoperation">FirebaseOperation</a> </li><li data-api-symbol="mutationdimension"> <a href="#mutationdimension">MutationDimension</a> </li><li data-api-symbol="probeclassification"> <a href="#probeclassification">ProbeClassification</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="assurance_broadcast_channel"> <a href="#assurance_broadcast_channel">ASSURANCE_BROADCAST_CHANNEL</a> </li><li data-api-symbol="assurance_browser_event"> <a href="#assurance_browser_event">ASSURANCE_BROWSER_EVENT</a> </li><li data-api-symbol="assurance_campaign_schema"> <a href="#assurance_campaign_schema">ASSURANCE_CAMPAIGN_SCHEMA</a> </li><li data-api-symbol="assurance_report_schema"> <a href="#assurance_report_schema">ASSURANCE_REPORT_SCHEMA</a> </li><li data-api-symbol="assurance_target_schema"> <a href="#assurance_target_schema">ASSURANCE_TARGET_SCHEMA</a> </li><li data-api-symbol="defaultassurancecampaignstore"> <a href="#defaultassurancecampaignstore">defaultAssuranceCampaignStore</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="createassurancetools()"> <a href="#createassurancetools">createAssuranceTools()</a> </li><li data-api-symbol="createauthorizationcampaign()"> <a href="#createauthorizationcampaign">createAuthorizationCampaign()</a> </li><li data-api-symbol="createsandboxattachmentprovider()"> <a href="#createsandboxattachmentprovider">createSandboxAttachmentProvider()</a> </li><li data-api-symbol="publishassurancevisualization()"> <a href="#publishassurancevisualization">publishAssuranceVisualization()</a> </li><li data-api-symbol="qualifyprobe()"> <a href="#qualifyprobe">qualifyProbe()</a> </li><li data-api-symbol="runauthorizationcampaign()"> <a href="#runauthorizationcampaign">runAuthorizationCampaign()</a> </li><li data-api-symbol="runsecuritycases()"> <a href="#runsecuritycases">runSecurityCases()</a> </li><li data-api-symbol="subscribeassurancevisualizations()"> <a href="#subscribeassurancevisualizations">subscribeAssuranceVisualizations()</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>
|
|
2252
|
+
<h3 id="subscribeassurancevisualizations">subscribeAssuranceVisualizations</h3>
|
|
2253
|
+
<p>Re-exports <a href="/docs/pyric-cli-assurance-browser-reference-api/#subscribeassurancevisualizations">subscribeAssuranceVisualizations</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="#classes"> Classes </a> <ul> <li data-api-symbol="assurancecampaignstore"> <a href="#assurancecampaignstore">AssuranceCampaignStore</a> </li><li data-api-symbol="assuranceinputerror"> <a href="#assuranceinputerror">AssuranceInputError</a> </li><li data-api-symbol="authorizationcampaign"> <a href="#authorizationcampaign">AuthorizationCampaign</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#interfaces"> Interfaces </a> <ul> <li data-api-symbol="actorevidence"> <a href="#actorevidence">ActorEvidence</a> </li><li data-api-symbol="assuranceactor"> <a href="#assuranceactor">AssuranceActor</a> </li><li data-api-symbol="assuranceattachment"> <a href="#assuranceattachment">AssuranceAttachment</a> </li><li data-api-symbol="assuranceattachmentinput"> <a href="#assuranceattachmentinput">AssuranceAttachmentInput</a> </li><li data-api-symbol="assuranceattachmentinventory"> <a href="#assuranceattachmentinventory">AssuranceAttachmentInventory</a> </li><li data-api-symbol="assuranceattachmentsource"> <a href="#assuranceattachmentsource">AssuranceAttachmentSource</a> </li><li data-api-symbol="assurancecampaigncontext"> <a href="#assurancecampaigncontext">AssuranceCampaignContext</a> </li><li data-api-symbol="assurancecoveragegap"> <a href="#assurancecoveragegap">AssuranceCoverageGap</a> </li><li data-api-symbol="assuranceeventevidence"> <a href="#assuranceeventevidence">AssuranceEventEvidence</a> </li><li data-api-symbol="assuranceobservation"> <a href="#assuranceobservation">AssuranceObservation</a> </li><li data-api-symbol="assuranceprobe"> <a href="#assuranceprobe">AssuranceProbe</a> </li><li data-api-symbol="assuranceproberesult"> <a href="#assuranceproberesult">AssuranceProbeResult</a> </li><li data-api-symbol="assurancereportsummary"> <a href="#assurancereportsummary">AssuranceReportSummary</a> </li><li data-api-symbol="assurancetooldeps"> <a href="#assurancetooldeps">AssuranceToolDeps</a> </li><li data-api-symbol="assurancevisualizationsnapshot"> <a href="#assurancevisualizationsnapshot">AssuranceVisualizationSnapshot</a> </li><li data-api-symbol="authfixtureuser"> <a href="#authfixtureuser">AuthFixtureUser</a> </li><li data-api-symbol="authorizationcampaignreport"> <a href="#authorizationcampaignreport">AuthorizationCampaignReport</a> </li><li data-api-symbol="authorizationcampaignspec"> <a href="#authorizationcampaignspec">AuthorizationCampaignSpec</a> </li><li data-api-symbol="campaignexport"> <a href="#campaignexport">CampaignExport</a> </li><li data-api-symbol="capabilityrequirement"> <a href="#capabilityrequirement">CapabilityRequirement</a> </li><li data-api-symbol="createauthorizationcampaignoptions"> <a href="#createauthorizationcampaignoptions">CreateAuthorizationCampaignOptions</a> </li><li data-api-symbol="enginequalification"> <a href="#enginequalification">EngineQualification</a> </li><li data-api-symbol="firestoreoperation"> <a href="#firestoreoperation">FirestoreOperation</a> </li><li data-api-symbol="firestorequeryconstraint"> <a href="#firestorequeryconstraint">FirestoreQueryConstraint</a> </li><li data-api-symbol="localfirebasetarget"> <a href="#localfirebasetarget">LocalFirebaseTarget</a> </li><li data-api-symbol="minimizationresult"> <a href="#minimizationresult">MinimizationResult</a> </li><li data-api-symbol="mutationcandidate"> <a href="#mutationcandidate">MutationCandidate</a> </li><li data-api-symbol="operationevidence"> <a href="#operationevidence">OperationEvidence</a> </li><li data-api-symbol="probemutation"> <a href="#probemutation">ProbeMutation</a> </li><li data-api-symbol="proposalinput"> <a href="#proposalinput">ProposalInput</a> </li><li data-api-symbol="rtdboperation"> <a href="#rtdboperation">RtdbOperation</a> </li><li data-api-symbol="runsecuritycasesinput"> <a href="#runsecuritycasesinput">RunSecurityCasesInput</a> </li><li data-api-symbol="sandboxattachmentprovideroptions"> <a href="#sandboxattachmentprovideroptions">SandboxAttachmentProviderOptions</a> </li><li data-api-symbol="securitycase"> <a href="#securitycase">SecurityCase</a> </li><li data-api-symbol="securityinvariant"> <a href="#securityinvariant">SecurityInvariant</a> </li><li data-api-symbol="statediff"> <a href="#statediff">StateDiff</a> </li><li data-api-symbol="storageobjectfixture"> <a href="#storageobjectfixture">StorageObjectFixture</a> </li><li data-api-symbol="storageoperation"> <a href="#storageoperation">StorageOperation</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="actoracquisition"> <a href="#actoracquisition">ActorAcquisition</a> </li><li data-api-symbol="assuranceattachmentprovider()"> <a href="#assuranceattachmentprovider">AssuranceAttachmentProvider()</a> </li><li data-api-symbol="assurancedecision"> <a href="#assurancedecision">AssuranceDecision</a> </li><li data-api-symbol="assuranceservice"> <a href="#assuranceservice">AssuranceService</a> </li><li data-api-symbol="firebaseoperation"> <a href="#firebaseoperation">FirebaseOperation</a> </li><li data-api-symbol="mutationdimension"> <a href="#mutationdimension">MutationDimension</a> </li><li data-api-symbol="probeclassification"> <a href="#probeclassification">ProbeClassification</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="assurance_campaign_schema"> <a href="#assurance_campaign_schema">ASSURANCE_CAMPAIGN_SCHEMA</a> </li><li data-api-symbol="assurance_report_schema"> <a href="#assurance_report_schema">ASSURANCE_REPORT_SCHEMA</a> </li><li data-api-symbol="assurance_target_schema"> <a href="#assurance_target_schema">ASSURANCE_TARGET_SCHEMA</a> </li><li data-api-symbol="defaultassurancecampaignstore"> <a href="#defaultassurancecampaignstore">defaultAssuranceCampaignStore</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="createassurancetools()"> <a href="#createassurancetools">createAssuranceTools()</a> </li><li data-api-symbol="createauthorizationcampaign()"> <a href="#createauthorizationcampaign">createAuthorizationCampaign()</a> </li><li data-api-symbol="createsandboxattachmentprovider()"> <a href="#createsandboxattachmentprovider">createSandboxAttachmentProvider()</a> </li><li data-api-symbol="qualifyprobe()"> <a href="#qualifyprobe">qualifyProbe()</a> </li><li data-api-symbol="runauthorizationcampaign()"> <a href="#runauthorizationcampaign">runAuthorizationCampaign()</a> </li><li data-api-symbol="runsecuritycases()"> <a href="#runsecuritycases">runSecurityCases()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group> <a class="api-symbol-kind" href="#references"> References </a> <ul> <li data-api-symbol="assurance_broadcast_channel"> <a href="#assurance_broadcast_channel">ASSURANCE_BROADCAST_CHANNEL</a> </li><li data-api-symbol="assurance_browser_event"> <a href="#assurance_browser_event">ASSURANCE_BROWSER_EVENT</a> </li><li data-api-symbol="publishassurancevisualization"> <a href="#publishassurancevisualization">publishAssuranceVisualization</a> </li><li data-api-symbol="subscribeassurancevisualizations"> <a href="#subscribeassurancevisualizations">subscribeAssuranceVisualizations</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>
|