@ai-coders/context 0.6.1 → 0.7.1

package/dist/generators/shared/structures/agents/factory.js

@@ -0,0 +1,138 @@
+"use strict";
+/**
+ * Factory function for creating agent structures
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAgentStructure = createAgentStructure;
+/**
+ * Map of section headings to content keys
+ */
+const SECTION_KEY_MAP = {
+    'Mission': 'mission',
+    'Responsibilities': 'responsibilities',
+    'Best Practices': 'bestPractices',
+    'Key Project Resources': 'keyProjectResources',
+    'Repository Starting Points': 'repositoryStartingPoints',
+    'Key Files': 'keyFiles',
+    'Architecture Context': 'architectureContext',
+    'Key Symbols for This Agent': 'keySymbols',
+    'Documentation Touchpoints': 'documentationTouchpoints',
+    'Collaboration Checklist': 'collaborationChecklist',
+    'Hand-off Notes': 'handoffNotes',
+};
+/**
+ * Create an agent structure with standard sections
+ */
+function createAgentStructure(agentType, title, description, additionalContext, defaultContent) {
+    const sections = [
+        {
+            heading: 'Mission',
+            order: 1,
+            contentType: 'prose',
+            guidance: `Describe how the ${title.toLowerCase()} agent supports the team and when to engage it.`,
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Responsibilities',
+            order: 2,
+            contentType: 'list',
+            guidance: 'List specific responsibilities this agent handles. Be concrete about what tasks it performs.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Best Practices',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List best practices and guidelines for this agent to follow.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Key Project Resources',
+            order: 4,
+            contentType: 'list',
+            guidance: 'Link to documentation index, agent handbook, AGENTS.md, and contributor guide.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Repository Starting Points',
+            order: 5,
+            contentType: 'list',
+            guidance: 'List top-level directories relevant to this agent with brief descriptions.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Key Files',
+            order: 6,
+            contentType: 'list',
+            guidance: 'List entry points, pattern implementations, and service files relevant to this agent.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Architecture Context',
+            order: 7,
+            contentType: 'list',
+            guidance: 'For each architectural layer, describe directories, symbol counts, and key exports.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Key Symbols for This Agent',
+            order: 8,
+            contentType: 'list',
+            guidance: 'List symbols (classes, functions, types) most relevant to this agent with links.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Documentation Touchpoints',
+            order: 9,
+            contentType: 'list',
+            guidance: 'Link to relevant documentation files this agent should reference.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Collaboration Checklist',
+            order: 10,
+            contentType: 'checklist',
+            guidance: 'Numbered checklist for agent workflow: confirm assumptions, review PRs, update docs, capture learnings.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Hand-off Notes',
+            order: 11,
+            contentType: 'prose',
+            guidance: 'Summarize outcomes, remaining risks, and suggested follow-up actions after the agent completes work.',
+            required: false,
+            headingLevel: 2,
+        },
+    ];
+    // Apply default content to sections
+    if (defaultContent) {
+        for (const section of sections) {
+            const key = SECTION_KEY_MAP[section.heading];
+            if (key && defaultContent[key]) {
+                section.defaultContent = defaultContent[key];
+            }
+        }
+    }
+    return {
+        fileType: 'agent',
+        documentName: agentType,
+        title: `${title} Agent Playbook`,
+        description,
+        tone: 'instructional',
+        audience: 'ai-agents',
+        sections,
+        linkTo: ['../docs/README.md', 'README.md', '../../AGENTS.md'],
+        additionalContext,
+    };
+}
+//# sourceMappingURL=factory.js.map

package/dist/generators/shared/structures/agents/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/agents/factory.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAyCH,oDAuHC;AA3ID;;GAEG;AACH,MAAM,eAAe,GAA8C;IACjE,SAAS,EAAE,SAAS;IACpB,kBAAkB,EAAE,kBAAkB;IACtC,gBAAgB,EAAE,eAAe;IACjC,uBAAuB,EAAE,qBAAqB;IAC9C,4BAA4B,EAAE,0BAA0B;IACxD,WAAW,EAAE,UAAU;IACvB,sBAAsB,EAAE,qBAAqB;IAC7C,4BAA4B,EAAE,YAAY;IAC1C,2BAA2B,EAAE,0BAA0B;IACvD,yBAAyB,EAAE,wBAAwB;IACnD,gBAAgB,EAAE,cAAc;CACjC,CAAC;AAEF;;GAEG;AACH,SAAgB,oBAAoB,CAClC,SAAiB,EACjB,KAAa,EACb,WAAmB,EACnB,iBAA0B,EAC1B,cAAoC;IAEpC,MAAM,QAAQ,GAAsB;QAClC;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oBAAoB,KAAK,CAAC,WAAW,EAAE,iDAAiD;YAClG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8FAA8F;YACxG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8DAA8D;YACxE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,gFAAgF;YAC1F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uFAAuF;YACjG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,qFAAqF;YAC/F,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,mEAAmE;YAC7E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,sGAAsG;YAChH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF,CAAC;IAEF,oCAAoC;IACpC,IAAI,cAAc,EAAE,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,YAAY,EAAE,SAAS;QACvB,KAAK,EAAE,GAAG,KAAK,iBAAiB;QAChC,WAAW;QACX,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,WAAW;QACrB,QAAQ;QACR,MAAM,EAAE,CAAC,mBAAmB,EAAE,WAAW,EAAE,iBAAiB,CAAC;QAC7D,iBAAiB;KAClB,CAAC;AACJ,CAAC"}

package/dist/generators/shared/structures/agents/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Agent structure exports
+ */
+export { createAgentStructure } from './factory';
+export { codeReviewerStructure, bugFixerStructure, featureDeveloperStructure, refactoringSpecialistStructure, testWriterStructure, documentationWriterStructure, performanceOptimizerStructure, securityAuditorStructure, backendSpecialistStructure, frontendSpecialistStructure, architectSpecialistStructure, devopsSpecialistStructure, databaseSpecialistStructure, mobileSpecialistStructure, } from './definitions';
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/shared/structures/agents/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/agents/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,yBAAyB,EACzB,8BAA8B,EAC9B,mBAAmB,EACnB,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,GAC1B,MAAM,eAAe,CAAC"}

package/dist/generators/shared/structures/agents/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Agent structure exports
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileSpecialistStructure = exports.databaseSpecialistStructure = exports.devopsSpecialistStructure = exports.architectSpecialistStructure = exports.frontendSpecialistStructure = exports.backendSpecialistStructure = exports.securityAuditorStructure = exports.performanceOptimizerStructure = exports.documentationWriterStructure = exports.testWriterStructure = exports.refactoringSpecialistStructure = exports.featureDeveloperStructure = exports.bugFixerStructure = exports.codeReviewerStructure = exports.createAgentStructure = void 0;
+var factory_1 = require("./factory");
+Object.defineProperty(exports, "createAgentStructure", { enumerable: true, get: function () { return factory_1.createAgentStructure; } });
+var definitions_1 = require("./definitions");
+Object.defineProperty(exports, "codeReviewerStructure", { enumerable: true, get: function () { return definitions_1.codeReviewerStructure; } });
+Object.defineProperty(exports, "bugFixerStructure", { enumerable: true, get: function () { return definitions_1.bugFixerStructure; } });
+Object.defineProperty(exports, "featureDeveloperStructure", { enumerable: true, get: function () { return definitions_1.featureDeveloperStructure; } });
+Object.defineProperty(exports, "refactoringSpecialistStructure", { enumerable: true, get: function () { return definitions_1.refactoringSpecialistStructure; } });
+Object.defineProperty(exports, "testWriterStructure", { enumerable: true, get: function () { return definitions_1.testWriterStructure; } });
+Object.defineProperty(exports, "documentationWriterStructure", { enumerable: true, get: function () { return definitions_1.documentationWriterStructure; } });
+Object.defineProperty(exports, "performanceOptimizerStructure", { enumerable: true, get: function () { return definitions_1.performanceOptimizerStructure; } });
+Object.defineProperty(exports, "securityAuditorStructure", { enumerable: true, get: function () { return definitions_1.securityAuditorStructure; } });
+Object.defineProperty(exports, "backendSpecialistStructure", { enumerable: true, get: function () { return definitions_1.backendSpecialistStructure; } });
+Object.defineProperty(exports, "frontendSpecialistStructure", { enumerable: true, get: function () { return definitions_1.frontendSpecialistStructure; } });
+Object.defineProperty(exports, "architectSpecialistStructure", { enumerable: true, get: function () { return definitions_1.architectSpecialistStructure; } });
+Object.defineProperty(exports, "devopsSpecialistStructure", { enumerable: true, get: function () { return definitions_1.devopsSpecialistStructure; } });
+Object.defineProperty(exports, "databaseSpecialistStructure", { enumerable: true, get: function () { return definitions_1.databaseSpecialistStructure; } });
+Object.defineProperty(exports, "mobileSpecialistStructure", { enumerable: true, get: function () { return definitions_1.mobileSpecialistStructure; } });
+//# sourceMappingURL=index.js.map

package/dist/generators/shared/structures/agents/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/agents/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,qCAAiD;AAAxC,+GAAA,oBAAoB,OAAA;AAC7B,6CAeuB;AAdrB,oHAAA,qBAAqB,OAAA;AACrB,gHAAA,iBAAiB,OAAA;AACjB,wHAAA,yBAAyB,OAAA;AACzB,6HAAA,8BAA8B,OAAA;AAC9B,kHAAA,mBAAmB,OAAA;AACnB,2HAAA,4BAA4B,OAAA;AAC5B,4HAAA,6BAA6B,OAAA;AAC7B,uHAAA,wBAAwB,OAAA;AACxB,yHAAA,0BAA0B,OAAA;AAC1B,0HAAA,2BAA2B,OAAA;AAC3B,2HAAA,4BAA4B,OAAA;AAC5B,wHAAA,yBAAyB,OAAA;AACzB,0HAAA,2BAA2B,OAAA;AAC3B,wHAAA,yBAAyB,OAAA"}

package/dist/generators/shared/structures/documentation/apiReference.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const apiReferenceStructure: ScaffoldStructure;
+//# sourceMappingURL=apiReference.d.ts.map

package/dist/generators/shared/structures/documentation/apiReference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiReference.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/apiReference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,qBAAqB,EAAE,iBA+FnC,CAAC"}

package/dist/generators/shared/structures/documentation/apiReference.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiReferenceStructure = void 0;
+exports.apiReferenceStructure = {
+    fileType: 'doc',
+    documentName: 'api-reference',
+    title: 'API Reference',
+    description: 'Complete API documentation for programmatic and AI agent access',
+    tone: 'technical',
+    audience: 'mixed',
+    sections: [
+        {
+            heading: 'API Reference',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Describe the API purpose and provide agent-specific instructions for programmatic interaction.',
+            exampleContent: '**Agent Usage Instructions:**\n- Use documented curl commands as templates\n- Verify expected response codes\n- Handle authentication token expiration automatically\n- Parse error responses to determine retry strategy\n- Log all API interactions for debugging',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Base URLs',
+            order: 2,
+            contentType: 'code-block',
+            guidance: 'List API base URLs for different environments (dev, staging, production) with example environment variable configuration.',
+            exampleContent: '```bash\nexport API_BASE_DEV="http://localhost:3000/api"\nexport API_BASE_STAGING="https://staging-api.example.com"\nexport API_BASE_PROD="https://api.example.com"\n```',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Authentication',
+            order: 3,
+            contentType: 'prose',
+            guidance: 'Document authentication flow including token generation, storage, expiration handling, and refresh mechanisms with curl examples for agents.',
+            exampleContent: 'Include bash examples for: 1) Obtain token via POST /auth/login, 2) Use token in requests with Bearer header, 3) Check token expiration and refresh if needed',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'API Versioning',
+            order: 4,
+            contentType: 'prose',
+            guidance: 'Document API versioning strategy (URL path, header, or query parameter), current version, and deprecation policy.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Rate Limiting',
+            order: 5,
+            contentType: 'prose',
+            guidance: 'Document rate limits with code examples showing agents how to check headers and handle backoff.',
+            exampleContent: 'Include monitoring of X-RateLimit-* headers and handling 429 responses with exponential backoff',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Common Headers',
+            order: 6,
+            contentType: 'list',
+            guidance: 'List request and response headers including Content-Type, Authorization, X-Request-ID, and any custom headers.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Endpoints',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Document API endpoints organized by resource with request/response examples for GET, POST, PUT, PATCH, DELETE methods.',
+            exampleContent: 'Include: method, path, parameters, request body examples, response codes, error handling for each endpoint',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Webhooks',
+            order: 8,
+            contentType: 'prose',
+            guidance: 'Document webhook registration, available events, payload structure, and security mechanisms.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Error Responses',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'Document standard error response format, HTTP status codes, and common error codes with their meanings.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'SDKs & Client Libraries',
+            order: 10,
+            contentType: 'list',
+            guidance: 'Link to available SDKs (JavaScript, Python, etc.) and OpenAPI/Swagger specifications.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['architecture.md', 'security.md'],
+};
+//# sourceMappingURL=apiReference.js.map

package/dist/generators/shared/structures/documentation/apiReference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiReference.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/apiReference.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAsB;IACtD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,eAAe;IAC7B,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,iEAAiE;IAC9E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gGAAgG;YAC1G,cAAc,EAAE,qQAAqQ;YACrR,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,YAAY;YACzB,QAAQ,EAAE,2HAA2H;YACrI,cAAc,EAAE,0KAA0K;YAC1L,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8IAA8I;YACxJ,cAAc,EAAE,+JAA+J;YAC/K,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,mHAAmH;YAC7H,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iGAAiG;YAC3G,cAAc,EAAE,iGAAiG;YACjH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,gHAAgH;YAC1H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wHAAwH;YAClI,cAAc,EAAE,4GAA4G;YAC5H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8FAA8F;YACxG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uFAAuF;YACjG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,EAAE,aAAa,CAAC;CAC3C,CAAC"}

package/dist/generators/shared/structures/documentation/architecture.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const architectureStructure: ScaffoldStructure;
+//# sourceMappingURL=architecture.d.ts.map

package/dist/generators/shared/structures/documentation/architecture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"architecture.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,qBAAqB,EAAE,iBA2KnC,CAAC"}

package/dist/generators/shared/structures/documentation/architecture.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.architectureStructure = void 0;
+exports.architectureStructure = {
+    fileType: 'doc',
+    documentName: 'architecture',
+    title: 'Architecture Notes',
+    description: 'System architecture, layers, patterns, and design decisions',
+    tone: 'technical',
+    audience: 'architects',
+    sections: [
+        {
+            heading: 'Architecture Notes',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Describe how the system is assembled and why the current design exists.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `This document describes the system architecture, design patterns, and key technical decisions.
+
+For complete symbol counts and dependency analysis, see [\`codebase-map.json\`](./codebase-map.json).`,
+        },
+        {
+            heading: 'System Architecture Overview',
+            order: 2,
+            contentType: 'prose',
+            guidance: 'Summarize the top-level topology (monolith, modular service, microservices) and deployment model. Highlight how requests traverse the system and where control pivots between layers.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `**Architecture Style**: [Monolith / Modular Monolith / Microservices]
+
+**Key Components**:
+- **Entry Layer**: Handles incoming requests (CLI, HTTP, etc.)
+- **Service Layer**: Core business logic and orchestration
+- **Data Layer**: Persistence and external service integration
+
+**Request Flow**:
+1. Request enters through entry point
+2. Routed to appropriate service handler
+3. Service processes and returns response`,
+        },
+        {
+            heading: 'Architectural Layers',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List architecture layers with their purpose and key directories. Do NOT list symbol counts inline - reference codebase-map.json for detailed analysis.',
+            exampleContent: '- **Services**: Core business logic (`src/services/`)\n- **Generators**: Content generation (`src/generators/`)\n\n> See [`codebase-map.json`](./codebase-map.json) for complete symbol counts and dependency graphs.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- **Entry Points**: Application entry and initialization (\`src/\`)
+- **Services**: Core business logic (\`src/services/\`)
+- **Models/Types**: Data structures and type definitions (\`src/types/\`)
+- **Utilities**: Shared helper functions (\`src/utils/\`)
+
+> See [\`codebase-map.json\`](./codebase-map.json) for complete symbol counts and dependency graphs.`,
+        },
+        {
+            heading: 'Detected Design Patterns',
+            order: 4,
+            contentType: 'table',
+            guidance: 'Table with Pattern, Confidence, Locations, and Description columns. Link to actual implementations.',
+            exampleContent: '| Pattern | Confidence | Locations | Description |\n|---------|------------|-----------|-------------|\n| Factory | 85% | `LLMClientFactory` | Creates LLM client instances |',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `| Pattern | Locations | Description |
+|---------|-----------|-------------|
+| [Pattern Name] | \`src/path/\` | [Brief description] |
+
+*Update this table as patterns are identified in the codebase.*`,
+        },
+        {
+            heading: 'Entry Points',
+            order: 5,
+            contentType: 'list',
+            guidance: 'List entry points with markdown links to the actual files.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- [\`src/index.ts\`](../src/index.ts) — Main module entry
+- [\`src/cli.ts\`](../src/cli.ts) — CLI entry point (if applicable)`,
+        },
+        {
+            heading: 'Public API',
+            order: 6,
+            contentType: 'table',
+            guidance: 'Table of exported symbols with Symbol, Type, and Location columns.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `| Symbol | Type | Location |
+|--------|------|----------|
+| [ExportName] | class/function/type | \`src/path.ts\` |
+
+See [\`codebase-map.json\`](./codebase-map.json) for the complete public API listing.`,
+        },
+        {
+            heading: 'Internal System Boundaries',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Document seams between domains, bounded contexts, or service ownership. Note data ownership, synchronization strategies, and shared contract enforcement.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'External Service Dependencies',
+            order: 8,
+            contentType: 'list',
+            guidance: 'List SaaS platforms, third-party APIs, or infrastructure services. Describe authentication methods, rate limits, and failure considerations.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Key Decisions & Trade-offs',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'Summarize architectural decisions, experiments, or ADR outcomes. Explain why selected approaches won over alternatives.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `Document key architectural decisions here. Consider creating Architecture Decision Records (ADRs) for significant choices.
+
+**Template**:
+- **Decision**: [What was decided]
+- **Context**: [Why this decision was needed]
+- **Alternatives**: [What else was considered]
+- **Consequences**: [Impact of this decision]`,
+        },
+        {
+            heading: 'Diagrams',
+            order: 10,
+            contentType: 'diagram',
+            guidance: 'Link architectural diagrams or add mermaid definitions showing system components and their relationships.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `\`\`\`mermaid
+graph TD
+    A[Entry Point] --> B[Service Layer]
+    B --> C[Data Layer]
+    B --> D[External Services]
+\`\`\`
+
+*Replace with actual system architecture diagram.*`,
+        },
+        {
+            heading: 'Risks & Constraints',
+            order: 11,
+            contentType: 'prose',
+            guidance: 'Document performance constraints, scaling considerations, or external system assumptions.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Top Directories Snapshot',
+            order: 12,
+            contentType: 'list',
+            guidance: 'List top directories with approximate file counts.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- \`src/\` — Source code
+- \`tests/\` — Test files
+- \`docs/\` — Documentation
+
+*See [\`codebase-map.json\`](./codebase-map.json) for detailed file counts.*`,
+        },
+        {
+            heading: 'Related Resources',
+            order: 13,
+            contentType: 'list',
+            guidance: 'Link to Project Overview and other relevant documentation.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- [Project Overview](./project-overview.md)
+- [Data Flow](./data-flow.md) (if applicable)
+- [Codebase Map](./codebase-map.json)`,
+        },
+    ],
+    linkTo: ['project-overview.md', 'data-flow.md', 'codebase-map.json'],
+};
+//# sourceMappingURL=architecture.js.map

package/dist/generators/shared/structures/documentation/architecture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"architecture.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAsB;IACtD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yEAAyE;YACnF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;sGAEgF;SACjG;QACD;YACE,OAAO,EAAE,8BAA8B;YACvC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uLAAuL;YACjM,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;;;;0CAUoB;SACrC;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,wJAAwJ;YAClK,cAAc,EAAE,uNAAuN;YACvO,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;qGAK+E;SAChG;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,qGAAqG;YAC/G,cAAc,EAAE,+KAA+K;YAC/L,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;gEAI0C;SAC3D;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;oEAC8C;SAC/D;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oEAAoE;YAC9E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;sFAIgE;SACjF;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,2JAA2J;YACrK,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8IAA8I;YACxJ,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yHAAyH;YACnI,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;8CAMwB;SACzC;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,SAAS;YACtB,QAAQ,EAAE,2GAA2G;YACrH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;mDAO6B;SAC9C;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,2FAA2F;YACrG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;6EAIuD;SACxE;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;sCAEgB;SACjC;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,EAAE,cAAc,EAAE,mBAAmB,CAAC;CACrE,CAAC"}

package/dist/generators/shared/structures/documentation/dataFlow.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const dataFlowStructure: ScaffoldStructure;
+//# sourceMappingURL=dataFlow.d.ts.map

package/dist/generators/shared/structures/documentation/dataFlow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataFlow.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBAsG/B,CAAC"}

package/dist/generators/shared/structures/documentation/dataFlow.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataFlowStructure = void 0;
+exports.dataFlowStructure = {
+    fileType: 'doc',
+    documentName: 'data-flow',
+    title: 'Data Flow & Integrations',
+    description: 'How data moves through the system and external integrations',
+    tone: 'technical',
+    audience: 'architects',
+    sections: [
+        {
+            heading: 'Data Flow & Integrations',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Explain how data enters, moves through, and exits the system, including interactions with external services.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `This document describes how data flows through the system, including internal processing and external integrations.
+
+Understanding data flow helps with debugging, performance optimization, and maintaining system reliability.`,
+        },
+        {
+            heading: 'Module Dependencies',
+            order: 2,
+            contentType: 'list',
+            guidance: 'List cross-module dependencies showing which modules depend on which.',
+            exampleContent: '- **src/** → `utils`, `config`\n- **services/** → `utils`',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `Module dependency overview:
+
+- **Entry Layer** → Services, Utils
+- **Services** → Data Access, External APIs
+- **Data Access** → Database, Cache
+
+*See [\`codebase-map.json\`](./codebase-map.json) for detailed dependency graphs.*`,
+        },
+        {
+            heading: 'Service Layer',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List service classes with links to their implementations.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `Key services in the system:
+
+- **[ServiceName]** — [Purpose] (\`src/services/path.ts\`)
+
+*See [\`codebase-map.json\`](./codebase-map.json) for complete service listings.*`,
+        },
+        {
+            heading: 'High-level Flow',
+            order: 4,
+            contentType: 'prose',
+            guidance: 'Summarize the primary pipeline from input to output. Reference diagrams or embed Mermaid definitions.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `\`\`\`mermaid
+flowchart LR
+    A[Input] --> B[Processing]
+    B --> C[Storage]
+    B --> D[Output]
+\`\`\`
+
+**Data Flow Steps**:
+1. Data enters through entry points (API, CLI, etc.)
+2. Services process and transform data
+3. Results are stored and/or returned to caller
+
+*Replace with actual system data flow.*`,
+        },
+        {
+            heading: 'Internal Movement',
+            order: 5,
+            contentType: 'prose',
+            guidance: 'Describe how modules collaborate (queues, events, RPC calls, shared databases).',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'External Integrations',
+            order: 6,
+            contentType: 'list',
+            guidance: 'Document each integration with purpose, authentication, payload shapes, and retry strategy.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `**External Services**:
+
+| Service | Purpose | Auth Method |
+|---------|---------|-------------|
+| [Service] | [Purpose] | [API Key/OAuth/etc.] |
+
+*Document error handling and retry strategies for each integration.*`,
+        },
+        {
+            heading: 'Observability & Failure Modes',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Describe metrics, traces, or logs that monitor the flow. Note backoff, dead-letter, or compensating actions.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['architecture.md'],
+};
+//# sourceMappingURL=dataFlow.js.map

package/dist/generators/shared/structures/documentation/dataFlow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataFlow.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,WAAW;IACzB,KAAK,EAAE,0BAA0B;IACjC,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8GAA8G;YACxH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;4GAEsF;SACvG;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uEAAuE;YACjF,cAAc,EAAE,2DAA2D;YAC3E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;mFAM6D;SAC9E;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2DAA2D;YACrE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;kFAI4D;SAC7E;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;;;;;;wCAYkB;SACnC;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iFAAiF;YAC3F,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,6FAA6F;YACvG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;qEAM+C;SAChE;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8GAA8G;YACxH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,CAAC;CAC5B,CAAC"}

package/dist/generators/shared/structures/documentation/glossary.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const glossaryStructure: ScaffoldStructure;
+//# sourceMappingURL=glossary.d.ts.map

package/dist/generators/shared/structures/documentation/glossary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBAsF/B,CAAC"}