@tamyla/clodo-framework 3.1.21 → 3.1.22

package/dist/ui-structures/reference/absolutely-required-inputs.json

@@ -1,315 +0,0 @@
-{
-  "metadata": {
-    "version": "1.0.0",
-    "description": "Three-tier categorization of CLODO Framework inputs with service manifest generation",
-    "created": "2025-10-08",
-    "categories": {
-      "absolutelyRequired": 6,
-      "userConfirmable": 15,
-      "absolutelyGeneratable": 67
-    },
-    "totalInputs": 88,
-    "automationPotential": "76.1%"
-  },
-  "categories": {
-    "absolutelyRequired": {
-      "description": "Core inputs that cannot be derived or assumed - must be provided by user",
-      "count": 6,
-      "inputs": ["service-name", "environment", "domain-name", "service-type", "customer-name", "cloudflare-api-token"],
-      "collectionOrder": "Logical sequence: fundamental identifier → environment context → domain scope → architecture type → customer context → technical access"
-    },
-    "userConfirmable": {
-      "description": "Derived inputs that can be auto-generated but should be presented for user review, confirmation, or customization",
-      "count": 15,
-      "rationale": "Users want flexibility to customize branding, URLs, descriptions, and configuration preferences",
-      "inputs": [
-        "display-name", "description", "version", "author",
-        "production-url", "staging-url", "development-url",
-        "service-directory", "database-name", "worker-name",
-        "log-level", "cors-policy", "env-prefix"
-      ]
-    },
-    "absolutelyGeneratable": {
-      "description": "Inputs that can be fully automated through discovery, API calls, or strict conventions",
-      "count": 66,
-      "automationMethods": ["file-discovery", "api-resolution", "convention-based", "context-inference"],
-      "inputs": [
-        "config-file-paths", "cloudflare-account-id", "cloudflare-zone-id",
-        "d1-database-id", "deployment-url", "customer-id", "customer-config-path",
-        "service-template", "deployment-strategy", "monitoring-config",
-        "security-policies", "resource-limits", "debug-mode", "node-env",
-        "repository-info", "branch-info", "commit-hash", "build-timestamps",
-        "dependency-versions", "environment-variables", "file-permissions",
-        "cache-settings", "backup-configurations", "health-check-endpoints"
-      ]
-    }
-  },
-  "absolutelyRequiredInputs": {
-    "service-name": {
-      "description": "The fundamental service identifier",
-      "type": "string",
-      "required": true,
-      "collectionOrder": 1,
-      "validation": {
-        "pattern": "^[a-z][a-z0-9-]*$",
-        "minLength": 3,
-        "maxLength": 50
-      },
-      "examples": ["user-service", "data-processor", "api-gateway"],
-      "userConfirmableDerivatives": 7,
-      "absolutelyGeneratableDerivatives": 12
-    },
-    "domain-name": {
-      "description": "Primary domain for service operations",
-      "type": "string",
-      "required": true,
-      "collectionOrder": 3,
-      "validation": {
-        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-\\.]*\\.[a-zA-Z]{2,}$",
-        "minLength": 4,
-        "maxLength": 253
-      },
-      "examples": ["mycompany.com", "api.example.org", "staging.internal"],
-      "userConfirmableDerivatives": 6,
-      "absolutelyGeneratableDerivatives": 8
-    },
-    "environment": {
-      "description": "Deployment target environment",
-      "type": "string",
-      "required": true,
-      "collectionOrder": 2,
-      "allowedValues": ["development", "staging", "production"],
-      "default": "development",
-      "validation": {
-        "enum": ["development", "staging", "production"]
-      },
-      "userConfirmableDerivatives": 5,
-      "absolutelyGeneratableDerivatives": 15
-    },
-    "cloudflare-api-token": {
-      "description": "Cloudflare API token for infrastructure management",
-      "type": "string",
-      "required": "contextual",
-      "collectionOrder": 6,
-      "context": "when not using environment variables for credentials",
-      "validation": {
-        "pattern": "^[A-Za-z0-9_-]{40,}$",
-        "minLength": 40
-      },
-      "userConfirmableDerivatives": 2,
-      "absolutelyGeneratableDerivatives": 8
-    },
-    "customer-name": {
-      "description": "Customer identifier for multi-tenant operations",
-      "type": "string",
-      "required": "contextual",
-      "collectionOrder": 5,
-      "context": "when deploying customer-specific services",
-      "validation": {
-        "pattern": "^[a-zA-Z][a-zA-Z0-9-_]*$",
-        "minLength": 2,
-        "maxLength": 30
-      },
-      "examples": ["acme-corp", "tech-startup", "enterprise-client"],
-      "userConfirmableDerivatives": 3,
-      "absolutelyGeneratableDerivatives": 6
-    },
-    "service-type": {
-      "description": "Service architecture pattern",
-      "type": "string",
-      "required": "contextual",
-      "collectionOrder": 4,
-      "context": "when not using generic service template",
-      "allowedValues": ["api", "worker", "database", "hybrid", "generic"],
-      "default": "generic",
-      "validation": {
-        "enum": ["api", "worker", "database", "hybrid", "generic"]
-      },
-      "userConfirmableDerivatives": 4,
-      "absolutelyGeneratableDerivatives": 17
-    }
-  },
-  "userConfirmableDerivatives": {
-    "description": "Inputs that should be auto-generated but presented for user confirmation/customization",
-    "count": 15,
-    "interaction": "show generated value, allow edit, require confirmation",
-    "rules": {
-      "display-name": {
-        "logic": "title-case conversion of service-name",
-        "example": "user-service → User Service",
-        "customization": "users may want custom branding"
-      },
-      "description": {
-        "logic": "template: 'A {service-type} service built with CLODO Framework'",
-        "example": "A api service built with CLODO Framework",
-        "customization": "users may want specific descriptions"
-      },
-      "version": {
-        "logic": "read from package.json or default to 1.0.0",
-        "fallback": "1.0.0",
-        "customization": "users may want to set specific versions"
-      },
-      "author": {
-        "logic": "process.env.USER or git config user.name",
-        "fallback": "CLODO Framework",
-        "customization": "users may want to specify team/organization"
-      },
-      "production-url": {
-        "logic": "api.{domain-name}",
-        "example": "api.mycompany.com",
-        "customization": "users may have specific subdomain preferences"
-      },
-      "staging-url": {
-        "logic": "staging-api.{domain-name}",
-        "example": "staging-api.mycompany.com",
-        "customization": "users may want different staging patterns"
-      },
-      "development-url": {
-        "logic": "dev-api.{domain-name}",
-        "example": "dev-api.mycompany.com",
-        "customization": "users may want different dev patterns"
-      },
-      "service-directory": {
-        "logic": "./services/{service-name}",
-        "example": "./services/user-service",
-        "customization": "users may have different directory structures"
-      },
-      "database-name": {
-        "logic": "{service-name}-db",
-        "example": "user-service-db",
-        "customization": "users may want custom database naming"
-      },
-      "worker-name": {
-        "logic": "{service-name}-worker",
-        "example": "user-service-worker",
-        "customization": "users may want custom worker naming"
-      },
-      "log-level": {
-        "logic": "environment-based default (production: warn, staging: info, development: debug)",
-        "customization": "users may want different log verbosity"
-      },
-      "cors-policy": {
-        "logic": "environment-based (production: restrict to domain, development: allow all)",
-        "customization": "users may have specific CORS requirements"
-      },
-      "env-prefix": {
-        "logic": "environment-based (PROD_, STAGING_, DEV_)",
-        "customization": "users may want different prefixes"
-      }
-    }
-  },
-  "absolutelyGeneratableDerivatives": {
-    "description": "Inputs that can be fully automated without user interaction",
-    "count": 66,
-    "interaction": "generate automatically, no user confirmation needed",
-    "rules": {
-      "config-file-paths": {
-        "logic": "file system discovery (find package.json, wrangler.toml, etc.)",
-        "automation": "recursive search with fallbacks"
-      },
-      "cloudflare-account-id": {
-        "logic": "API call using cloudflare-api-token",
-        "automation": "Cloudflare API resolution"
-      },
-      "cloudflare-zone-id": {
-        "logic": "API call using domain-name + cloudflare-api-token",
-        "automation": "Cloudflare API resolution"
-      },
-      "d1-database-id": {
-        "logic": "API call to list D1 databases matching service-name",
-        "automation": "Cloudflare API resolution"
-      },
-      "deployment-url": {
-        "logic": "construct from cloudflare-zone-id",
-        "automation": "URL construction"
-      },
-      "customer-id": {
-        "logic": "lookup from customer database using customer-name",
-        "automation": "database lookup"
-      },
-      "customer-config-path": {
-        "logic": "./customers/{customer-name}/config.json",
-        "automation": "path construction"
-      },
-      "service-template": {
-        "logic": "select template based on service-type",
-        "automation": "template selection"
-      },
-      "deployment-strategy": {
-        "logic": "service-type + environment based rules",
-        "automation": "rule-based selection"
-      },
-      "monitoring-config": {
-        "logic": "service-type templates with environment overrides",
-        "automation": "template application"
-      },
-      "security-policies": {
-        "logic": "environment + service-type security profiles",
-        "automation": "policy application"
-      },
-      "resource-limits": {
-        "logic": "service-type resource templates",
-        "automation": "resource allocation"
-      },
-      "debug-mode": {
-        "logic": "environment === 'development'",
-        "automation": "boolean logic"
-      },
-      "node-env": {
-        "logic": "direct mapping from environment",
-        "automation": "value mapping"
-      },
-      "repository-info": {
-        "logic": "git config remote.origin.url",
-        "automation": "git command execution"
-      },
-      "branch-info": {
-        "logic": "git rev-parse --abbrev-ref HEAD",
-        "automation": "git command execution"
-      },
-      "commit-hash": {
-        "logic": "git rev-parse HEAD",
-        "automation": "git command execution"
-      },
-      "build-timestamps": {
-        "logic": "new Date().toISOString()",
-        "automation": "timestamp generation"
-      },
-      "dependency-versions": {
-        "logic": "read from package.json dependencies",
-        "automation": "file parsing"
-      },
-      "environment-variables": {
-        "logic": "construct from all inputs using naming conventions",
-        "automation": "variable generation"
-      },
-      "file-permissions": {
-        "logic": "service-type based permission templates",
-        "automation": "permission assignment"
-      },
-      "cache-settings": {
-        "logic": "environment + service-type cache profiles",
-        "automation": "cache configuration"
-      },
-      "backup-configurations": {
-        "logic": "service-type + environment backup policies",
-        "automation": "backup setup"
-      },
-      "health-check-endpoints": {
-        "logic": "service-type standard health check patterns",
-        "automation": "endpoint generation"
-      }
-    }
-  },
-  "acquisitionStrategy": {
-    "primary": "interactive prompts for core inputs only",
-    "secondary": "environment variable fallbacks",
-    "tertiary": "file-based configuration discovery",
-    "fallback": "sensible defaults and auto-generation"
-  },
-  "validationStrategy": {
-    "preValidation": "validate core inputs before derivation",
-    "crossValidation": "ensure derived values are consistent",
-    "postValidation": "test derived configurations against schemas"
-  }
-}

package/dist/ui-structures/reference/service-manifest-template.json

@@ -1,342 +0,0 @@
-{
-  "template": {
-    "name": "service-manifest",
-    "description": "Comprehensive service configuration and history file generated during CLODO Framework service creation",
-    "version": "1.0.0",
-    "purpose": "Complete audit trail, service consumption, and rectification support"
-  },
-  "metadata": {
-    "serviceId": "auto-generated-uuid",
-    "createdAt": "2025-10-08T10:30:00Z",
-    "createdBy": "CLODO Framework v2.0.0",
-    "creationMethod": "three-phase-collection",
-    "frameworkVersion": "2.0.0",
-    "nodeVersion": "18.17.0",
-    "platform": "windows",
-    "workingDirectory": "C:\\Users\\Admin\\Documents\\coding\\tamyla\\clodo-framework"
-  },
-  "coreInputs": {
-    "description": "The 6 absolutely required inputs provided by the user",
-    "providedAt": "2025-10-08T10:25:00Z",
-    "validationStatus": "passed",
-    "inputs": {
-      "service-name": "user-service",
-      "environment": "development",
-      "domain-name": "mycompany.com",
-      "service-type": "api",
-      "customer-name": null,
-      "cloudflare-api-token": null
-    }
-  },
-  "userConfirmableInputs": {
-    "description": "The 15 user-confirmable inputs with user's final decisions",
-    "confirmedAt": "2025-10-08T10:27:00Z",
-    "customizations": 3,
-    "acceptances": 12,
-    "inputs": {
-      "display-name": "User Service",
-      "description": "A api service built with CLODO Framework for user management",
-      "version": "1.0.0",
-      "author": "CLODO Framework",
-      "production-url": "api.mycompany.com",
-      "staging-url": "staging-api.mycompany.com",
-      "development-url": "dev-api.mycompany.com",
-      "service-directory": "./services/user-service",
-      "database-name": "user-service-db",
-      "worker-name": "user-service-worker",
-      "log-level": "debug",
-      "cors-policy": "*",
-      "env-prefix": "DEV_"
-    },
-    "customizationDetails": [
-      {
-        "field": "description",
-        "action": "customized",
-        "original": "A api service built with CLODO Framework",
-        "final": "A api service built with CLODO Framework for user management",
-        "reason": "Added specific functionality description"
-      },
-      {
-        "field": "log-level",
-        "action": "customized",
-        "original": "debug",
-        "final": "debug",
-        "reason": "Confirmed development logging level"
-      }
-    ]
-  },
-  "autoGeneratedInputs": {
-    "description": "The 66 absolutely generatable inputs created automatically",
-    "generatedAt": "2025-10-08T10:28:00Z",
-    "generationStatus": "completed",
-    "successCount": 66,
-    "errorCount": 0,
-    "categories": {
-      "fileDiscovery": {
-        "count": 8,
-        "status": "completed",
-        "inputs": {
-          "packageJsonPath": "./package.json",
-          "wranglerTomlPath": "./wrangler.toml",
-          "tsconfigJsonPath": "./tsconfig.json",
-          "eslintConfigPath": "./eslint.config.js",
-          "jestConfigPath": "./jest.config.js",
-          "babelConfigPath": "./babel.config.js",
-          "dockerfilePath": "./Dockerfile",
-          "readmePath": "./README.md"
-        }
-      },
-      "apiResolution": {
-        "count": 12,
-        "status": "completed",
-        "inputs": {
-          "cloudflareAccountId": "1234567890abcdef",
-          "cloudflareZoneId": "fedcba0987654321",
-          "d1DatabaseId": "user-service-db-uuid",
-          "workerDeploymentUrl": "https://user-service.mycompany.com",
-          "gitRepositoryUrl": "https://github.com/tamylaa/clodo-framework",
-          "gitBranch": "master",
-          "gitCommitHash": "a1b2c3d4e5f6",
-          "npmRegistry": "https://registry.npmjs.org",
-          "cloudflareApiVersion": "v4",
-          "domainRegistrar": "namecheap",
-          "sslCertificateExpiry": "2026-10-08",
-          "dnsRecords": ["A", "CNAME", "TXT"]
-        }
-      },
-      "conventionBased": {
-        "count": 28,
-        "status": "completed",
-        "inputs": {
-          "serviceTemplate": "api-template-v2",
-          "deploymentStrategy": "cloudflare-worker-d1",
-          "monitoringConfig": "basic-api-monitoring",
-          "securityPolicies": "development-security",
-          "resourceLimits": "small-service-limits",
-          "environmentVariables": {
-            "DEV_DATABASE_URL": "postgresql://localhost:5432/user_service_dev",
-            "DEV_REDIS_URL": "redis://localhost:6379",
-            "DEV_JWT_SECRET": "dev-secret-key",
-            "DEV_API_PORT": "3000"
-          },
-          "filePermissions": "755",
-          "cacheSettings": "development-cache",
-          "backupConfigurations": "daily-backup",
-          "healthCheckEndpoints": ["/health", "/ready", "/metrics"],
-          "middlewareStack": ["cors", "helmet", "compression", "logging"],
-          "errorHandling": "development-error-handling",
-          "rateLimiting": "development-rate-limits",
-          "apiVersioning": "header-based",
-          "documentationFormat": "openapi-3.0",
-          "testingFramework": "jest",
-          "codeCoverage": "80%",
-          "lintingRules": "clodo-standard",
-          "buildTool": "esbuild",
-          "packageManager": "npm",
-          "ciCdPipeline": "github-actions",
-          "deploymentTarget": "cloudflare-pages",
-          "rollbackStrategy": "immediate-rollback",
-          "scalingStrategy": "manual-scaling",
-          "costOptimization": "development-optimization"
-        }
-      },
-      "contextInference": {
-        "count": 18,
-        "status": "completed",
-        "inputs": {
-          "debugMode": true,
-          "nodeEnv": "development",
-          "logFormat": "json",
-          "timestampFormat": "ISO-8601",
-          "timezone": "UTC",
-          "locale": "en-US",
-          "currency": "USD",
-          "dateFormat": "YYYY-MM-DD",
-          "timeFormat": "HH:mm:ss",
-          "numberFormat": "en-US",
-          "errorReporting": "console-only",
-          "performanceMonitoring": "basic",
-          "memoryLimit": "512MB",
-          "cpuLimit": "0.5",
-          "networkTimeout": "30s",
-          "retryAttempts": 3,
-          "circuitBreaker": "disabled",
-          "featureFlags": {}
-        }
-      }
-    }
-  },
-  "serviceConfiguration": {
-    "description": "Final computed configuration used to create the service",
-    "computedAt": "2025-10-08T10:28:00Z",
-    "config": {
-      "service": {
-        "name": "user-service",
-        "displayName": "User Service",
-        "description": "A api service built with CLODO Framework for user management",
-        "version": "1.0.0",
-        "type": "api",
-        "environment": "development",
-        "author": "CLODO Framework"
-      },
-      "networking": {
-        "domain": "mycompany.com",
-        "urls": {
-          "production": "api.mycompany.com",
-          "staging": "staging-api.mycompany.com",
-          "development": "dev-api.mycompany.com"
-        },
-        "corsPolicy": "*",
-        "ssl": true,
-        "http2": true
-      },
-      "infrastructure": {
-        "provider": "cloudflare",
-        "worker": {
-          "name": "user-service-worker",
-          "runtime": "cloudflare-worker",
-          "memory": "128MB",
-          "cpu": "100ms"
-        },
-        "database": {
-          "type": "D1",
-          "name": "user-service-db",
-          "location": "WEUR"
-        }
-      },
-      "deployment": {
-        "strategy": "cloudflare-worker-d1",
-        "directory": "./services/user-service",
-        "buildCommand": "npm run build",
-        "startCommand": "npm run start",
-        "healthCheck": "/health"
-      }
-    }
-  },
-  "fileManifest": {
-    "description": "All files created/modified during service generation",
-    "createdAt": "2025-10-08T10:28:00Z",
-    "files": {
-      "created": [
-        "./services/user-service/package.json",
-        "./services/user-service/src/index.js",
-        "./services/user-service/src/routes.js",
-        "./services/user-service/src/middleware.js",
-        "./services/user-service/test/unit.spec.js",
-        "./services/user-service/test/integration.spec.js",
-        "./services/user-service/README.md",
-        "./services/user-service/.env.example",
-        "./services/user-service/wrangler.toml",
-        "./services/user-service/jest.config.js",
-        "./services/user-service/eslint.config.js"
-      ],
-      "modified": [
-        "./package.json",
-        "./wrangler.toml"
-      ],
-      "templates": [
-        "api-template-v2",
-        "cloudflare-worker-template",
-        "d1-database-template",
-        "jest-config-template",
-        "eslint-config-template"
-      ]
-    }
-  },
-  "relationships": {
-    "description": "Relationships to other services and resources",
-    "dependsOn": [],
-    "usedBy": [],
-    "shares": {
-      "database": "user-service-db",
-      "domain": "mycompany.com"
-    },
-    "relatedServices": []
-  },
-  "auditTrail": {
-    "description": "Complete history of service creation and modifications",
-    "entries": [
-      {
-        "timestamp": "2025-10-08T10:25:00Z",
-        "action": "core-inputs-collected",
-        "actor": "user",
-        "details": "Collected 6 core inputs via interactive prompts"
-      },
-      {
-        "timestamp": "2025-10-08T10:27:00Z",
-        "action": "inputs-confirmed",
-        "actor": "user",
-        "details": "User confirmed 12 defaults and customized 3 inputs"
-      },
-      {
-        "timestamp": "2025-10-08T10:28:00Z",
-        "action": "service-generated",
-        "actor": "CLODO Framework",
-        "details": "Successfully generated service with 66 auto-generated configurations"
-      }
-    ]
-  },
-  "consumption": {
-    "description": "Information for other tools/services to consume this service",
-    "api": {
-      "baseUrl": "https://dev-api.mycompany.com",
-      "documentation": "./services/user-service/README.md",
-      "openapiSpec": "./services/user-service/openapi.yaml",
-      "healthCheck": "https://dev-api.mycompany.com/health"
-    },
-    "dependencies": {
-      "runtime": ["@cloudflare/workers-types", "hono", "zod"],
-      "development": ["jest", "@types/jest", "eslint"]
-    },
-    "environmentVariables": [
-      "DEV_DATABASE_URL",
-      "DEV_REDIS_URL",
-      "DEV_JWT_SECRET",
-      "DEV_API_PORT"
-    ],
-    "ports": [3000],
-    "commands": {
-      "install": "npm install",
-      "build": "npm run build",
-      "test": "npm test",
-      "start": "npm start",
-      "deploy": "npm run deploy"
-    }
-  },
-  "rectification": {
-    "description": "Information to help fix issues or recreate the service",
-    "troubleshooting": {
-      "commonIssues": [
-        "Database connection fails - check DEV_DATABASE_URL",
-        "Worker deployment fails - verify Cloudflare credentials",
-        "CORS errors - check cors-policy configuration"
-      ],
-      "logs": "./logs/user-service/",
-      "debugMode": true,
-      "rollbackCommand": "npm run rollback"
-    },
-    "recreation": {
-      "command": "clodo recreate user-service --from-manifest",
-      "requiredInputs": "All inputs stored in this manifest",
-      "validationSteps": [
-        "Verify Cloudflare credentials",
-        "Check domain availability",
-        "Validate environment variables"
-      ]
-    }
-  },
-  "validation": {
-    "description": "Validation results for the generated service",
-    "performedAt": "2025-10-08T10:29:00Z",
-    "overallStatus": "passed",
-    "checks": {
-      "configuration": "passed",
-      "dependencies": "passed",
-      "build": "passed",
-      "tests": "passed",
-      "deployment": "ready"
-    },
-    "warnings": [],
-    "errors": []
-  }
-}