sysprom 1.0.0 → 1.0.6

package/dist/src/operations/graph.d.ts

@@ -0,0 +1,303 @@
+import * as z from "zod";
+export declare const graphOp: 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;
+        };
+    };
+    format: z.ZodDefault<z.ZodEnum<{
+        dot: "dot";
+        mermaid: "mermaid";
+    }>>;
+    typeFilter: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodString>;

package/dist/src/operations/graph.js

@@ -0,0 +1,71 @@
+import * as z from "zod";
+import { defineOperation } from "./define-operation.js";
+import { SysProMDocument } from "../schema.js";
+function sanitiseMermaidId(id) {
+    return id.replace(/[^a-zA-Z0-9_]/g, "_");
+}
+function generateDot(doc, rels) {
+    const lines = [];
+    lines.push("digraph SysProM {");
+    lines.push("  rankdir=LR;");
+    // Add node labels
+    for (const node of doc.nodes) {
+        const label = `${node.id}\\n${node.name}`;
+        lines.push(`  "${node.id}" [label="${label}"];`);
+    }
+    // Add relationships
+    for (const rel of rels ?? []) {
+        lines.push(`  "${rel.from}" -> "${rel.to}" [label="${rel.type}"];`);
+    }
+    lines.push("}");
+    return lines.join("\n");
+}
+function generateMermaid(doc, rels) {
+    const lines = [];
+    lines.push("graph LR");
+    // Add node definitions with type-specific shapes
+    for (const node of doc.nodes) {
+        const id = sanitiseMermaidId(node.id);
+        let shape;
+        if (node.type === "decision") {
+            shape = `{${node.id}: ${node.name}}`;
+        }
+        else if (node.type === "invariant") {
+            shape = `[/${node.id}: ${node.name}/]`;
+        }
+        else {
+            shape = `[${node.id}: ${node.name}]`;
+        }
+        lines.push(`  ${id}${shape}`);
+    }
+    // Add relationships
+    for (const rel of rels ?? []) {
+        const fromId = sanitiseMermaidId(rel.from);
+        const toId = sanitiseMermaidId(rel.to);
+        lines.push(`  ${fromId} -->|${rel.type}| ${toId}`);
+    }
+    return lines.join("\n");
+}
+function generateGraph(doc, format, typeFilter) {
+    let rels = doc.relationships ?? [];
+    if (typeFilter) {
+        rels = rels.filter((r) => r.type === typeFilter);
+    }
+    if (format === "dot") {
+        return generateDot(doc, rels);
+    }
+    return generateMermaid(doc, rels);
+}
+export const graphOp = defineOperation({
+    name: "graph",
+    description: "Generate a graph of the SysProM document in Mermaid or DOT format, with optional filtering by relationship type.",
+    input: z.object({
+        doc: SysProMDocument,
+        format: z.enum(["mermaid", "dot"]).default("mermaid"),
+        typeFilter: z.string().optional(),
+    }),
+    output: z.string(),
+    fn({ doc, format, typeFilter }) {
+        return generateGraph(doc, format, typeFilter);
+    },
+});

package/dist/src/operations/index.d.ts

@@ -0,0 +1,38 @@
+export { defineOperation, type OperationDef, type DefinedOperation, } from "./define-operation.js";
+export { addNodeOp } from "./add-node.js";
+export { removeNodeOp, type RemoveResult } from "./remove-node.js";
+export { updateNodeOp } from "./update-node.js";
+export { addRelationshipOp } from "./add-relationship.js";
+export { removeRelationshipOp } from "./remove-relationship.js";
+export { updateMetadataOp } from "./update-metadata.js";
+export { nextIdOp } from "./next-id.js";
+export { initDocumentOp } from "./init-document.js";
+export { addPlanTaskOp } from "./add-plan-task.js";
+export { updatePlanTaskOp } from "./update-plan-task.js";
+export { markTaskDoneOp } from "./mark-task-done.js";
+export { markTaskUndoneOp } from "./mark-task-undone.js";
+export { taskListOp } from "./task-list.js";
+export { planInitOp } from "./plan-init.js";
+export { planAddTaskOp } from "./plan-add-task.js";
+export { planStatusOp, type PlanStatusResult } from "./plan-status.js";
+export { planProgressOp, type PhaseProgressResult } from "./plan-progress.js";
+export { planGateOp, type GateResultOutput } from "./plan-gate.js";
+export { queryNodesOp } from "./query-nodes.js";
+export { queryNodeOp, type NodeDetail } from "./query-node.js";
+export { queryRelationshipsOp } from "./query-relationships.js";
+export { traceFromNodeOp, type TraceNode } from "./trace-from-node.js";
+export { timelineOp, type TimelineEvent } from "./timeline.js";
+export { nodeHistoryOp } from "./node-history.js";
+export { stateAtOp, type NodeState } from "./state-at.js";
+export { validateOp, type ValidationResult } from "./validate.js";
+export { statsOp, type DocumentStats } from "./stats.js";
+export { searchOp } from "./search.js";
+export { checkOp } from "./check.js";
+export { graphOp } from "./graph.js";
+export { renameOp } from "./rename.js";
+export { jsonToMarkdownOp } from "./json-to-markdown.js";
+export { markdownToJsonOp } from "./markdown-to-json.js";
+export { speckitImportOp } from "./speckit-import.js";
+export { speckitExportOp } from "./speckit-export.js";
+export { speckitSyncOp, type SyncResult } from "./speckit-sync.js";
+export { speckitDiffOp, type DiffResult } from "./speckit-diff.js";

package/dist/src/operations/index.js

@@ -0,0 +1,45 @@
+export { defineOperation, } from "./define-operation.js";
+// Mutation operations
+export { addNodeOp } from "./add-node.js";
+export { removeNodeOp } from "./remove-node.js";
+export { updateNodeOp } from "./update-node.js";
+export { addRelationshipOp } from "./add-relationship.js";
+export { removeRelationshipOp } from "./remove-relationship.js";
+export { updateMetadataOp } from "./update-metadata.js";
+export { nextIdOp } from "./next-id.js";
+export { initDocumentOp } from "./init-document.js";
+export { addPlanTaskOp } from "./add-plan-task.js";
+export { updatePlanTaskOp } from "./update-plan-task.js";
+export { markTaskDoneOp } from "./mark-task-done.js";
+export { markTaskUndoneOp } from "./mark-task-undone.js";
+export { taskListOp } from "./task-list.js";
+export { planInitOp } from "./plan-init.js";
+export { planAddTaskOp } from "./plan-add-task.js";
+export { planStatusOp } from "./plan-status.js";
+export { planProgressOp } from "./plan-progress.js";
+export { planGateOp } from "./plan-gate.js";
+// Query operations
+export { queryNodesOp } from "./query-nodes.js";
+export { queryNodeOp } from "./query-node.js";
+export { queryRelationshipsOp } from "./query-relationships.js";
+export { traceFromNodeOp } from "./trace-from-node.js";
+// Temporal operations
+export { timelineOp } from "./timeline.js";
+export { nodeHistoryOp } from "./node-history.js";
+export { stateAtOp } from "./state-at.js";
+// Inspection operations
+export { validateOp } from "./validate.js";
+export { statsOp } from "./stats.js";
+// New API operations (previously CLI-only)
+export { searchOp } from "./search.js";
+export { checkOp } from "./check.js";
+export { graphOp } from "./graph.js";
+export { renameOp } from "./rename.js";
+// Conversion operations
+export { jsonToMarkdownOp } from "./json-to-markdown.js";
+export { markdownToJsonOp } from "./markdown-to-json.js";
+// Spec-Kit interoperability operations
+export { speckitImportOp } from "./speckit-import.js";
+export { speckitExportOp } from "./speckit-export.js";
+export { speckitSyncOp } from "./speckit-sync.js";
+export { speckitDiffOp } from "./speckit-diff.js";