pi-guard 1.0.0

package/src/types.ts

@@ -0,0 +1,52 @@
+import type { Command } from "unbash";
+
+/** A concrete command node together with the source string its positions refer to. */
+export interface CommandRef {
+  node: Command;
+  source: string;
+}
+
+/** Matcher types define how to extract and match input from a tool call. */
+export type MatcherType = "bash" | "glob" | "exact";
+
+/** Defines how to extract and match input from a tool call. */
+export interface Matcher {
+  /** Tool parameter to extract (e.g., "command", "path", "url") */
+  param: string;
+  /** How to match the extracted value */
+  type: MatcherType;
+}
+
+/** Permission actions. */
+export type Action = "allow" | "ask" | "deny";
+
+/** Rules for a single tool - can be a single action or pattern-based rules. */
+export type ToolRules = Action | Record<string, Action>;
+
+/** All rules organized by tool name. */
+export type Rules = Action | Record<string, ToolRules>;
+
+/** Custom matchers for additional tools. */
+export type Matchers = Record<string, Matcher>;
+
+/** Full configuration for pi-guard. */
+export interface GuardConfig {
+  enabled: boolean;
+  matchers?: Matchers;
+  rules: Rules;
+}
+
+/** Result of a permission check. */
+export interface PermissionResult {
+  /** Whether to block the tool call */
+  block: boolean;
+  /** Human-readable reason for the decision */
+  reason?: string;
+  /** Context to inject into the tool result */
+  context?: string;
+}
+
+/** Tool call event shape for type-safe matching. */
+export interface ToolCallInput {
+  [key: string]: unknown;
+}