@egintegrations/telemetry 0.2.2 → 0.3.1

package/README.md

@@ -26,12 +26,37 @@ npx @egintegrations/telemetry init
 ```
 
 The CLI will:
-1. Detect your framework (Next.js, Express, Fastify, or generic)
-2. Prompt for engine name, SKU version, and Control Center URL
-3. Generate configuration file (`.egi/telemetry.json`)
-4. Create integration code (`lib/telemetry.ts` for Next.js, `src/telemetry.ts` for Express)
-5. Add environment variables (`.env.local` or `.env`)
-6. Optionally generate status endpoint boilerplate
+1. Show the EGI ASCII logo and welcome message
+2. Detect your framework (Next.js, Express, Fastify, or generic)
+3. Prompt for engine configuration:
+   - Engine name
+   - Version (semantic version like 1.0.0)
+   - System type (16 options: API, BOT, WA, RAG, ETL, INT, CMS, MA, DA, AI, DB, OP, FX, SDK, CLI, QA)
+   - Platform (25 options: VE, EKS, GKE, NPM, PYPI, etc.)
+4. Generate full SKU automatically (e.g., `1.0.0.API.VE.20260113`)
+5. Create configuration file (`.egi/telemetry.json`)
+6. Create integration code (`lib/telemetry.ts` for Next.js, `telemetry.ts` for Express/Fastify)
+
+### How It Works
+
+1. **Install and configure** (30 seconds)
+2. **Deploy your project** (Vercel, Heroku, K8s, anywhere)
+3. **Engine automatically registers** on first startup
+4. **View in dashboard**: https://control-center.egintegrations.com/ui
+
+No manual configuration. No YAML files. Just install, configure, and deploy!
+
+### SKU Format
+
+SKUs follow the format: `VERSION.TYPE.PLATFORM.DATE`
+
+**Example:** `1.0.0.API.VE.20260113`
+- **VERSION**: Semantic version (1.0.0, 2.1.3, etc.)
+- **TYPE**: System type - API, BOT, WA, RAG, ETL, INT, CMS, MA, DA, AI, DB, OP, FX, SDK, CLI, QA
+- **PLATFORM**: Deployment platform - VE (Vercel), EKS, GKE, NPM, PYPI, etc.
+- **DATE**: Auto-generated timestamp (YYYYMMDD)
+
+The CLI will guide you through selecting the appropriate type and platform for your project.
 
 ### Non-Interactive Setup
 
@@ -40,9 +65,10 @@ For CI/CD or automated setups:
 ```bash
 npx @egintegrations/telemetry init \
   --engine my-engine \
-  --sku 1.0.0 \
-  --url https://control-center.egintegrations.com \
-  --token your-auth-token
+  --version 1.0.0 \
+  --type API \
+  --platform VE \
+  --url https://control-center.egintegrations.com
 ```
 
 ### CLI Options
@@ -50,15 +76,16 @@ npx @egintegrations/telemetry init \
 | Option | Description | Default |
 |--------|-------------|---------|
 | `--engine <name>` | Engine name (required) | - |
-| `--sku <version>` | SKU version (required) | - |
-| `--url <url>` | Control Center URL (required) | - |
+| `--version <version>` | Semantic version (required) | - |
+| `--type <type>` | System type (API, BOT, WA, etc.) | - |
+| `--platform <platform>` | Platform (VE, EKS, NPM, etc.) | - |
+| `--url <url>` | Control Center URL | `https://control-center.egintegrations.com` |
 | `--token <token>` | Auth token (optional) | - |
 | `--modules <modules>` | Comma-separated module list | - |
 | `--output <path>` | Config file location | `.egi/telemetry.json` |
 | `--framework <type>` | Force framework type (nextjs, express, fastify, generic) | Auto-detected |
 | `--no-interactive` | Skip prompts, fail on missing args | Interactive mode |
 | `--no-codegen` | Only generate config file | Code generation enabled |
-| `--status-endpoint` | Generate status endpoint boilerplate | false |
 
 ### Framework-Specific Examples
 
@@ -66,18 +93,26 @@ npx @egintegrations/telemetry init \
 
 ```bash
 cd my-nextjs-app
+npm install @egintegrations/telemetry
 npx @egintegrations/telemetry init
+# Select: 1.0.0, API type, VE platform
+
+# Deploy to Vercel
+vercel deploy --prod
+
+# Check dashboard - engine appears automatically!
+# https://control-center.egintegrations.com/ui
 ```
 
 **Generated Files:**
-- `.egi/telemetry.json` - Configuration
-- `lib/telemetry.ts` - Telemetry client singleton
-- `.env.local` - Environment variables
-- `app/api/engine-status/route.ts` - Status endpoint (if requested)
+- `.egi/telemetry.json` - Configuration with full SKU
+- `lib/telemetry.ts` - Telemetry client singleton (auto-registers on import)
 
 **Usage in Next.js:**
 ```typescript
-// app/api/data/route.ts
+// The telemetry client is already registered automatically
+// Just import and use when you need custom metrics:
+
 import telemetry from '@/lib/telemetry';
 
 export async function GET() {
@@ -93,35 +128,38 @@ export async function GET() {
 
 ```bash
 cd my-express-app
+npm install @egintegrations/telemetry
 npx @egintegrations/telemetry init
+# Select: 1.0.0, API type, EKS platform
+
+# Deploy however you normally deploy
+npm start
 ```
 
 **Generated Files:**
-- `.egi/telemetry.json` - Configuration
-- `src/telemetry.ts` - Telemetry client
-- `.env` - Environment variables
-- `src/routes/status.ts` - Status endpoint (if requested)
+- `.egi/telemetry.json` - Configuration with full SKU
+- `telemetry.ts` - Telemetry client with health endpoint
 
 **Usage in Express:**
 ```typescript
-// src/index.ts
+// telemetry.ts already sets up /.well-known/engine-status endpoint
+// and registers on startup. Just import and use:
+
 import express from 'express';
 import telemetry from './telemetry';
 
 const app = express();
 
-// Auto-track requests
+// Optional: Auto-track requests
 app.use(telemetry.middleware());
 
-// Use in routes
+// Use in routes for custom metrics
 app.get('/data', async (req, res) => {
   await telemetry.sendMetrics({ metrics: { requests: 1 } });
   res.json({ ok: true });
 });
 
-app.listen(3000, async () => {
-  await telemetry.register();
-});
+app.listen(3000);
 ```
 
 ## Manual Setup (Advanced)
@@ -136,13 +174,13 @@ import { TelemetryClient } from '@egintegrations/telemetry';
 // Initialize the client
 const telemetry = new TelemetryClient({
   engineName: 'my-awesome-engine',
-  skuVersion: '1.0.0',
+  skuVersion: '1.0.0.API.VE.20260113', // Full SKU format: VERSION.TYPE.PLATFORM.DATE
   controlCenterUrl: 'https://control-center.egintegrations.com',
   authToken: 'optional-auth-token', // Optional
   enabled: true, // Default: true
 });
 
-// Register your engine
+// Register your engine (auto-creates engine in dashboard)
 await telemetry.register({
   environment: 'production',
   region: 'us-east-1',
@@ -179,14 +217,16 @@ import { TelemetryClient } from '@egintegrations/telemetry';
 const app = express();
 const telemetry = new TelemetryClient({
   engineName: 'api-server',
-  skuVersion: '1.0.0',
+  skuVersion: '1.0.0.API.EKS.20260113', // Full SKU format
   controlCenterUrl: 'https://control-center.egintegrations.com',
 });
 
 // Automatic request metrics
 app.use(telemetry.middleware());
 
-app.listen(3000);
+app.listen(3000, async () => {
+  await telemetry.register(); // Auto-registers in dashboard
+});
 ```
 
 ### Automatic Health Checks
@@ -215,7 +255,7 @@ process.on('SIGTERM', async () => {
 #### Constructor Options
 
 - `engineName` (string, required) - Unique name for your engine
-- `skuVersion` (string, required) - Version of your engine (e.g., "1.0.0")
+- `skuVersion` (string, required) - Full SKU (e.g., "1.0.0.API.VE.20260113")
 - `controlCenterUrl` (string, required) - URL of your control center
 - `authToken` (string, optional) - Authentication token if required
 - `enabled` (boolean, optional) - Enable/disable telemetry (default: true)

package/dist/cli.js

@@ -131,6 +131,120 @@ function buildSku(version, systemType, platform, date) {
   return `${version}.${systemType}.${platform}.${skuDate}`;
 }
 
+// src/cli/banner.ts
+var import_chalk = __toESM(require("chalk"));
+var import_boxen = __toESM(require("boxen"));
+var import_gradient_string = __toESM(require("gradient-string"));
+var ASCII_LOGO = `
+                 ###########################*#*#**#+
+             ########################*******************
+          ######%@@%###########**************###%@@@*******
+        #%%%%@*+===--===-------::::::::::::::--------=%@*****
+      %%%%%+==-%#####################################:::-@****
+     %%%%*==+%%%%#######################################:-+@****
+    %%%%===%%%%%#                                   ######--@*##*
+   %%%%==*%%##                                        #####--%####
+  %%%%*==%%%#      %+*####    *****+++++++========      ####--%###
+  %%%%++%%%%     %%%++%###    *******++++++++=======    %###--%###*
+ -%%%%++%%%%    %%%%++%###    *#********+++++++======    ####-=####
+ =%%%%++%%%%    %%%%=+%###.   ###*******+++++++++====    ####--####
+ =%%%%+*%%%%    %%%%=+%###:    ..                 ...     :.    ::
+ =%%%%**%%%%    %%%%=+%%%%:
+ =%%%%**%%%%    %%%%=+%%%%%%%%#################*******************#
+ =%%%%*#%%%%    %%%%++%%%%###%%%%%%#######################*#*******
+ =%%%%*#%%%%    %%%%+*@%%%###@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ =%%%%*#%%%%    %%%%+*@%%%****++      ===================----------
+ =%%%%*#%%%%    @@%%+*%%%%###%%%%%%%%%%%%%#########################
+ =%%%%*#%%%%    @@@@*#%%%%%%%%%%%%%%%%%%%%%%%%#####################
+ +@%%%*#%%%%    @@@@*#%%%%
+ +@%@%*#%%%%    @@@@##%%%%
+ +@%%%*#%%%%    @@@@##%%%%    ##########**********+++    %%%%+*%%%%
+ +@@@%*#%%%%    @@@@#%%%%%    #############********++    %%%%++%%%%
+  @@@@**@%%%=   %@@@#%@%%%    %%%%%##########*******    +%%%%=#%%%%
+  @@@@##%%%%%     @@#%@@%%    %%%%%%##########*****     %%%%==@%%%
+  %@@@@**@@%%%      %%@@@@    %%%%%%###########*       @%%%*=+%%%%
+   @@@@@**@@@@@@                                     %%%%%*==%%%%
+    @@@@@+**@@@@@@@%+-:::::::::..........      =%%%%%%%%%++#%%%%
+     %@@@@@*##@@@@@@@@@@@@@%%%%%%%%%%%%%%%%%%%%%%%%%%@#*++%%%%%
+       @@@@@@*####%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%#***+@%%%%
+         @@@@@@@%*###*##############***####********#%%%%%%%%
+           @@@@@@@@@@@@@@@@@@@@@@@@@@%%%%%%%@@@%@%%%%%%%%
+               @@@@@@@@@@@@@@@@@@%@@@@@%%%%%@@@%@%%@@%
+`;
+var TAGLINE = "EGI Engine Platform \xB7 Telemetry SDK";
+var VERSION = "v0.3.0";
+function showBanner() {
+  console.clear();
+  const coloredLogo = (0, import_gradient_string.default)("cyan", "#00ffff", "#0099ff").multiline(ASCII_LOGO);
+  console.log(coloredLogo);
+  console.log();
+  console.log(
+    (0, import_boxen.default)(
+      import_chalk.default.cyan.bold(TAGLINE) + "\n" + import_chalk.default.gray(VERSION),
+      {
+        padding: 1,
+        margin: 1,
+        borderStyle: "round",
+        borderColor: "cyan",
+        align: "center"
+      }
+    )
+  );
+  console.log();
+}
+function showDetectedInfo(framework, version, features) {
+  const info = [
+    import_chalk.default.cyan("\u{1F50D} Project Detection"),
+    "",
+    import_chalk.default.white("Framework: ") + import_chalk.default.green.bold(framework)
+  ];
+  if (version) {
+    info.push(import_chalk.default.white("Version: ") + import_chalk.default.yellow(version));
+  }
+  if (features && features.length > 0) {
+    info.push(import_chalk.default.white("Features: ") + import_chalk.default.magenta(features.join(", ")));
+  }
+  console.log(
+    (0, import_boxen.default)(info.join("\n"), {
+      padding: 1,
+      margin: { top: 0, bottom: 1, left: 2, right: 2 },
+      borderStyle: "single",
+      borderColor: "cyan"
+    })
+  );
+}
+function showSuccess(message) {
+  console.log();
+  console.log(
+    (0, import_boxen.default)(
+      import_chalk.default.green("\u2713 ") + import_chalk.default.white.bold(message),
+      {
+        padding: 1,
+        margin: 1,
+        borderStyle: "round",
+        borderColor: "green",
+        align: "center"
+      }
+    )
+  );
+}
+function showGeneratedSku(sku) {
+  console.log();
+  console.log(
+    (0, import_boxen.default)(
+      import_chalk.default.cyan("\u{1F4E6} Generated SKU\n\n") + import_chalk.default.yellow.bold(sku),
+      {
+        padding: 1,
+        margin: { top: 0, bottom: 1, left: 2, right: 2 },
+        borderStyle: "round",
+        borderColor: "yellow",
+        align: "center"
+      }
+    )
+  );
+  console.log();
+}
+
 // src/cli/prompts.ts
 async function gatherOptions(cliArgs, detected) {
   const questions = [];
@@ -222,8 +336,7 @@ async function gatherOptions(cliArgs, detected) {
   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}`);
+    showGeneratedSku(finalSku);
   }
   return {
     engine: cliArgs.engine || answers.engine,
@@ -496,15 +609,15 @@ async function runGenerator(ctx) {
 
 // src/cli/commands.ts
 async function initCommand(options) {
-  console.log("\u{1F680} EGI Telemetry SDK Initialization\n");
+  showBanner();
   try {
     const cwd = process.cwd();
-    console.log("\u{1F50D} Detecting framework...");
     const detected = await detectFramework(cwd);
-    console.log(`   Found: ${detected.type}${detected.version ? ` v${detected.version}` : ""}`);
+    const features = [];
     if (detected.type === "nextjs" && detected.appDir) {
-      console.log("   Next.js App Router detected");
+      features.push("App Router");
     }
+    showDetectedInfo(detected.type, detected.version, features);
     console.log("");
     const telemetryOptions = await gatherOptions(options, detected);
     console.log("");
@@ -517,7 +630,7 @@ async function initCommand(options) {
     for (const file of files) {
       await writeFile(file);
     }
-    console.log("\n\u2705 Telemetry SDK initialized successfully!\n");
+    showSuccess("Telemetry SDK initialized successfully!");
     if (telemetryOptions.codegen && detected.type !== "generic") {
       console.log("\u{1F4DD} Next steps:");
       console.log("   1. Review the generated files");
@@ -527,7 +640,8 @@ async function initCommand(options) {
       } else {
         console.log("      import telemetry from './telemetry';");
       }
-      console.log("   3. Start using telemetry.sendMetrics() in your app");
+      console.log("   3. Deploy your project");
+      console.log("   4. Engine will auto-register in dashboard");
       console.log("");
     }
   } catch (error) {

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@egintegrations/telemetry",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "Telemetry SDK for EGIntegrations client engines",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "bin": {
-    "egi-telemetry": "./dist/cli.js"
+    "egi-telemetry": "dist/cli.js"
   },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs"
     }
   },
   "scripts": {
@@ -33,7 +33,12 @@
   "license": "PROPRIETARY",
   "dependencies": {
     "axios": "^1.6.0",
+    "boxen": "^5.1.2",
+    "chalk": "^4.1.2",
+    "cli-table3": "^0.6.5",
     "commander": "^12.0.0",
+    "gradient-string": "^2.0.2",
+    "ora": "^5.4.1",
     "prompts": "^2.4.2"
   },
   "devDependencies": {