sysprom 1.0.0 → 1.0.5

package/dist/src/operations/speckit-sync.js

@@ -0,0 +1,116 @@
+import * as z from "zod";
+import { dirname } from "node:path";
+import { defineOperation } from "./define-operation.js";
+import { SysProMDocument } from "../schema.js";
+import { parseSpecKitFeature } from "../speckit/parse.js";
+import { generateSpecKitProject } from "../speckit/generate.js";
+import { detectSpecKitProject } from "../speckit/project.js";
+function compareDocuments(oldDoc, newDoc) {
+    const oldNodes = new Map(oldDoc.nodes.map((n) => [n.id, n]));
+    const newNodes = new Map(newDoc.nodes.map((n) => [n.id, n]));
+    const added = [];
+    const modified = [];
+    const removed = [];
+    // Find added and modified
+    for (const [id, newNode] of newNodes) {
+        const oldNode = oldNodes.get(id);
+        if (!oldNode) {
+            added.push(newNode);
+        }
+        else if (JSON.stringify(oldNode) !== JSON.stringify(newNode)) {
+            modified.push({ old: oldNode, new: newNode });
+        }
+    }
+    // Find removed
+    for (const [id, oldNode] of oldNodes) {
+        if (!newNodes.has(id)) {
+            removed.push(oldNode);
+        }
+    }
+    return { added, modified, removed };
+}
+export const SyncResult = z.object({
+    doc: SysProMDocument,
+    added: z.number(),
+    modified: z.number(),
+    removed: z.number(),
+});
+export const speckitSyncOp = defineOperation({
+    name: "speckitSync",
+    description: "Synchronise a SysProM document with a Spec-Kit directory",
+    input: z.object({
+        doc: SysProMDocument,
+        speckitDir: z.string().describe("Path to Spec-Kit directory"),
+        prefix: z
+            .string()
+            .optional()
+            .describe("ID prefix (defaults to directory name)"),
+    }),
+    output: SyncResult,
+    fn: ({ doc: syspromDoc, speckitDir, prefix }) => {
+        // Determine the prefix: use flag if provided, otherwise use directory name
+        const idPrefix = prefix ?? speckitDir.split("/").pop() ?? "FEAT";
+        // Find constitution file
+        let constitutionPath;
+        let searchDir = dirname(speckitDir);
+        for (let i = 0; i < 5; i++) {
+            const project = detectSpecKitProject(searchDir);
+            if (project.constitutionPath) {
+                constitutionPath = project.constitutionPath;
+                break;
+            }
+            const parent = dirname(searchDir);
+            if (parent === searchDir)
+                break;
+            searchDir = parent;
+        }
+        // Parse Spec-Kit feature
+        const specKitDoc = parseSpecKitFeature(speckitDir, idPrefix, constitutionPath);
+        // Compare documents
+        const diff = compareDocuments(syspromDoc, specKitDoc);
+        // Merge: Spec-Kit wins for content (description, status), SysProM wins for structure
+        const mergedNodes = new Map(syspromDoc.nodes.map((n) => [n.id, n]));
+        const specKitNodes = new Map(specKitDoc.nodes.map((n) => [n.id, n]));
+        for (const [id, specKitNode] of specKitNodes) {
+            const syspromNode = mergedNodes.get(id);
+            if (syspromNode) {
+                // Merge: Spec-Kit content wins, SysProM structure wins
+                const merged = {
+                    ...syspromNode,
+                    description: specKitNode.description ?? syspromNode.description,
+                    status: specKitNode.status ?? syspromNode.status,
+                    context: specKitNode.context ?? syspromNode.context,
+                    options: specKitNode.options ?? syspromNode.options,
+                    selected: specKitNode.selected ?? syspromNode.selected,
+                    rationale: specKitNode.rationale ?? syspromNode.rationale,
+                    scope: specKitNode.scope ?? syspromNode.scope,
+                    operations: specKitNode.operations ?? syspromNode.operations,
+                    plan: specKitNode.plan ?? syspromNode.plan,
+                };
+                mergedNodes.set(id, merged);
+            }
+            else {
+                // Add new node from Spec-Kit
+                mergedNodes.set(id, specKitNode);
+            }
+        }
+        // Remove nodes that were deleted in Spec-Kit
+        for (const node of diff.removed) {
+            mergedNodes.delete(node.id);
+        }
+        // Update merged document
+        const mergedDoc = {
+            ...syspromDoc,
+            nodes: Array.from(mergedNodes.values()),
+            relationships: syspromDoc.relationships, // Keep original relationships
+        };
+        // Re-generate Spec-Kit files from merged document
+        generateSpecKitProject(mergedDoc, speckitDir, idPrefix);
+        return {
+            doc: mergedDoc,
+            added: diff.added.length,
+            modified: diff.modified.length,
+            removed: diff.removed.length,
+        };
+    },
+});

package/dist/src/operations/state-at.d.ts

@@ -0,0 +1,309 @@
+import * as z from "zod";
+export declare const NodeState: z.ZodObject<{
+    nodeId: z.ZodString;
+    nodeName: z.ZodString;
+    activeStates: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type NodeState = z.infer<typeof NodeState>;
+export declare const stateAtOp: 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;
+        };
+    };
+    timestamp: z.ZodString;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+    nodeId: z.ZodString;
+    nodeName: z.ZodString;
+    activeStates: z.ZodArray<z.ZodString>;
+}, z.core.$strip>>>;

package/dist/src/operations/state-at.js

@@ -0,0 +1,53 @@
+import * as z from "zod";
+import { defineOperation } from "./define-operation.js";
+import { SysProMDocument } from "../schema.js";
+export const NodeState = z.object({
+    nodeId: z.string(),
+    nodeName: z.string(),
+    activeStates: z.array(z.string()),
+});
+export const stateAtOp = defineOperation({
+    name: "state-at",
+    description: "Determine the active states of all nodes at a specific point in time",
+    input: z.object({
+        doc: SysProMDocument,
+        timestamp: z.string(),
+    }),
+    output: z.array(NodeState),
+    fn: (input) => {
+        const nodeStates = new Map();
+        function processNode(node) {
+            if (node.lifecycle) {
+                const activeStates = [];
+                for (const [state, value] of Object.entries(node.lifecycle)) {
+                    if (typeof value === "boolean") {
+                        if (value) {
+                            activeStates.push(state);
+                        }
+                    }
+                    else if (typeof value === "string") {
+                        if (value.localeCompare(input.timestamp) <= 0) {
+                            activeStates.push(state);
+                        }
+                    }
+                }
+                if (activeStates.length > 0) {
+                    nodeStates.set(node.id, {
+                        nodeId: node.id,
+                        nodeName: node.name,
+                        activeStates: activeStates.sort(),
+                    });
+                }
+            }
+            if (node.subsystem) {
+                for (const subNode of node.subsystem.nodes) {
+                    processNode(subNode);
+                }
+            }
+        }
+        for (const node of input.doc.nodes) {
+            processNode(node);
+        }
+        return Array.from(nodeStates.values()).sort((a, b) => a.nodeId.localeCompare(b.nodeId));
+    },
+});