@pyric/ui 0.1.0-alpha.11 → 0.1.0-alpha.13

package/src/traffic/types.ts

@@ -0,0 +1,85 @@
+/**
+ * The traffic domain types. `TrafficEvent` is structurally identical
+ * to `pyric/sandbox`'s `RequestEvent` (locked in
+ * the design rationale) — but the library defines its
+ * own copy so it never imports `pyric/sandbox`. `sandbox.onRequest`
+ * is assignable as a `TrafficSource` with zero adapter code; a prod
+ * log feed can satisfy the same shape.
+ */
+
+export type TrafficMethod =
+  | 'get'
+  | 'list'
+  | 'create'
+  | 'update'
+  | 'set'
+  | 'delete'
+  | 'remove'
+  | 'push'
+  | 'listen'
+  | 'transaction'
+  | (string & {});
+
+export type TrafficResult = 'allow' | 'deny' | 'unsupported' | 'error' | 'not-applicable';
+
+export type TrafficOrigin = 'user' | 'listener' | 'transaction' | 'batch' | 'admin' | 'system';
+
+export interface TrafficAuthState {
+  uid: string;
+  token?: Record<string, unknown>;
+}
+
+export interface TrafficResourceState {
+  data: unknown;
+  exists: boolean;
+}
+
+export interface TrafficMatchedRule {
+  ruleIndex: number;
+  operations: string[];
+}
+
+export interface TrafficEvent {
+  /** Unique per emission. */
+  id: string;
+  /** Source event kind. Firestore request events omit this in older adapters. */
+  kind?: 'request' | 'operation';
+  /** Service that emitted the event. Omitted means Firestore. */
+  service?: 'firestore' | 'auth' | 'storage' | 'rtdb' | (string & {});
+  /** `Date.now()` at op start. */
+  at: number;
+  /** Simulator eval duration in ms. De-featured in the UI (local
+   *  simulator) — present for the detail panel only. */
+  evalMs?: number;
+  /** Canonical service-operation duration. */
+  durationMs?: number;
+  method: TrafficMethod;
+  path: string;
+  auth: TrafficAuthState | null;
+  result: TrafficResult;
+  /** Simulator debug messages — `Rule #N (op) → ALLOW` format. */
+  reasons: string[];
+  /** Proposed write payload — absent on reads + delete. */
+  request?: { data?: unknown; resourceData?: unknown; query?: unknown };
+  /** Existing doc state before the write (or the read target). */
+  resourceBefore?: TrafficResourceState;
+  /** Projected doc state after the write — absent on reads. */
+  resourceAfter?: TrafficResourceState;
+  /** Parsed from the matched `Rule #N` debug line — absent if none. */
+  matchedRule?: TrafficMatchedRule;
+  origin: TrafficOrigin;
+  /** Shared across ops in one batch or transaction. */
+  groupId?: string;
+  groupKind?: 'batch' | 'transaction' | (string & {});
+  /** For listener re-evals — the originating user op. */
+  triggeredBy?: { method: string; path?: string };
+}
+
+/**
+ * A subscription function: register a callback, get back an
+ * unsubscribe. `pyric/sandbox`'s `Sandbox.onRequest` matches this
+ * signature exactly.
+ */
+export type TrafficSource = (
+  cb: (event: TrafficEvent) => void,
+) => () => void;