@tamyla/clodo-framework 3.1.21 → 3.1.22

package/dist/service-management/generators/documentation/ApiDocsGenerator.js

@@ -1,331 +0,0 @@
-import { BaseGenerator } from '../BaseGenerator.js';
-import { join } from 'path';
-import { writeFileSync, mkdirSync } from 'fs';
-
-/**
- * API Documentation Generator
- * Generates comprehensive API documentation with service-type specific endpoints
- */
-export class ApiDocsGenerator extends BaseGenerator {
-  /**
-   * Generate API documentation
-   * @param {Object} context - Generation context
-   * @returns {Promise<string>} Path to generated API docs file
-   */
-  async generate(context) {
-    const {
-      coreInputs,
-      confirmedValues,
-      servicePath
-    } = this.extractContext(context);
-    if (!this.shouldGenerate(context)) {
-      return null;
-    }
-
-    // Ensure docs directory exists
-    const docsDir = join(servicePath, 'docs');
-    mkdirSync(docsDir, {
-      recursive: true
-    });
-    const apiDocsContent = this._generateApiDocsContent(coreInputs, confirmedValues);
-    const filePath = join(servicePath, 'docs', 'API.md');
-    writeFileSync(filePath, apiDocsContent, 'utf8');
-    return filePath;
-  }
-
-  /**
-   * Generate API documentation content
-   * @private
-   */
-  _generateApiDocsContent(coreInputs, confirmedValues) {
-    return `# ${confirmedValues.displayName} API Documentation
-
-## Overview
-
-${confirmedValues.description}
-
-**Base URL**: ${confirmedValues.productionUrl}
-**API Base Path**: ${confirmedValues.apiBasePath}
-**Version**: ${confirmedValues.version}
-
-## Authentication
-
-${confirmedValues.features.authentication ? 'This service requires authentication. Include your API key in the request headers:\n\n' + '```\nAuthorization: Bearer YOUR_API_KEY\n```' : 'This service does not require authentication.'}
-
-## Endpoints
-
-### Health Check
-
-**GET** ${confirmedValues.healthCheckPath}
-
-Check the health status of the service.
-
-**Response:**
-\`\`\`json
-{
-  "status": "healthy",
-  "timestamp": "2024-01-01T00:00:00.000Z",
-  "service": "${coreInputs.serviceName}",
-  "version": "${confirmedValues.version}",
-  "environment": "${coreInputs.environment}",
-  "checks": [
-    {
-      "name": "database",
-      "status": "healthy"
-    },
-    {
-      "name": "configuration",
-      "status": "healthy"
-    }
-  ]
-}
-\`\`\`
-
-### API Endpoints
-
-**Base Path**: ${confirmedValues.apiBasePath}
-
-${this._generateApiEndpointsForType(coreInputs.serviceType, coreInputs, confirmedValues)}
-
-## Error Responses
-
-All error responses follow this format:
-
-\`\`\`json
-{
-  "success": false,
-  "error": "Error message",
-  "timestamp": "2024-01-01T00:00:00.000Z"
-}
-\`\`\`
-
-### Common HTTP Status Codes
-
-- **200**: Success
-- **400**: Bad Request
-- **401**: Unauthorized
-- **403**: Forbidden
-- **404**: Not Found
-- **500**: Internal Server Error
-
-## Rate Limiting
-
-${confirmedValues.features.rateLimiting ? 'This service implements rate limiting. Please respect the following limits:\n\n' + '- 1000 requests per hour for authenticated users\n' + '- 100 requests per hour for anonymous users' : 'This service does not implement rate limiting.'}
-
-## Data Formats
-
-All requests and responses use JSON format.
-
-### Request Headers
-
-\`\`\`
-Content-Type: application/json
-Authorization: Bearer YOUR_API_KEY (if required)
-\`\`\`
-
-### Response Headers
-
-\`\`\`
-Content-Type: application/json
-X-Service: ${coreInputs.serviceName}
-X-Version: ${confirmedValues.version}
-X-Response-Time: 150
-\`\`\`
-`;
-  }
-
-  /**
-   * Generate service-type specific API endpoints documentation
-   * @private
-   */
-  _generateApiEndpointsForType(serviceType, coreInputs, confirmedValues) {
-    const endpoints = {
-      'data-service': `
-#### List Items
-**GET** /items
-
-Retrieve a paginated list of items.
-
-**Query Parameters:**
-- \`limit\` (optional): Number of items per page (default: 20, max: 100)
-- \`offset\` (optional): Number of items to skip (default: 0)
-- \`search\` (optional): Search query string
-- \`filters\` (optional): JSON object with filter criteria
-
-**Response:**
-\`\`\`json
-{
-  "success": true,
-  "data": [...],
-  "pagination": {
-    "limit": 20,
-    "offset": 0,
-    "total": 150,
-    "hasMore": true
-  }
-}
-\`\`\`
-
-#### Create Item
-**POST** /items
-
-Create a new item.
-
-**Request Body:**
-\`\`\`json
-{
-  "name": "Item Name",
-  "description": "Item description",
-  "data": {}
-}
-\`\`\`
-
-#### Get Item
-**GET** /items/{id}
-
-Retrieve a specific item by ID.
-
-#### Update Item
-**PUT** /items/{id}
-
-Update an existing item.
-
-#### Delete Item
-**DELETE** /items/{id}
-
-Delete an item.
-`,
-      'auth-service': `
-#### Register User
-**POST** /auth/register
-
-Register a new user account.
-
-**Request Body:**
-\`\`\`json
-{
-  "email": "user@example.com",
-  "username": "username",
-  "password": "password"
-}
-\`\`\`
-
-#### Login
-**POST** /auth/login
-
-Authenticate a user and receive access tokens.
-
-**Request Body:**
-\`\`\`json
-{
-  "email": "user@example.com",
-  "password": "password"
-}
-\`\`\`
-
-#### Get Profile
-**GET** /auth/profile
-
-Get the current user's profile information.
-
-#### Update Profile
-**PUT** /auth/profile
-
-Update the current user's profile.
-
-#### Logout
-**POST** /auth/logout
-
-Invalidate the current user's session.
-`,
-      'content-service': `
-#### List Content
-**GET** /content
-
-Retrieve a list of content items.
-
-#### Create Content
-**POST** /content
-
-Create new content.
-
-**Request Body:**
-\`\`\`json
-{
-  "title": "Content Title",
-  "content": "Content body",
-  "contentType": "article",
-  "tags": ["tag1", "tag2"]
-}
-\`\`\`
-
-#### Get Content
-**GET** /content/{id}
-
-Retrieve specific content by ID.
-
-#### Update Content
-**PUT** /content/{id}
-
-Update existing content.
-
-#### Delete Content
-**DELETE** /content/{id}
-
-Delete content.
-
-#### Upload Media
-**POST** /media/upload
-
-Upload media files.
-`,
-      'api-gateway': `
-#### Route Request
-**ANY** /*
-
-All requests are routed through the API gateway.
-
-**Headers:**
-- \`X-Target-Service\`: Target service name
-- \`X-Target-Path\`: Path on target service
-
-#### Get Routes
-**GET** /routes
-
-List all configured routes.
-
-#### Health Status
-**GET** /status
-
-Get gateway health and route status.
-`,
-      'generic': `
-#### Service Info
-**GET** /info
-
-Get service information and capabilities.
-
-**Response:**
-\`\`\`json
-{
-  "success": true,
-  "data": {
-    "name": "${coreInputs.serviceName}",
-    "type": "${coreInputs.serviceType}",
-    "version": "${confirmedValues.version}",
-    "features": ${JSON.stringify(Object.keys(confirmedValues.features).filter(key => confirmedValues.features[key]), null, 4)}
-  }
-}
-\`\`\`
-`
-    };
-    return endpoints[serviceType] || endpoints.generic;
-  }
-
-  /**
-   * Determine if generator should run
-   */
-  shouldGenerate(context) {
-    return true; // Always generate API documentation
-  }
-}

package/dist/service-management/generators/documentation/ConfigurationDocsGenerator.js

@@ -1,294 +0,0 @@
-import { BaseGenerator } from '../BaseGenerator.js';
-import { join } from 'path';
-import { writeFileSync, mkdirSync } from 'fs';
-
-/**
- * Configuration Documentation Generator
- * Generates comprehensive configuration guide covering all config layers
- */
-export class ConfigurationDocsGenerator extends BaseGenerator {
-  /**
-   * Generate configuration documentation
-   * @param {Object} context - Generation context
-   * @returns {Promise<string>} Path to generated configuration docs file
-   */
-  async generate(context) {
-    const {
-      coreInputs,
-      confirmedValues,
-      servicePath
-    } = this.extractContext(context);
-    if (!this.shouldGenerate(context)) {
-      return null;
-    }
-
-    // Ensure docs directory exists
-    const docsDir = join(servicePath, 'docs');
-    mkdirSync(docsDir, {
-      recursive: true
-    });
-    const configDocsContent = this._generateConfigDocsContent(coreInputs, confirmedValues);
-    const filePath = join(servicePath, 'docs', 'CONFIGURATION.md');
-    writeFileSync(filePath, configDocsContent, 'utf8');
-    return filePath;
-  }
-
-  /**
-   * Generate configuration documentation content
-   * @private
-   */
-  _generateConfigDocsContent(coreInputs, confirmedValues) {
-    return `# ${confirmedValues.displayName} - Configuration Guide
-
-## Overview
-
-${confirmedValues.displayName} is configured using multiple layers of configuration files and environment variables.
-
-## Configuration Hierarchy
-
-1. **Environment Variables** (.env) - Runtime secrets and environment-specific values
-2. **Service Configuration** (src/config/domains.js) - Service-specific settings
-3. **Worker Configuration** (wrangler.toml) - Cloudflare Workers deployment settings
-4. **Package Configuration** (package.json) - Node.js package settings
-
-## Environment Variables
-
-### Required Variables
-
-\`\`\`bash
-# Cloudflare Configuration
-CLOUDFLARE_ACCOUNT_ID=${coreInputs.cloudflareAccountId}
-CLOUDFLARE_ZONE_ID=${coreInputs.cloudflareZoneId}
-CLOUDFLARE_API_TOKEN=your_api_token
-
-# Service Configuration
-SERVICE_NAME=${coreInputs.serviceName}
-SERVICE_TYPE=${coreInputs.serviceType}
-DOMAIN_NAME=${coreInputs.domainName}
-ENVIRONMENT=${coreInputs.environment}
-\`\`\`
-
-### Optional Variables
-
-\`\`\`bash
-# URLs (override defaults)
-PRODUCTION_URL=${confirmedValues.productionUrl}
-STAGING_URL=${confirmedValues.stagingUrl}
-DEVELOPMENT_URL=${confirmedValues.developmentUrl}
-DOCUMENTATION_URL=${confirmedValues.documentationUrl}
-
-# API Configuration
-API_BASE_PATH=${confirmedValues.apiBasePath}
-HEALTH_CHECK_PATH=${confirmedValues.healthCheckPath}
-
-# Database
-DATABASE_NAME=${confirmedValues.databaseName}
-
-# Logging and Monitoring
-LOG_LEVEL=info
-METRICS_ENABLED=true
-ERROR_REPORTING_ENABLED=true
-
-# Custom Variables
-CUSTOM_VAR=value
-\`\`\`
-
-## Service Configuration (domains.js)
-
-Located at \`src/config/domains.js\`, this file contains service-specific configuration:
-
-\`\`\`javascript
-export const domains = {
-  '${coreInputs.serviceName}': {
-    name: '${coreInputs.serviceName}',
-    displayName: '${confirmedValues.displayName}',
-    description: '${confirmedValues.description}',
-    accountId: process.env.CLOUDFLARE_ACCOUNT_ID,
-    zoneId: process.env.CLOUDFLARE_ZONE_ID,
-    domains: {
-      production: '${confirmedValues.productionUrl}',
-      staging: '${confirmedValues.stagingUrl}',
-      development: '${confirmedValues.developmentUrl}'
-    },
-    services: [
-      '${coreInputs.serviceName}'
-    ],
-    databases: [
-      {
-        name: '${confirmedValues.databaseName}',
-        type: 'd1',
-        binding: 'DB'
-      }
-    ],
-    features: ${JSON.stringify(confirmedValues.features, null, 4)},
-    metadata: {
-      version: '${confirmedValues.version}',
-      author: '${confirmedValues.author}',
-      generatedAt: '${new Date().toISOString()}',
-      frameworkVersion: '3.0.0',
-      serviceType: '${coreInputs.serviceType}',
-      environment: '${coreInputs.environment}'
-    }
-  }
-};
-\`\`\`
-
-## Worker Configuration (wrangler.toml)
-
-Cloudflare Workers configuration with environment-specific settings:
-
-\`\`\`toml
-name = "${confirmedValues.workerName}"
-main = "src/worker/index.js"
-compatibility_date = "${new Date().toISOString().split('T')[0]}"
-compatibility_flags = ["nodejs_compat"]
-
-# Environment configurations
-[env.development]
-name = "${confirmedValues.workerName}-dev"
-
-[env.staging]
-name = "${confirmedValues.workerName}-staging"
-
-[env.production]
-name = "${confirmedValues.workerName}"
-
-# Database bindings
-[[d1_databases]]
-binding = "DB"
-database_name = "${confirmedValues.databaseName}"
-
-# Environment variables
-[vars]
-SERVICE_NAME = "${coreInputs.serviceName}"
-SERVICE_TYPE = "${coreInputs.serviceType}"
-DOMAIN_NAME = "${coreInputs.domainName}"
-ENVIRONMENT = "${coreInputs.environment}"
-API_BASE_PATH = "${confirmedValues.apiBasePath}"
-HEALTH_CHECK_PATH = "${confirmedValues.healthCheckPath}"
-
-# Domain-specific variables
-PRODUCTION_URL = "${confirmedValues.productionUrl}"
-STAGING_URL = "${confirmedValues.stagingUrl}"
-DEVELOPMENT_URL = "${confirmedValues.developmentUrl}"
-
-# Feature flags
-${Object.entries(confirmedValues.features).filter(([, enabled]) => enabled).map(([feature, enabled]) => `FEATURE_${feature.toUpperCase()} = ${enabled}`).join('\n')}
-
-# Custom environment variables (configure as needed)
-# CUSTOM_VAR = "value"
-\`\`\`
-
-## Feature Flags
-
-The service supports the following feature flags:
-
-${Object.entries(confirmedValues.features).map(([feature, enabled]) => `- **${feature}**: ${enabled ? '✅ Enabled' : '❌ Disabled'}`).join('\n')}
-
-### Feature Descriptions
-
-- **logging**: Request/response logging
-- **monitoring**: Performance monitoring and metrics
-- **errorReporting**: Error tracking and reporting
-- **metrics**: Application metrics collection
-- **healthChecks**: Health check endpoints
-${confirmedValues.features.database ? '- **database**: Database operations and connectivity\n' : ''}
-${confirmedValues.features.authentication ? '- **authentication**: User authentication\n' : ''}
-${confirmedValues.features.authorization ? '- **authorization**: Access control and permissions\n' : ''}
-${confirmedValues.features.search ? '- **search**: Search functionality\n' : ''}
-${confirmedValues.features.filtering ? '- **filtering**: Data filtering capabilities\n' : ''}
-${confirmedValues.features.pagination ? '- **pagination**: Paginated responses\n' : ''}
-${confirmedValues.features.caching ? '- **caching**: Response caching\n' : ''}
-${confirmedValues.features.backup ? '- **backup**: Data backup functionality\n' : ''}
-
-## Environment-Specific Configuration
-
-### Development
-- Full debugging enabled
-- Local database connections
-- Hot reload enabled
-- Less strict validation
-
-### Staging
-- Production-like settings
-- Separate database
-- Full feature set enabled
-- Error reporting enabled
-
-### Production
-- Optimized settings
-- Production database
-- Security hardening
-- Full monitoring enabled
-
-## Configuration Validation
-
-The service validates configuration on startup:
-
-1. **Environment Variables**: Required variables present and valid
-2. **Service Configuration**: domains.js structure and values
-3. **Worker Configuration**: wrangler.toml syntax and bindings
-4. **Feature Compatibility**: Feature flags compatible with service type
-
-## Runtime Configuration
-
-Some configuration can be changed at runtime:
-
-- Environment variables (require restart)
-- Feature flags (may require restart)
-- Database connections (handled automatically)
-- Logging levels (immediate effect)
-
-## Security Considerations
-
-- Never commit secrets to version control
-- Use Cloudflare Workers secrets for sensitive data
-- Rotate API tokens regularly
-- Limit feature access based on environment
-- Validate all input data
-- Use HTTPS for all production endpoints
-
-## Troubleshooting Configuration Issues
-
-### Common Problems
-
-1. **Missing environment variables**
-   - Check .env file exists and is loaded
-   - Verify variable names match expectations
-
-2. **Invalid Cloudflare credentials**
-   - Check account ID format (32 hex characters)
-   - Verify API token permissions
-   - Confirm zone ID is correct
-
-3. **Database connection issues**
-   - Verify D1 database exists
-   - Check database ID in wrangler.toml
-   - Confirm database binding name
-
-4. **Feature flag conflicts**
-   - Some features require others to be enabled
-   - Check service type compatibility
-
-### Debugging Configuration
-
-\`\`\`bash
-# Check environment variables
-node -e "console.log(process.env)"
-
-# Validate service configuration
-node -e "import('./src/config/domains.js').then(config => console.log(JSON.stringify(config, null, 2)))"
-
-# Test wrangler configuration
-wrangler dev --dry-run
-\`\`\`
-`;
-  }
-
-  /**
-   * Determine if generator should run
-   */
-  shouldGenerate(context) {
-    return true; // Always generate configuration documentation
-  }
-}