oh-my-oop 0.2.0

package/dist/oop/commands.d.ts

@@ -0,0 +1,446 @@
+import { z } from "zod";
+import { type OopConfig } from "../config.js";
+/** Transport-neutral data plus optional human-readable presentation. Errors throw. */
+export interface OopCommandResult<T = unknown> {
+    data: T;
+    text?: string;
+}
+/** Shared contracts and handlers for CLI, MCP, and in-process callers. */
+export declare const OOP_OPERATIONS: {
+    oop_init: {
+        inputSchema: z.ZodObject<{
+            project: z.ZodOptional<z.ZodString>;
+            force: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            force: boolean;
+            project?: string | undefined;
+        }, {
+            project?: string | undefined;
+            force?: boolean | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            project_root: string;
+            oop_dir: string;
+            created: string[];
+            existed: string[];
+            index: import("../domain/model.js").DesignIndex;
+        }>>;
+    };
+    oop_use_case_add: {
+        inputSchema: z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            title: z.ZodString;
+            actor: z.ZodString;
+            preconditions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            main_flow: z.ZodArray<z.ZodString, "many">;
+            postconditions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            related_classes: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            notes: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            actor: string;
+            preconditions: string[];
+            main_flow: string[];
+            postconditions: string[];
+            related_classes: string[];
+            id?: string | undefined;
+            notes?: string | undefined;
+        }, {
+            title: string;
+            actor: string;
+            main_flow: string[];
+            id?: string | undefined;
+            notes?: string | undefined;
+            preconditions?: string[] | undefined;
+            postconditions?: string[] | undefined;
+            related_classes?: string[] | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            id: string;
+            path: string;
+            created: boolean;
+        }>>;
+    };
+    oop_use_case_list: {
+        inputSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            use_cases: {
+                id: string;
+                title: string;
+                actor: string;
+                related_classes: string[];
+            }[];
+        }>>;
+    };
+    oop_propose_responsibilities: {
+        inputSchema: z.ZodObject<{
+            use_case_id: z.ZodString;
+            n: z.ZodDefault<z.ZodNumber>;
+            bias_hint: z.ZodOptional<z.ZodEnum<["by-noun", "by-verb", "balanced"]>>;
+        }, "strip", z.ZodTypeAny, {
+            n: number;
+            use_case_id: string;
+            bias_hint?: "by-noun" | "by-verb" | "balanced" | undefined;
+        }, {
+            use_case_id: string;
+            n?: number | undefined;
+            bias_hint?: "by-noun" | "by-verb" | "balanced" | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            alternatives: import("../tradeoff/heuristics/responsibilitySplit.js").ResponsibilityAlternative[];
+            expansion_prompt: string;
+        }>>;
+    };
+    oop_assign_responsibility: {
+        inputSchema: z.ZodObject<{
+            class_id: z.ZodString;
+            kind: z.ZodEnum<["knowing", "doing"]>;
+            text: z.ZodString;
+            from_use_case: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            kind: "knowing" | "doing";
+            text: string;
+            class_id: string;
+            from_use_case?: string | undefined;
+        }, {
+            kind: "knowing" | "doing";
+            text: string;
+            class_id: string;
+            from_use_case?: string | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            class_id: string;
+            kind: "knowing" | "doing";
+            path: string;
+        }>>;
+    };
+    oop_class_upsert: {
+        inputSchema: z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            name: z.ZodString;
+            stereotype: z.ZodEnum<["InformationHolder", "ServiceProvider", "Structurer", "Coordinator", "Interfacer"]>;
+            responsibilities: z.ZodDefault<z.ZodObject<{
+                knowing: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+                doing: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                knowing: string[];
+                doing: string[];
+            }, {
+                knowing?: string[] | undefined;
+                doing?: string[] | undefined;
+            }>>;
+            from_use_cases: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            notes: z.ZodOptional<z.ZodString>;
+            snapshot_label: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            stereotype: "InformationHolder" | "ServiceProvider" | "Structurer" | "Coordinator" | "Interfacer";
+            responsibilities: {
+                knowing: string[];
+                doing: string[];
+            };
+            from_use_cases: string[];
+            id?: string | undefined;
+            notes?: string | undefined;
+            snapshot_label?: string | undefined;
+        }, {
+            name: string;
+            stereotype: "InformationHolder" | "ServiceProvider" | "Structurer" | "Coordinator" | "Interfacer";
+            id?: string | undefined;
+            responsibilities?: {
+                knowing?: string[] | undefined;
+                doing?: string[] | undefined;
+            } | undefined;
+            notes?: string | undefined;
+            from_use_cases?: string[] | undefined;
+            snapshot_label?: string | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            id: string;
+            path: string;
+            created: boolean;
+        }>>;
+    };
+    oop_class_list: {
+        inputSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            classes: {
+                id: string;
+                name: string;
+                stereotype: "InformationHolder" | "ServiceProvider" | "Structurer" | "Coordinator" | "Interfacer";
+                responsibility_count: number;
+                collaborator_count: number;
+            }[];
+        }>>;
+    };
+    oop_collaboration_define: {
+        inputSchema: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+            message: z.ZodString;
+            direction: z.ZodDefault<z.ZodEnum<["send", "query", "event"]>>;
+            multiplicity: z.ZodOptional<z.ZodString>;
+            rationale: z.ZodOptional<z.ZodString>;
+            snapshot_label: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            from: string;
+            to: string;
+            direction: "send" | "query" | "event";
+            multiplicity?: string | undefined;
+            rationale?: string | undefined;
+            snapshot_label?: string | undefined;
+        }, {
+            message: string;
+            from: string;
+            to: string;
+            direction?: "send" | "query" | "event" | undefined;
+            multiplicity?: string | undefined;
+            rationale?: string | undefined;
+            snapshot_label?: string | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            id: string;
+            path: string;
+            created: boolean;
+        }>>;
+    };
+    oop_propose_alternatives: {
+        inputSchema: z.ZodObject<{
+            question: z.ZodEnum<["responsibility_split", "class_split", "collaboration_shape", "stereotype_choice", "value_object_shape", "strategy_or_policy", "error_handling", "collection_shape", "dual_subject_comparison", "free_form"]>;
+            context: z.ZodObject<{
+                description: z.ZodString;
+                class_id: z.ZodOptional<z.ZodString>;
+                use_case_id: z.ZodOptional<z.ZodString>;
+                involved: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                description: string;
+                use_case_id?: string | undefined;
+                class_id?: string | undefined;
+                involved?: string[] | undefined;
+            }, {
+                description: string;
+                use_case_id?: string | undefined;
+                class_id?: string | undefined;
+                involved?: string[] | undefined;
+            }>;
+            n: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            n: number;
+            question: "responsibility_split" | "class_split" | "collaboration_shape" | "stereotype_choice" | "value_object_shape" | "strategy_or_policy" | "error_handling" | "collection_shape" | "dual_subject_comparison" | "free_form";
+            context: {
+                description: string;
+                use_case_id?: string | undefined;
+                class_id?: string | undefined;
+                involved?: string[] | undefined;
+            };
+        }, {
+            question: "responsibility_split" | "class_split" | "collaboration_shape" | "stereotype_choice" | "value_object_shape" | "strategy_or_policy" | "error_handling" | "collection_shape" | "dual_subject_comparison" | "free_form";
+            context: {
+                description: string;
+                use_case_id?: string | undefined;
+                class_id?: string | undefined;
+                involved?: string[] | undefined;
+            };
+            n?: number | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<import("../tradeoff/engine.js").AlternativesResult>>;
+    };
+    oop_diagram_generate: {
+        inputSchema: z.ZodObject<{
+            write_current: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            write_current: boolean;
+        }, {
+            write_current?: boolean | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            mermaid: string;
+            path: string | undefined;
+            next_step: string;
+        }>>;
+    };
+    oop_design_compare: {
+        inputSchema: z.ZodObject<{
+            before: z.ZodUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"history">;
+                file: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                file: string;
+                kind: "history";
+            }, {
+                file: string;
+                kind: "history";
+            }>, z.ZodObject<{
+                kind: z.ZodLiteral<"current">;
+            }, "strip", z.ZodTypeAny, {
+                kind: "current";
+            }, {
+                kind: "current";
+            }>, z.ZodObject<{
+                kind: z.ZodLiteral<"inline">;
+                mermaid: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                kind: "inline";
+                mermaid: string;
+            }, {
+                kind: "inline";
+                mermaid: string;
+            }>]>;
+            after: z.ZodDefault<z.ZodUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"history">;
+                file: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                file: string;
+                kind: "history";
+            }, {
+                file: string;
+                kind: "history";
+            }>, z.ZodObject<{
+                kind: z.ZodLiteral<"current">;
+            }, "strip", z.ZodTypeAny, {
+                kind: "current";
+            }, {
+                kind: "current";
+            }>, z.ZodObject<{
+                kind: z.ZodLiteral<"inline">;
+                mermaid: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                kind: "inline";
+                mermaid: string;
+            }, {
+                kind: "inline";
+                mermaid: string;
+            }>]>>;
+            labels: z.ZodDefault<z.ZodObject<{
+                before: z.ZodDefault<z.ZodString>;
+                after: z.ZodDefault<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                before: string;
+                after: string;
+            }, {
+                before?: string | undefined;
+                after?: string | undefined;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            before: {
+                file: string;
+                kind: "history";
+            } | {
+                kind: "current";
+            } | {
+                kind: "inline";
+                mermaid: string;
+            };
+            after: {
+                file: string;
+                kind: "history";
+            } | {
+                kind: "current";
+            } | {
+                kind: "inline";
+                mermaid: string;
+            };
+            labels: {
+                before: string;
+                after: string;
+            };
+        }, {
+            before: {
+                file: string;
+                kind: "history";
+            } | {
+                kind: "current";
+            } | {
+                kind: "inline";
+                mermaid: string;
+            };
+            after?: {
+                file: string;
+                kind: "history";
+            } | {
+                kind: "current";
+            } | {
+                kind: "inline";
+                mermaid: string;
+            } | undefined;
+            labels?: {
+                before?: string | undefined;
+                after?: string | undefined;
+            } | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            before_mermaid: string;
+            after_mermaid: string;
+            diff: import("../render/diff.js").DesignDiff;
+            side_by_side_markdown: string;
+        }>>;
+    };
+    oop_design_validate: {
+        inputSchema: z.ZodObject<{
+            rules: z.ZodOptional<z.ZodArray<z.ZodEnum<["god-object", "low-cohesion", "too-many-collaborators", "non-newable", "side-effect-in-holder", "mocking-pressure", "cycle", "mixed-stereotype", "feature-envy", "orphan-class", "vague-class-name", "validation-misplacement", "dependency-direction", "data-source-duplication", "function-not-object", "empty-object-external-fill", "collection-wrapper-without-behavior", "primitive-wrapper-without-invariant", "strategy-default-param-pollution", "function-decomposition-excess", "dual-purpose-knowing", "singleton-stateful-holder", "presentation-in-domain"]>, "many">>;
+            severity_min: z.ZodDefault<z.ZodEnum<["info", "warn", "error"]>>;
+        }, "strip", z.ZodTypeAny, {
+            severity_min: "info" | "warn" | "error";
+            rules?: ("god-object" | "low-cohesion" | "too-many-collaborators" | "non-newable" | "side-effect-in-holder" | "mocking-pressure" | "cycle" | "vague-class-name" | "validation-misplacement" | "dependency-direction" | "data-source-duplication" | "function-not-object" | "empty-object-external-fill" | "collection-wrapper-without-behavior" | "primitive-wrapper-without-invariant" | "strategy-default-param-pollution" | "function-decomposition-excess" | "dual-purpose-knowing" | "singleton-stateful-holder" | "presentation-in-domain" | "mixed-stereotype" | "feature-envy" | "orphan-class")[] | undefined;
+        }, {
+            rules?: ("god-object" | "low-cohesion" | "too-many-collaborators" | "non-newable" | "side-effect-in-holder" | "mocking-pressure" | "cycle" | "vague-class-name" | "validation-misplacement" | "dependency-direction" | "data-source-duplication" | "function-not-object" | "empty-object-external-fill" | "collection-wrapper-without-behavior" | "primitive-wrapper-without-invariant" | "strategy-default-param-pollution" | "function-decomposition-excess" | "dual-purpose-knowing" | "singleton-stateful-holder" | "presentation-in-domain" | "mixed-stereotype" | "feature-envy" | "orphan-class")[] | undefined;
+            severity_min?: "info" | "warn" | "error" | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            findings: import("../validate/findings.js").Finding[];
+            summary: {
+                error: number;
+                warn: number;
+                info: number;
+            };
+        }>>;
+    };
+    oop_conformance_check: {
+        inputSchema: z.ZodObject<{
+            class_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            class_ids?: string[] | undefined;
+        }, {
+            class_ids?: string[] | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<{
+            instruction: string;
+            checklist: string[];
+            design_contract: {
+                id: string;
+                name: string;
+                stereotype: "InformationHolder" | "ServiceProvider" | "Structurer" | "Coordinator" | "Interfacer";
+                stereotype_means: string;
+                fits: string[];
+                misfits: string[];
+                designed_responsibilities: {
+                    knowing: string[];
+                    doing: string[];
+                };
+                designed_collaborators: import("../domain/model.js").CollaboratorRef[];
+            }[];
+        }>>;
+    };
+    oop_state_read: {
+        inputSchema: z.ZodObject<{
+            include: z.ZodOptional<z.ZodArray<z.ZodEnum<["use_cases", "classes", "collaborations", "diagram", "history"]>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            include?: ("classes" | "collaborations" | "history" | "use_cases" | "diagram")[] | undefined;
+        }, {
+            include?: ("classes" | "collaborations" | "history" | "use_cases" | "diagram")[] | undefined;
+        }>;
+        execute: (config: OopConfig, input: unknown) => Promise<OopCommandResult<Record<string, unknown>>>;
+    };
+};
+export type OopOperationName = keyof typeof OOP_OPERATIONS;
+export declare const OOP_OPERATION_NAMES: [OopOperationName, ...OopOperationName[]];
+export declare const OopRequestSchema: z.ZodObject<{
+    action: z.ZodEnum<["oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read", ...("oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read")[]]>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    action: z.ZodEnum<["oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read", ...("oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read")[]]>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    action: z.ZodEnum<["oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read", ...("oop_init" | "oop_use_case_add" | "oop_use_case_list" | "oop_propose_responsibilities" | "oop_assign_responsibility" | "oop_class_upsert" | "oop_class_list" | "oop_collaboration_define" | "oop_propose_alternatives" | "oop_diagram_generate" | "oop_design_compare" | "oop_design_validate" | "oop_conformance_check" | "oop_state_read")[]]>;
+}, z.ZodTypeAny, "passthrough">>;
+/** Execute an OOP action with an explicitly chosen workspace; no environment lookup. */
+export declare function oopCommand(config: OopConfig, input: unknown): Promise<unknown>;