@pyric/cli 0.1.0-alpha.10 → 0.1.0-alpha.12

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

@@ -1,5 +1,4 @@
-
-<!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
 
 ## Interfaces
 
@@ -24,11 +23,11 @@ request fields alongside.
 | `auth.token` | `Record`\<`string`, `unknown`\> | - |
 | `auth.uid` | `string` | - |
 | <a id="decision"></a> `decision` | `"DENY"` | - |
-| <a id="evaluation"></a> `evaluation` | `RuleEvaluation`[] | Per allow-rule evaluation, in source order. Each entry carries the `line`, `verdict`, `conditionText`, and `expressionTrace`. |
+| <a id="evaluation"></a> `evaluation` | [`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)[] | Per allow-rule evaluation, in source order. Each entry carries the `line`, `verdict`, `conditionText`, and `expressionTrace`. |
 | <a id="lens"></a> `lens?` | [`DenialLens`](#deniallens-1) | Identity lens the request was issued under. |
-| <a id="method"></a> `method` | `FirestoreMethod` | - |
+| <a id="method"></a> `method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` | - |
 | <a id="path"></a> `path` | `string` | Resource path, e.g. `notes/3agHoZHZ`. |
-| <a id="pathresolution"></a> `pathResolution?` | `PathResolutionTrace` | Path-resolution attempts — present for no-match (default-deny) denials, where no `allow` rule was evaluated because no `match` block covered the path. |
+| <a id="pathresolution"></a> `pathResolution?` | [`PathResolutionTrace`](pyric-rules-reference-api.md#pathresolutiontrace) | Path-resolution attempts — present for no-match (default-deny) denials, where no `allow` rule was evaluated because no `match` block covered the path. |
 | <a id="requestdata"></a> `requestData?` | `Record`\<`string`, `unknown`\> | `request.resource.data` — present for writes. |
 | <a id="resourcedata"></a> `resourceData?` | `Record`\<`string`, `unknown`\> | `resource.data` — the existing document, `null` when absent. |
 | <a id="rulessource"></a> `rulesSource` | `string` | `firestore.rules` source the request was evaluated against. |
@@ -121,7 +120,7 @@ the request was denied.
 | <a id="auth-1"></a> `auth?` | \{ `token?`: `Record`\<`string`, `unknown`\>; `uid`: `string`; \} | `request.auth` — `null`/omitted for unauthenticated. |
 | `auth.token?` | `Record`\<`string`, `unknown`\> | - |
 | `auth.uid` | `string` | - |
-| <a id="method-1"></a> `method` | `FirestoreMethod` | - |
+| <a id="method-1"></a> `method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` | - |
 | <a id="path-1"></a> `path` | `string` | Resource path, e.g. `notes/3agHoZHZ`. |
 | <a id="requestdata-1"></a> `requestData?` | `Record`\<`string`, `unknown`\> | `request.resource.data` — for writes. |
 | <a id="requesttime"></a> `requestTime?` | `string` | Override `request.time` (ISO-8601). Defaults to wallclock. |
@@ -138,9 +137,9 @@ the request was denied.
 | Property | Type | Description |
 | :------ | :------ | :------ |
 | <a id="error"></a> `error?` | `string` | Populated when `ok` is false (e.g. the rules source failed to parse). |
-| <a id="evaluation-1"></a> `evaluation` | `RuleEvaluation`[] | Per allow-rule evaluation, in source order. Empty for no-match denials. |
+| <a id="evaluation-1"></a> `evaluation` | [`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)[] | Per allow-rule evaluation, in source order. Empty for no-match denials. |
 | <a id="ok"></a> `ok` | `boolean` | True when the simulator could parse + evaluate. False on a parse error. |
-| <a id="pathresolution-1"></a> `pathResolution?` | `PathResolutionTrace` | Which `match` blocks the resolver tried — present for no-match denials. |
+| <a id="pathresolution-1"></a> `pathResolution?` | [`PathResolutionTrace`](pyric-rules-reference-api.md#pathresolutiontrace) | Which `match` blocks the resolver tried — present for no-match denials. |
 
 ***
 
@@ -214,16 +213,6 @@ allow line; `skip` is an allow line whose operations don't include
 the request method ("not checked"); `allow` is any other allow line.
 Non-allow lines (match/braces/comments) get no verdict.
 
-***
-
-<a id="ruleevaluation"></a>
-
-### RuleEvaluation
-
-```ts
-type RuleEvaluation = any;
-```
-
 ## Functions
 
 <a id="decidingevaluation"></a>
@@ -231,7 +220,7 @@ type RuleEvaluation = any;
 ### decidingEvaluation()
 
 ```ts
-function decidingEvaluation(evaluation: RuleEvaluation[]): any;
+function decidingEvaluation(evaluation: RuleEvaluation[]): RuleEvaluation;
 ```
 
 The allow rule that decided the denial: the last rule actually
@@ -243,11 +232,11 @@ last evaluated one — the closest miss the user should reason about.
 
 | Parameter | Type |
 | :------ | :------ |
-| `evaluation` | `RuleEvaluation`[] |
+| `evaluation` | [`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)[] |
 
 #### Returns
 
-`any`
+[`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)
 
 ***
 
@@ -292,7 +281,7 @@ Zero styling — every visual decision is a consumer's via the
 ```ts
 function denialReason(
    evaluation: RuleEvaluation[],
-   method: FirestoreMethod,
+   method: "delete" | "get" | "list" | "create" | "update",
    path: string): string;
 ```
 
@@ -304,8 +293,8 @@ rule was evaluated.
 
 | Parameter | Type |
 | :------ | :------ |
-| `evaluation` | `RuleEvaluation`[] |
-| `method` | `FirestoreMethod` |
+| `evaluation` | [`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)[] |
+| `method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` |
 | `path` | `string` |
 
 #### Returns
@@ -345,7 +334,7 @@ Render a trace value the way the mock shows it: JSON-ish, quoted
 function markRuleLines(
    rulesSource: string,
    evaluation: RuleEvaluation[],
-   method: FirestoreMethod): RuleLine[];
+   method: "delete" | "get" | "list" | "create" | "update"): RuleLine[];
 ```
 
 Split the rules source into numbered lines and mark each `allow` line
@@ -362,8 +351,8 @@ Verdicts are matched to source lines via `RuleEvaluation.line` (1-indexed
 | Parameter | Type |
 | :------ | :------ |
 | `rulesSource` | `string` |
-| `evaluation` | `RuleEvaluation`[] |
-| `method` | `FirestoreMethod` |
+| `evaluation` | [`RuleEvaluation`](pyric-rules-reference-api.md#ruleevaluation)[] |
+| `method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` |
 
 #### Returns
 
@@ -376,7 +365,7 @@ Verdicts are matched to source lines via `RuleEvaluation.line` (1-indexed
 ### methodOperations()
 
 ```ts
-function methodOperations(method: FirestoreMethod): string[];
+function methodOperations(method: "delete" | "get" | "list" | "create" | "update"): string[];
 ```
 
 Operations a request method satisfies — `update` matches `update` and
@@ -386,7 +375,7 @@ Operations a request method satisfies — `update` matches `update` and
 
 | Parameter | Type |
 | :------ | :------ |
-| `method` | `FirestoreMethod` |
+| `method` | `"delete"` \| `"get"` \| `"list"` \| `"create"` \| `"update"` |
 
 #### Returns
 
@@ -433,7 +422,7 @@ Depth of a trace node from its `parent` chain (0 for roots).
 
 | Parameter | Type |
 | :------ | :------ |
-| `entries` | `ExprTraceEntry`[] |
+| `entries` | [`ExprTraceEntry`](pyric-rules-reference-api.md#exprtraceentry)[] |
 | `index` | `number` |
 
 #### Returns
@@ -481,7 +470,7 @@ const denial: Denial = { ...req, decision: 'DENY', rulesSource: rules,
 
 ### ExprTraceEntry
 
-Renames and re-exports [RuleEvaluation](#ruleevaluation)
+Re-exports [ExprTraceEntry](pyric-rules-reference-api.md#exprtraceentry)
 
 ***
 
@@ -489,7 +478,7 @@ Renames and re-exports [RuleEvaluation](#ruleevaluation)
 
 ### FirestoreMethod
 
-Renames and re-exports [RuleEvaluation](#ruleevaluation)
+Re-exports [FirestoreMethod](pyric-rules-reference-api.md#firestoremethod)
 
 ***
 
@@ -497,7 +486,7 @@ Renames and re-exports [RuleEvaluation](#ruleevaluation)
 
 ### PathResolutionEntry
 
-Renames and re-exports [RuleEvaluation](#ruleevaluation)
+Re-exports [PathResolutionEntry](pyric-rules-reference-api.md#pathresolutionentry)
 
 ***
 
@@ -505,4 +494,12 @@ Renames and re-exports [RuleEvaluation](#ruleevaluation)
 
 ### PathResolutionTrace
 
-Renames and re-exports [RuleEvaluation](#ruleevaluation)
+Re-exports [PathResolutionTrace](pyric-rules-reference-api.md#pathresolutiontrace)
+
+***
+
+<a id="ruleevaluation"></a>
+
+### RuleEvaluation
+
+Re-exports [RuleEvaluation](pyric-rules-reference-api.md#ruleevaluation)