docworks 0.11.0-next.1

package/README.md

@@ -0,0 +1,200 @@
+<img width="250" height="70" alt="logo-light" src="https://github.com/user-attachments/assets/ab45ecc7-adad-42e2-84bd-a87145fbc01b" />
+<br/><br/>
+
+Ensure your docs answer critical questions. AI-powered validation that checks if developers can actually find what they need.
+
+## The Problem
+
+Your docs mention "authentication" 50 times, but developers still can't figure out HOW to authenticate. Keywords exist, but answers are fragmented across pages. Support tickets spike.
+
+## How It Works
+
+Define what questions your docs must answer. DocWorks uses AI to verify they remain answerable after every change.
+
+```yaml
+# docworks.yml
+questions:
+  critical:
+    - How do I authenticate?
+    - What are the rate limits?
+    - How do I handle errors?
+```
+
+## Install
+
+```bash
+npm install -g docworks
+```
+
+## Quick Start
+
+```bash
+# 1. Initialize with smart defaults
+docworks init
+
+# 2. Check your docs (with your OpenAI key)
+OPENAI_API_KEY=sk-... docworks check
+```
+
+Output:
+
+```
+✅ How do I authenticate?
+✅ What are the rate limits?
+❌ How do I handle errors?
+
+Documentation check failed:
+Critical questions cannot be answered from current docs
+```
+
+## CI/CD Integration
+
+```yaml
+# .github/workflows/docs.yml
+name: Documentation Check
+on: [pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npx docworks check
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+```
+
+## Configuration
+
+```yaml
+# docworks.yml
+questions:
+  critical: # These block PRs if unanswerable
+    - How do I install this?
+    - How do I authenticate?
+
+  important: # These warn but don't block
+    - How do I debug issues?
+    - What are the rate limits?
+
+  nice_to_have: # Informational only
+    - Are there TypeScript types?
+
+# Optional: Use your preferred AI provider
+provider: openai # or anthropic, azure
+model: gpt-4o-mini
+```
+
+## Templates
+
+Start quickly with pre-built templates:
+
+```bash
+# API documentation
+docworks init --template api
+
+# NPM package
+docworks init --template library
+
+# Internal platform
+docworks init --template internal
+```
+
+## Why DocWorks?
+
+- **Explicit control** - You define what matters, not magic patterns
+- **AI-powered** - Understands context, not just keywords
+- **Progressive adoption** - Start advisory, enable blocking when ready
+- **Provider flexible** - OpenAI, Anthropic, Azure (BYO keys)
+- **Fast** - Cached responses, parallel validation
+
+## Examples
+
+### API Documentation
+
+```yaml
+questions:
+  critical:
+    - How do I authenticate with the API?
+    - What are the API endpoints?
+    - How do I handle errors?
+```
+
+### Library/Package
+
+```yaml
+questions:
+  critical:
+    - How do I install this package?
+    - How do I import and use it?
+    - What's a basic example?
+```
+
+### Internal Docs
+
+```yaml
+questions:
+  critical:
+    - How do I get access?
+    - Who do I contact for help?
+    - Where are the runbooks?
+```
+
+## How It Really Works
+
+1. **You define questions** your docs must answer
+2. **DocWorks reads** all your documentation
+3. **AI validates** each question is answerable
+4. **CI/CD enforces** on every PR
+
+No keyword matching. No regex patterns. Just: "Can a developer find this answer?"
+
+## Requirements
+
+- Node.js 16+
+- OpenAI API key (or Anthropic, Azure)
+- Documentation in Markdown
+
+## Pricing
+
+- **DocWorks**: Free, open source, MIT licensed
+- **AI costs**: ~$0.01 per check with caching (you pay provider directly)
+
+## Development
+
+```bash
+# Clone and install
+git clone https://github.com/caiopizzol/docworks
+cd docworks
+npm install
+
+# Run locally
+npm run dev
+
+# Run tests
+npm test
+```
+
+## FAQ
+
+**Q: Will this block my PRs?**  
+A: Not by default. Starts in advisory mode. Enable blocking when ready.
+
+**Q: What if the AI is wrong?**  
+A: Adjust confidence thresholds, use advisory mode, or override specific questions.
+
+**Q: Can I use this with private docs?**  
+A: Yes. Runs in your CI with your API keys. Docs never leave your infrastructure.
+
+**Q: Does it support other languages?**  
+A: Currently Markdown/MDX. More formats coming soon.
+
+## License
+
+MIT
+
+## Links
+
+- [Documentation](https://docworks.dev)
+- [GitHub](https://github.com/caiopizzol/docworks)
+- [NPM](https://npmjs.com/package/docworks)

package/dist/commands/check.d.ts

@@ -0,0 +1,7 @@
+export declare function check(options: {
+    config: string;
+    journey?: string;
+    cache?: boolean;
+    format?: 'terminal' | 'json' | 'github';
+}): Promise<void>;
+//# sourceMappingURL=check.d.ts.map

package/dist/commands/check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAMA,wBAAsB,KAAK,CAAC,OAAO,EAAE;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAA;CACxC,GAAG,OAAO,CAAC,IAAI,CAAC,CA2EhB"}

package/dist/commands/check.js

@@ -0,0 +1,61 @@
+import { loadConfig } from '../utils/config.js';
+import { createSource } from '../sources/base.js';
+import { validateJourneys, validateQuestions } from '../core/validator.js';
+import { formatReport, formatJSON } from '../utils/reporter.js';
+export async function check(options) {
+    try {
+        // Load config
+        const config = await loadConfig(options.config || 'docworks.yml');
+        // Validate API key
+        const apiKey = process.env.OPENAI_API_KEY ||
+            process.env.ANTHROPIC_API_KEY ||
+            config.api_key;
+        if (!apiKey) {
+            console.error('❌ No API key found\n');
+            console.error('Set one of:');
+            console.error('  export OPENAI_API_KEY=sk-...');
+            console.error('  export ANTHROPIC_API_KEY=sk-ant-...');
+            process.exit(1);
+        }
+        // Load documentation
+        console.log('📚 Loading documentation...');
+        const source = await createSource(config);
+        console.log(`Source: ${source.name}\n`);
+        const docs = await source.fetch();
+        // Validate journeys
+        console.log('🔍 Validating journeys...\n');
+        let results;
+        if (options.journey) {
+            // Validate single journey
+            const questions = config.journeys[options.journey];
+            if (!questions) {
+                console.error(`Journey "${options.journey}" not found`);
+                process.exit(1);
+            }
+            console.log(`Journey: ${options.journey}`);
+            console.log('─'.repeat(40));
+            results = {
+                [options.journey]: await validateQuestions(questions, docs, apiKey, options.cache !== false),
+            };
+        }
+        else {
+            // Validate all journeys
+            results = await validateJourneys(config.journeys, docs, apiKey, options.cache !== false);
+        }
+        // Format output
+        if (options.format === 'json') {
+            console.log(formatJSON(results, source.name));
+            const hasFailures = Object.values(results).some((questions) => questions.some((q) => q.answerable === 'NO'));
+            process.exit(hasFailures ? 1 : 0);
+        }
+        else {
+            const exitCode = formatReport(results, options.format === 'github');
+            process.exit(exitCode);
+        }
+    }
+    catch (error) {
+        console.error('❌ Error:', error.message);
+        process.exit(1);
+    }
+}
+//# sourceMappingURL=check.js.map

package/dist/commands/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAE/D,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAK3B;IACC,IAAI,CAAC;QACH,cAAc;QACd,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QAEjE,mBAAmB;QACnB,MAAM,MAAM,GACV,OAAO,CAAC,GAAG,CAAC,cAAc;YAC1B,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC7B,MAAM,CAAC,OAAO,CAAA;QAEhB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACrC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YAC5B,OAAO,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;YAC/C,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;YACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,qBAAqB;QACrB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACzC,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,IAAI,IAAI,CAAC,CAAA;QAEvC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QAEjC,oBAAoB;QACpB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAE1C,IAAI,OAAuB,CAAA;QAE3B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,0BAA0B;YAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,YAAY,OAAO,CAAC,OAAO,aAAa,CAAC,CAAA;gBACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAE3B,OAAO,GAAG;gBACR,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,iBAAiB,CACxC,SAAS,EACT,IAAI,EACJ,MAAM,EACN,OAAO,CAAC,KAAK,KAAK,KAAK,CACxB;aACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,wBAAwB;YACxB,OAAO,GAAG,MAAM,gBAAgB,CAC9B,MAAM,CAAC,QAAQ,EACf,IAAI,EACJ,MAAM,EACN,OAAO,CAAC,KAAK,KAAK,KAAK,CACxB,CAAA;QACH,CAAC;QAED,gBAAgB;QAChB,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAC5D,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAC7C,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAA;YACnE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,UAAU,EAAG,KAAe,CAAC,OAAO,CAAC,CAAA;QACnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC"}

package/dist/commands/init.d.ts

@@ -0,0 +1,5 @@
+export declare function init(options: {
+    template?: string;
+    platform?: string;
+}): Promise<void>;
+//# sourceMappingURL=init.d.ts.map

package/dist/commands/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAkHA,wBAAsB,IAAI,CAAC,OAAO,EAAE;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqChB"}

package/dist/commands/init.js

@@ -0,0 +1,165 @@
+import fs from 'fs';
+import { glob } from 'glob';
+const TEMPLATES = {
+    default: `# DocWorks Configuration
+source: ./llms.txt
+
+journeys:
+  getting_started:
+    - How do I install this?
+    - How do I get started?
+    - Where are examples?
+    
+  development:
+    - How do I run tests?
+    - How do I debug issues?
+    - Where can I get help?
+
+provider: openai
+model: gpt-4o-mini`,
+    api: `# DocWorks Configuration - API Documentation
+source: ./llms.txt
+
+journeys:
+  authentication:
+    - How do I authenticate?
+    - Where do I get API keys?
+    - What auth methods are supported?
+    
+  integration:
+    - What are the endpoints?
+    - How do I handle errors?
+    - What are the rate limits?
+    
+  production:
+    - How do I monitor usage?
+    - Where are status pages?
+    - How do I get support?
+
+provider: openai
+model: gpt-4o-mini`,
+    library: `# DocWorks Configuration - Library/Package
+source: ./llms.txt
+
+journeys:
+  setup:
+    - How do I install this package?
+    - How do I import it?
+    - What are the requirements?
+    
+  basic_usage:
+    - What's a hello world example?
+    - What are the main functions?
+    - How do I configure options?
+    
+  typescript:
+    - Does it have TypeScript support?
+    - Where are the type definitions?
+    - How do I use with TypeScript?
+
+provider: openai
+model: gpt-4o-mini`,
+    mintlify: `# DocWorks Configuration - Mintlify
+source:
+  type: mcp
+  server: "@mintlify/mcp-server"
+
+journeys:
+  api_reference:
+    - Where is the API reference?
+    - Are all endpoints documented?
+    - Do examples work?
+    
+  getting_started:
+    - Is there a quickstart guide?
+    - How do I authenticate?
+    - What SDKs are available?
+
+provider: openai
+model: gpt-4o-mini`,
+    readme: `# DocWorks Configuration - ReadMe
+source:
+  type: mcp
+  server: "@readme/mcp-server"
+
+journeys:
+  developer_experience:
+    - Can I try the API interactively?
+    - Are there code examples?
+    - Is versioning documented?
+
+provider: openai
+model: gpt-4o-mini`,
+    gitbook: `# DocWorks Configuration - GitBook
+source:
+  type: mcp
+  server: "@gitbook/mcp-server"
+
+journeys:
+  knowledge_base:
+    - Is content organized logically?
+    - Can I search effectively?
+    - Are guides comprehensive?
+
+provider: openai
+model: gpt-4o-mini`,
+};
+export async function init(options) {
+    console.log('🚀 Initializing DocWorks...\n');
+    // Check existing config
+    if (fs.existsSync('docworks.yml')) {
+        console.log('⚠️  docworks.yml already exists');
+        process.exit(1);
+    }
+    // Select template
+    const templateName = options.platform || options.template || 'default';
+    const template = TEMPLATES[templateName];
+    if (!template) {
+        console.error(`Unknown template: ${templateName}`);
+        console.log('Available: default, api, library, mintlify, readme, gitbook');
+        process.exit(1);
+    }
+    // Create llms.txt if needed (not for MCP platforms)
+    if (!options.platform && !fs.existsSync('llms.txt')) {
+        await createLLMSTxt();
+    }
+    // Write config
+    fs.writeFileSync('docworks.yml', template);
+    console.log('✅ Created docworks.yml\n');
+    // Next steps
+    console.log('Next steps:');
+    if (!options.platform) {
+        console.log('1. Review llms.txt - ensure all docs are listed');
+    }
+    console.log('2. Set your API key:');
+    console.log('   export OPENAI_API_KEY=sk-...');
+    console.log('3. Run validation:');
+    console.log('   docworks check');
+}
+async function createLLMSTxt() {
+    console.log('📝 Creating llms.txt...');
+    // Find common documentation files
+    const patterns = ['README.md', 'readme.md', 'docs/**/*.md', '*.md'];
+    const files = new Set();
+    for (const pattern of patterns) {
+        const matches = await glob(pattern, {
+            ignore: ['node_modules/**', '.git/**', 'CHANGELOG.md'],
+        });
+        matches.forEach((file) => files.add(file));
+    }
+    const content = [
+        '# Documentation sources for DocWorks',
+        '# Add your documentation files below, one per line',
+        '# Lines starting with # are comments',
+        '',
+        ...Array.from(files).slice(0, 20), // Limit initial list
+        '',
+        '# Add more files as needed:',
+        '# docs/api/authentication.md',
+        '# examples/quickstart.js',
+        '# https://api.example.com/openapi.json',
+    ].join('\n');
+    fs.writeFileSync('llms.txt', content);
+    console.log(`✅ Created llms.txt with ${files.size} documentation files\n`);
+}
+//# sourceMappingURL=init.js.map

package/dist/commands/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,MAAM,SAAS,GAAG;IAChB,OAAO,EAAE;;;;;;;;;;;;;;;mBAeQ;IAEjB,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;mBAoBY;IAEjB,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;mBAoBQ;IAEjB,QAAQ,EAAE;;;;;;;;;;;;;;;;;mBAiBO;IAEjB,MAAM,EAAE;;;;;;;;;;;;mBAYS;IAEjB,OAAO,EAAE;;;;;;;;;;;;mBAYQ;CAClB,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAG1B;IACC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAE5C,wBAAwB;IACxB,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,kBAAkB;IAClB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,IAAI,SAAS,CAAA;IACtE,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAsC,CAAC,CAAA;IAElE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAA;QAClD,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAA;QAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,oDAAoD;IACpD,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QACpD,MAAM,aAAa,EAAE,CAAA;IACvB,CAAC;IAED,eAAe;IACf,EAAE,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC1C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IAEvC,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IAC1B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;IAChE,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACnC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;IAC9C,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACjC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AAClC,CAAC;AAED,KAAK,UAAU,aAAa;IAC1B,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAA;IAEtC,kCAAkC;IAClC,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAA;IAEnE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAA;IAC/B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE;YAClC,MAAM,EAAE,CAAC,iBAAiB,EAAE,SAAS,EAAE,cAAc,CAAC;SACvD,CAAC,CAAA;QACF,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,OAAO,GAAG;QACd,sCAAsC;QACtC,oDAAoD;QACpD,sCAAsC;QACtC,EAAE;QACF,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,qBAAqB;QACxD,EAAE;QACF,6BAA6B;QAC7B,8BAA8B;QAC9B,0BAA0B;QAC1B,wCAAwC;KACzC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEZ,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IACrC,OAAO,CAAC,GAAG,CAAC,2BAA2B,KAAK,CAAC,IAAI,wBAAwB,CAAC,CAAA;AAC5E,CAAC"}

package/dist/commands/test.d.ts

@@ -0,0 +1,5 @@
+export declare function test(options: {
+    config: string;
+    ai?: string;
+}): Promise<void>;
+//# sourceMappingURL=test.d.ts.map

package/dist/commands/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/commands/test.ts"],"names":[],"mappings":"AAIA,wBAAsB,IAAI,CAAC,OAAO,EAAE;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,IAAI,CAAC,CA+ChB"}

package/dist/commands/test.js

@@ -0,0 +1,45 @@
+import { loadConfig } from '../utils/config.js';
+import { createSource } from '../sources/base.js';
+import { createProvider } from '../providers/base.js';
+export async function test(options) {
+    if (!options.ai) {
+        console.error('Specify a task: docworks test --ai "build hello world"');
+        process.exit(1);
+    }
+    try {
+        const config = await loadConfig(options.config || 'docworks.yml');
+        const apiKey = process.env.OPENAI_API_KEY || config.api_key;
+        if (!apiKey) {
+            console.error('❌ No API key found');
+            process.exit(1);
+        }
+        // Load docs
+        console.log('📚 Loading documentation...');
+        const source = await createSource(config);
+        const docs = await source.fetch();
+        // Ask AI to complete task
+        console.log(`\n🤖 Testing: "${options.ai}"\n`);
+        const provider = createProvider(config.provider || 'openai', apiKey);
+        const prompt = `
+Using ONLY this documentation, ${options.ai}.
+Provide working code.
+
+Documentation:
+${docs.substring(0, 30000)}
+
+Provide ONLY the code, no explanation.`;
+        const response = await provider.complete(prompt);
+        console.log('Generated code:');
+        console.log('─'.repeat(40));
+        console.log(response);
+        console.log('─'.repeat(40));
+        // Future: Actually execute and validate the code
+        console.log('\n✅ AI successfully generated code from documentation');
+        console.log('⚠️  Code execution validation coming soon');
+    }
+    catch (error) {
+        console.error('❌ Error:', error.message);
+        process.exit(1);
+    }
+}
+//# sourceMappingURL=test.js.map

package/dist/commands/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/commands/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAErD,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAG1B;IACC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAA;QACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,MAAM,CAAC,OAAO,CAAA;QAE3D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,YAAY;QACZ,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACzC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QAEjC,0BAA0B;QAC1B,OAAO,CAAC,GAAG,CAAC,kBAAkB,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9C,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,EAAE,MAAM,CAAC,CAAA;QACpE,MAAM,MAAM,GAAG;iCACc,OAAO,CAAC,EAAE;;;;EAIzC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC;;uCAEa,CAAA;QAEnC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAEhD,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACrB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;QAE3B,iDAAiD;QACjD,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAA;QACpE,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,UAAU,EAAG,KAAe,CAAC,OAAO,CAAC,CAAA;QACnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC"}

package/dist/core/ai.d.ts

@@ -0,0 +1,2 @@
+export declare function checkAnswerability(question: string, docs: string, apiKey: string, provider?: string, model?: string): Promise<import("../providers/base.js").ValidationResult>;
+//# sourceMappingURL=ai.d.ts.map

package/dist/core/ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../src/core/ai.ts"],"names":[],"mappings":"AAEA,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,SAAW,EACnB,KAAK,CAAC,EAAE,MAAM,4DA8Bf"}

package/dist/core/ai.js

@@ -0,0 +1,29 @@
+import { createProvider } from '../providers/base.js';
+export async function checkAnswerability(question, docs, apiKey, provider = 'openai', model) {
+    const maxRetries = 3;
+    let lastError = null;
+    for (let attempt = 1; attempt <= maxRetries; attempt++) {
+        try {
+            const aiProvider = createProvider(provider, apiKey, model);
+            return await aiProvider.checkAnswerability(question, docs);
+        }
+        catch (error) {
+            lastError = error;
+            // Retry on rate limits with exponential backoff
+            if (error.status === 429 && attempt < maxRetries) {
+                const delay = Math.pow(2, attempt) * 1000;
+                await new Promise((resolve) => setTimeout(resolve, delay));
+                continue;
+            }
+            // Don't retry on other errors
+            break;
+        }
+    }
+    // Return error state instead of throwing
+    return {
+        answerable: 'NO',
+        reason: lastError?.message || 'Unknown error',
+        location: 'N/A',
+    };
+}
+//# sourceMappingURL=ai.js.map

package/dist/core/ai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../src/core/ai.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAErD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,QAAgB,EAChB,IAAY,EACZ,MAAc,EACd,QAAQ,GAAG,QAAQ,EACnB,KAAc;IAEd,MAAM,UAAU,GAAG,CAAC,CAAA;IACpB,IAAI,SAAS,GAAiB,IAAI,CAAA;IAElC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;YAC1D,OAAO,MAAM,UAAU,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5D,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,SAAS,GAAG,KAAK,CAAA;YAEjB,gDAAgD;YAChD,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,OAAO,GAAG,UAAU,EAAE,CAAC;gBACjD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;gBACzC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;gBAC1D,SAAQ;YACV,CAAC;YAED,8BAA8B;YAC9B,MAAK;QACP,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,OAAO;QACL,UAAU,EAAE,IAAa;QACzB,MAAM,EAAE,SAAS,EAAE,OAAO,IAAI,eAAe;QAC7C,QAAQ,EAAE,KAAK;KAChB,CAAA;AACH,CAAC"}

package/dist/core/cache.d.ts

@@ -0,0 +1,3 @@
+export declare function getCached(key: string): any;
+export declare function setCached(key: string, data: any): void;
+//# sourceMappingURL=cache.d.ts.map

package/dist/core/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/core/cache.ts"],"names":[],"mappings":"AAYA,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAgB1C;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,CAUtD"}

package/dist/core/cache.js

@@ -0,0 +1,31 @@
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+const CACHE_DIR = path.join(os.homedir(), '.docworks', 'cache');
+const CACHE_TTL = 7 * 24 * 60 * 60 * 1000; // 7 days
+// Ensure cache directory exists
+if (!fs.existsSync(CACHE_DIR)) {
+    fs.mkdirSync(CACHE_DIR, { recursive: true });
+}
+export function getCached(key) {
+    const cachePath = path.join(CACHE_DIR, `${key}.json`);
+    if (!fs.existsSync(cachePath)) {
+        return null;
+    }
+    const cached = JSON.parse(fs.readFileSync(cachePath, 'utf-8'));
+    // Check if expired
+    if (Date.now() - cached.timestamp > CACHE_TTL) {
+        fs.unlinkSync(cachePath);
+        return null;
+    }
+    return cached.data;
+}
+export function setCached(key, data) {
+    const cachePath = path.join(CACHE_DIR, `${key}.json`);
+    fs.writeFileSync(cachePath, JSON.stringify({
+        timestamp: Date.now(),
+        data,
+    }));
+}
+//** */
+//# sourceMappingURL=cache.js.map

package/dist/core/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/core/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;AAC/D,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,SAAS;AAEnD,gCAAgC;AAChC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;IAC9B,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;AAC9C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,CAAA;IAErD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;IAE9D,mBAAmB;IACnB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC;QAC9C,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;QACxB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAA;AACpB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,IAAS;IAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,CAAA;IAErD,EAAE,CAAC,aAAa,CACd,SAAS,EACT,IAAI,CAAC,SAAS,CAAC;QACb,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,IAAI;KACL,CAAC,CACH,CAAA;AACH,CAAC;AACD,OAAO"}

package/dist/core/validator.d.ts

@@ -0,0 +1,4 @@
+import { ValidationResult, JourneyResults } from '../types/config.js';
+export declare function validateJourneys(journeys: Record<string, string[]>, docs: string, apiKey: string, useCache?: boolean): Promise<JourneyResults>;
+export declare function validateQuestions(questions: string[], docs: string, apiKey: string, useCache?: boolean): Promise<ValidationResult[]>;
+//# sourceMappingURL=validator.d.ts.map

package/dist/core/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/core/validator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAIrE,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,UAAO,GACd,OAAO,CAAC,cAAc,CAAC,CAazB;AAED,wBAAsB,iBAAiB,CACrC,SAAS,EAAE,MAAM,EAAE,EACnB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,UAAO,GACd,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA4C7B"}

package/dist/core/validator.js

@@ -0,0 +1,47 @@
+import crypto from 'crypto';
+import { checkAnswerability } from './ai.js';
+import { getCached, setCached } from './cache.js';
+export async function validateJourneys(journeys, docs, apiKey, useCache = true) {
+    const results = {};
+    for (const [journey, questions] of Object.entries(journeys)) {
+        results[journey] = await validateQuestions(questions, docs, apiKey, useCache);
+    }
+    return results;
+}
+export async function validateQuestions(questions, docs, apiKey, useCache = true) {
+    const results = [];
+    for (const question of questions) {
+        // Generate cache key
+        const cacheKey = crypto
+            .createHash('md5')
+            .update(question + docs.substring(0, 1000)) // Use first 1KB for cache key
+            .digest('hex');
+        let result = null;
+        // Try cache first
+        if (useCache) {
+            result = getCached(cacheKey);
+        }
+        // If not cached, check with AI
+        if (!result) {
+            const validation = await checkAnswerability(question, docs, apiKey);
+            result = {
+                question,
+                ...validation,
+            };
+            // Cache the result
+            if (useCache) {
+                setCached(cacheKey, result);
+            }
+        }
+        results.push(result);
+        // Show progress
+        const icon = result.answerable === 'YES'
+            ? '✅'
+            : result.answerable === 'PARTIAL'
+                ? '⚠️'
+                : '❌';
+        console.log(`  ${icon} ${question}`);
+    }
+    return results;
+}
+//# sourceMappingURL=validator.js.map