@zigrivers/scaffold 2.1.0

package/dist/core/assembly/engine.js

@@ -0,0 +1,215 @@
+import { ExitCode } from '../../types/index.js';
+/** Depth guidance text for each level 1-5 (ADR-045). */
+const DEPTH_GUIDANCE = {
+    1: 'Focus on the essential deliverable only.',
+    2: 'Cover primary use cases; skip advanced configurations.',
+    3: 'Full requirements coverage with common edge cases.',
+    4: 'Thorough analysis including performance and alternatives.',
+    5: 'Exhaustive exploration of all angles and tradeoffs.',
+};
+/** Depth scale descriptions for each level in the Methodology section. */
+const DEPTH_SCALE_DESCRIPTIONS = {
+    1: 'Depth 1 (MVP): Focus on core requirements only. Minimal viable output.',
+    2: 'Depth 2 (Lite): Cover primary use cases. Skip edge cases and advanced configurations.',
+    3: 'Depth 3 (Standard): Full coverage of requirements. Include common edge cases.',
+    4: 'Depth 4 (Thorough): Deep coverage including edge cases, performance considerations, and alternatives.',
+    5: 'Depth 5 (Exhaustive): Maximum depth. Explore all angles, tradeoffs, alternatives, and implications.',
+};
+const SECTION_HEADINGS = [
+    'System',
+    'Meta-Prompt',
+    'Knowledge Base',
+    'Project Context',
+    'Methodology',
+    'Instructions',
+    'Execution',
+];
+/**
+ * AssemblyEngine — takes pre-loaded components and assembles them into a
+ * 7-section prompt string following ADR-045.
+ *
+ * Pure orchestrator: no file I/O, no async. All data comes via assemble() options.
+ */
+export class AssemblyEngine {
+    /**
+     * Assemble the prompt for a single pipeline step.
+     * Returns AssemblyResult with success/failure, prompt, errors, and warnings.
+     */
+    assemble(step, options) {
+        const startMs = Date.now();
+        // --- Validation ---
+        if (options.metaPrompt == null) {
+            return {
+                success: false,
+                errors: [
+                    {
+                        code: 'ASM_META_PROMPT_MISSING',
+                        message: `Meta-prompt is missing for step "${step}". Cannot assemble prompt.`,
+                        exitCode: ExitCode.ValidationError,
+                        recovery: 'Ensure the meta-prompt file exists and was loaded before calling assemble().',
+                    },
+                ],
+                warnings: [],
+            };
+        }
+        const depth = options.depth;
+        if (depth < 1 || depth > 5 || !Number.isInteger(depth)) {
+            return {
+                success: false,
+                errors: [
+                    {
+                        code: 'ASM_INVALID_DEPTH',
+                        message: `Invalid depth "${depth}" for step "${step}". Depth must be an integer between 1 and 5.`,
+                        exitCode: ExitCode.ValidationError,
+                        recovery: 'Provide a depth value between 1 and 5.',
+                    },
+                ],
+                warnings: [],
+            };
+        }
+        try {
+            const artifacts = options.artifacts ?? [];
+            const decisions = options.decisions ?? '';
+            // --- Build the 7 sections ---
+            const sections = [
+                { heading: 'System', content: this.buildSystemSection(step, options) },
+                { heading: 'Meta-Prompt', content: options.metaPrompt.body },
+                { heading: 'Knowledge Base', content: this.buildKnowledgeBaseSection(options.knowledgeEntries) },
+                { heading: 'Project Context', content: this.buildProjectContextSection(artifacts, decisions, options) },
+                { heading: 'Methodology', content: this.buildMethodologySection(depth, options.depthProvenance) },
+                { heading: 'Instructions', content: this.buildInstructionsSection(options.instructions) },
+                { heading: 'Execution', content: this.buildExecutionSection(depth) },
+            ];
+            // --- Concatenate text ---
+            const text = sections
+                .map(s => `# ${s.heading}\n\n${s.content}\n\n`)
+                .join('');
+            // --- Build metadata ---
+            const assemblyDurationMs = Date.now() - startMs;
+            const instructionLayers = this.resolveInstructionLayers(options.instructions);
+            const decisionCount = decisions.trim() === '' ? 0 : decisions.trim().split('\n').filter(l => l.trim() !== '').length;
+            const metadata = {
+                stepName: step,
+                depth,
+                depthProvenance: options.depthProvenance,
+                knowledgeBaseEntries: options.knowledgeEntries.map(e => e.name),
+                instructionLayers,
+                artifactCount: artifacts.length,
+                decisionCount,
+                assemblyDurationMs,
+                assembledAt: new Date().toISOString(),
+                updateMode: options.updateMode,
+                sectionsIncluded: [...SECTION_HEADINGS],
+            };
+            const prompt = { text, sections, metadata };
+            return { success: true, prompt, errors: [], warnings: [] };
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            return {
+                success: false,
+                errors: [
+                    {
+                        code: 'ASM_UNEXPECTED_ERROR',
+                        message: `Unexpected error assembling step "${step}": ${message}`,
+                        exitCode: ExitCode.BuildError,
+                    },
+                ],
+                warnings: [],
+            };
+        }
+    }
+    // ---------------------------------------------------------------------------
+    // Section builders
+    // ---------------------------------------------------------------------------
+    buildSystemSection(step, options) {
+        const { state, config, depth } = options;
+        const methodology = config.methodology;
+        const steps = Object.values(state.steps);
+        const totalCount = steps.length;
+        const completedCount = steps.filter(s => s.status === 'completed').length;
+        return [
+            'You are an expert software architect and senior developer working on a software project.',
+            `You are executing step ${step} of the Scaffold pipeline.`,
+            `Methodology: ${methodology} | Depth: ${depth}/5 | Progress: ${completedCount}/${totalCount} steps`,
+        ].join('\n');
+    }
+    buildKnowledgeBaseSection(entries) {
+        if (entries.length === 0) {
+            return '(No knowledge base entries specified for this step.)';
+        }
+        return entries
+            .map(entry => `## ${entry.name}: ${entry.description}\n\n${entry.content}`)
+            .join('\n\n');
+    }
+    buildProjectContextSection(artifacts, decisions, options) {
+        const parts = [];
+        // Artifacts
+        for (const artifact of artifacts) {
+            parts.push(`## Artifact: ${artifact.filePath}\n\n${artifact.content}`);
+        }
+        // Decisions log
+        if (decisions.trim() !== '') {
+            parts.push(`## Decisions Log\n\n${decisions}`);
+        }
+        // Existing artifact in update mode
+        if (options.updateMode && options.existingArtifact) {
+            const ea = options.existingArtifact;
+            parts.push(`## Existing Output: ${ea.filePath}\n\n${ea.content}\n\n` +
+                '*Note: You are in update mode. Revise the existing output to incorporate new requirements.*');
+        }
+        if (parts.length === 0) {
+            return '(No prior artifacts available.)';
+        }
+        return parts.join('\n\n');
+    }
+    buildMethodologySection(depth, depthProvenance) {
+        const guidance = DEPTH_GUIDANCE[depth] ?? '';
+        const scaleLines = Object.entries(DEPTH_SCALE_DESCRIPTIONS)
+            .sort(([a], [b]) => Number(a) - Number(b))
+            .map(([, desc]) => `- ${desc}`)
+            .join('\n');
+        return [
+            `Executing at depth ${depth}/5.`,
+            '',
+            'Depth scale guidance:',
+            scaleLines,
+            '',
+            `Current depth: ${depth} — ${guidance}`,
+            `Depth determined by: ${depthProvenance}`,
+        ].join('\n');
+    }
+    buildInstructionsSection(instructions) {
+        const parts = [];
+        if (instructions.global != null) {
+            parts.push(`### Global Instructions\n\n${instructions.global}`);
+        }
+        if (instructions.perStep != null) {
+            parts.push(`### Step-Specific Instructions\n\n${instructions.perStep}`);
+        }
+        if (instructions.inline != null) {
+            parts.push(`### Inline Instructions\n\n${instructions.inline}`);
+        }
+        if (parts.length === 0) {
+            return '(No user instructions provided.)';
+        }
+        return parts.join('\n\n');
+    }
+    buildExecutionSection(depth) {
+        return [
+            'Execute this step now. Produce all required outputs as specified in the meta-prompt above.',
+            `Work methodically at depth ${depth}/5. When complete, summarize what you produced and any decisions made.`,
+        ].join('\n');
+    }
+    resolveInstructionLayers(instructions) {
+        const layers = [];
+        if (instructions.global != null)
+            layers.push('global');
+        if (instructions.perStep != null)
+            layers.push('per-step');
+        if (instructions.inline != null)
+            layers.push('inline');
+        return layers;
+    }
+}
+//# sourceMappingURL=engine.js.map

package/dist/core/assembly/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../../src/core/assembly/engine.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAE/C,wDAAwD;AACxD,MAAM,cAAc,GAA2B;IAC7C,CAAC,EAAE,0CAA0C;IAC7C,CAAC,EAAE,wDAAwD;IAC3D,CAAC,EAAE,oDAAoD;IACvD,CAAC,EAAE,2DAA2D;IAC9D,CAAC,EAAE,qDAAqD;CACzD,CAAA;AAED,0EAA0E;AAC1E,MAAM,wBAAwB,GAA2B;IACvD,CAAC,EAAE,wEAAwE;IAC3E,CAAC,EAAE,uFAAuF;IAC1F,CAAC,EAAE,+EAA+E;IAClF,CAAC,EAAE,uGAAuG;IAC1G,CAAC,EAAE,qGAAqG;CACzG,CAAA;AAED,MAAM,gBAAgB,GAAG;IACvB,QAAQ;IACR,aAAa;IACb,gBAAgB;IAChB,iBAAiB;IACjB,aAAa;IACb,cAAc;IACd,WAAW;CACH,CAAA;AAEV;;;;;GAKG;AACH,MAAM,OAAO,cAAc;IACzB;;;OAGG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAE1B,qBAAqB;QACrB,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;YAC/B,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,yBAAyB;wBAC/B,OAAO,EAAE,oCAAoC,IAAI,4BAA4B;wBAC7E,QAAQ,EAAE,QAAQ,CAAC,eAAe;wBAClC,QAAQ,EAAE,8EAA8E;qBACzF;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC3B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,mBAAmB;wBACzB,OAAO,EAAE,kBAAkB,KAAK,eAAe,IAAI,8CAA8C;wBACjG,QAAQ,EAAE,QAAQ,CAAC,eAAe;wBAClC,QAAQ,EAAE,wCAAwC;qBACnD;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAA;YACzC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAA;YAEzC,+BAA+B;YAC/B,MAAM,QAAQ,GAAoB;gBAChC,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;gBACtE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE;gBAC5D,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;gBAChG,EAAE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,IAAI,CAAC,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE;gBACvG,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE;gBACjG,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;gBACzF,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;aACrE,CAAA;YAED,2BAA2B;YAC3B,MAAM,IAAI,GAAG,QAAQ;iBAClB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,OAAO,MAAM,CAAC;iBAC9C,IAAI,CAAC,EAAE,CAAC,CAAA;YAEX,yBAAyB;YACzB,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAA;YAE/C,MAAM,iBAAiB,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YAC7E,MAAM,aAAa,GACjB,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAA;YAEhG,MAAM,QAAQ,GAAqB;gBACjC,QAAQ,EAAE,IAAI;gBACd,KAAK;gBACL,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,oBAAoB,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC/D,iBAAiB;gBACjB,aAAa,EAAE,SAAS,CAAC,MAAM;gBAC/B,aAAa;gBACb,kBAAkB;gBAClB,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACrC,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,gBAAgB,EAAE,CAAC,GAAG,gBAAgB,CAAC;aACxC,CAAA;YAED,MAAM,MAAM,GAAoB,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;YAE5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QAC5D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAChE,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,sBAAsB;wBAC5B,OAAO,EAAE,qCAAqC,IAAI,MAAM,OAAO,EAAE;wBACjE,QAAQ,EAAE,QAAQ,CAAC,UAAU;qBAC9B;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb,CAAA;QACH,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,mBAAmB;IACnB,8EAA8E;IAEtE,kBAAkB,CAAC,IAAY,EAAE,OAAwB;QAC/D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QACxC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;QAEtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACxC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAA;QAC/B,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,MAAM,CAAA;QAEzE,OAAO;YACL,0FAA0F;YAC1F,0BAA0B,IAAI,4BAA4B;YAC1D,gBAAgB,WAAW,aAAa,KAAK,kBAAkB,cAAc,IAAI,UAAU,QAAQ;SACpG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAEO,yBAAyB,CAAC,OAAyB;QACzD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,sDAAsD,CAAA;QAC/D,CAAC;QAED,OAAO,OAAO;aACX,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,WAAW,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;aAC1E,IAAI,CAAC,MAAM,CAAC,CAAA;IACjB,CAAC;IAEO,0BAA0B,CAChC,SAA0B,EAC1B,SAAiB,EACjB,OAAwB;QAExB,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,YAAY;QACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,gBAAgB,QAAQ,CAAC,QAAQ,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;QACxE,CAAC;QAED,gBAAgB;QAChB,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAA;QAChD,CAAC;QAED,mCAAmC;QACnC,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACnD,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAA;YACnC,KAAK,CAAC,IAAI,CACR,uBAAuB,EAAE,CAAC,QAAQ,OAAO,EAAE,CAAC,OAAO,MAAM;gBACvD,6FAA6F,CAChG,CAAA;QACH,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,iCAAiC,CAAA;QAC1C,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC3B,CAAC;IAEO,uBAAuB,CAAC,KAAiB,EAAE,eAAgC;QACjF,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC;aACxD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;aACzC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;aAC9B,IAAI,CAAC,IAAI,CAAC,CAAA;QAEb,OAAO;YACL,sBAAsB,KAAK,KAAK;YAChC,EAAE;YACF,uBAAuB;YACvB,UAAU;YACV,EAAE;YACF,kBAAkB,KAAK,MAAM,QAAQ,EAAE;YACvC,wBAAwB,eAAe,EAAE;SAC1C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAEO,wBAAwB,CAAC,YAA8B;QAC7D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,YAAY,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,8BAA8B,YAAY,CAAC,MAAM,EAAE,CAAC,CAAA;QACjE,CAAC;QAED,IAAI,YAAY,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,qCAAqC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAA;QACzE,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,8BAA8B,YAAY,CAAC,MAAM,EAAE,CAAC,CAAA;QACjE,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,kCAAkC,CAAA;QAC3C,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC3B,CAAC;IAEO,qBAAqB,CAAC,KAAiB;QAC7C,OAAO;YACL,4FAA4F;YAC5F,8BAA8B,KAAK,wEAAwE;SAC5G,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAEO,wBAAwB,CAC9B,YAA8B;QAE9B,MAAM,MAAM,GAA4C,EAAE,CAAA;QAC1D,IAAI,YAAY,CAAC,MAAM,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtD,IAAI,YAAY,CAAC,OAAO,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACzD,IAAI,YAAY,CAAC,MAAM,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtD,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}

package/dist/core/assembly/engine.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=engine.test.d.ts.map

package/dist/core/assembly/engine.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.test.d.ts","sourceRoot":"","sources":["../../../src/core/assembly/engine.test.ts"],"names":[],"mappings":""}