@synergenius/flow-weaver 0.33.2 → 0.44.0

package/dist/doc-metadata/extractors/cli-commands.js

@@ -1,326 +0,0 @@
-/**
- * Extractor for CLI command documentation
- *
- * This defines all CLI commands with their descriptions, options, and action blocks.
- * The data is extracted from the Commander.js definitions in cli/index.ts.
- * Template lists are generated from the actual template registries.
- */
-import { workflowTemplates, nodeTemplates } from '../../cli/templates/index.js';
-/**
- * CLI command definitions - single source of truth for CLI documentation
- */
-export const CLI_COMMANDS = [
-    // ── Core commands ──────────────────────────────────────────────
-    {
-        name: 'compile',
-        syntax: 'fw compile <file> [options]',
-        description: 'Compile workflow source file',
-        botCompatible: true,
-        options: [
-            { flags: '-o, --output', arg: '<path>', description: 'Output file or directory' },
-            { flags: '-p, --production', description: 'Production build (no debug events)' },
-            { flags: '-s, --source-map', description: 'Generate source maps' },
-            { flags: '-w, --workflow-name', arg: '<name>', description: 'Target specific workflow' },
-            { flags: '-f, --format', arg: 'esm|cjs|auto', description: 'Module format', defaultValue: 'auto' },
-            { flags: '--strict', description: 'Treat type coercion warnings as errors' },
-            { flags: '--dry-run', description: 'Preview compilation without writing files' },
-            { flags: '--verbose', description: 'Detailed output' },
-        ],
-    },
-    {
-        name: 'validate',
-        syntax: 'fw validate <file> [options]',
-        description: 'Validate workflow without compiling',
-        botCompatible: true,
-        options: [
-            { flags: '-w, --workflow-name', arg: '<name>', description: 'Target specific workflow' },
-            { flags: '--json', description: 'Output as JSON', exclusive: 'output-mode' },
-            { flags: '--verbose', description: 'Verbose output', exclusive: 'output-mode' },
-            { flags: '-q, --quiet', description: 'Suppress warnings', exclusive: 'output-mode' },
-            { flags: '--strict', description: 'Treat type coercion warnings as errors' },
-        ],
-    },
-    {
-        name: 'describe',
-        syntax: 'fw describe <file> [options]',
-        description: 'Output workflow structure in LLM-friendly formats (JSON, text, mermaid)',
-        botCompatible: true,
-        options: [
-            { flags: '-f, --format', arg: 'json|text|mermaid|paths', description: 'Output format (paths: enumerate all Start-to-Exit paths via DFS)' },
-            { flags: '-w, --workflow-name', arg: '<name>', description: 'Target workflow' },
-            { flags: '-n, --node', arg: '<id>', description: 'Focus on specific node' },
-            { flags: '--compile', description: 'Also update runtime markers in the source file' },
-        ],
-    },
-    {
-        name: 'run',
-        syntax: 'fw run <file> [options]',
-        description: 'Execute a workflow file directly',
-        botCompatible: true,
-        options: [
-            { flags: '-w, --workflow', arg: '<name>', description: 'Specific workflow to run' },
-            { flags: '--params', arg: '<json>', description: 'Input parameters as JSON string', exclusive: 'params' },
-            { flags: '--params-file', arg: '<path>', description: 'Path to JSON file with input parameters', exclusive: 'params' },
-            { flags: '-p, --production', description: 'Production mode (no trace events)' },
-            { flags: '-t, --trace', description: 'Include execution trace events' },
-            { flags: '--json', description: 'Output result as JSON' },
-            { flags: '--timeout', arg: '<ms>', description: 'Execution timeout in milliseconds' },
-        ],
-    },
-    {
-        name: 'serve',
-        syntax: 'fw serve [directory] [options]',
-        description: 'Start HTTP server exposing workflows as endpoints',
-        options: [
-            { flags: '-p, --port', arg: '<port>', description: 'Server port', defaultValue: '3000' },
-            { flags: '-H, --host', arg: '<host>', description: 'Server host', defaultValue: '0.0.0.0' },
-            { flags: '--no-watch', description: 'Disable file watching for hot reload' },
-            { flags: '--production', description: 'Production mode (no trace events)' },
-            { flags: '--precompile', description: 'Precompile all workflows on startup' },
-            { flags: '--cors', arg: '<origin>', description: 'CORS origin', defaultValue: '*' },
-            { flags: '--swagger', description: 'Enable Swagger UI at /docs' },
-        ],
-    },
-    // ── Create subcommands ─────────────────────────────────────────
-    {
-        name: 'create workflow',
-        syntax: 'fw create workflow <template> <file> [options]',
-        description: 'Create new workflow from template',
-        botCompatible: true,
-        group: 'create',
-        positionalChoices: {
-            template: workflowTemplates.map(t => ({ id: t.id, label: t.id })),
-        },
-        options: [
-            { flags: '-p, --preview', description: 'Show without writing' },
-            { flags: '--provider', arg: 'openai|anthropic|ollama|mock', description: 'LLM provider' },
-            { flags: '--model', arg: '<model>', description: 'Model identifier' },
-            { flags: '--name', arg: '<name>', description: 'Override derived function name' },
-            { flags: '--nodes', arg: '<names>', description: 'Comma-separated node function names' },
-            { flags: '--config', arg: '<json>', description: 'Configuration as JSON string' },
-            { flags: '--input', arg: '<name>', description: 'Custom input port name', defaultValue: 'data' },
-            { flags: '--output', arg: '<name>', description: 'Custom output port name', defaultValue: 'result' },
-            { flags: '-l, --line', arg: '<number>', description: 'Insert at specific line number' },
-            { flags: '-a, --async', description: 'Generate an async workflow' },
-        ],
-    },
-    {
-        name: 'create node',
-        syntax: 'fw create node <name> <file> [options]',
-        description: 'Create a node type from template',
-        botCompatible: true,
-        group: 'create',
-        options: [
-            { flags: '-t, --template', arg: nodeTemplates.map(t => t.id).join('|'), description: 'Node template to use', defaultValue: 'processor' },
-            { flags: '-p, --preview', description: 'Preview generated code without writing' },
-            { flags: '-l, --line', arg: '<number>', description: 'Insert at specific line number' },
-        ],
-    },
-    // ── Templates (generated from registries) ──────────────────────
-    {
-        name: 'templates',
-        syntax: 'fw templates [--json]',
-        description: `List available workflow templates (${workflowTemplates.length} total)`,
-        botCompatible: true,
-        listStyle: 'definition',
-        options: [
-            { flags: '--json', description: 'Output as JSON' },
-        ],
-        list: workflowTemplates.map(t => `${t.id} - ${t.description}`),
-    },
-    {
-        name: 'Node Templates',
-        syntax: 'fw create node <name> <file> --template <type>',
-        description: `Create node types from templates (${nodeTemplates.length} total)`,
-        listStyle: 'definition',
-        options: [],
-        list: nodeTemplates.map(t => `${t.id} - ${t.description}`),
-    },
-    // ── Pattern subcommands ────────────────────────────────────────
-    {
-        name: 'pattern list',
-        syntax: 'fw pattern list <path> [--json]',
-        description: 'List patterns in file or directory',
-        botCompatible: true,
-        group: 'pattern',
-        options: [
-            { flags: '--json', description: 'Output as JSON' },
-        ],
-    },
-    {
-        name: 'pattern apply',
-        syntax: 'fw pattern apply <pattern-file> <target-file> [options]',
-        description: 'Apply a pattern to a workflow file',
-        botCompatible: true,
-        group: 'pattern',
-        options: [
-            { flags: '-p, --preview', description: 'Preview changes without writing' },
-            { flags: '--prefix', arg: '<prefix>', description: 'Prefix for node instance IDs' },
-            { flags: '-n, --name', arg: '<name>', description: 'Specific pattern name to apply' },
-        ],
-    },
-    {
-        name: 'pattern extract',
-        syntax: 'fw pattern extract <source-file> --nodes <ids> -o <file> [options]',
-        description: 'Extract nodes as reusable pattern',
-        botCompatible: true,
-        group: 'pattern',
-        options: [
-            { flags: '--nodes', arg: '<ids>', description: 'Comma-separated list of node IDs to extract', required: true },
-            { flags: '-o, --output', arg: '<file>', description: 'Output pattern file', required: true },
-            { flags: '-n, --name', arg: '<name>', description: 'Pattern name' },
-            { flags: '-p, --preview', description: 'Preview pattern without writing' },
-        ],
-    },
-    // ── Project & dev commands ─────────────────────────────────────
-    {
-        name: 'init',
-        syntax: 'fw init [directory] [options]',
-        description: 'Create a new flow-weaver project with templates and config',
-        options: [
-            { flags: '-n, --name', arg: '<name>', description: 'Project name (defaults to directory name)' },
-            { flags: '-t, --template', arg: workflowTemplates.map(t => t.id).join('|'), description: 'Workflow template', defaultValue: 'sequential' },
-            { flags: '-f, --format', arg: 'esm|cjs', description: 'Module format', defaultValue: 'esm' },
-            { flags: '-y, --yes', description: 'Skip prompts, use defaults' },
-            { flags: '--install / --no-install', description: 'Run npm install after scaffolding' },
-            { flags: '--git / --no-git', description: 'Initialize a git repository' },
-            { flags: '--force', description: 'Overwrite existing files' },
-            { flags: '--json', description: 'Output results as JSON' },
-        ],
-    },
-    {
-        name: 'watch',
-        syntax: 'fw watch <file> [options]',
-        description: 'Watch workflow files and recompile on changes',
-        options: [
-            { flags: '-o, --output', arg: '<path>', description: 'Output file or directory' },
-            { flags: '-p, --production', description: 'Production build (no debug events)' },
-            { flags: '-s, --source-map', description: 'Generate source maps' },
-            { flags: '-w, --workflow-name', arg: '<name>', description: 'Target specific workflow' },
-            { flags: '-f, --format', arg: 'esm|cjs|auto', description: 'Module format', defaultValue: 'auto' },
-            { flags: '--verbose', description: 'Detailed output' },
-        ],
-    },
-    {
-        name: 'doctor',
-        syntax: 'fw doctor [--json]',
-        description: 'Check project environment and configuration. Validates Node.js version, TypeScript, package installation, and tsconfig.json settings.',
-        botCompatible: true,
-        options: [
-            { flags: '--json', description: 'Output results as JSON' },
-        ],
-    },
-    // ── Context ─────────────────────────────────────────────────────
-    {
-        name: 'context',
-        syntax: 'fw context [preset] [options]',
-        description: 'Generate LLM context bundle from documentation and grammar',
-        botCompatible: true,
-        options: [
-            { flags: '--profile', arg: 'standalone|assistant', description: 'Output profile', defaultValue: 'standalone' },
-            { flags: '--topics', arg: '<slugs>', description: 'Comma-separated topic slugs (overrides preset)' },
-            { flags: '--add', arg: '<slugs>', description: 'Extra topic slugs to add to preset' },
-            { flags: '--no-grammar', description: 'Omit EBNF grammar section' },
-            { flags: '-o, --output', arg: '<path>', description: 'Write to file instead of stdout' },
-            { flags: '--list', description: 'List available presets and exit' },
-        ],
-        positionalChoices: {
-            preset: [
-                { id: 'core', label: 'core' },
-                { id: 'authoring', label: 'authoring' },
-                { id: 'ops', label: 'ops' },
-                { id: 'full', label: 'full' },
-            ],
-        },
-    },
-    // ── Export & generation ────────────────────────────────────────
-    {
-        name: 'export',
-        syntax: 'fw export <file> -t <target> -o <path> [options]',
-        description: 'Export workflow as serverless function',
-        botCompatible: true,
-        options: [
-            { flags: '-t, --target', arg: '<target>', description: 'Target platform (provided by installed packs)', required: true },
-            { flags: '-o, --output', arg: '<path>', description: 'Output directory', required: true },
-            { flags: '-w, --workflow', arg: '<name>', description: 'Specific workflow to export' },
-            { flags: '-p, --production', description: 'Production mode', defaultValue: 'true' },
-            { flags: '--multi', description: 'Export all workflows as single multi-workflow service' },
-            { flags: '--workflows', arg: '<names>', description: 'Comma-separated workflow subset (with --multi)' },
-            { flags: '--docs', description: 'Include API documentation routes (/docs, /openapi.json)' },
-            { flags: '--dry-run', description: 'Preview without writing files' },
-        ],
-    },
-    {
-        name: 'diff',
-        syntax: 'fw diff <file1> <file2> [options]',
-        description: 'Semantic diff between two workflow files',
-        botCompatible: true,
-        options: [
-            { flags: '-f, --format', arg: 'text|json|compact', description: 'Output format', defaultValue: 'text' },
-            { flags: '-w, --workflow-name', arg: '<name>', description: 'Specific workflow to compare' },
-            { flags: '--exit-zero', description: 'Exit 0 even when differences are found' },
-        ],
-    },
-    {
-        name: 'openapi',
-        syntax: 'fw openapi <directory> [options]',
-        description: 'Generate OpenAPI specification from workflows',
-        options: [
-            { flags: '-o, --output', arg: '<path>', description: 'Output file path' },
-            { flags: '--title', arg: '<title>', description: 'API title', defaultValue: 'Flow Weaver API' },
-            { flags: '--version', arg: '<version>', description: 'API version', defaultValue: '1.0.0' },
-            { flags: '--description', arg: '<desc>', description: 'API description' },
-            { flags: '-f, --format', arg: 'json|yaml', description: 'Output format', defaultValue: 'json' },
-            { flags: '--server', arg: '<url>', description: 'Server URL' },
-        ],
-    },
-    {
-        name: 'grammar',
-        syntax: 'fw grammar [options]',
-        description: 'Output JSDoc annotation grammar specification',
-        options: [
-            { flags: '-f, --format', arg: 'html|ebnf', description: 'Output format', defaultValue: 'html' },
-            { flags: '-o, --output', arg: '<path>', description: 'Write output to file instead of stdout' },
-        ],
-    },
-    // ── Integration commands ───────────────────────────────────────
-    {
-        name: 'mcp-server',
-        syntax: 'fw mcp-server [options]',
-        description: 'Start MCP server for Claude Code integration',
-        options: [
-            { flags: '--stdio', description: 'Run in MCP stdio mode (skip interactive registration)' },
-        ],
-    },
-    // ── Plugin subcommands ─────────────────────────────────────────
-    {
-        name: 'plugin init',
-        syntax: 'fw plugin init <name> [options]',
-        description: 'Scaffold a new external plugin',
-        group: 'plugin',
-        options: [
-            { flags: '-a, --area', arg: 'sidebar|main|toolbar|modal|panel', description: 'Component area', defaultValue: 'panel' },
-            { flags: '--no-system', description: 'Skip generating a system module' },
-            { flags: '-p, --preview', description: 'Preview generated files without writing' },
-            { flags: '--force', description: 'Overwrite existing files' },
-        ],
-    },
-    // ── Migration & changelog ──────────────────────────────────────
-    {
-        name: 'migrate',
-        syntax: 'fw migrate <glob> [options]',
-        description: 'Migrate workflow files to current syntax via parse → regenerate round-trip',
-        botCompatible: true,
-        options: [
-            { flags: '--dry-run', description: 'Preview changes without writing files' },
-            { flags: '--diff', description: 'Show semantic diff before/after' },
-        ],
-    },
-];
-/**
- * Extract CLI command documentation
- */
-export function extractCliCommands() {
-    return CLI_COMMANDS;
-}
-//# sourceMappingURL=cli-commands.js.map

package/dist/doc-metadata/extractors/core-metadata.js

@@ -1,61 +0,0 @@
-/**
- * Core metadata extractor.
- *
- * Provides runtime-accessible arrays and objects for data types, strategies,
- * reserved names, templates, and package exports — derived from the actual
- * source constants so documentation stays in sync automatically.
- */
-import { RESERVED_NODE_NAMES, RESERVED_PORT_NAMES, SCOPED_PORT_NAMES, EXECUTION_STRATEGIES, BRANCHING_STRATEGIES, VALID_NODE_COLORS, } from '../../constants.js';
-import { workflowTemplates, nodeTemplates, } from '../../cli/templates/index.js';
-// ── Data Types ──────────────────────────────────────────────────────────
-/** All supported port data types (runtime array, mirrors TDataType union). */
-export const DATA_TYPES = [
-    'STRING',
-    'NUMBER',
-    'BOOLEAN',
-    'OBJECT',
-    'ARRAY',
-    'FUNCTION',
-    'STEP',
-    'ANY',
-];
-/** All supported merge strategies (runtime array, mirrors TMergeStrategy union). */
-export const MERGE_STRATEGIES = ['FIRST', 'LAST', 'COLLECT', 'MERGE', 'CONCAT'];
-/** All supported branching strategies (runtime array, mirrors TBranchingStrategy union). */
-export const BRANCHING_STRATEGY_VALUES = ['value-based', 'exception-based', 'none'];
-/** All supported execution strategies (runtime array, mirrors TExecuteWhen union). */
-export const EXECUTION_STRATEGY_VALUES = ['CONJUNCTION', 'DISJUNCTION', 'CUSTOM'];
-// ── Reserved Names ──────────────────────────────────────────────────────
-export { RESERVED_NODE_NAMES, RESERVED_PORT_NAMES, SCOPED_PORT_NAMES };
-export { EXECUTION_STRATEGIES, BRANCHING_STRATEGIES, VALID_NODE_COLORS };
-/** All registered workflow templates (id, name, description, category). */
-export const WORKFLOW_TEMPLATES = workflowTemplates.map(({ id, name, description, category }) => ({ id, name, description, category }));
-/** All registered node templates (id, name, description, category). */
-export const NODE_TEMPLATES = nodeTemplates.map(({ id, name, description, category }) => ({ id, name, description, category }));
-// ── Package Exports ─────────────────────────────────────────────────────
-/** All named export subpaths from @synergenius/flow-weaver/package.json. */
-export const PACKAGE_EXPORTS = [
-    { subpath: '.', description: 'Core library (parser, validator, compiler)' },
-    { subpath: './runtime', description: 'Workflow runtime executor' },
-    { subpath: './built-in-nodes', description: 'Standard node type library' },
-    { subpath: './diagram', description: 'Diagram rendering (SVG/Mermaid)' },
-    { subpath: './describe', description: 'Workflow description formatter' },
-    { subpath: './doc-metadata', description: 'Documentation metadata extractors' },
-    { subpath: './docs', description: 'Documentation generation utilities' },
-    { subpath: './ast', description: 'AST type definitions and builders' },
-    { subpath: './api', description: 'Public API (parseWorkflow, validateWorkflow, etc.)' },
-    { subpath: './diff', description: 'Workflow semantic diff engine' },
-    { subpath: './editor', description: 'Editor completions and diagnostics' },
-    { subpath: './browser', description: 'Browser-compatible JSDoc port sync' },
-    { subpath: './generated-branding', description: 'Generated branding configuration' },
-    { subpath: './npm-packages', description: 'NPM package metadata' },
-    { subpath: './deployment', description: 'Deployment target configurations' },
-    { subpath: './marketplace', description: 'Extension/pack marketplace APIs' },
-    { subpath: './testing', description: 'Testing utilities' },
-    { subpath: './generator', description: 'Code generation' },
-    { subpath: './constants', description: 'Constants and reserved names' },
-    { subpath: './cli', description: 'CLI command definitions' },
-    { subpath: './executor', description: 'MCP workflow executor' },
-    { subpath: './context', description: 'LLM context generation' },
-];
-//# sourceMappingURL=core-metadata.js.map