@pome-sh/checks 0.1.0

package/dist/_types/wire/recorder-events.d.ts

@@ -0,0 +1,526 @@
+/**
+ * recorder-events — twin runtime trace format
+ *
+ * Single source of truth for the per-request event a twin runtime emits into
+ * its recorder ring buffer. Consumed by:
+ *   - twin runtimes (`@pome-sh/twin-github`, `@pome-sh/twin-stripe`) — emit shape
+ *   - `@pome-sh/sdk` — read shape for post-run analysis
+ *   - `pome-cloud` correlator — input to trace correlation on ingest
+ *   - `pome-cloud` recorder writers — persisted shape for events.jsonl S3 blob
+ *
+ * v1.0 freeze of the twin runtime trace format. Breaking changes go through a
+ * documented deprecation policy.
+ */
+import { z } from "zod";
+export declare const KNOWN_TWIN_IDS: readonly ["github", "stripe", "slack", "gmail", "linear"];
+export type KnownTwinId = (typeof KNOWN_TWIN_IDS)[number];
+export declare const twinIdSchema: z.ZodString;
+export type TwinId = z.infer<typeof twinIdSchema>;
+export declare const recorderFidelitySchema: z.ZodEnum<{
+    semantic: "semantic";
+    unsupported: "unsupported";
+}>;
+export type RecorderFidelity = z.infer<typeof recorderFidelitySchema>;
+export declare const stateDeltaSchema: z.ZodNullable<z.ZodObject<{
+    before: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    after: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>>;
+export type StateDelta = z.infer<typeof stateDeltaSchema>;
+export declare const recorderEventSchema: z.ZodPipe<z.ZodObject<{
+    ts: z.ZodString;
+    run_id: z.ZodString;
+    twin: z.ZodString;
+    request_id: z.ZodString;
+    correlation_id: z.ZodOptional<z.ZodString>;
+    task_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    scenario_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    step_id: z.ZodNullable<z.ZodString>;
+    tool_call_id: z.ZodNullable<z.ZodString>;
+    method: z.ZodString;
+    path: z.ZodString;
+    request_body: z.ZodUnknown;
+    request_headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    tool: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodNumber;
+    response_body: z.ZodUnknown;
+    latency_ms: z.ZodNumber;
+    fidelity: z.ZodEnum<{
+        semantic: "semantic";
+        unsupported: "unsupported";
+    }>;
+    state_mutation: z.ZodBoolean;
+    state_delta: z.ZodNullable<z.ZodObject<{
+        before: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        after: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    idempotency_dedupe: z.ZodOptional<z.ZodBoolean>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodTransform<{
+    ts: string;
+    run_id: string;
+    twin: string;
+    request_id: string;
+    step_id: string | null;
+    tool_call_id: string | null;
+    method: string;
+    path: string;
+    request_body: unknown;
+    status: number;
+    response_body: unknown;
+    latency_ms: number;
+    fidelity: "semantic" | "unsupported";
+    state_mutation: boolean;
+    state_delta: {
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    } | null;
+    error: string | null;
+    correlation_id?: string | undefined;
+    task_step_id?: string | null | undefined;
+    scenario_step_id?: string | null | undefined;
+    request_headers?: Record<string, string> | undefined;
+    tool?: string | null | undefined;
+    idempotency_dedupe?: boolean | undefined;
+}, {
+    ts: string;
+    run_id: string;
+    twin: string;
+    request_id: string;
+    step_id: string | null;
+    tool_call_id: string | null;
+    method: string;
+    path: string;
+    request_body: unknown;
+    status: number;
+    response_body: unknown;
+    latency_ms: number;
+    fidelity: "semantic" | "unsupported";
+    state_mutation: boolean;
+    state_delta: {
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    } | null;
+    error: string | null;
+    correlation_id?: string | undefined;
+    task_step_id?: string | null | undefined;
+    scenario_step_id?: string | null | undefined;
+    request_headers?: Record<string, string> | undefined;
+    tool?: string | null | undefined;
+    idempotency_dedupe?: boolean | undefined;
+}>>;
+export type RecorderEvent = z.infer<typeof recorderEventSchema>;
+export declare const twinHttpEventSchema: z.ZodObject<{
+    ts: z.ZodString;
+    run_id: z.ZodString;
+    twin: z.ZodString;
+    request_id: z.ZodString;
+    correlation_id: z.ZodOptional<z.ZodString>;
+    task_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    scenario_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    step_id: z.ZodNullable<z.ZodString>;
+    tool_call_id: z.ZodNullable<z.ZodString>;
+    method: z.ZodString;
+    path: z.ZodString;
+    request_body: z.ZodUnknown;
+    request_headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    tool: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodNumber;
+    response_body: z.ZodUnknown;
+    latency_ms: z.ZodNumber;
+    fidelity: z.ZodEnum<{
+        semantic: "semantic";
+        unsupported: "unsupported";
+    }>;
+    state_mutation: z.ZodBoolean;
+    state_delta: z.ZodNullable<z.ZodObject<{
+        before: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        after: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    idempotency_dedupe: z.ZodOptional<z.ZodBoolean>;
+    error: z.ZodNullable<z.ZodString>;
+    kind: z.ZodLiteral<"TwinHttpEvent">;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type TwinHttpEvent = z.infer<typeof twinHttpEventSchema>;
+export declare const llmCallEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"LlmCallEvent">;
+    host: z.ZodString;
+    port: z.ZodNumber;
+    latency_ms: z.ZodNumber;
+    bytes_in: z.ZodNumber;
+    bytes_out: z.ZodNumber;
+    url: z.ZodNullable<z.ZodString>;
+    method: z.ZodNullable<z.ZodString>;
+    status: z.ZodNullable<z.ZodNumber>;
+    model: z.ZodNullable<z.ZodString>;
+    prompt_tokens: z.ZodNullable<z.ZodNumber>;
+    completion_tokens: z.ZodNullable<z.ZodNumber>;
+    cost_usd: z.ZodNullable<z.ZodNumber>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type LlmCallEvent = z.infer<typeof llmCallEventSchema>;
+export declare const toolUseEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"ToolUseEvent">;
+    tool_use_id: z.ZodString;
+    tool_name: z.ZodString;
+    input: z.ZodUnknown;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type ToolUseEvent = z.infer<typeof toolUseEventSchema>;
+export declare const toolResultEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"ToolResultEvent">;
+    tool_use_id: z.ZodString;
+    output: z.ZodUnknown;
+    is_error: z.ZodBoolean;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type ToolResultEvent = z.infer<typeof toolResultEventSchema>;
+export declare const subagentSpawnEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"SubagentSpawnEvent">;
+    parent_tool_use_id: z.ZodString;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type SubagentSpawnEvent = z.infer<typeof subagentSpawnEventSchema>;
+export declare const hookEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"HookEvent">;
+    hook_name: z.ZodString;
+    tool_name: z.ZodNullable<z.ZodString>;
+    causing_tool_use_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type HookEvent = z.infer<typeof hookEventSchema>;
+export declare const llmTurnEventSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"LlmTurnEvent">;
+    turn_index: z.ZodNumber;
+    model: z.ZodNullable<z.ZodString>;
+    input_tokens: z.ZodNullable<z.ZodNumber>;
+    output_tokens: z.ZodNullable<z.ZodNumber>;
+    cache_read_input_tokens: z.ZodNullable<z.ZodNumber>;
+    cache_creation_input_tokens: z.ZodNullable<z.ZodNumber>;
+    finish_reasons: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    latency_ms: z.ZodNumber;
+    latency_ms_estimated: z.ZodBoolean;
+    session_id: z.ZodNullable<z.ZodString>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type LlmTurnEvent = z.infer<typeof llmTurnEventSchema>;
+export declare const eventSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    ts: z.ZodString;
+    run_id: z.ZodString;
+    twin: z.ZodString;
+    request_id: z.ZodString;
+    correlation_id: z.ZodOptional<z.ZodString>;
+    task_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    scenario_step_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    step_id: z.ZodNullable<z.ZodString>;
+    tool_call_id: z.ZodNullable<z.ZodString>;
+    method: z.ZodString;
+    path: z.ZodString;
+    request_body: z.ZodUnknown;
+    request_headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    tool: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodNumber;
+    response_body: z.ZodUnknown;
+    latency_ms: z.ZodNumber;
+    fidelity: z.ZodEnum<{
+        semantic: "semantic";
+        unsupported: "unsupported";
+    }>;
+    state_mutation: z.ZodBoolean;
+    state_delta: z.ZodNullable<z.ZodObject<{
+        before: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        after: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    idempotency_dedupe: z.ZodOptional<z.ZodBoolean>;
+    error: z.ZodNullable<z.ZodString>;
+    kind: z.ZodLiteral<"TwinHttpEvent">;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"LlmCallEvent">;
+    host: z.ZodString;
+    port: z.ZodNumber;
+    latency_ms: z.ZodNumber;
+    bytes_in: z.ZodNumber;
+    bytes_out: z.ZodNumber;
+    url: z.ZodNullable<z.ZodString>;
+    method: z.ZodNullable<z.ZodString>;
+    status: z.ZodNullable<z.ZodNumber>;
+    model: z.ZodNullable<z.ZodString>;
+    prompt_tokens: z.ZodNullable<z.ZodNumber>;
+    completion_tokens: z.ZodNullable<z.ZodNumber>;
+    cost_usd: z.ZodNullable<z.ZodNumber>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"ToolUseEvent">;
+    tool_use_id: z.ZodString;
+    tool_name: z.ZodString;
+    input: z.ZodUnknown;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"ToolResultEvent">;
+    tool_use_id: z.ZodString;
+    output: z.ZodUnknown;
+    is_error: z.ZodBoolean;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"SubagentSpawnEvent">;
+    parent_tool_use_id: z.ZodString;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"HookEvent">;
+    hook_name: z.ZodString;
+    tool_name: z.ZodNullable<z.ZodString>;
+    causing_tool_use_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"LlmTurnEvent">;
+    turn_index: z.ZodNumber;
+    model: z.ZodNullable<z.ZodString>;
+    input_tokens: z.ZodNullable<z.ZodNumber>;
+    output_tokens: z.ZodNullable<z.ZodNumber>;
+    cache_read_input_tokens: z.ZodNullable<z.ZodNumber>;
+    cache_creation_input_tokens: z.ZodNullable<z.ZodNumber>;
+    finish_reasons: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    latency_ms: z.ZodNumber;
+    latency_ms_estimated: z.ZodBoolean;
+    session_id: z.ZodNullable<z.ZodString>;
+    ts: z.ZodString;
+    event_id: z.ZodString;
+    parent_event_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>], "kind">, z.ZodTransform<{
+    ts: string;
+    run_id: string;
+    twin: string;
+    request_id: string;
+    step_id: string | null;
+    tool_call_id: string | null;
+    method: string;
+    path: string;
+    request_body: unknown;
+    status: number;
+    response_body: unknown;
+    latency_ms: number;
+    fidelity: "semantic" | "unsupported";
+    state_mutation: boolean;
+    state_delta: {
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    } | null;
+    error: string | null;
+    kind: "TwinHttpEvent";
+    event_id: string;
+    correlation_id?: string | undefined;
+    task_step_id?: string | null | undefined;
+    scenario_step_id?: string | null | undefined;
+    request_headers?: Record<string, string> | undefined;
+    tool?: string | null | undefined;
+    idempotency_dedupe?: boolean | undefined;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "LlmCallEvent";
+    host: string;
+    port: number;
+    latency_ms: number;
+    bytes_in: number;
+    bytes_out: number;
+    url: string | null;
+    method: string | null;
+    status: number | null;
+    model: string | null;
+    prompt_tokens: number | null;
+    completion_tokens: number | null;
+    cost_usd: number | null;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "ToolUseEvent";
+    tool_use_id: string;
+    tool_name: string;
+    input: unknown;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "ToolResultEvent";
+    tool_use_id: string;
+    output: unknown;
+    is_error: boolean;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "SubagentSpawnEvent";
+    parent_tool_use_id: string;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "HookEvent";
+    hook_name: string;
+    tool_name: string | null;
+    ts: string;
+    event_id: string;
+    causing_tool_use_id?: string | null | undefined;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "LlmTurnEvent";
+    turn_index: number;
+    model: string | null;
+    input_tokens: number | null;
+    output_tokens: number | null;
+    cache_read_input_tokens: number | null;
+    cache_creation_input_tokens: number | null;
+    finish_reasons: string[] | null;
+    latency_ms: number;
+    latency_ms_estimated: boolean;
+    session_id: string | null;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+}, {
+    ts: string;
+    run_id: string;
+    twin: string;
+    request_id: string;
+    step_id: string | null;
+    tool_call_id: string | null;
+    method: string;
+    path: string;
+    request_body: unknown;
+    status: number;
+    response_body: unknown;
+    latency_ms: number;
+    fidelity: "semantic" | "unsupported";
+    state_mutation: boolean;
+    state_delta: {
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    } | null;
+    error: string | null;
+    kind: "TwinHttpEvent";
+    event_id: string;
+    correlation_id?: string | undefined;
+    task_step_id?: string | null | undefined;
+    scenario_step_id?: string | null | undefined;
+    request_headers?: Record<string, string> | undefined;
+    tool?: string | null | undefined;
+    idempotency_dedupe?: boolean | undefined;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "LlmCallEvent";
+    host: string;
+    port: number;
+    latency_ms: number;
+    bytes_in: number;
+    bytes_out: number;
+    url: string | null;
+    method: string | null;
+    status: number | null;
+    model: string | null;
+    prompt_tokens: number | null;
+    completion_tokens: number | null;
+    cost_usd: number | null;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "ToolUseEvent";
+    tool_use_id: string;
+    tool_name: string;
+    input: unknown;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "ToolResultEvent";
+    tool_use_id: string;
+    output: unknown;
+    is_error: boolean;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "SubagentSpawnEvent";
+    parent_tool_use_id: string;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "HookEvent";
+    hook_name: string;
+    tool_name: string | null;
+    ts: string;
+    event_id: string;
+    causing_tool_use_id?: string | null | undefined;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+} | {
+    kind: "LlmTurnEvent";
+    turn_index: number;
+    model: string | null;
+    input_tokens: number | null;
+    output_tokens: number | null;
+    cache_read_input_tokens: number | null;
+    cache_creation_input_tokens: number | null;
+    finish_reasons: string[] | null;
+    latency_ms: number;
+    latency_ms_estimated: boolean;
+    session_id: string | null;
+    ts: string;
+    event_id: string;
+    parent_event_id?: string | null | undefined;
+    parent_id?: string | null | undefined;
+}>>;
+export type Event = z.infer<typeof eventSchema>;
+export declare function isLegacyEventRow(row: unknown): boolean;

package/dist/_types/wire/redaction.d.ts

@@ -0,0 +1,2 @@
+export declare function redactSecrets(value: unknown): unknown;
+export declare function redactEvent<T>(event: T): T;