@pyric/cli 0.1.0-alpha.16 → 0.1.0-alpha.18

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

@@ -306,9 +306,13 @@ reference traces.
 | <a id="resource"></a> `resource?` | `public` | \{ `data`: `Record`\<`string`, `unknown`\>; `exists`: `boolean`; \} | Eval-time existing-document snapshot — what the rule saw on `resource.data`. `null` data with `exists: false` mirrors how the rule sees an absent doc. Absent for collection ops (`list`). |
 | `resource.data` | `public` | `Record`\<`string`, `unknown`\> | - |
 | `resource.exists` | `public` | `boolean` | - |
-| <a id="rule"></a> `rule?` | `public` | \{ `expression`: `string`; `line`: `number`; \} | The rule whose evaluation produced the denial. Best effort; may be absent until source positions land in the AST. |
-| `rule.expression` | `public` | `string` | - |
-| `rule.line` | `public` | `number` | - |
+| <a id="rule"></a> `rule?` | `public` | \{ `citation?`: `string`; `col?`: `number`; `column?`: `number`; `expression?`: `string`; `file?`: `string`; `line?`: `number`; \} | The rule whose evaluation produced the denial (#370). |
+| `rule.citation?` | `public` | `string` | - |
+| `rule.col?` | `public` | `number` | - |
+| `rule.column?` | `public` | `number` | - |
+| `rule.expression?` | `public` | `string` | - |
+| `rule.file?` | `public` | `string` | - |
+| `rule.line?` | `public` | `number` | - |
 
 ***
 
@@ -1009,12 +1013,12 @@ as a user, while an app or agent may use an admin lens.
 | `auth.token?` | `public` | `Record`\<`string`, `unknown`\> |
 | `auth.uid` | `public` | `string` |
 | <a id="context"></a> `context` | `readonly` | [`OperationContext`](#operationcontext-2) |
-| <a id="eventkind"></a> `eventKind` | `readonly` | `"request"` \| `"operation"` |
+| <a id="eventkind"></a> `eventKind` | `readonly` | `"request"` \| `"listener"` \| `"operation"` |
 | <a id="id-1"></a> `id` | `readonly` | `string` |
 | <a id="method"></a> `method` | `readonly` | `string` |
 | <a id="path"></a> `path?` | `readonly` | `string` |
-| <a id="result"></a> `result` | `readonly` | `"unsupported"` \| `"error"` \| `"allow"` \| `"deny"` \| `"not-applicable"` |
-| <a id="rules-1"></a> `rules` | `readonly` | [`RulesDisposition`](#rulesdisposition-2) |
+| <a id="result"></a> `result?` | `readonly` | `"unsupported"` \| `"error"` \| `"allow"` \| `"deny"` \| `"not-applicable"` |
+| <a id="rules-1"></a> `rules` | `readonly` | [`RulesDisposition`](#rulesdisposition-3) |
 | <a id="service-1"></a> `service` | `readonly` | [`EventService`](#eventservice) |
 
 ***
@@ -2089,7 +2093,7 @@ traffic-monitor-decision.md for the field-by-field rationale.
 | `resourceBefore.data` | `Record`\<`string`, `unknown`\> | - |
 | `resourceBefore.exists` | `boolean` | - |
 | <a id="result-1"></a> `result` | `"unsupported"` \| `"allow"` \| `"deny"` | `'unsupported'` fires when the simulator hit an unmodelled feature and the sandbox upgraded it (today: thrown as SimulatorUnsupportedError, surfaced here as a discrete result so the panel can show it distinctly from a real denial). |
-| <a id="rulesdisposition"></a> `rulesDisposition?` | [`RulesDisposition`](#rulesdisposition-2) | Canonical statement of whether Security Rules evaluated this request. Added by the sandbox event recorder when an older emitter omits it. |
+| <a id="rulesdisposition"></a> `rulesDisposition?` | [`RulesDisposition`](#rulesdisposition-3) | Canonical statement of whether Security Rules evaluated this request. Added by the sandbox event recorder when an older emitter omits it. |
 | <a id="triggeredby"></a> `triggeredBy?` | \{ `method`: `string`; `path`: `string`; \} | For listener re-evals: the originating user op that triggered this re-evaluation. Absent on the initial-snapshot fire. |
 | `triggeredBy.method` | `string` | - |
 | `triggeredBy.path` | `string` | - |
@@ -2168,7 +2172,18 @@ service listeners the same debuggable surface.
 | <a id="listenerid-2"></a> `listenerId` | `string` |
 | <a id="phase"></a> `phase` | `"attach"` \| `"detach"` \| `"delivery"` \| `"suppressed"` \| `"errored"` |
 | <a id="reason"></a> `reason?` | `string` |
+| <a id="reasons-3"></a> `reasons?` | `string`[] |
 | <a id="result-2"></a> `result?` | `"unsupported"` \| `"error"` \| `"allow"` \| `"deny"` |
+| <a id="rules-2"></a> `rules?` | \{ `engine`: `"firestore"` \| `"rtdb"` \| `"storage"`; `errorCode?`: `string`; `matchedPath?`: `string`; `matchedRule?`: `string`; `operations?`: `string`[]; `pathVariableBindings?`: `Record`\<`string`, `string`\>; `reason?`: `string`; `ruleIndex?`: `number`; \} |
+| `rules.engine` | `"firestore"` \| `"rtdb"` \| `"storage"` |
+| `rules.errorCode?` | `string` |
+| `rules.matchedPath?` | `string` |
+| `rules.matchedRule?` | `string` |
+| `rules.operations?` | `string`[] |
+| `rules.pathVariableBindings?` | `Record`\<`string`, `string`\> |
+| `rules.reason?` | `string` |
+| `rules.ruleIndex?` | `number` |
+| <a id="rulesdisposition-1"></a> `rulesDisposition?` | [`RulesDisposition`](#rulesdisposition-3) |
 | <a id="sample"></a> `sample?` | `unknown` |
 | <a id="service-3"></a> `service` | [`EventService`](#eventservice) |
 | <a id="size"></a> `size?` | `number` |
@@ -2213,7 +2228,7 @@ their state is a Firestore document.
 | <a id="method-3"></a> `method` | `string` | - |
 | <a id="origin-1"></a> `origin` | `"admin"` \| `"user"` \| `"system"` \| `"transaction"` \| `"listener"` \| `"batch"` | - |
 | <a id="path-3"></a> `path?` | `string` | - |
-| <a id="reasons-3"></a> `reasons?` | `string`[] | - |
+| <a id="reasons-4"></a> `reasons?` | `string`[] | - |
 | <a id="request-3"></a> `request?` | \{ `data?`: `unknown`; `query?`: `unknown`; `resourceData?`: `unknown`; \} | - |
 | `request.data?` | `unknown` | - |
 | `request.query?` | `unknown` | - |
@@ -2225,7 +2240,7 @@ their state is a Firestore document.
 | `resourceBefore.data` | `unknown` | - |
 | `resourceBefore.exists` | `boolean` | - |
 | <a id="result-3"></a> `result` | `"unsupported"` \| `"error"` \| `"allow"` \| `"deny"` \| `"not-applicable"` | - |
-| <a id="rules-2"></a> `rules?` | \{ `engine`: `"firestore"` \| `"rtdb"` \| `"storage"`; `errorCode?`: `string`; `matchedPath?`: `string`; `matchedRule?`: `string`; `operations?`: `string`[]; `pathVariableBindings?`: `Record`\<`string`, `string`\>; `reason?`: `string`; `ruleIndex?`: `number`; \} | - |
+| <a id="rules-3"></a> `rules?` | \{ `engine`: `"firestore"` \| `"rtdb"` \| `"storage"`; `errorCode?`: `string`; `matchedPath?`: `string`; `matchedRule?`: `string`; `operations?`: `string`[]; `pathVariableBindings?`: `Record`\<`string`, `string`\>; `reason?`: `string`; `ruleIndex?`: `number`; \} | - |
 | `rules.engine` | `"firestore"` \| `"rtdb"` \| `"storage"` | - |
 | `rules.errorCode?` | `string` | - |
 | `rules.matchedPath?` | `string` | - |
@@ -2234,7 +2249,7 @@ their state is a Firestore document.
 | `rules.pathVariableBindings?` | `Record`\<`string`, `string`\> | - |
 | `rules.reason?` | `string` | - |
 | `rules.ruleIndex?` | `number` | - |
-| <a id="rulesdisposition-1"></a> `rulesDisposition?` | [`RulesDisposition`](#rulesdisposition-2) | Canonical statement of whether Security Rules evaluated this operation. Service emitters may provide it directly; the recorder normalizes legacy operation shapes at the unified stream seam. |
+| <a id="rulesdisposition-2"></a> `rulesDisposition?` | [`RulesDisposition`](#rulesdisposition-3) | Canonical statement of whether Security Rules evaluated this operation. Service emitters may provide it directly; the recorder normalizes legacy operation shapes at the unified stream seam. |
 | <a id="service-4"></a> `service` | [`EventService`](#eventservice) | - |
 | <a id="triggeredby-2"></a> `triggeredBy?` | \{ `method`: `string`; `path?`: `string`; \} | - |
 | `triggeredBy.method` | `string` | - |
@@ -2446,7 +2461,7 @@ scenario surfaces them.
 | `auth.uid` | `string` |
 | <a id="code-1"></a> `code` | `"permission-denied"` |
 | <a id="message-1"></a> `message` | `string` |
-| <a id="reasons-4"></a> `reasons?` | `string`[] |
+| <a id="reasons-5"></a> `reasons?` | `string`[] |
 | <a id="request-4"></a> `request?` | \{ `method`: `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"`; `path`: `string`; `resourceData?`: `Record`\<`string`, `unknown`\>; \} |
 | `request.method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` |
 | `request.path` | `string` |
@@ -2771,7 +2786,7 @@ lazy inside the handle's channel).
 
 ***
 
-<a id="rulesdisposition-2"></a>
+<a id="rulesdisposition-3"></a>
 
 ### RulesDisposition
 
@@ -3460,7 +3475,7 @@ presence of a trace themselves.
 
 #### Returns
 
-[`RulesDisposition`](#rulesdisposition-2)
+[`RulesDisposition`](#rulesdisposition-3)
 
 ***