@ai-coders/context 0.6.0 → 0.7.0

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,iBAoHnC,CAAC"}

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

@@ -0,0 +1,121 @@
+"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,
+        },
+        {
+            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,
+        },
+        {
+            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,
+        },
+        {
+            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,
+        },
+        {
+            heading: 'Entry Points',
+            order: 5,
+            contentType: 'list',
+            guidance: 'List entry points with markdown links to the actual files.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Public API',
+            order: 6,
+            contentType: 'table',
+            guidance: 'Table of exported symbols with Symbol, Type, and Location columns.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            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,
+        },
+        {
+            heading: 'Diagrams',
+            order: 10,
+            contentType: 'diagram',
+            guidance: 'Link architectural diagrams or add mermaid definitions showing system components and their relationships.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            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,
+        },
+        {
+            heading: 'Related Resources',
+            order: 13,
+            contentType: 'list',
+            guidance: 'Link to Project Overview and other relevant documentation.',
+            required: true,
+            headingLevel: 2,
+        },
+    ],
+    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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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,iBAmE/B,CAAC"}

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

@@ -0,0 +1,72 @@
+"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,
+        },
+        {
+            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,
+        },
+        {
+            heading: 'Service Layer',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List service classes with links to their implementations.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            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,
+        },
+        {
+            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,
+        },
+        {
+            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;SAChB;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;SAChB;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;SAChB;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;SAChB;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;SAChB;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,iBAkE/B,CAAC"}

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

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.glossaryStructure = void 0;
+exports.glossaryStructure = {
+    fileType: 'doc',
+    documentName: 'glossary',
+    title: 'Glossary & Domain Concepts',
+    description: 'Project terminology, type definitions, domain entities, and business rules',
+    tone: 'technical',
+    audience: 'mixed',
+    sections: [
+        {
+            heading: 'Glossary & Domain Concepts',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'List project-specific terminology, acronyms, domain entities, and user personas.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Type Definitions',
+            order: 2,
+            contentType: 'list',
+            guidance: 'List exported type definitions and interfaces with links to their locations.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Enumerations',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List exported enums with links to their locations.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Core Terms',
+            order: 4,
+            contentType: 'list',
+            guidance: 'Define key terms, their relevance, and where they surface in the codebase.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Acronyms & Abbreviations',
+            order: 5,
+            contentType: 'list',
+            guidance: 'Expand abbreviations and note associated services or APIs.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Personas / Actors',
+            order: 6,
+            contentType: 'prose',
+            guidance: 'Describe user goals, key workflows, and pain points addressed by the system.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Domain Rules & Invariants',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Capture business rules, validation constraints, or compliance requirements. Note region/localization nuances.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['project-overview.md'],
+};
+//# sourceMappingURL=glossary.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,4EAA4E;IACzF,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,+GAA+G;YACzH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,CAAC;CAChC,CAAC"}

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

@@ -0,0 +1,16 @@
+/**
+ * Documentation structure definitions
+ */
+export { projectOverviewStructure } from './projectOverview';
+export { architectureStructure } from './architecture';
+export { developmentWorkflowStructure } from './workflow';
+export { testingStrategyStructure } from './testing';
+export { toolingStructure } from './tooling';
+export { securityStructure } from './security';
+export { glossaryStructure } from './glossary';
+export { dataFlowStructure } from './dataFlow';
+export { onboardingStructure } from './onboarding';
+export { apiReferenceStructure } from './apiReference';
+export { migrationStructure } from './migration';
+export { troubleshootingStructure } from './troubleshooting';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}

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

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * Documentation structure definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.troubleshootingStructure = exports.migrationStructure = exports.apiReferenceStructure = exports.onboardingStructure = exports.dataFlowStructure = exports.glossaryStructure = exports.securityStructure = exports.toolingStructure = exports.testingStrategyStructure = exports.developmentWorkflowStructure = exports.architectureStructure = exports.projectOverviewStructure = void 0;
+var projectOverview_1 = require("./projectOverview");
+Object.defineProperty(exports, "projectOverviewStructure", { enumerable: true, get: function () { return projectOverview_1.projectOverviewStructure; } });
+var architecture_1 = require("./architecture");
+Object.defineProperty(exports, "architectureStructure", { enumerable: true, get: function () { return architecture_1.architectureStructure; } });
+var workflow_1 = require("./workflow");
+Object.defineProperty(exports, "developmentWorkflowStructure", { enumerable: true, get: function () { return workflow_1.developmentWorkflowStructure; } });
+var testing_1 = require("./testing");
+Object.defineProperty(exports, "testingStrategyStructure", { enumerable: true, get: function () { return testing_1.testingStrategyStructure; } });
+var tooling_1 = require("./tooling");
+Object.defineProperty(exports, "toolingStructure", { enumerable: true, get: function () { return tooling_1.toolingStructure; } });
+var security_1 = require("./security");
+Object.defineProperty(exports, "securityStructure", { enumerable: true, get: function () { return security_1.securityStructure; } });
+var glossary_1 = require("./glossary");
+Object.defineProperty(exports, "glossaryStructure", { enumerable: true, get: function () { return glossary_1.glossaryStructure; } });
+var dataFlow_1 = require("./dataFlow");
+Object.defineProperty(exports, "dataFlowStructure", { enumerable: true, get: function () { return dataFlow_1.dataFlowStructure; } });
+var onboarding_1 = require("./onboarding");
+Object.defineProperty(exports, "onboardingStructure", { enumerable: true, get: function () { return onboarding_1.onboardingStructure; } });
+var apiReference_1 = require("./apiReference");
+Object.defineProperty(exports, "apiReferenceStructure", { enumerable: true, get: function () { return apiReference_1.apiReferenceStructure; } });
+var migration_1 = require("./migration");
+Object.defineProperty(exports, "migrationStructure", { enumerable: true, get: function () { return migration_1.migrationStructure; } });
+var troubleshooting_1 = require("./troubleshooting");
+Object.defineProperty(exports, "troubleshootingStructure", { enumerable: true, get: function () { return troubleshooting_1.troubleshootingStructure; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,qDAA6D;AAApD,2HAAA,wBAAwB,OAAA;AACjC,+CAAuD;AAA9C,qHAAA,qBAAqB,OAAA;AAC9B,uCAA0D;AAAjD,wHAAA,4BAA4B,OAAA;AACrC,qCAAqD;AAA5C,mHAAA,wBAAwB,OAAA;AACjC,qCAA6C;AAApC,2GAAA,gBAAgB,OAAA;AACzB,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,+CAAuD;AAA9C,qHAAA,qBAAqB,OAAA;AAC9B,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,qDAA6D;AAApD,2HAAA,wBAAwB,OAAA"}

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

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

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

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

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

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrationStructure = void 0;
+exports.migrationStructure = {
+    fileType: 'doc',
+    documentName: 'migration',
+    title: 'Migration Guide',
+    description: 'Complete guide for upgrading between versions, breaking changes, and data migration procedures',
+    tone: 'technical',
+    audience: 'developers',
+    sections: [
+        {
+            heading: 'Migration Guide',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Introduction explaining version support policy and the migration guide purpose.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Current Version & Support Policy',
+            order: 2,
+            contentType: 'prose',
+            guidance: 'Document latest version, release date, and version support lifecycle (how long each version receives support).',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Before You Migrate',
+            order: 3,
+            contentType: 'checklist',
+            guidance: 'Pre-migration checklist including backup, changelog review, staging test, dependency check, stakeholder notification, and rollback planning.',
+            exampleContent: '- [ ] Backup all data (database, file storage)\n- [ ] Review changelog for target version\n- [ ] Test migration in staging environment\n- [ ] Check dependency compatibility\n- [ ] Notify stakeholders\n- [ ] Plan rollback procedure\n- [ ] Schedule maintenance window',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'System Requirements',
+            order: 4,
+            contentType: 'list',
+            guidance: 'List minimum requirements for each version including Node.js, database, OS, memory, and disk space.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Migration Paths',
+            order: 5,
+            contentType: 'prose',
+            guidance: 'Document supported upgrade paths with breaking changes, step-by-step procedures with bash commands, and rollback instructions.',
+            exampleContent: 'For each major version upgrade: list breaking changes, provide detailed migration steps with code blocks, include rollback procedures',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Database Migrations',
+            order: 6,
+            contentType: 'prose',
+            guidance: 'Document database migration procedures including running migrations, creating custom migrations, and handling large datasets.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Data Transformation',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Document data transformation strategies including batch migration scripts and zero-downtime migration patterns.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Deprecation Timeline',
+            order: 8,
+            contentType: 'list',
+            guidance: 'List deprecated features and the timeline for removal with migration paths.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Backward Compatibility',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'Explain compatibility mode and feature flags for managing transition between versions.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Common Issues & Solutions',
+            order: 10,
+            contentType: 'prose',
+            guidance: 'Document common migration issues and solutions including migration failures, data inconsistencies, and performance problems.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Verification & Testing',
+            order: 11,
+            contentType: 'list',
+            guidance: 'List scripts and tools for verifying migration success and testing application functionality.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Getting Help',
+            order: 12,
+            contentType: 'prose',
+            guidance: 'Provide support contact information and guidance for reporting migration issues.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['development-workflow.md', 'architecture.md'],
+};
+//# sourceMappingURL=migration.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"migration.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/migration.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAsB;IACnD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,WAAW;IACzB,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,gGAAgG;IAC7G,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iFAAiF;YAC3F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kCAAkC;YAC3C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gHAAgH;YAC1H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,8IAA8I;YACxJ,cAAc,EAAE,2QAA2Q;YAC3R,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,qGAAqG;YAC/G,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gIAAgI;YAC1I,cAAc,EAAE,uIAAuI;YACvJ,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,+HAA+H;YACzI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iHAAiH;YAC3H,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,6EAA6E;YACvF,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wFAAwF;YAClG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8HAA8H;YACxI,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,+FAA+F;YACzG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,EAAE,iBAAiB,CAAC;CACvD,CAAC"}

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

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

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

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