@pitcher/cli-scripts 1.0.9 → 2.0.0

package/README.md

@@ -2,26 +2,46 @@
 
 > Pitcher CLI Tools provide a suite of command-line utilities to streamline your workflow. For the best experience, we recommend installing the tools globally using `npm install -g @pitcher/cli-scripts`.
 
-
 ## Help
+
 ```bash
 p --help
 # or for specific command help:
 p command --help
 ```
 
-
-## To run the `copy-instance-files` command:
-
-```bash
-p copy-instance-files <fromInstance> <toInstance> --org pitcher --api-key myapikey
-```
-
 ## To run the `publish-app` command:
+
 ```bash
+# Basic usage
 p publish-app <folder> --url https://dev.my.pitcher.com --api-key myapikey
-# or for current folder and dev org
+
+# Publish to current folder and dev org
 p publish-app --api-key myapikey
-# or for dry run and incrementing app.json's version
+
+# Dry run with version increment
 p publish-app --api-key myapikey --dry-run --increment-version
+
+# Publish and install to specific instances
+p publish-app --api-key myapikey --increment-version --install-to "01HG0C5NS1BTQ2ZPE1XCGKSGDH, 01HG0C5NS1BTQ2ZPE1XCGKSGDA"
+
+# Publish and install to all instances with a specific environment name
+p publish-app --api-key myapikey --increment-version --install-to-env-name "Demo"
+
+# Combine both: install to specific instances AND all instances in an environment
+p publish-app --api-key myapikey --increment-version --install-to "01HG0C5NS1BTQ2ZPE1XCGKSGDH" --install-to-env-name "Demo"
+
+# Alternative: Set API key via environment variable
+export NG_API_KEY=myapikey
+p publish-app --increment-version --install-to-env-name "Production"
 ```
+
+### Options
+
+- `--api-key <apiKey>`: API Key for authentication (can also use `NG_API_KEY` env variable)
+- `--org <organization>`: Organization subdomain (default: "dev")
+- `--increment-version`: Increment version in app.json with timestamp
+- `--dry-run`: Perform a dry run without publishing
+- `--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

package/dist/index.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 import { Command } from "commander";
-import { createCopyInstanceFilesCommand } from "./src/copyInstanceFiles.js";
 import { createPublishAppCommand } from "./src/publishApp.js";
 import { readFileSync } from "fs";
 import { fileURLToPath } from "url";
@@ -14,6 +13,5 @@ program
     .description("The Pitcher CLI for various tasks in its ecosystem.")
     .version(pkg.version);
 // Add subcommands
-program.addCommand(createCopyInstanceFilesCommand());
 program.addCommand(createPublishAppCommand());
 program.parse(process.argv);

package/dist/src/publishApp.js

@@ -4,18 +4,97 @@ import axios from "axios";
 import fs from "fs";
 import path from "path";
 import FormData from "form-data";
-import { fileURLToPath } from 'url';
+import { fileURLToPath } from "url";
+async function fetchAllInstances(baseUrl, apiKey) {
+    try {
+        const response = await axios.get(`${baseUrl}/api/v1/instances`, {
+            headers: {
+                accept: "application/json",
+                "x-api-key": apiKey,
+            },
+        });
+        const instances = response.data.results || response.data;
+        console.log(`Fetched ${instances.length} total instance(s) from API`);
+        return instances;
+    }
+    catch (error) {
+        const axiosError = error;
+        console.error("Error fetching instances:", axiosError?.response?.data?.detail ?? axiosError.message);
+        return [];
+    }
+}
+function filterInstancesByEnvName(instances, envName) {
+    const filtered = instances.filter((instance) => instance.env_name === envName);
+    if (filtered.length === 0) {
+        console.warn(`No instances found with environment name "${envName}"`);
+    }
+    else {
+        console.log(`Found ${filtered.length} instance(s) with environment name "${envName}"`);
+    }
+    return filtered;
+}
+function validateInstanceIds(instances, requestedIds) {
+    const instanceMap = new Map(instances.map((inst) => [inst.id, inst]));
+    const valid = [];
+    const invalid = [];
+    for (const id of requestedIds) {
+        const instance = instanceMap.get(id);
+        if (instance) {
+            valid.push(instance);
+        }
+        else {
+            invalid.push(id);
+        }
+    }
+    return { valid, invalid };
+}
+async function installAppToInstances(baseUrl, apiKey, appName, instances) {
+    if (instances.length === 0) {
+        console.log("No instances to install to.");
+        return;
+    }
+    const instanceIds = instances.map((inst) => inst.id);
+    console.log(`\nInstalling app "${appName}" to ${instances.length} instance(s):`);
+    instances.forEach((inst) => {
+        console.log(`  - ${inst.id}${inst.env_name ? ` (${inst.env_name})` : ""}${inst.name ? ` - ${inst.name}` : ""}`);
+    });
+    try {
+        const response = await axios.post(`${baseUrl}/api/v1/apps/${appName}/install/`, { instance_ids: instanceIds }, {
+            headers: {
+                accept: "application/json",
+                "content-type": "application/json",
+                "x-api-key": apiKey,
+            },
+        });
+        console.log("\nInstallation response:", response.data);
+        console.log(`✓ Successfully installed app to ${instances.length} instance(s)`);
+    }
+    catch (error) {
+        const axiosError = error;
+        console.error("\n✗ Error installing app:", axiosError?.response?.data?.detail ?? axiosError.message);
+    }
+}
 export function createPublishAppCommand() {
     const program = new Command("publish-app");
     program
         .arguments("[folder]")
-        .requiredOption("--api-key <apiKey>", "API Key for authentication")
+        .option("--api-key <apiKey>", "API Key for authentication")
         .option("--org <organization>", "Organization subdomain", "dev")
         .option("--increment-version", "Increment version in app.json")
         .option("--dry-run", "Perform a dry run without publishing")
         .option("--publish-url <url>", "Explicit publish URL")
+        .option("--install-to <instanceIds>", "Comma-separated list of instance IDs to install the app to after publishing")
+        .option("--install-to-env-name <envName>", "Environment name to filter instances and install the app to after publishing")
         .description('zip the contents of a folder and publish as an app to a pitcher org URL. for current folder: "p publish-app --api-key myapikey"')
         .action(async (folder = ".", 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);
+        }
+        if (!options.publishUrl && !options.org)
+            options.org = "dev";
+        options.apiKey = apiKey;
         try {
             const folderPath = path.resolve(folder);
             if (options.incrementVersion) {
@@ -47,7 +126,8 @@ export function createPublishAppCommand() {
                 console.log(`Zipped ${archive.pointer()} total bytes`);
                 const formData = new FormData();
                 formData.append("file", fs.createReadStream(zipFilePath));
-                const publishUrl = options.publishUrl || `https://${options.org}.my.pitcher.com/api/v1/apps/publish/`;
+                const publishUrl = options.publishUrl ||
+                    `https://${options.org}.my.pitcher.com/api/v1/apps/publish/`;
                 if (options.dryRun) {
                     console.log("Dry run mode enabled. The following data would be published:");
                     console.log("Publish URL:", publishUrl);
@@ -67,6 +147,51 @@ export function createPublishAppCommand() {
                             },
                         });
                         console.log("Publish response:", response.data);
+                        const baseUrl = options.publishUrl
+                            ? new URL(options.publishUrl).origin
+                            : `https://${options.org}.my.pitcher.com`;
+                        const appName = response.data?.app?.name;
+                        if (!appName) {
+                            console.warn("Could not determine app name from publish response");
+                        }
+                        else if (options.installTo || options.installToEnvName) {
+                            console.log("\n--- Starting installation process ---");
+                            const allInstances = await fetchAllInstances(baseUrl, options.apiKey);
+                            if (allInstances.length === 0) {
+                                console.warn("Cannot proceed with installation: no instances available");
+                            }
+                            else {
+                                let targetInstances = [];
+                                if (options.installTo) {
+                                    const requestedIds = options.installTo
+                                        .split(",")
+                                        .map((id) => id.trim())
+                                        .filter(Boolean);
+                                    console.log(`\nValidating ${requestedIds.length} requested instance ID(s)...`);
+                                    const { valid, invalid } = validateInstanceIds(allInstances, requestedIds);
+                                    if (invalid.length > 0) {
+                                        console.warn(`⚠ Warning: ${invalid.length} invalid instance ID(s) will be skipped:`);
+                                        invalid.forEach((id) => console.warn(`  - ${id}`));
+                                    }
+                                    if (valid.length > 0) {
+                                        console.log(`✓ Found ${valid.length} valid instance(s)`);
+                                        targetInstances = [...targetInstances, ...valid];
+                                    }
+                                }
+                                if (options.installToEnvName) {
+                                    console.log(`\nFiltering instances by environment name: "${options.installToEnvName}"`);
+                                    const envInstances = filterInstancesByEnvName(allInstances, options.installToEnvName);
+                                    targetInstances = [...targetInstances, ...envInstances];
+                                }
+                                const uniqueInstances = Array.from(new Map(targetInstances.map((inst) => [inst.id, inst])).values());
+                                if (uniqueInstances.length > 0) {
+                                    await installAppToInstances(baseUrl, options.apiKey, appName, uniqueInstances);
+                                }
+                                else {
+                                    console.log("\nNo valid instances found to install to.");
+                                }
+                            }
+                        }
                     }
                     catch (e) {
                         const error = e;

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "@pitcher/cli-scripts",
-  "version": "1.0.9",
+  "version": "2.0.0",
   "description": "The Pitcher CLI for various tasks in its ecosystem.",
   "author": "Pitcher AG",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/PitcherAG/ng-scripts.git"
-  },
   "keywords": [
     "pitcher",
     "cli",
@@ -27,14 +23,14 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/archiver": "^6.0.2",
-    "@types/node": "^20.0.0",
-    "typescript": "^5.4.5"
+    "@types/archiver": "^6.0.3",
+    "@types/node": "^22.18.0",
+    "typescript": "^5.9.2"
   },
   "dependencies": {
     "archiver": "^7.0.1",
-    "axios": "^1.7.2",
-    "commander": "^12.1.0",
-    "form-data": "^4.0.0"
+    "axios": "^1.12.0",
+    "commander": "^13.1.0",
+    "form-data": "^4.0.2"
   }
 }

package/README.internal.md

@@ -1,21 +0,0 @@
-## To install dependencies:
-
-```bash
-yarn install
-```
-
-## To work on it
-
-```bash
-# at the root folder:
-npm link
-```
-
-## To use version from npm globally installed
-
-```bash
-# anywhere:
-npm unlink @pitcher/cli-scripts
-# then
-npm install -g @pitcher/cli-scripts
-```