@alcedocore/cli 0.0.1-rc.1 → 0.0.1-rc.2

package/dist/commands/init.js

@@ -11,6 +11,7 @@ const logger_1 = require("../utils/logger");
 const ejs_renderer_1 = require("../utils/ejs-renderer");
 const config_1 = require("../config");
 const node_readline_1 = __importDefault(require("node:readline"));
+const node_child_process_1 = require("node:child_process");
 exports.initCommand = new commander_1.Command("init")
     .argument("<name>", "Plugin project name (e.g., my-plugin)")
     .option("-l, --language <language>", "Plugin language (python or node)")
@@ -36,6 +37,7 @@ exports.initCommand = new commander_1.Command("init")
         description: `A new AlcedoCore plugin`,
         language,
         registryUrl,
+        startCMD: language == "node" ? "npm run dev" : "python server.py",
     };
     const spinner = (0, logger_1.createSpinner)(`Scaffolding plugin: ${name}`);
     try {
@@ -50,21 +52,28 @@ exports.initCommand = new commander_1.Command("init")
             : "Dockerfile.node.ejs";
         (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", dockerTemplate), node_path_1.default.join(targetDir, "Dockerfile"), data);
         // Server stub (language-specific)
-        const serverTemplate = language === "python" ? "server.py.ejs" : "server.js.ejs";
-        (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", serverTemplate), node_path_1.default.join(targetDir, `server.${language === "python" ? "py" : "js"}`), data);
+        const serverTemplate = language === "python" ? "server.py" : "server.ts";
+        (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", serverTemplate), node_path_1.default.join(targetDir, `server.${language === "python" ? "py" : "ts"}`), data);
         // .gitignore
         (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", "gitignore.ejs"), node_path_1.default.join(targetDir, ".gitignore"), data);
         // README.md
-        (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", "README.md.ejs"), node_path_1.default.join(targetDir, "README.md"), data);
+        (0, ejs_renderer_1.renderAndWrite)(node_path_1.default.join(templatesDir, "plugin", "README.md"), node_path_1.default.join(targetDir, "README.md"), data);
         copyGitkeep(templatesDir, targetDir, "migrations");
         copyGitkeep(templatesDir, targetDir, "pages");
         copyGitkeep(templatesDir, targetDir, "public");
+        if (language == "node") {
+            copyFile(node_path_1.default.join(templatesDir, "plugin", "tsconfig.json"), node_path_1.default.join(targetDir, "tsconfig.json"));
+            copyFile(node_path_1.default.join(templatesDir, "plugin", "package.json"), node_path_1.default.join(targetDir, "package.json"));
+            spinner.text = "Installing NPM packages...";
+            (0, node_child_process_1.execSync)("npm install", { cwd: targetDir });
+        }
         spinner.succeed();
         (0, logger_1.success)(`Plugin scaffolded: ${targetDir}`);
         (0, logger_1.info)(`Next steps:
-      cd ${name}
-      # Edit server.${language === "python" ? "py" : "js"} and manifest.json
-      # Build with: docker build -t ${registryUrl}/${slug}:1.0.0 .`);
+- cd ${name}
+- You can now edit the server.${language === "python" ? "py" : "ts"} and manifest.json
+- See the README.md for getting started!
+      `);
     }
     catch (err) {
         spinner.fail();
@@ -113,6 +122,11 @@ function copyGitkeep(templateDir, targetDir, subDir) {
         node_fs_1.default.writeFileSync(dest, "");
     }
 }
+function copyFile(sourceDir, targetDir) {
+    if (node_fs_1.default.existsSync(sourceDir)) {
+        node_fs_1.default.copyFileSync(sourceDir, targetDir);
+    }
+}
 function parseLanguage(lang) {
     const v = lang.trim().toLowerCase();
     if (v === "python" || v === "py")

package/dist/commands/proxy.js

@@ -38,14 +38,6 @@ exports.proxyCommand = new commander_1.Command("proxy")
     validateSpinner.succeed();
     const server = node_http_1.default.createServer(async (clientReq, clientRes) => {
         const startTime = Date.now();
-        const requestId = await registerRequest(coreUrl, apiKey || undefined, slug);
-        if (!requestId) {
-            (0, logger_1.error)("Failed to register request ID with core");
-            clientRes.statusCode = 502;
-            clientRes.setHeader("Content-Type", "text/plain");
-            clientRes.end("Bad Gateway: core unavailable");
-            return;
-        }
         // Clone headers and inject X-Request-ID
         const headers = {};
         for (const [key, value] of Object.entries(clientReq.headers)) {
@@ -55,7 +47,17 @@ exports.proxyCommand = new commander_1.Command("proxy")
                     : value;
             }
         }
-        headers["X-Request-ID"] = requestId;
+        if (!clientReq.url || !clientReq.url.includes(".")) {
+            const requestId = await registerRequest(coreUrl, apiKey || undefined, slug);
+            if (!requestId) {
+                (0, logger_1.error)("Failed to register request ID with core");
+                clientRes.statusCode = 502;
+                clientRes.setHeader("Content-Type", "text/plain");
+                clientRes.end("Bad Gateway: core unavailable");
+                return;
+            }
+            headers["X-Request-ID"] = requestId;
+        }
         headers["host"] = `${parsedTarget.hostname}:${parsedTarget.port}`;
         const options = {
             hostname: parsedTarget.hostname,

package/dist/commands/publish.js

@@ -42,8 +42,7 @@ exports.publishCommand = new commander_1.Command("publish")
     try {
         spinner.text = "Building Docker image...";
         await buildDockerImage(pluginDir, config.registryUrl, manifest.name, manifest.version);
-        (0, logger_1.success)(`Plugin has been build`);
-        spinner.text = "Pushing Docker image...";
+        spinner.text = "Building complete, pushing Docker image...";
         await pushDockerImage(config.registryUrl, manifest.name, manifest.version);
         spinner.succeed();
         (0, logger_1.success)(`Plugin has been build and pushed under ${manifest.name}:${manifest.version}`);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@alcedocore/cli",
-    "version": "0.0.1-rc.1",
+    "version": "0.0.1-rc.2",
     "description": "Alcedo plugin development CLI - scaffold, develop, and test plugins",
     "main": "dist/index.js",
     "bin": {

package/src/commands/init.ts

@@ -10,6 +10,7 @@ import {
 import { renderAndWrite } from "../utils/ejs-renderer";
 import { loadConfig } from "../config";
 import readline from "node:readline";
+import { exec, execSync } from "node:child_process";
 
 export const initCommand = new Command("init")
     .argument("<name>", "Plugin project name (e.g., my-plugin)")
@@ -41,6 +42,8 @@ export const initCommand = new Command("init")
                 description: `A new AlcedoCore plugin`,
                 language,
                 registryUrl,
+                startCMD:
+                    language == "node" ? "npm run dev" : "python server.py",
             };
 
             const spinner = createSpinner(`Scaffolding plugin: ${name}`);
@@ -70,12 +73,12 @@ export const initCommand = new Command("init")
 
                 // Server stub (language-specific)
                 const serverTemplate =
-                    language === "python" ? "server.py.ejs" : "server.js.ejs";
+                    language === "python" ? "server.py" : "server.ts";
                 renderAndWrite(
                     path.join(templatesDir, "plugin", serverTemplate),
                     path.join(
                         targetDir,
-                        `server.${language === "python" ? "py" : "js"}`,
+                        `server.${language === "python" ? "py" : "ts"}`,
                     ),
                     data,
                 );
@@ -89,7 +92,7 @@ export const initCommand = new Command("init")
 
                 // README.md
                 renderAndWrite(
-                    path.join(templatesDir, "plugin", "README.md.ejs"),
+                    path.join(templatesDir, "plugin", "README.md"),
                     path.join(targetDir, "README.md"),
                     data,
                 );
@@ -98,13 +101,28 @@ export const initCommand = new Command("init")
                 copyGitkeep(templatesDir, targetDir, "pages");
                 copyGitkeep(templatesDir, targetDir, "public");
 
-                spinner.succeed();
+                if (language == "node") {
+                    copyFile(
+                        path.join(templatesDir, "plugin", "tsconfig.json"),
+                        path.join(targetDir, "tsconfig.json"),
+                    );
+                    copyFile(
+                        path.join(templatesDir, "plugin", "package.json"),
+                        path.join(targetDir, "package.json"),
+                    );
+
+                    spinner.text = "Installing NPM packages...";
+                    execSync("npm install", { cwd: targetDir });
+                }
 
+                spinner.succeed();
                 success(`Plugin scaffolded: ${targetDir}`);
+
                 info(`Next steps:
-      cd ${name}
-      # Edit server.${language === "python" ? "py" : "js"} and manifest.json
-      # Build with: docker build -t ${registryUrl}/${slug}:1.0.0 .`);
+- cd ${name}
+- You can now edit the server.${language === "python" ? "py" : "ts"} and manifest.json
+- See the README.md for getting started!
+      `);
             } catch (err: any) {
                 spinner.fail();
                 logError(`Failed to scaffold plugin: ${err.message}`);
@@ -162,6 +180,12 @@ function copyGitkeep(
     }
 }
 
+function copyFile(sourceDir: string, targetDir: string) {
+    if (fs.existsSync(sourceDir)) {
+        fs.copyFileSync(sourceDir, targetDir);
+    }
+}
+
 function parseLanguage(lang: string): "python" | "node" {
     const v = lang.trim().toLowerCase();
     if (v === "python" || v === "py") return "python";

package/src/commands/proxy.ts

@@ -63,19 +63,6 @@ export const proxyCommand = new Command("proxy")
         const server = http.createServer(async (clientReq, clientRes) => {
             const startTime = Date.now();
 
-            const requestId = await registerRequest(
-                coreUrl,
-                apiKey || undefined,
-                slug,
-            );
-            if (!requestId) {
-                logError("Failed to register request ID with core");
-                clientRes.statusCode = 502;
-                clientRes.setHeader("Content-Type", "text/plain");
-                clientRes.end("Bad Gateway: core unavailable");
-                return;
-            }
-
             // Clone headers and inject X-Request-ID
             const headers: Record<string, string> = {};
             for (const [key, value] of Object.entries(clientReq.headers)) {
@@ -85,7 +72,23 @@ export const proxyCommand = new Command("proxy")
                         : value;
                 }
             }
-            headers["X-Request-ID"] = requestId;
+
+            if (!clientReq.url || !clientReq.url.includes(".")) {
+                const requestId = await registerRequest(
+                    coreUrl,
+                    apiKey || undefined,
+                    slug,
+                );
+                if (!requestId) {
+                    logError("Failed to register request ID with core");
+                    clientRes.statusCode = 502;
+                    clientRes.setHeader("Content-Type", "text/plain");
+                    clientRes.end("Bad Gateway: core unavailable");
+                    return;
+                }
+
+                headers["X-Request-ID"] = requestId;
+            }
             headers["host"] = `${parsedTarget.hostname}:${parsedTarget.port}`;
 
             const options: http.RequestOptions = {

package/src/commands/publish.ts

@@ -49,8 +49,7 @@ export const publishCommand = new Command("publish")
                 manifest.name,
                 manifest.version,
             );
-            success(`Plugin has been build`);
-            spinner.text = "Pushing Docker image...";
+            spinner.text = "Building complete, pushing Docker image...";
             await pushDockerImage(
                 config.registryUrl,
                 manifest.name,

package/templates/plugin/Dockerfile.node.ejs

@@ -1,13 +1,9 @@
-FROM node:20-slim
+FROM node:24-slim
 
 WORKDIR /app
 
-COPY server.js .
-COPY endpoints/ ./endpoints/
-COPY public/ ./public/
-COPY migrations/ ./migrations/
-COPY pages/dist/ ./pages/dist/
-COPY manifest.json .
+COPY . . 
+RUN npm ci
 
 EXPOSE 8080
 

package/templates/plugin/README.md

@@ -0,0 +1,31 @@
+# <%= name %>
+
+A plugin for AlcedoCore.
+
+## Getting Started
+
+Run locally during development:
+
+### Connect
+
+Run `alcedo connect` to connect to your AlcedoCore instance.
+
+### Development
+
+In one terminal:
+
+```bash
+alcedo dev proxy
+```
+
+In another terminal:
+
+```bash
+<%= startCMD %>
+```
+
+### Build and deploy
+
+```bash
+alcedo publish
+```

package/templates/plugin/manifest.json.ejs

@@ -2,7 +2,6 @@
   "name": "<%= name %>",
   "version": "<%= version || '1.0.0' %>",
   "plugin_type": "docker",
-  "system_plugin": false,
   "image": "<%= registryUrl %>/<%= slug %>:1.0.0",
   "env": {},
   "resources": {},

package/templates/plugin/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "<%= slug %>",
+    "version": "1.0.0",
+    "description": "A plugin for Alcedo.",
+    "main": "index.js",
+    "scripts": {
+        "dev": "npx tsx server.ts"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "type": "module",
+    "devDependencies": {
+        "typescript": "^7.0.2"
+    },
+    "dependencies": {
+        "@alcedocore/sdk": "^0.0.1-rc.0"
+    }
+}

package/templates/plugin/server.ts

@@ -0,0 +1,33 @@
+import express from "express";
+import { createClient } from "@alcedocore/sdk";
+
+const app = express();
+const port = process.env.PORT || 3000;
+const CORE_URL = process.env.CORE_URL || "http://localhost:8080";
+const PLUGIN_SLUG = process.env.PLUGIN_SLUG || "<%= slug %>";
+
+const client = createClient(CORE_URL, {
+    timeout: 30_000,
+    retry: { limit: 2 },
+});
+
+app.get("/", (req, res) => {
+    res.send("Hello World!");
+});
+
+app.get("/settings", async (_req, res) => {
+    try {
+        const settings = await client.settings.get(PLUGIN_SLUG, {
+            headers: {
+                ["x-request-id"]: _req.headers["x-request-id"],
+            },
+        });
+        res.json({ slug: PLUGIN_SLUG, settings });
+    } catch (err) {
+        res.status(500).json({ slug: PLUGIN_SLUG, error: err.message });
+    }
+});
+
+app.listen(port, () => {
+    console.log(`Example app listening on port ${port}`);
+});

package/templates/plugin/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "target": "es2022",
+    "lib": ["esnext"],
+    "types": ["node"],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "verbatimModuleSyntax": false,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  }
+}

package/templates/plugin/README.md.ejs

@@ -1,19 +0,0 @@
-# <%= name %>
-
-A plugin for Alcedo.
-
-## Getting Started
-
-```bash
-# Build and deploy
-docker build -t localhost:5000/<%= slug %>:1.0.0 .
-docker push localhost:5000/<%= slug %>:1.0.0
-```
-
-## Development
-
-Run locally during development:
-
-```bash
-python server.py
-```

package/templates/plugin/server.js.ejs

@@ -1,27 +0,0 @@
-const http = require("http");
-const url = require("url");
-
-const server = http.createServer((req, res) => {
-  const parsed = url.parse(req.url);
-  const path = parsed.pathname;
-
-  const sendJson = (data, status = 200) => {
-    const body = JSON.stringify(data);
-    res.writeHead(status, { "Content-Type": "application/json", "Content-Length": Buffer.byteLength(body) });
-    res.end(body);
-  };
-
-  if (path === "/health") {
-    sendJson({ status: "healthy" });
-  } else if (req.method === "GET") {
-    sendJson({ status: "ok", path });
-  } else if (req.method === "POST") {
-    sendJson({ status: "ok", method: "POST" });
-  } else {
-    sendJson({ error: "Method not allowed" }, 405);
-  }
-});
-
-server.listen(8080, "0.0.0.0", () => {
-  console.log("Plugin running on port 8080");
-});