@egintegrations/telemetry 0.2.0 → 0.2.1

package/dist/cli.js

@@ -111,8 +111,21 @@ async function appendEnvFile(envPath, content) {
   await fs2.promises.writeFile(envPath, updated, "utf-8");
   console.log(`\u2713 Updated: ${envPath}`);
 }
-function validateSku(sku) {
-  return /^\d+\.\d+\.\d+/.test(sku);
+function loadSkuStandards() {
+  const standardsDir = path2.join(__dirname, "standards");
+  const systemTypesPath = path2.join(standardsDir, "system_types.json");
+  const platformsPath = path2.join(standardsDir, "platforms.json");
+  const systemTypes = JSON.parse(
+    fs2.readFileSync(systemTypesPath, "utf-8")
+  );
+  const platforms = JSON.parse(
+    fs2.readFileSync(platformsPath, "utf-8")
+  );
+  return { systemTypes, platforms };
+}
+function buildSku(version, systemType, platform, date) {
+  const skuDate = date || (/* @__PURE__ */ new Date()).toISOString().slice(0, 10).replace(/-/g, "");
+  return `${version}.${systemType}.${platform}.${skuDate}`;
 }
 
 // src/cli/prompts.ts
@@ -126,12 +139,34 @@ async function gatherOptions(cliArgs, detected) {
       validate: (v) => v.length > 0 || "Engine name is required"
     });
   }
+  let skuComponents = {};
   if (!cliArgs.sku) {
+    const standards = loadSkuStandards();
     questions.push({
       type: "text",
-      name: "sku",
-      message: "SKU version (e.g., 1.0.0):",
-      validate: (v) => validateSku(v) || "Invalid SKU format (expected: X.Y.Z...)"
+      name: "skuVersion",
+      message: "Version (MAJOR.MINOR.PATCH, e.g., 1.0.0):",
+      validate: (v) => /^\d+\.\d+\.\d+$/.test(v) || "Invalid version format (expected: X.Y.Z)"
+    });
+    questions.push({
+      type: "select",
+      name: "skuType",
+      message: "System Type:",
+      choices: standards.systemTypes.map((t) => ({
+        title: `${t.code} - ${t.label}`,
+        description: t.description,
+        value: t.code
+      }))
+    });
+    questions.push({
+      type: "select",
+      name: "skuPlatform",
+      message: "Platform:",
+      choices: standards.platforms.map((p) => ({
+        title: `${p.code} - ${p.label}`,
+        description: p.description,
+        value: p.code
+      }))
     });
   }
   if (!cliArgs.url) {
@@ -181,9 +216,15 @@ async function gatherOptions(cliArgs, detected) {
       process.exit(0);
     }
   });
+  let finalSku = cliArgs.sku;
+  if (!finalSku && answers.skuVersion && answers.skuType && answers.skuPlatform) {
+    finalSku = buildSku(answers.skuVersion, answers.skuType, answers.skuPlatform);
+    console.log(`
+\u{1F4E6} Generated SKU: ${finalSku}`);
+  }
   return {
     engine: cliArgs.engine || answers.engine,
-    sku: cliArgs.sku || answers.sku,
+    sku: finalSku,
     url: cliArgs.url || answers.url,
     token: cliArgs.token || answers.token || void 0,
     modules: cliArgs.modules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egintegrations/telemetry",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Telemetry SDK for EGIntegrations client engines",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -45,6 +45,7 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "src/cli/standards"
   ]
 }

package/src/cli/standards/platforms.json

@@ -0,0 +1,202 @@
+[
+  {
+    "code": "EKS",
+    "label": "AWS EKS (Kubernetes)",
+    "description": "Amazon Elastic Kubernetes Service",
+    "provider": "AWS",
+    "type": "managed-kubernetes",
+    "notes": "Preferred for production containerized workloads on AWS"
+  },
+  {
+    "code": "GKE",
+    "label": "Google Kubernetes Engine",
+    "description": "Google's managed Kubernetes service",
+    "provider": "GCP",
+    "type": "managed-kubernetes",
+    "notes": "Preferred for production containerized workloads on GCP"
+  },
+  {
+    "code": "AKS",
+    "label": "Azure Kubernetes Service",
+    "description": "Microsoft Azure managed Kubernetes",
+    "provider": "Azure",
+    "type": "managed-kubernetes",
+    "notes": "Preferred for production containerized workloads on Azure"
+  },
+  {
+    "code": "K8S",
+    "label": "Kubernetes (generic)",
+    "description": "Self-managed or other Kubernetes distributions",
+    "provider": "Various",
+    "type": "kubernetes",
+    "notes": "Use for DigitalOcean, Linode, self-hosted K8s"
+  },
+  {
+    "code": "DK",
+    "label": "Docker (generic container build/runtime)",
+    "description": "Docker containers, docker-compose",
+    "provider": "Various",
+    "type": "container",
+    "notes": "For Docker-based deployments without orchestration"
+  },
+  {
+    "code": "DKO",
+    "label": "Docker Offline (air-gapped/off-net)",
+    "description": "Docker in air-gapped or offline environments",
+    "provider": "Various",
+    "type": "container",
+    "notes": "For secure/isolated environments"
+  },
+  {
+    "code": "LM",
+    "label": "AWS Lambda",
+    "description": "AWS serverless functions",
+    "provider": "AWS",
+    "type": "serverless",
+    "notes": "For event-driven, serverless workloads"
+  },
+  {
+    "code": "CF",
+    "label": "Cloudflare (Workers/Pages)",
+    "description": "Cloudflare Workers and Pages",
+    "provider": "Cloudflare",
+    "type": "edge-compute",
+    "notes": "Edge compute and static hosting"
+  },
+  {
+    "code": "VE",
+    "label": "Vercel",
+    "description": "Vercel serverless platform",
+    "provider": "Vercel",
+    "type": "serverless",
+    "notes": "Optimized for Next.js and frontend frameworks"
+  },
+  {
+    "code": "FH",
+    "label": "Firebase Hosting",
+    "description": "Google Firebase static hosting",
+    "provider": "GCP",
+    "type": "static-hosting",
+    "notes": "For static sites and SPAs"
+  },
+  {
+    "code": "EC2",
+    "label": "AWS EC2",
+    "description": "Amazon Elastic Compute Cloud VMs",
+    "provider": "AWS",
+    "type": "vm",
+    "notes": "Traditional VM-based deployments"
+  },
+  {
+    "code": "CR",
+    "label": "Google Cloud Run",
+    "description": "Google's container-as-a-service platform",
+    "provider": "GCP",
+    "type": "managed-container",
+    "notes": "Managed container runtime with auto-scaling"
+  },
+  {
+    "code": "ECS",
+    "label": "AWS ECS",
+    "description": "Amazon Elastic Container Service",
+    "provider": "AWS",
+    "type": "managed-container",
+    "notes": "AWS-native container orchestration"
+  },
+  {
+    "code": "AP",
+    "label": "AWS App Runner",
+    "description": "AWS fully managed container application service",
+    "provider": "AWS",
+    "type": "managed-container",
+    "notes": "Simplified container deployments"
+  },
+  {
+    "code": "EXP",
+    "label": "Expo (mobile)",
+    "description": "Expo platform for React Native",
+    "provider": "Expo",
+    "type": "mobile-platform",
+    "notes": "React Native mobile app builds and OTA updates"
+  },
+  {
+    "code": "APP",
+    "label": "App Stores (iOS/Android)",
+    "description": "Apple App Store and Google Play Store",
+    "provider": "Apple/Google",
+    "type": "mobile-distribution",
+    "notes": "Native app distribution"
+  },
+  {
+    "code": "OP",
+    "label": "On-Prem (customer environment)",
+    "description": "Customer-managed infrastructure",
+    "provider": "Customer",
+    "type": "on-premise",
+    "notes": "Deployed to customer's own infrastructure"
+  },
+  {
+    "code": "LH",
+    "label": "Local Host (dev/test deliverable)",
+    "description": "Local development or testing environment",
+    "provider": "Dev",
+    "type": "local",
+    "notes": "Not for production use"
+  },
+  {
+    "code": "PYPI",
+    "label": "Python Package Index",
+    "description": "Python package distribution",
+    "provider": "PyPI",
+    "type": "package-registry",
+    "notes": "For Python SDK/library distribution"
+  },
+  {
+    "code": "NPM",
+    "label": "npm Registry",
+    "description": "Node.js package distribution",
+    "provider": "npm",
+    "type": "package-registry",
+    "notes": "For JavaScript/TypeScript package distribution"
+  },
+  {
+    "code": "GH",
+    "label": "GitHub Releases",
+    "description": "GitHub release artifacts",
+    "provider": "GitHub",
+    "type": "artifact-distribution",
+    "notes": "For CLI tools, binaries, and releases"
+  },
+  {
+    "code": "GHA",
+    "label": "GitHub Actions",
+    "description": "CI/CD on GitHub Actions",
+    "provider": "GitHub",
+    "type": "ci-cd",
+    "notes": "For test suites and automation that runs in CI"
+  },
+  {
+    "code": "AWS",
+    "label": "Amazon Web Services (generic)",
+    "description": "Generic AWS deployment",
+    "provider": "AWS",
+    "type": "cloud-platform",
+    "notes": "Use when specific AWS service is unknown or mixed"
+  },
+  {
+    "code": "GCP",
+    "label": "Google Cloud Platform (generic)",
+    "description": "Generic GCP deployment",
+    "provider": "GCP",
+    "type": "cloud-platform",
+    "notes": "Use when specific GCP service is unknown or mixed"
+  },
+  {
+    "code": "AZR",
+    "label": "Microsoft Azure (generic)",
+    "description": "Generic Azure deployment",
+    "provider": "Azure",
+    "type": "cloud-platform",
+    "notes": "Use when specific Azure service is unknown or mixed"
+  }
+]

package/src/cli/standards/system_types.json

@@ -0,0 +1,130 @@
+[
+  {
+    "code": "API",
+    "label": "API service / microservice",
+    "description": "RESTful or GraphQL API endpoints, backend services",
+    "examples": ["FastAPI backend", "Express API", "Django REST", "gRPC service"],
+    "typical_platforms": ["EKS", "GKE", "DK", "LM"],
+    "notes": "Use for any backend service exposing HTTP/RPC endpoints"
+  },
+  {
+    "code": "BOT",
+    "label": "Chatbot / Automation agent",
+    "description": "Event-driven automation, background workers, message processors, bots",
+    "examples": ["Discord bot", "Slack bot", "Queue worker", "Cron jobs", "Telegram bot"],
+    "typical_platforms": ["EKS", "GKE", "DK", "LM"],
+    "notes": "Includes both conversational bots and background automation workers"
+  },
+  {
+    "code": "MA",
+    "label": "Mobile App (native or hybrid)",
+    "description": "Native or hybrid mobile applications for iOS/Android",
+    "examples": ["React Native app", "Flutter app", "Swift/Kotlin native", "Expo app"],
+    "typical_platforms": ["EXP", "CF", "APP"],
+    "notes": "SKU tracks the app binary/release, not backend services"
+  },
+  {
+    "code": "WA",
+    "label": "Web Application (interactive web apps, portals)",
+    "description": "Frontend web applications (SPAs, SSR, SSG)",
+    "examples": ["React SPA", "Next.js app", "Vue app", "Angular", "Svelte"],
+    "typical_platforms": ["VE", "CF", "EKS", "FH"],
+    "notes": "Use for user-facing web applications"
+  },
+  {
+    "code": "RAG",
+    "label": "Retrieval-Augmented Generation (AI systems with retrieval)",
+    "description": "RAG systems with vector search, embeddings, and LLM integration",
+    "examples": ["LangChain RAG", "LlamaIndex app", "Pinecone integration", "Semantic search"],
+    "typical_platforms": ["EKS", "LM", "EC2"],
+    "notes": "Specifically for RAG architectures, not general AI"
+  },
+  {
+    "code": "DA",
+    "label": "Data Analytics / Dashboard",
+    "description": "Data processing, analytics pipelines, BI dashboards",
+    "examples": ["Metabase", "Superset", "dbt models", "Tableau integration"],
+    "typical_platforms": ["EKS", "EC2", "GKE"],
+    "notes": "Use for analytics/BI tools and data visualization"
+  },
+  {
+    "code": "AI",
+    "label": "AI pipeline/agent (non-RAG)",
+    "description": "Machine learning models, inference APIs, training pipelines",
+    "examples": ["TensorFlow Serving", "PyTorch models", "Hugging Face", "OpenAI integration"],
+    "typical_platforms": ["EKS", "LM", "EC2"],
+    "notes": "Use for AI/ML services that aren't RAG-specific"
+  },
+  {
+    "code": "CMS",
+    "label": "Content Management System",
+    "description": "Content management systems, headless CMS, documentation sites",
+    "examples": ["Strapi", "Docusaurus", "Sanity", "WordPress"],
+    "typical_platforms": ["EKS", "VE", "FH"],
+    "notes": "Includes both traditional and headless CMS"
+  },
+  {
+    "code": "DB",
+    "label": "Database system / data layer deliverable",
+    "description": "Managed databases, data stores, database migrations",
+    "examples": ["PostgreSQL", "MongoDB", "Redis", "Elasticsearch"],
+    "typical_platforms": ["AWS", "GCP", "AZR", "DK"],
+    "notes": "Use for database instances or migration projects"
+  },
+  {
+    "code": "OP",
+    "label": "Operations Tool",
+    "description": "Internal tooling, admin panels, DevOps utilities, on-prem systems",
+    "examples": ["Admin dashboard", "Deployment tool", "Monitoring agent", "CLI tool"],
+    "typical_platforms": ["EKS", "DK", "EC2", "OP"],
+    "notes": "Internal tools not exposed to end users"
+  },
+  {
+    "code": "ETL",
+    "label": "Data pipelines (extract/transform/load)",
+    "description": "ETL/ELT pipelines, data ingestion, data transformation",
+    "examples": ["Airflow DAGs", "dbt", "Fivetran sync", "Custom ETL"],
+    "typical_platforms": ["LM", "EKS", "GKE", "EC2"],
+    "notes": "Any data pipeline or transformation workflow"
+  },
+  {
+    "code": "INT",
+    "label": "Integration/Orchestration layer",
+    "description": "Third-party API integrations, middleware, webhooks",
+    "examples": ["Stripe integration", "Salesforce sync", "Zapier connector", "Webhook processor"],
+    "typical_platforms": ["LM", "EKS", "CF"],
+    "notes": "Services that connect or orchestrate other systems"
+  },
+  {
+    "code": "FX",
+    "label": "Feature module/add-on shipped as a distinct unit",
+    "description": "Serverless functions, edge functions, feature modules",
+    "examples": ["AWS Lambda function", "Cloudflare Workers", "Vercel Functions"],
+    "typical_platforms": ["LM", "CF", "VE"],
+    "notes": "Small, single-purpose functions or modules"
+  },
+  {
+    "code": "SDK",
+    "label": "Client/developer SDK deliverable",
+    "description": "Client libraries, SDKs, packages for developers",
+    "examples": ["Python package", "npm library", "Go module", "REST client"],
+    "typical_platforms": ["PYPI", "NPM", "GH"],
+    "notes": "Distributed as packages, not deployed services"
+  },
+  {
+    "code": "CLI",
+    "label": "Command-line tool",
+    "description": "Command-line interface tools and utilities",
+    "examples": ["Deployment CLI", "Admin CLI", "Data migration tool"],
+    "typical_platforms": ["GH", "PYPI", "NPM"],
+    "notes": "Downloadable/installable CLI tools"
+  },
+  {
+    "code": "QA",
+    "label": "QA/Test harness deliverable",
+    "description": "Test suites, E2E testing, load testing, QA automation",
+    "examples": ["Playwright tests", "k6 load tests", "Postman collections", "Selenium"],
+    "typical_platforms": ["GHA", "EKS", "GKE"],
+    "notes": "Testing infrastructure and automation"
+  }
+]