@pitcher/cli-scripts 2.0.8 → 2.1.0

package/README.md

@@ -48,3 +48,41 @@ p publish-app --org pitcher --increment-version --install-to-env-name Production
 - `--publish-url <url>`: Explicit publish URL
 - `--install-to <instanceIds>`: Comma-separated list of instance IDs to install the app to after publishing
 - `--install-to-env-name <envName>`: Environment name to filter instances and install the app to after publishing (case-insensitive)
+
+## To run the `dev-sync` command:
+
+Sync a marketplace app directly to S3 for live development testing without publishing. This is useful for testing app changes in a pre-production environment.
+
+```bash
+# One-time sync from dist folder
+p dev-sync sync --file-id <pitcher_file_id> --api-key myapikey
+
+# Sync to a specific organization (default: dev)
+p dev-sync sync --file-id <pitcher_file_id> --org pitcher
+
+# Watch mode - auto-sync on file changes (reverts on Ctrl+C)
+p dev-sync watch --file-id <pitcher_file_id> --api-key myapikey
+
+# Watch with custom debounce (default: 2500ms)
+p dev-sync watch --file-id <pitcher_file_id> --debounce 5000
+
+# Manually revert dev override to restore original version
+p dev-sync revert --file-id <pitcher_file_id> --api-key myapikey
+
+# Alternative: Set API key via environment variable
+export NG_API_KEY=myapikey
+p dev-sync watch --file-id <pitcher_file_id> --org pitcher
+```
+
+### Options
+
+- `--file-id <id>`: (Required) File ID of the installed app (`pitcher_file.id`) - copy this from the installed apps view
+- `--api-key <apiKey>`: API Key for authentication (can also use `NG_API_KEY` env variable)
+- `--org <organization>`: Organization subdomain (default: "dev")
+- `--debounce <ms>`: Debounce time in milliseconds for watch mode (default: 2500)
+
+### Notes
+
+- Run from your app's project root (with `dist/` folder) or directly from the `dist/` folder
+- The `watch` command automatically reverts changes on graceful shutdown (Ctrl+C)
+- Apps with dev override show a badge in the installed apps view

package/dist/index.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import { Command } from "commander";
 import { createPublishAppCommand } from "./src/publishApp.js";
+import { createDevSyncCommand } from "./src/devSync.js";
 import { readFileSync } from "fs";
 import { fileURLToPath } from "url";
 import { dirname, join } from "path";
@@ -14,4 +15,5 @@ program
     .version(pkg.version);
 // Add subcommands
 program.addCommand(createPublishAppCommand());
+program.addCommand(createDevSyncCommand());
 program.parse(process.argv);

package/dist/src/devSync.d.ts

@@ -0,0 +1,2 @@
+import { Command } from "commander";
+export declare function createDevSyncCommand(): Command;

package/dist/src/devSync.js

@@ -0,0 +1,234 @@
+import { Command } from "commander";
+import archiver from "archiver";
+import axios from "axios";
+import chokidar from "chokidar";
+import fs from "fs";
+import path from "path";
+import FormData from "form-data";
+function findDistPath() {
+    const cwd = process.cwd();
+    // Check if app.json exists in current directory
+    if (fs.existsSync(path.join(cwd, "app.json"))) {
+        return cwd;
+    }
+    // Check if app.json exists in dist subdirectory
+    const distPath = path.join(cwd, "dist");
+    if (fs.existsSync(path.join(distPath, "app.json"))) {
+        return distPath;
+    }
+    console.error("❌ Could not find app.json in current directory or ./dist");
+    console.error("   Run this command from your app's dist folder or from the project root.");
+    process.exit(1);
+}
+function readAppJson(distPath) {
+    const appJsonPath = path.join(distPath, "app.json");
+    if (!fs.existsSync(appJsonPath)) {
+        throw new Error(`app.json not found in ${distPath}`);
+    }
+    const content = fs.readFileSync(appJsonPath, "utf-8");
+    const appJson = JSON.parse(content);
+    if (!appJson.name) {
+        throw new Error('app.json must contain a "name" field');
+    }
+    return appJson;
+}
+async function createZipBuffer(distPath) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        const archive = archiver("zip", { zlib: { level: 9 } });
+        archive.on("data", (chunk) => chunks.push(chunk));
+        archive.on("end", () => resolve(Buffer.concat(chunks)));
+        archive.on("error", reject);
+        archive.directory(distPath, false);
+        archive.finalize();
+    });
+}
+async function syncToApi(distPath, org, appName, fileId, apiKey) {
+    console.log(`Creating zip from ${distPath}...`);
+    const zipBuffer = await createZipBuffer(distPath);
+    console.log(`Zip created: ${(zipBuffer.length / 1024).toFixed(2)} KB`);
+    const formData = new FormData();
+    formData.append("app_name", appName);
+    formData.append("file_id", fileId);
+    formData.append("zip", zipBuffer, {
+        filename: "app.zip",
+        contentType: "application/zip",
+    });
+    const endpoint = `https://${org}.my.pitcher.com/core/api/protected/development/s3-app-sync`;
+    console.log(`Uploading to ${endpoint}...`);
+    try {
+        const response = await axios.post(endpoint, formData, {
+            headers: {
+                "x-api-key": apiKey,
+                ...formData.getHeaders(),
+            },
+            maxBodyLength: Infinity,
+            maxContentLength: Infinity,
+        });
+        return response.data;
+    }
+    catch (error) {
+        const axiosError = error;
+        const errData = axiosError?.response?.data;
+        throw new Error(`Upload failed (${axiosError?.response?.status}): ${errData?.error || errData?.detail || axiosError.message}`);
+    }
+}
+async function revertDevOverride(org, fileId, apiKey) {
+    const endpoint = `https://${org}.my.pitcher.com/core/api/protected/development/s3-app-sync`;
+    try {
+        const response = await axios.delete(endpoint, {
+            headers: {
+                "x-api-key": apiKey,
+                "Content-Type": "application/json",
+            },
+            data: { file_id: fileId },
+        });
+        console.log("✅ Dev override reverted");
+        console.log(`   Restored version: ${response.data.restored_version}`);
+    }
+    catch (error) {
+        const axiosError = error;
+        const errData = axiosError?.response?.data;
+        throw new Error(`Revert failed (${axiosError?.response?.status}): ${errData?.error || errData?.detail || axiosError.message}`);
+    }
+}
+export function createDevSyncCommand() {
+    const program = new Command("dev-sync");
+    program.description("Sync a marketplace app to S3 for live development testing");
+    program
+        .command("sync")
+        .description("One-time sync of the app to S3")
+        .requiredOption("--file-id <id>", "File ID of the installed app (pitcher_file.id)")
+        .option("--api-key <apiKey>", "API Key for authentication")
+        .option("--org <organization>", "Organization subdomain", "dev")
+        .action(async (options) => {
+        try {
+            const apiKey = options.apiKey || process.env.NG_API_KEY;
+            if (!apiKey) {
+                console.error("Error: API key is required. Provide it via --api-key or set the NG_API_KEY environment variable.");
+                process.exit(1);
+            }
+            const distPath = findDistPath();
+            const appJson = readAppJson(distPath);
+            console.log(`Syncing ${appJson.name}...`);
+            console.log(`   From: ${distPath}`);
+            const result = await syncToApi(distPath, options.org, appJson.name, options.fileId, apiKey);
+            console.log("\n✅ Sync completed!");
+            console.log(`   Dev version: ${result.dev_version}`);
+            console.log(`   Original version: ${result.original_version}`);
+            console.log(`   Files uploaded: ${result.files_uploaded}`);
+            console.log(`   S3 prefix: ${result.s3_prefix}`);
+        }
+        catch (error) {
+            console.error("❌ Sync failed:", error instanceof Error ? error.message : error);
+            process.exit(1);
+        }
+    });
+    program
+        .command("watch")
+        .description("Watch the dist folder and sync on changes")
+        .requiredOption("--file-id <id>", "File ID of the installed app (pitcher_file.id)")
+        .option("--api-key <apiKey>", "API Key for authentication")
+        .option("--org <organization>", "Organization subdomain", "dev")
+        .option("--debounce <ms>", "Debounce time in milliseconds", "2500")
+        .action(async (options) => {
+        const apiKey = options.apiKey || process.env.NG_API_KEY;
+        if (!apiKey) {
+            console.error("Error: API key is required. Provide it via --api-key or set the NG_API_KEY environment variable.");
+            process.exit(1);
+        }
+        const distPath = findDistPath();
+        const debounceMs = parseInt(options.debounce, 10);
+        let appJson;
+        try {
+            appJson = readAppJson(distPath);
+        }
+        catch (error) {
+            console.error("❌ Could not read app.json. Make sure the dist folder exists and contains app.json.");
+            process.exit(1);
+        }
+        console.log(`👀 Watching ${distPath} for changes...`);
+        console.log(`   App: ${appJson.name}`);
+        console.log(`   Org: ${options.org}`);
+        console.log(`   File ID: ${options.fileId}`);
+        console.log(`   Debounce: ${debounceMs}ms`);
+        console.log("");
+        let syncTimeout = null;
+        let isSyncing = false;
+        const doSync = async () => {
+            if (isSyncing) {
+                console.log("⏳ Sync already in progress, queuing...");
+                syncTimeout = setTimeout(doSync, debounceMs);
+                return;
+            }
+            isSyncing = true;
+            const startTime = Date.now();
+            try {
+                const currentAppJson = readAppJson(distPath);
+                console.log(`\n🔄 Syncing ${currentAppJson.name}...`);
+                const result = await syncToApi(distPath, options.org, currentAppJson.name, options.fileId, apiKey);
+                const duration = ((Date.now() - startTime) / 1000).toFixed(1);
+                console.log(`✅ Synced in ${duration}s - ${result.files_uploaded} files`);
+            }
+            catch (error) {
+                console.error("❌ Sync failed:", error instanceof Error ? error.message : error);
+            }
+            finally {
+                isSyncing = false;
+            }
+        };
+        const watcher = chokidar.watch(distPath, {
+            persistent: true,
+            ignoreInitial: true,
+            awaitWriteFinish: {
+                stabilityThreshold: 500,
+                pollInterval: 100,
+            },
+        });
+        watcher.on("all", (_event, filePath) => {
+            if (syncTimeout) {
+                clearTimeout(syncTimeout);
+            }
+            console.log(`📝 Change detected: ${path.relative(distPath, filePath)}`);
+            syncTimeout = setTimeout(doSync, debounceMs);
+        });
+        // Initial sync
+        console.log("🚀 Initial sync...");
+        await doSync();
+        // Graceful shutdown - revert dev override
+        const shutdown = async (signal) => {
+            console.log(`\n👋 ${signal} received, reverting dev override...`);
+            watcher.close();
+            try {
+                await revertDevOverride(options.org, options.fileId, apiKey);
+            }
+            catch (error) {
+                console.error("⚠️  Failed to revert:", error instanceof Error ? error.message : error);
+            }
+            process.exit(0);
+        };
+        process.on("SIGINT", () => shutdown("SIGINT"));
+        process.on("SIGTERM", () => shutdown("SIGTERM"));
+    });
+    program
+        .command("revert")
+        .description("Revert the dev override and restore the original version")
+        .requiredOption("--file-id <id>", "File ID of the installed app (pitcher_file.id)")
+        .option("--api-key <apiKey>", "API Key for authentication")
+        .option("--org <organization>", "Organization subdomain", "dev")
+        .action(async (options) => {
+        try {
+            const apiKey = options.apiKey || process.env.NG_API_KEY;
+            if (!apiKey) {
+                console.error("Error: API key is required. Provide it via --api-key or set the NG_API_KEY environment variable.");
+                process.exit(1);
+            }
+            await revertDevOverride(options.org, options.fileId, apiKey);
+        }
+        catch (error) {
+            console.error("❌ Revert failed:", error instanceof Error ? error.message : error);
+            process.exit(1);
+        }
+    });
+    return program;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/cli-scripts",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "The Pitcher CLI for various tasks in its ecosystem.",
   "author": "Pitcher AG",
   "license": "MIT",
@@ -23,14 +23,15 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/archiver": "^6.0.3",
+    "@types/archiver": "^7.0.0",
     "@types/node": "^22.18.0",
     "typescript": "^5.9.2"
   },
   "dependencies": {
     "archiver": "^7.0.1",
     "axios": "^1.12.0",
-    "commander": "^13.1.0",
+    "chokidar": "^5.0.0",
+    "commander": "^14.0.2",
     "form-data": "^4.0.2"
   }
 }