sysprom 1.14.0 → 1.15.0

package/dist/src/operations/infer-completeness.d.ts

@@ -0,0 +1,414 @@
+import * as z from "zod";
+/**
+ * Completeness result for a single node.
+ */
+declare const CompletenessResult: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<{
+        intent: "intent";
+        concept: "concept";
+        capability: "capability";
+        element: "element";
+        realisation: "realisation";
+        invariant: "invariant";
+        principle: "principle";
+        policy: "policy";
+        protocol: "protocol";
+        stage: "stage";
+        role: "role";
+        gate: "gate";
+        mode: "mode";
+        artefact: "artefact";
+        artefact_flow: "artefact_flow";
+        decision: "decision";
+        change: "change";
+        view: "view";
+        milestone: "milestone";
+        version: "version";
+    }> & {
+        is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
+    };
+    name: z.ZodString;
+    score: z.ZodNumber;
+    issues: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/** Completeness result for a single node with score and issues. */
+export type CompletenessResult = z.infer<typeof CompletenessResult>;
+/**
+ * Output schema for inferCompletenessOp.
+ */
+declare const CompletenessOutput: z.ZodObject<{
+    nodes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<{
+            intent: "intent";
+            concept: "concept";
+            capability: "capability";
+            element: "element";
+            realisation: "realisation";
+            invariant: "invariant";
+            principle: "principle";
+            policy: "policy";
+            protocol: "protocol";
+            stage: "stage";
+            role: "role";
+            gate: "gate";
+            mode: "mode";
+            artefact: "artefact";
+            artefact_flow: "artefact_flow";
+            decision: "decision";
+            change: "change";
+            view: "view";
+            milestone: "milestone";
+            version: "version";
+        }> & {
+            is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
+        };
+        name: z.ZodString;
+        score: z.ZodNumber;
+        issues: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    averageScore: z.ZodNumber;
+    completeNodes: z.ZodNumber;
+    incompleteNodes: z.ZodNumber;
+}, z.core.$strip>;
+/** Output of completeness inference operation. */
+export type CompletenessOutput = z.infer<typeof CompletenessOutput>;
+/**
+ * Infer completeness of nodes based on expected relationships.
+ *
+ * Analyses each node to determine if it has expected refinements or
+ * relationships, returning a score (0-1) and list of issues for incomplete nodes.
+ */
+export declare const inferCompletenessOp: import("./define-operation.js").DefinedOperation<z.ZodObject<{
+    doc: z.ZodObject<{
+        $schema: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            doc_type: z.ZodOptional<z.ZodString>;
+            scope: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodString>;
+            version: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
+        }, z.core.$loose> & {
+            is(value: unknown): value is {
+                [x: string]: unknown;
+                title?: string | undefined;
+                doc_type?: string | undefined;
+                scope?: string | undefined;
+                status?: string | undefined;
+                version?: string | number | undefined;
+            };
+        }>;
+        nodes: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodEnum<{
+                intent: "intent";
+                concept: "concept";
+                capability: "capability";
+                element: "element";
+                realisation: "realisation";
+                invariant: "invariant";
+                principle: "principle";
+                policy: "policy";
+                protocol: "protocol";
+                stage: "stage";
+                role: "role";
+                gate: "gate";
+                mode: "mode";
+                artefact: "artefact";
+                artefact_flow: "artefact_flow";
+                decision: "decision";
+                change: "change";
+                view: "view";
+                milestone: "milestone";
+                version: "version";
+            }> & {
+                is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
+            };
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+            status: z.ZodOptional<z.ZodEnum<{
+                deprecated: "deprecated";
+                proposed: "proposed";
+                accepted: "accepted";
+                active: "active";
+                implemented: "implemented";
+                adopted: "adopted";
+                defined: "defined";
+                introduced: "introduced";
+                in_progress: "in_progress";
+                complete: "complete";
+                consolidated: "consolidated";
+                experimental: "experimental";
+                retired: "retired";
+                superseded: "superseded";
+                abandoned: "abandoned";
+                deferred: "deferred";
+            }> & {
+                is(value: unknown): value is "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred";
+            }>;
+            lifecycle: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>;
+            context: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+            options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                    is(value: unknown): value is string | string[];
+                };
+            }, z.core.$loose> & {
+                is(value: unknown): value is {
+                    [x: string]: unknown;
+                    id: string;
+                    description: string | string[];
+                };
+            }>>;
+            selected: z.ZodOptional<z.ZodString>;
+            rationale: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+            scope: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            operations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodEnum<{
+                    link: "link";
+                    add: "add";
+                    update: "update";
+                    remove: "remove";
+                }>;
+                target: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                    is(value: unknown): value is string | string[];
+                }>;
+            }, z.core.$loose> & {
+                is(value: unknown): value is {
+                    [x: string]: unknown;
+                    type: "link" | "add" | "update" | "remove";
+                    target?: string | undefined;
+                    description?: string | string[] | undefined;
+                };
+            }>>;
+            plan: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                    is(value: unknown): value is string | string[];
+                };
+                done: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$loose> & {
+                is(value: unknown): value is {
+                    [x: string]: unknown;
+                    description: string | string[];
+                    done?: boolean | undefined;
+                };
+            }>>;
+            propagation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+            includes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            input: z.ZodOptional<z.ZodString>;
+            output: z.ZodOptional<z.ZodString>;
+            external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                role: z.ZodEnum<{
+                    output: "output";
+                    input: "input";
+                    context: "context";
+                    evidence: "evidence";
+                    source: "source";
+                    standard: "standard";
+                    prior_art: "prior_art";
+                }> & {
+                    is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+                };
+                identifier: z.ZodString;
+                description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                    is(value: unknown): value is string | string[];
+                }>;
+                node_id: z.ZodOptional<z.ZodString>;
+                internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                    is(value: unknown): value is string | string[];
+                }>;
+            }, z.core.$strip> & {
+                is(value: unknown): value is {
+                    role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+                    identifier: string;
+                    description?: string | string[] | undefined;
+                    node_id?: string | undefined;
+                    internalised?: string | string[] | undefined;
+                };
+            }>>;
+            readonly subsystem: z.ZodOptional<z.ZodObject</*elided*/ any, z.core.$strip>>;
+        }, z.core.$loose>>;
+        relationships: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+            type: z.ZodEnum<{
+                refines: "refines";
+                realises: "realises";
+                implements: "implements";
+                depends_on: "depends_on";
+                constrained_by: "constrained_by";
+                affects: "affects";
+                supersedes: "supersedes";
+                must_preserve: "must_preserve";
+                performs: "performs";
+                part_of: "part_of";
+                precedes: "precedes";
+                must_follow: "must_follow";
+                blocks: "blocks";
+                routes_to: "routes_to";
+                governed_by: "governed_by";
+                modifies: "modifies";
+                triggered_by: "triggered_by";
+                applies_to: "applies_to";
+                produces: "produces";
+                consumes: "consumes";
+                transforms_into: "transforms_into";
+                selects: "selects";
+                requires: "requires";
+                disables: "disables";
+            }> & {
+                is(value: unknown): value is "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
+            };
+            description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+        }, z.core.$loose> & {
+            is(value: unknown): value is {
+                [x: string]: unknown;
+                from: string;
+                to: string;
+                type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
+                description?: string | string[] | undefined;
+            };
+        }>>;
+        external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            role: z.ZodEnum<{
+                output: "output";
+                input: "input";
+                context: "context";
+                evidence: "evidence";
+                source: "source";
+                standard: "standard";
+                prior_art: "prior_art";
+            }> & {
+                is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+            };
+            identifier: z.ZodString;
+            description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+            node_id: z.ZodOptional<z.ZodString>;
+            internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
+                is(value: unknown): value is string | string[];
+            }>;
+        }, z.core.$strip> & {
+            is(value: unknown): value is {
+                role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+                identifier: string;
+                description?: string | string[] | undefined;
+                node_id?: string | undefined;
+                internalised?: string | string[] | undefined;
+            };
+        }>>;
+    }, z.core.$strip> & {
+        is(value: unknown): value is {
+            nodes: {
+                [x: string]: unknown;
+                id: string;
+                type: "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
+                name: string;
+                description?: string | string[] | undefined;
+                status?: "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred" | undefined;
+                lifecycle?: Record<string, string | boolean> | undefined;
+                context?: string | string[] | undefined;
+                options?: {
+                    [x: string]: unknown;
+                    id: string;
+                    description: string | string[];
+                }[] | undefined;
+                selected?: string | undefined;
+                rationale?: string | string[] | undefined;
+                scope?: string[] | undefined;
+                operations?: {
+                    [x: string]: unknown;
+                    type: "link" | "add" | "update" | "remove";
+                    target?: string | undefined;
+                    description?: string | string[] | undefined;
+                }[] | undefined;
+                plan?: {
+                    [x: string]: unknown;
+                    description: string | string[];
+                    done?: boolean | undefined;
+                }[] | undefined;
+                propagation?: Record<string, boolean> | undefined;
+                includes?: string[] | undefined;
+                input?: string | undefined;
+                output?: string | undefined;
+                external_references?: {
+                    role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+                    identifier: string;
+                    description?: string | string[] | undefined;
+                    node_id?: string | undefined;
+                    internalised?: string | string[] | undefined;
+                }[] | undefined;
+                subsystem?: /*elided*/ any | undefined;
+            }[];
+            $schema?: string | undefined;
+            metadata?: {
+                [x: string]: unknown;
+                title?: string | undefined;
+                doc_type?: string | undefined;
+                scope?: string | undefined;
+                status?: string | undefined;
+                version?: string | number | undefined;
+            } | undefined;
+            relationships?: {
+                [x: string]: unknown;
+                from: string;
+                to: string;
+                type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
+                description?: string | string[] | undefined;
+            }[] | undefined;
+            external_references?: {
+                role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
+                identifier: string;
+                description?: string | string[] | undefined;
+                node_id?: string | undefined;
+                internalised?: string | string[] | undefined;
+            }[] | undefined;
+        };
+    };
+}, z.core.$strip>, z.ZodObject<{
+    nodes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<{
+            intent: "intent";
+            concept: "concept";
+            capability: "capability";
+            element: "element";
+            realisation: "realisation";
+            invariant: "invariant";
+            principle: "principle";
+            policy: "policy";
+            protocol: "protocol";
+            stage: "stage";
+            role: "role";
+            gate: "gate";
+            mode: "mode";
+            artefact: "artefact";
+            artefact_flow: "artefact_flow";
+            decision: "decision";
+            change: "change";
+            view: "view";
+            milestone: "milestone";
+            version: "version";
+        }> & {
+            is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
+        };
+        name: z.ZodString;
+        score: z.ZodNumber;
+        issues: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    averageScore: z.ZodNumber;
+    completeNodes: z.ZodNumber;
+    incompleteNodes: z.ZodNumber;
+}, z.core.$strip>>;
+export {};

package/dist/src/operations/infer-completeness.js

@@ -0,0 +1,131 @@
+import * as z from "zod";
+import { defineOperation } from "./define-operation.js";
+import { SysProMDocument, NodeType } from "../schema.js";
+/**
+ * Completeness result for a single node.
+ */
+const CompletenessResult = z.object({
+    id: z.string(),
+    type: NodeType,
+    name: z.string(),
+    score: z.number().min(0).max(1),
+    issues: z.array(z.string()),
+});
+/**
+ * Output schema for inferCompletenessOp.
+ */
+const CompletenessOutput = z.object({
+    nodes: z.array(CompletenessResult),
+    averageScore: z.number(),
+    completeNodes: z.number(),
+    incompleteNodes: z.number(),
+});
+/**
+ * Node types that are expected to have downward refinement relationships.
+ */
+const REFINEMENT_HIERARCHY = {
+    intent: { expectedChildren: ["concept", "capability"], relType: "refines" },
+    concept: { expectedChildren: ["capability", "element"], relType: "refines" },
+    capability: {
+        expectedChildren: ["element", "realisation"],
+        relType: "realises",
+    },
+    element: { expectedChildren: ["realisation"], relType: "implements" },
+    decision: { expectedChildren: ["invariant"], relType: "must_preserve" },
+    change: { expectedChildren: ["decision"], relType: "implements" },
+};
+/**
+ * Infer completeness of nodes based on expected relationships.
+ *
+ * Analyses each node to determine if it has expected refinements or
+ * relationships, returning a score (0-1) and list of issues for incomplete nodes.
+ */
+export const inferCompletenessOp = defineOperation({
+    name: "infer-completeness",
+    description: "Infer completeness of nodes based on expected refinement relationships",
+    input: z.object({
+        doc: SysProMDocument,
+    }),
+    output: CompletenessOutput,
+    fn: (input) => {
+        const typeMap = new Map(input.doc.nodes.map((n) => [n.id, n.type]));
+        const results = [];
+        for (const node of input.doc.nodes) {
+            const issues = [];
+            let score = 1.0;
+            if (node.type in REFINEMENT_HIERARCHY) {
+                const expected = REFINEMENT_HIERARCHY[node.type];
+                // For decision: find relationships FROM decision TO invariant (must_preserve)
+                // For change: find relationships FROM change TO decision (implements)
+                // For others: find relationships TO this node (refines, realises, implements)
+                const isOutgoingRel = ["decision", "change"].includes(node.type);
+                const children = (input.doc.relationships ?? [])
+                    .filter((r) => {
+                    if (isOutgoingRel) {
+                        return r.from === node.id && r.type === expected.relType;
+                    }
+                    return r.to === node.id && r.type === expected.relType;
+                })
+                    .map((r) => ({
+                    id: isOutgoingRel ? r.to : r.from,
+                    type: typeMap.get(isOutgoingRel ? r.to : r.from),
+                }));
+                // Check if any children match expected types
+                const validChildren = children.filter((c) => expected.expectedChildren.includes(c.type ?? ""));
+                if (validChildren.length === 0) {
+                    issues.push(`No ${expected.relType} relationships ${isOutgoingRel ? "to" : "from"} ${expected.expectedChildren.join("/")} nodes`);
+                    score -= 0.5;
+                }
+            }
+            // Check for required fields based on node type
+            if (node.type === "decision") {
+                if (!node.options || node.options.length === 0) {
+                    issues.push("Decision has no options");
+                    score -= 0.25;
+                }
+                if (!node.selected) {
+                    issues.push("Decision has no selected option");
+                    score -= 0.25;
+                }
+                if (!node.rationale) {
+                    issues.push("Decision has no rationale");
+                    score -= 0.1;
+                }
+            }
+            if (node.type === "change") {
+                if (!node.scope || node.scope.length === 0) {
+                    issues.push("Change has no scope");
+                    score -= 0.2;
+                }
+                if (!node.plan || node.plan.length === 0) {
+                    issues.push("Change has no plan");
+                    score -= 0.1;
+                }
+            }
+            if (node.type === "invariant") {
+                if (!node.description) {
+                    issues.push("Invariant has no description");
+                    score -= 0.3;
+                }
+            }
+            // Clamp score to [0, 1]
+            score = Math.max(0, Math.min(1, score));
+            results.push({
+                id: node.id,
+                type: node.type,
+                name: node.name,
+                score,
+                issues,
+            });
+        }
+        const completeNodes = results.filter((r) => r.score === 1).length;
+        const incompleteNodes = results.filter((r) => r.score < 1).length;
+        const averageScore = results.reduce((sum, r) => sum + r.score, 0) / results.length;
+        return {
+            nodes: results,
+            averageScore,
+            completeNodes,
+            incompleteNodes,
+        };
+    },
+});