@h-rig/contracts 0.0.6-alpha.14 → 0.0.6-alpha.140

package/dist/src/plugin.d.ts

@@ -0,0 +1,416 @@
+import { Schema } from "effect";
+export declare const ValidatorCategory: Schema.Literals<readonly ["boundary", "contract", "integration", "regression", "external", "custom"]>;
+export type ValidatorCategory = typeof ValidatorCategory.Type;
+export declare const ValidatorRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly category: Schema.Literals<readonly ["boundary", "contract", "integration", "regression", "external", "custom"]>;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type ValidatorRegistration = typeof ValidatorRegistration.Type;
+export declare const AgentSessionHookEvent: Schema.Literals<readonly ["PreToolUse", "PostToolUse", "UserPromptSubmit", "Stop", "SessionStart", "SessionEnd"]>;
+export type AgentSessionHookEvent = typeof AgentSessionHookEvent.Type;
+export declare const HookEvent: Schema.Literals<readonly ["PreToolUse", "PostToolUse", "UserPromptSubmit", "Stop", "SessionStart", "SessionEnd"]>;
+export type HookEvent = typeof HookEvent.Type;
+export declare const HookMatcher: Schema.Union<readonly [Schema.Struct<{
+    readonly kind: Schema.Literal<"all">;
+}>, Schema.Struct<{
+    readonly kind: Schema.Literal<"tool">;
+    readonly name: Schema.String;
+}>, Schema.Struct<{
+    readonly kind: Schema.Literal<"glob">;
+    readonly pattern: Schema.String;
+}>]>;
+export type HookMatcher = typeof HookMatcher.Type;
+export declare const HookRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly event: Schema.Literals<readonly ["PreToolUse", "PostToolUse", "UserPromptSubmit", "Stop", "SessionStart", "SessionEnd"]>;
+    readonly matcher: Schema.Union<readonly [Schema.Struct<{
+        readonly kind: Schema.Literal<"all">;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"tool">;
+        readonly name: Schema.String;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"glob">;
+        readonly pattern: Schema.String;
+    }>]>;
+    /**
+     * Shell command Claude Code invokes when this hook fires. Resolved as-is by
+     * Claude Code's hook runner. Use absolute paths or expand
+     * `$CLAUDE_PROJECT_DIR` for project-relative paths.
+     *
+     * Alternative: leave `command` unset and ship a typed implementation via
+     * definePlugin's runtime channel (`{ hooks: { [hookId]: fn } }`) — see
+     * `HookContext`/`HookResult`/`HookImplementation` in plugin-hooks.ts. The
+     * runtime materializes a shim command for typed hooks automatically. A hook
+     * may not have both a `command` and a typed implementation.
+     */
+    readonly command: Schema.optional<Schema.String>;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type HookRegistration = typeof HookRegistration.Type;
+export declare const SkillRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly path: Schema.String;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type SkillRegistration = typeof SkillRegistration.Type;
+export declare const RepoSourceRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly url: Schema.String;
+    readonly defaultPath: Schema.optional<Schema.String>;
+    readonly description: Schema.optional<Schema.String>;
+    readonly defaultBranch: Schema.optional<Schema.String>;
+    readonly remoteEnvVar: Schema.optional<Schema.String>;
+    readonly checkoutEnvVar: Schema.optional<Schema.String>;
+}>;
+export type RepoSourceRegistration = typeof RepoSourceRegistration.Type;
+export declare const AgentRoleRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly defaultModel: Schema.optional<Schema.String>;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type AgentRoleRegistration = typeof AgentRoleRegistration.Type;
+export declare const TaskFieldExtension: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly fieldName: Schema.String;
+    readonly schemaJson: Schema.String;
+}>;
+export type TaskFieldExtension = typeof TaskFieldExtension.Type;
+export declare const TaskSourceKind: Schema.String;
+export type TaskSourceKind = string;
+export declare const TaskSourceRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly kind: Schema.String;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type TaskSourceRegistration = typeof TaskSourceRegistration.Type;
+export declare const CliCommandRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly family: Schema.optional<Schema.String>;
+    readonly command: Schema.optional<Schema.String>;
+    readonly description: Schema.optional<Schema.String>;
+    readonly usage: Schema.optional<Schema.String>;
+    readonly aliases: Schema.optional<Schema.$Array<Schema.String>>;
+    readonly projectRequired: Schema.optional<Schema.Boolean>;
+}>;
+export type CliCommandRegistration = typeof CliCommandRegistration.Type;
+export declare const ProductCapabilityRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly title: Schema.String;
+    readonly description: Schema.optional<Schema.String>;
+    readonly commandId: Schema.optional<Schema.String>;
+    readonly panelId: Schema.optional<Schema.String>;
+}>;
+export type ProductCapabilityRegistration = typeof ProductCapabilityRegistration.Type;
+export declare const PanelRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly slot: Schema.String;
+    readonly title: Schema.String;
+    readonly capabilityId: Schema.optional<Schema.String>;
+    readonly badge: Schema.optional<Schema.String>;
+    readonly disabled: Schema.optional<Schema.Boolean>;
+    readonly description: Schema.optional<Schema.String>;
+}>;
+export type PanelRegistration = typeof PanelRegistration.Type;
+export declare const BlockerClassifierRegistration: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly description: Schema.optional<Schema.String>;
+    readonly priority: Schema.optional<Schema.Number>;
+}>;
+export type BlockerClassifierRegistration = typeof BlockerClassifierRegistration.Type;
+export declare const PluginContributes: Schema.Struct<{
+    readonly validators: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly category: Schema.Literals<readonly ["boundary", "contract", "integration", "regression", "external", "custom"]>;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly hooks: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly event: Schema.Literals<readonly ["PreToolUse", "PostToolUse", "UserPromptSubmit", "Stop", "SessionStart", "SessionEnd"]>;
+        readonly matcher: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"all">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"tool">;
+            readonly name: Schema.String;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"glob">;
+            readonly pattern: Schema.String;
+        }>]>;
+        /**
+         * Shell command Claude Code invokes when this hook fires. Resolved as-is by
+         * Claude Code's hook runner. Use absolute paths or expand
+         * `$CLAUDE_PROJECT_DIR` for project-relative paths.
+         *
+         * Alternative: leave `command` unset and ship a typed implementation via
+         * definePlugin's runtime channel (`{ hooks: { [hookId]: fn } }`) — see
+         * `HookContext`/`HookResult`/`HookImplementation` in plugin-hooks.ts. The
+         * runtime materializes a shim command for typed hooks automatically. A hook
+         * may not have both a `command` and a typed implementation.
+         */
+        readonly command: Schema.optional<Schema.String>;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly skills: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly path: Schema.String;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly repoSources: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly url: Schema.String;
+        readonly defaultPath: Schema.optional<Schema.String>;
+        readonly description: Schema.optional<Schema.String>;
+        readonly defaultBranch: Schema.optional<Schema.String>;
+        readonly remoteEnvVar: Schema.optional<Schema.String>;
+        readonly checkoutEnvVar: Schema.optional<Schema.String>;
+    }>>>;
+    readonly agentRoles: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly defaultModel: Schema.optional<Schema.String>;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly taskFieldSchemas: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly fieldName: Schema.String;
+        readonly schemaJson: Schema.String;
+    }>>>;
+    readonly taskSources: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly kind: Schema.String;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly cliCommands: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly family: Schema.optional<Schema.String>;
+        readonly command: Schema.optional<Schema.String>;
+        readonly description: Schema.optional<Schema.String>;
+        readonly usage: Schema.optional<Schema.String>;
+        readonly aliases: Schema.optional<Schema.$Array<Schema.String>>;
+        readonly projectRequired: Schema.optional<Schema.Boolean>;
+    }>>>;
+    readonly stages: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.brand<Schema.Trim, "StageId">;
+        readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+        readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+        readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+        readonly priority: Schema.withDecodingDefault<Schema.Number>;
+        readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+    }>>>;
+    readonly stageMutations: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly op: Schema.Literal<"insert">;
+        readonly stage: Schema.Struct<{
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+            readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly priority: Schema.withDecodingDefault<Schema.Number>;
+            readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+        }>;
+        readonly contributedBy: Schema.optional<Schema.Trim>;
+    }>, Schema.Struct<{
+        readonly op: Schema.Literal<"remove">;
+        readonly id: Schema.brand<Schema.Trim, "StageId">;
+        readonly contributedBy: Schema.optional<Schema.Trim>;
+    }>, Schema.Struct<{
+        readonly op: Schema.Literal<"replace">;
+        readonly id: Schema.brand<Schema.Trim, "StageId">;
+        readonly stage: Schema.Struct<{
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+            readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly priority: Schema.withDecodingDefault<Schema.Number>;
+            readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+        }>;
+        readonly contributedBy: Schema.optional<Schema.Trim>;
+    }>, Schema.Struct<{
+        readonly op: Schema.Literal<"wrap">;
+        readonly id: Schema.brand<Schema.Trim, "StageId">;
+        readonly around: Schema.Struct<{
+            readonly id: Schema.Trim;
+            readonly priority: Schema.withDecodingDefault<Schema.Number>;
+        }>;
+        readonly contributedBy: Schema.optional<Schema.Trim>;
+    }>, Schema.Struct<{
+        readonly op: Schema.Literal<"reorder">;
+        readonly id: Schema.brand<Schema.Trim, "StageId">;
+        readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+        readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+        readonly contributedBy: Schema.optional<Schema.Trim>;
+    }>]>>>;
+    readonly capabilities: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly title: Schema.String;
+        readonly description: Schema.optional<Schema.String>;
+        readonly commandId: Schema.optional<Schema.String>;
+        readonly panelId: Schema.optional<Schema.String>;
+    }>>>;
+    readonly panels: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly slot: Schema.String;
+        readonly title: Schema.String;
+        readonly capabilityId: Schema.optional<Schema.String>;
+        readonly badge: Schema.optional<Schema.String>;
+        readonly disabled: Schema.optional<Schema.Boolean>;
+        readonly description: Schema.optional<Schema.String>;
+    }>>>;
+    readonly blockerClassifiers: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly description: Schema.optional<Schema.String>;
+        readonly priority: Schema.optional<Schema.Number>;
+    }>>>;
+}>;
+export type PluginContributes = typeof PluginContributes.Type;
+export declare const RigPlugin: Schema.Struct<{
+    readonly name: Schema.String;
+    readonly version: Schema.String;
+    readonly provides: Schema.optional<Schema.$Array<Schema.Literals<readonly ["kernel", "journal", "stage-runner", "transport", "loader-policy"]>>>;
+    readonly requires: Schema.optional<Schema.$Array<Schema.Literals<readonly ["kernel", "journal", "stage-runner", "transport", "loader-policy"]>>>;
+    readonly replaces: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly capability: Schema.Literals<readonly ["kernel", "journal", "stage-runner", "transport", "loader-policy"]>;
+        readonly providerPluginId: Schema.Trim;
+    }>, Schema.Trim]>>>;
+    readonly contributes: Schema.optional<Schema.Struct<{
+        readonly validators: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly category: Schema.Literals<readonly ["boundary", "contract", "integration", "regression", "external", "custom"]>;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly hooks: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly event: Schema.Literals<readonly ["PreToolUse", "PostToolUse", "UserPromptSubmit", "Stop", "SessionStart", "SessionEnd"]>;
+            readonly matcher: Schema.Union<readonly [Schema.Struct<{
+                readonly kind: Schema.Literal<"all">;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"tool">;
+                readonly name: Schema.String;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"glob">;
+                readonly pattern: Schema.String;
+            }>]>;
+            /**
+             * Shell command Claude Code invokes when this hook fires. Resolved as-is by
+             * Claude Code's hook runner. Use absolute paths or expand
+             * `$CLAUDE_PROJECT_DIR` for project-relative paths.
+             *
+             * Alternative: leave `command` unset and ship a typed implementation via
+             * definePlugin's runtime channel (`{ hooks: { [hookId]: fn } }`) — see
+             * `HookContext`/`HookResult`/`HookImplementation` in plugin-hooks.ts. The
+             * runtime materializes a shim command for typed hooks automatically. A hook
+             * may not have both a `command` and a typed implementation.
+             */
+            readonly command: Schema.optional<Schema.String>;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly skills: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly path: Schema.String;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly repoSources: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly url: Schema.String;
+            readonly defaultPath: Schema.optional<Schema.String>;
+            readonly description: Schema.optional<Schema.String>;
+            readonly defaultBranch: Schema.optional<Schema.String>;
+            readonly remoteEnvVar: Schema.optional<Schema.String>;
+            readonly checkoutEnvVar: Schema.optional<Schema.String>;
+        }>>>;
+        readonly agentRoles: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly defaultModel: Schema.optional<Schema.String>;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly taskFieldSchemas: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly fieldName: Schema.String;
+            readonly schemaJson: Schema.String;
+        }>>>;
+        readonly taskSources: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly kind: Schema.String;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly cliCommands: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly family: Schema.optional<Schema.String>;
+            readonly command: Schema.optional<Schema.String>;
+            readonly description: Schema.optional<Schema.String>;
+            readonly usage: Schema.optional<Schema.String>;
+            readonly aliases: Schema.optional<Schema.$Array<Schema.String>>;
+            readonly projectRequired: Schema.optional<Schema.Boolean>;
+        }>>>;
+        readonly stages: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+            readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly priority: Schema.withDecodingDefault<Schema.Number>;
+            readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+        }>>>;
+        readonly stageMutations: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly op: Schema.Literal<"insert">;
+            readonly stage: Schema.Struct<{
+                readonly id: Schema.brand<Schema.Trim, "StageId">;
+                readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+                readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+                readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+                readonly priority: Schema.withDecodingDefault<Schema.Number>;
+                readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+            }>;
+            readonly contributedBy: Schema.optional<Schema.Trim>;
+        }>, Schema.Struct<{
+            readonly op: Schema.Literal<"remove">;
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly contributedBy: Schema.optional<Schema.Trim>;
+        }>, Schema.Struct<{
+            readonly op: Schema.Literal<"replace">;
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly stage: Schema.Struct<{
+                readonly id: Schema.brand<Schema.Trim, "StageId">;
+                readonly kind: Schema.Literals<readonly ["transform", "gate", "observe"]>;
+                readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+                readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+                readonly priority: Schema.withDecodingDefault<Schema.Number>;
+                readonly protected: Schema.withDecodingDefault<Schema.Boolean>;
+            }>;
+            readonly contributedBy: Schema.optional<Schema.Trim>;
+        }>, Schema.Struct<{
+            readonly op: Schema.Literal<"wrap">;
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly around: Schema.Struct<{
+                readonly id: Schema.Trim;
+                readonly priority: Schema.withDecodingDefault<Schema.Number>;
+            }>;
+            readonly contributedBy: Schema.optional<Schema.Trim>;
+        }>, Schema.Struct<{
+            readonly op: Schema.Literal<"reorder">;
+            readonly id: Schema.brand<Schema.Trim, "StageId">;
+            readonly before: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly after: Schema.optional<Schema.$Array<Schema.brand<Schema.Trim, "StageId">>>;
+            readonly contributedBy: Schema.optional<Schema.Trim>;
+        }>]>>>;
+        readonly capabilities: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly title: Schema.String;
+            readonly description: Schema.optional<Schema.String>;
+            readonly commandId: Schema.optional<Schema.String>;
+            readonly panelId: Schema.optional<Schema.String>;
+        }>>>;
+        readonly panels: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly slot: Schema.String;
+            readonly title: Schema.String;
+            readonly capabilityId: Schema.optional<Schema.String>;
+            readonly badge: Schema.optional<Schema.String>;
+            readonly disabled: Schema.optional<Schema.Boolean>;
+            readonly description: Schema.optional<Schema.String>;
+        }>>>;
+        readonly blockerClassifiers: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly description: Schema.optional<Schema.String>;
+            readonly priority: Schema.optional<Schema.Number>;
+        }>>>;
+    }>>;
+}>;
+export type RigPlugin = typeof RigPlugin.Type;