@laitszkin/apollo-toolkit 4.0.11 → 4.1.0

package/packages/tools/codegraph/dist/lib/cmd-survey.test.js

@@ -0,0 +1,136 @@
+import { describe, it, before, beforeEach, afterEach, mock } from 'node:test';
+import assert from 'node:assert/strict';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+describe('cmd-survey', () => {
+    let handleSurvey;
+    // Mock CodeGraph instance shared across tests:
+    // - Symbol A in src/feature/a.ts calls symbol B in src/lib/b.ts (cross-boundary)
+    // - Symbol X in src/feature/a.ts is exported but only called internally
+    const mockCg = {
+        getFiles: () => [{ path: 'src/feature/a.ts', language: 'typescript' }],
+        getNodesInFile: () => [
+            {
+                id: 'node-a',
+                name: 'A',
+                kind: 'function',
+                qualifiedName: 'A',
+                startLine: 1,
+                endLine: 10,
+                isExported: true,
+            },
+            {
+                id: 'node-x',
+                name: 'X',
+                kind: 'function',
+                qualifiedName: 'X',
+                startLine: 20,
+                endLine: 30,
+                isExported: true,
+            },
+        ],
+        getNodesByName: (name) => {
+            if (name === 'A') {
+                return [{ id: 'node-a', filePath: 'src/feature/a.ts', name: 'A' }];
+            }
+            if (name === 'X') {
+                return [{ id: 'node-x', filePath: 'src/feature/a.ts', name: 'X' }];
+            }
+            return [];
+        },
+        getCallees: (_id) => {
+            if (_id === 'node-a') {
+                return [{ node: { name: 'B', filePath: 'src/lib/b.ts' } }];
+            }
+            return [];
+        },
+        getCallers: (_id) => {
+            if (_id === 'node-x') {
+                return [{ node: { name: 'internal', filePath: 'src/feature/a.ts' } }];
+            }
+            return [];
+        },
+        close: () => { },
+    };
+    before(async () => {
+        // Module-level mocks (only need to be set up once):
+        mock.module('./survey/scanner.js', {
+            namedExports: {
+                scanDirectory: async () => ({
+                    directory: 'src/feature',
+                    files: [
+                        {
+                            filePath: 'src/feature/a.ts',
+                            language: 'typescript',
+                            symbols: [
+                                { name: 'A', kind: 'function', qualifiedName: 'A', startLine: 1, endLine: 10, isExported: true, signature: undefined },
+                                { name: 'X', kind: 'function', qualifiedName: 'X', startLine: 20, endLine: 30, isExported: true, signature: undefined },
+                            ],
+                        },
+                    ],
+                    allSymbols: [
+                        { name: 'A', kind: 'function', filePath: 'src/feature/a.ts', qualifiedName: 'A', startLine: 1, isExported: true },
+                        { name: 'X', kind: 'function', filePath: 'src/feature/a.ts', qualifiedName: 'X', startLine: 20, isExported: true },
+                    ],
+                    totalFiles: 1,
+                    totalSymbols: 2,
+                }),
+            },
+        });
+        mock.module('./survey/grouper.js', {
+            namedExports: { groupIntoSubmodules: () => [] },
+        });
+        mock.module('./cg-instance.js', {
+            namedExports: { closeIndex: () => { } },
+        });
+        // Import the compiled module (dist/lib/cmd-survey.js has the fixed code)
+        const mod = await import('./cmd-survey.js');
+        handleSurvey = mod.handleSurvey;
+    });
+    beforeEach(() => {
+        // Re-apply CodeGraph.open mock before each test (mock.reset() in afterEach clears it).
+        // Must use manual mock.method instead of mock.module because lazy CJS require()
+        // inside handlers bypasses mock.module interception.
+        const { CodeGraph } = require('@colbymchenry/codegraph');
+        mock.method(CodeGraph, 'open', async () => mockCg);
+    });
+    afterEach(() => {
+        mock.reset();
+    });
+    it('REGTEST-10: Cross-boundary edges point outside the scanned directory', async () => {
+        const stdoutChunks = [];
+        mock.method(process.stdout, 'write', (chunk) => {
+            stdoutChunks.push(String(chunk));
+            return true;
+        });
+        // Use a real directory for projectRoot so existsSync returns true naturally
+        const exitCode = await handleSurvey(process.cwd(), 'packages');
+        assert.equal(exitCode, 0);
+        const output = stdoutChunks.join('');
+        assert.ok(output.includes('src/feature/a.ts -> src/lib/b.ts'), `Expected cross-boundary edge label in output, got:\n${output}`);
+    });
+    it('REGTEST-11: Exported symbol called only from within the directory is not an entry point', async () => {
+        const stdoutChunks = [];
+        mock.method(process.stdout, 'write', (chunk) => {
+            stdoutChunks.push(String(chunk));
+            return true;
+        });
+        // Use a real directory for projectRoot so existsSync returns true naturally
+        const exitCode = await handleSurvey(process.cwd(), 'packages');
+        assert.equal(exitCode, 0);
+        const output = stdoutChunks.join('');
+        // X has only internal callers, so "(none)" should appear for entry points
+        assert.ok(output.includes('(none)'), `Expected "(none)" for entry points, got:\n${output}`);
+    });
+    it('REGTEST-12: Non-existent directory returns exit code 1 with error message', async () => {
+        const stderrChunks = [];
+        mock.method(process.stderr, 'write', (chunk) => {
+            stderrChunks.push(String(chunk));
+            return true;
+        });
+        // Use a path that does not exist on disk
+        const exitCode = await handleSurvey('/tmp', 'nonexistent-' + process.hrtime.bigint().toString());
+        assert.equal(exitCode, 1);
+        assert.ok(stderrChunks.join('').includes('Directory not found'), `Expected "Directory not found" error, got: ${stderrChunks.join('')}`);
+    });
+});

package/packages/tools/codegraph/dist/lib/cmd-sync.d.ts

@@ -0,0 +1,4 @@
+export interface SyncOptions {
+    json?: boolean;
+}
+export declare function handleSync(projectRoot: string, options?: SyncOptions): Promise<number>;

package/packages/tools/codegraph/dist/lib/cmd-sync.js

@@ -0,0 +1,51 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+import { closeIndex } from './cg-instance.js';
+import { formatSummary, formatOutput } from './formatter.js';
+export async function handleSync(projectRoot, options = {}) {
+    const { CodeGraph } = require('@colbymchenry/codegraph');
+    if (!CodeGraph.isInitialized(projectRoot)) {
+        process.stderr.write('CodeGraph is not initialized. Run `apltk codegraph init` first.\n');
+        return 1;
+    }
+    const cg = await CodeGraph.open(projectRoot, { sync: false, readOnly: false });
+    let progressEvents = [];
+    const result = await cg.sync({
+        onProgress: (p) => {
+            progressEvents.push({ phase: p.phase, current: p.current, total: p.total });
+            if (process.stdout.isTTY) {
+                process.stdout.write(`\r  Indexing: ${p.phase} ${p.current}/${p.total}`);
+            }
+        },
+    });
+    if (process.stdout.isTTY) {
+        process.stdout.write('\n');
+    }
+    closeIndex(cg);
+    const output = {
+        projectRoot,
+        filesChecked: result.filesChecked,
+        filesAdded: result.filesAdded,
+        filesModified: result.filesModified,
+        filesRemoved: result.filesRemoved,
+        nodesUpdated: result.nodesUpdated,
+        durationMs: result.durationMs,
+        progress: progressEvents.length > 0 ? progressEvents : undefined,
+    };
+    if (options.json) {
+        process.stdout.write(formatOutput(output, { json: true }) + '\n');
+    }
+    else {
+        const summary = [
+            ['Project:', projectRoot],
+            ['Checked:', result.filesChecked],
+            ['Added:', result.filesAdded],
+            ['Modified:', result.filesModified],
+            ['Removed:', result.filesRemoved],
+            ['Nodes updated:', result.nodesUpdated],
+            ['Duration:', `${result.durationMs}ms`],
+        ];
+        process.stdout.write(formatSummary(summary) + '\n');
+    }
+    return 0;
+}

package/packages/tools/codegraph/dist/lib/cmd-sync.test.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/tools/codegraph/dist/lib/cmd-sync.test.js

@@ -0,0 +1,30 @@
+import { describe, it, mock } from 'node:test';
+import assert from 'node:assert/strict';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+describe('cmd-sync handleSync', () => {
+    it('should return exit code 1 when CodeGraph is not initialized', async () => {
+        // Pre-load CodeGraph via CJS require (same mechanism used by cmd-sync.ts)
+        // and mock isInitialized BEFORE the module under test is evaluated, so
+        // the mock is in place when cmd-sync.ts runs its own require().
+        const { CodeGraph } = require('@colbymchenry/codegraph');
+        const isInitializedMock = mock.method(CodeGraph, 'isInitialized', () => false);
+        // Capture stderr output
+        const stderrWriteMock = mock.method(process.stderr, 'write', () => true);
+        // Import the module under test after mocks are set up
+        const { handleSync } = await import('./cmd-sync.js');
+        // Call the handler with an uninitialized project
+        const exitCode = await handleSync('/tmp/fake-project', { json: false });
+        // Verify exit code is 1 (error)
+        assert.strictEqual(exitCode, 1);
+        // Verify stderr mentions "init"
+        assert.strictEqual(stderrWriteMock.mock.calls.length, 1);
+        const callArg = stderrWriteMock.mock.calls[0].arguments[0];
+        assert.ok(callArg !== undefined, 'Expected stderr write argument to be defined');
+        const stderrOutput = typeof callArg === 'string' ? callArg : Buffer.from(callArg).toString('utf8');
+        assert.ok(stderrOutput.toLowerCase().includes('init'), `Expected stderr to mention "init", got: ${JSON.stringify(stderrOutput)}`);
+        // Cleanup mocks
+        isInitializedMock.mock.restore();
+        stderrWriteMock.mock.restore();
+    });
+});

package/packages/tools/codegraph/dist/lib/cmd-verify.d.ts

@@ -0,0 +1,4 @@
+export interface VerifyOptions {
+    json?: boolean;
+}
+export declare function handleVerify(projectRoot: string, specDir: string, options?: VerifyOptions): Promise<number>;

package/packages/tools/codegraph/dist/lib/cmd-verify.js

@@ -0,0 +1,134 @@
+import path from 'node:path';
+import fs from 'node:fs';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+import { closeIndex } from './cg-instance.js';
+import { formatOutput } from './formatter.js';
+import { verifyOverlay } from './verify/checker.js';
+import yaml from 'js-yaml';
+/**
+ * Read a spec overlay from the standard atlas directory layout.
+ * Loads the overlay in the same way as skills/init-project-html/lib/atlas/state.js::loadOverlay.
+ */
+function loadOverlay(specDir) {
+    const overlayDir = path.join(specDir, 'architecture_diff', 'atlas');
+    if (!fs.existsSync(overlayDir)) {
+        throw new Error(`No architecture diff atlas found at: ${overlayDir}. Run "apltk architecture diff" first to generate the overlay.`);
+    }
+    const overlay = {
+        meta: null,
+        actors: null,
+        edges: null,
+        featureOrder: null,
+        features: {},
+        removed: { features: [], submodules: [] },
+    };
+    // Parse atlas.index.yaml via js-yaml
+    const indexFile = path.join(overlayDir, 'atlas.index.yaml');
+    if (fs.existsSync(indexFile)) {
+        const raw = fs.readFileSync(indexFile, 'utf8');
+        if (raw.trim()) {
+            const index = yaml.load(raw);
+            if (index && typeof index === 'object' && !Array.isArray(index)) {
+                if (index.meta !== undefined)
+                    overlay.meta = index.meta;
+                if (index.actors !== undefined)
+                    overlay.actors = index.actors;
+                if (index.edges !== undefined)
+                    overlay.edges = index.edges;
+                if (Array.isArray(index.features)) {
+                    overlay.featureOrder = index.features
+                        .map((entry) => (typeof entry === 'string' ? entry : entry?.slug))
+                        .filter(Boolean);
+                }
+            }
+        }
+    }
+    // Load feature files via js-yaml
+    const featuresDir = path.join(overlayDir, 'features');
+    if (fs.existsSync(featuresDir)) {
+        for (const entry of fs.readdirSync(featuresDir)) {
+            if (!entry.endsWith('.yaml'))
+                continue;
+            const featureFile = path.join(featuresDir, entry);
+            const raw = fs.readFileSync(featureFile, 'utf8');
+            if (raw.trim()) {
+                const data = yaml.load(raw);
+                if (data && typeof data === 'object' && data.slug) {
+                    const feature = {
+                        slug: data.slug,
+                        submodules: Array.isArray(data.submodules)
+                            ? data.submodules.map(normalizeSubmodule)
+                            : [],
+                        edges: Array.isArray(data.edges) ? data.edges : [],
+                    };
+                    if (data.action !== undefined)
+                        feature.action = data.action;
+                    overlay.features[data.slug] = feature;
+                }
+            }
+        }
+    }
+    // Load _removed.yaml via js-yaml
+    const removedFile = path.join(overlayDir, '_removed.yaml');
+    if (fs.existsSync(removedFile)) {
+        const raw = fs.readFileSync(removedFile, 'utf8');
+        if (raw.trim()) {
+            const removed = yaml.load(raw);
+            if (removed && typeof removed === 'object' && !Array.isArray(removed)) {
+                if (Array.isArray(removed.features))
+                    overlay.removed.features = removed.features;
+                if (Array.isArray(removed.submodules))
+                    overlay.removed.submodules = removed.submodules;
+            }
+        }
+    }
+    return overlay;
+}
+function normalizeSubmodule(sub) {
+    if (!sub || typeof sub !== 'object')
+        return sub;
+    return {
+        slug: sub.slug,
+        kind: sub.kind || 'service',
+        role: sub.role || '',
+        functions: Array.isArray(sub.functions) ? sub.functions : [],
+        variables: Array.isArray(sub.variables) ? sub.variables : [],
+        ...(sub.action !== undefined ? { action: sub.action } : {}),
+    };
+}
+export async function handleVerify(projectRoot, specDir, options = {}) {
+    const resolvedSpecDir = path.resolve(specDir);
+    let overlay;
+    try {
+        overlay = loadOverlay(resolvedSpecDir);
+    }
+    catch (err) {
+        process.stderr.write(`Error loading overlay: ${err.message}\n`);
+        return 1;
+    }
+    const { CodeGraph } = require('@colbymchenry/codegraph');
+    const cg = await CodeGraph.open(projectRoot, { sync: false, readOnly: true });
+    const report = await verifyOverlay(cg, overlay);
+    closeIndex(cg);
+    if (options.json) {
+        process.stdout.write(formatOutput(report, { json: true }) + '\n');
+    }
+    else {
+        process.stdout.write(`\n=== Verify Report ===\n\n`);
+        process.stdout.write(`Total:  ${report.total}\n`);
+        process.stdout.write(`Passed: ${report.passed}\n`);
+        process.stdout.write(`Failed: ${report.failed.length}\n`);
+        process.stdout.write(`Skipped: ${report.skipped}\n`);
+        if (report.failed.length > 0) {
+            process.stdout.write('\nFailures:\n');
+            for (const f of report.failed) {
+                process.stdout.write(`  [${f.type}] ${f.location}\n`);
+                if (f.suggestion)
+                    process.stdout.write(`    Suggestion: ${f.suggestion}\n`);
+            }
+        }
+        process.stdout.write('\n');
+    }
+    return report.failed.length > 0 ? 1 : 0;
+}

package/packages/tools/codegraph/dist/lib/cmd-verify.test.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/tools/codegraph/dist/lib/cmd-verify.test.js

@@ -0,0 +1,139 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'node:os';
+import yaml from 'js-yaml';
+/**
+ * REGTEST-1: Verify that the js-yaml based parser (used in `loadOverlay`)
+ * correctly parses object-format YAML function declarations.
+ *
+ * The fix replaced a custom YAML parser with `js-yaml`. The old parser
+ * incorrectly produced raw string fragments like `"name: init"` when
+ * encountering object-format functions:
+ *
+ *   functions:
+ *     - name: init
+ *       in: string
+ *       out: void
+ *
+ * With `js-yaml`, the parser produces actual objects:
+ *   `{ name: "init", in: "string", out: "void" }`
+ *
+ * This test exercises the same parsing path as `loadOverlay`: reading a YAML
+ * file from disk with `fs.readFileSync`, then parsing with `yaml.load`.
+ */
+describe('REGTEST-1: loadOverlay YAML parser', () => {
+    it('should parse object-format functions and correctly extract .name', () => {
+        const yamlStr = [
+            'slug: test-feature',
+            'submodules:',
+            '  - slug: module-a',
+            '    functions:',
+            '      - name: init',
+            '        in: string',
+            '        out: void',
+            'edges:',
+            '  - from: funcA',
+            '    to: funcB',
+            '    kind: call',
+        ].join('\n');
+        // Parse with js-yaml (same library used by loadOverlay)
+        const data = yaml.load(yamlStr);
+        // Verify object-format function parsing
+        const fn = data.submodules[0].functions[0];
+        assert.strictEqual(typeof fn, 'object', 'object-format function should be parsed as object, not string');
+        assert.strictEqual(fn.name, 'init', 'parsed function .name should be "init"');
+        // Verify the old bug is fixed: no raw "name: init" string
+        assert.notStrictEqual(fn, 'name: init', 'function should NOT be a raw string fragment');
+        assert.notStrictEqual(typeof fn, 'string', 'object-format function should not be a string');
+        // Verify additional fields are preserved
+        assert.strictEqual(fn.in, 'string', 'function "in" field should be preserved');
+        assert.strictEqual(fn.out, 'void', 'function "out" field should be preserved');
+        // Verify string-format functions still work
+        // Note: the YAML above only has object-format functions; string format is tested separately
+    });
+    it('should parse string-format functions correctly', () => {
+        const yamlStr = [
+            'slug: test-feature',
+            'submodules:',
+            '  - slug: module-a',
+            '    functions:',
+            '      - init',
+            '      - process',
+        ].join('\n');
+        const data = yaml.load(yamlStr);
+        const functions = data.submodules[0].functions;
+        assert.strictEqual(functions.length, 2, 'should have 2 string-format functions');
+        assert.strictEqual(typeof functions[0], 'string', 'string-format function should be a string');
+        assert.strictEqual(functions[0], 'init', 'string function name should be "init"');
+        assert.strictEqual(functions[1], 'process', 'string function name should be "process"');
+    });
+    it('should parse mixed object and string format functions', () => {
+        const yamlStr = [
+            'slug: test-feature',
+            'submodules:',
+            '  - slug: module-a',
+            '    functions:',
+            '      - name: init',
+            '        in: string',
+            '        out: void',
+            '      - process',
+            '      - name: render',
+            '        in: string',
+            '        out: void',
+            '      - cleanup',
+        ].join('\n');
+        const data = yaml.load(yamlStr);
+        const functions = data.submodules[0].functions;
+        assert.strictEqual(functions.length, 4, 'should have 4 functions total');
+        // Index 0: object-format
+        assert.strictEqual(typeof functions[0], 'object', 'functions[0] should be object');
+        assert.strictEqual(functions[0].name, 'init');
+        // Index 1: string-format
+        assert.strictEqual(typeof functions[1], 'string', 'functions[1] should be string');
+        assert.strictEqual(functions[1], 'process');
+        // Index 2: object-format
+        assert.strictEqual(typeof functions[2], 'object', 'functions[2] should be object');
+        assert.strictEqual(functions[2].name, 'render');
+        // Index 3: string-format
+        assert.strictEqual(typeof functions[3], 'string', 'functions[3] should be string');
+        assert.strictEqual(functions[3], 'cleanup');
+    });
+    it('should parse feature YAML from disk (same path as loadOverlay)', async () => {
+        // Create a temp directory matching the loadOverlay structure
+        const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'codegraph-verify-test-'));
+        try {
+            const featuresDir = path.join(tmpDir, 'architecture_diff', 'atlas', 'features');
+            fs.mkdirSync(featuresDir, { recursive: true });
+            const yamlPath = path.join(featuresDir, 'test-feature.yaml');
+            fs.writeFileSync(yamlPath, [
+                'slug: test-feature',
+                'submodules:',
+                '  - slug: module-a',
+                '    functions:',
+                '      - name: init',
+                '        in: string',
+                '        out: void',
+                '    edges:',
+                '      - from: funcA',
+                '        to: funcB',
+                '        kind: call',
+            ].join('\n') + '\n');
+            // Read file and parse (same as loadOverlay)
+            const raw = fs.readFileSync(yamlPath, 'utf8');
+            const data = yaml.load(raw);
+            assert.ok(data, 'parsed data should be truthy');
+            assert.strictEqual(typeof data, 'object', 'parsed data should be an object');
+            assert.strictEqual(data.slug, 'test-feature', 'feature slug should be preserved');
+            const fn = data.submodules[0].functions[0];
+            assert.strictEqual(typeof fn, 'object', 'object-format function parsed from file should be object');
+            assert.strictEqual(fn.name, 'init', 'function .name should be "init"');
+            assert.strictEqual(fn.in, 'string', 'function .in should be "string"');
+            assert.strictEqual(fn.out, 'void', 'function .out should be "void"');
+        }
+        finally {
+            fs.rmSync(tmpDir, { recursive: true, force: true });
+        }
+    });
+});

package/packages/tools/codegraph/dist/lib/formatter.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Format structured data for CLI output.
+ *
+ * - TTY mode produces human-readable tables and headings.
+ * - Non-TTY or `--json` produces JSON.stringify with 2-space indent.
+ * - Auto-detects TTY via `process.stdout.isTTY`.
+ */
+export interface FormatOptions {
+    json?: boolean;
+    tty?: boolean;
+}
+/**
+ * Format generic data for output.
+ */
+export declare function formatOutput(data: unknown, options?: FormatOptions): string;
+/**
+ * Format a key-value summary block for human-readable output.
+ * Example:
+ *   Files:       42
+ *   Nodes:     1280
+ *   Edges:     5600
+ */
+export declare function formatSummary(rows: [string, string | number][]): string;
+/**
+ * Format a list of search results as a human-readable table.
+ */
+export declare function formatSearchResults(results: Array<{
+    node: {
+        name: string;
+        kind: string;
+        filePath: string;
+        startLine: number;
+    };
+    score: number;
+}>): string;
+/**
+ * Format an API directory listing for human-readable output.
+ */
+export declare function formatApiList(apis: Array<{
+    name: string;
+    kind: string;
+    filePath: string;
+    startLine: number;
+    signature?: string;
+    callerCount: number;
+    callers?: Array<{
+        name: string;
+        filePath: string;
+        startLine: number;
+    }>;
+}>): string;
+/**
+ * Format an API listing grouped by directory.
+ */
+export declare function formatApiListGrouped(apis: Array<{
+    name: string;
+    kind: string;
+    filePath: string;
+    startLine: number;
+    signature?: string;
+    callerCount: number;
+    callers?: Array<{
+        name: string;
+        filePath: string;
+        startLine: number;
+    }>;
+}>): string;