@pitcher/cli-scripts 1.0.8 → 1.1.0

package/README.md

@@ -1,12 +1,13 @@
 # @pitcher/cli-scripts
-Pitcher CLI Tools
+
+> 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 
+p command --help
 ```
 
 
@@ -23,4 +24,8 @@ p publish-app <folder> --url https://dev.my.pitcher.com --api-key myapikey
 p publish-app --api-key myapikey
 # or for dry run and incrementing app.json's version
 p publish-app --api-key myapikey --dry-run --increment-version
+
+# Alternative: Set API key via environment variable
+export NG_API_KEY=myapikey
+p publish-app --increment-version
 ```

package/dist/src/publishApp.js

@@ -9,13 +9,19 @@ 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")
         .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);
+        }
+        options.apiKey = apiKey;
         try {
             const folderPath = path.resolve(folder);
             if (options.incrementVersion) {

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "@pitcher/cli-scripts",
-  "version": "1.0.8",
+  "version": "1.1.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.13.4",
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "archiver": "^7.0.1",
-    "axios": "^1.7.2",
-    "commander": "^12.1.0",
-    "form-data": "^4.0.0"
+    "axios": "^1.8.3",
+    "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
-```

package/dist/copyInstanceFiles.d.ts

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

package/dist/copyInstanceFiles.js

@@ -1,17 +0,0 @@
-import { Command } from "commander";
-export function createCopyInstanceFilesCommand() {
-    const program = new Command("copy-instance-files");
-    program
-        .arguments("<fromInstance> <toInstance>")
-        .requiredOption("--api-key <apiKey>", "API Key", process.env.PITCHER_API_KEY)
-        .requiredOption("--org <orgName>", "Organization Name", process.env.PITCHER_ORG)
-        .description('clone instance files into another one e.g. "p copy-instance-files <fromInstanceId> <toInstanceId> --org mondelez --api-key myapikey"')
-        .action((sourceInstanceId, destinationInstanceId, options) => {
-        console.log("clone instance files command called", {
-            sourceInstanceId,
-            destinationInstanceId,
-            options,
-        });
-    });
-    return program;
-}

package/dist/package.json

@@ -1,40 +0,0 @@
-{
-    "name": "@pitcher/cli-scripts",
-    "version": "1.0.6",
-    "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",
-        "ng-scripts"
-    ],
-    "type": "module",
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "scripts": {
-        "build": "tsc",
-        "prepublishOnly": "npm run build"
-    },
-    "bin": {
-        "p": "node --no-warnings ./dist/index.js"
-    },
-    "files": [
-        "dist"
-    ],
-    "devDependencies": {
-        "@types/archiver": "^6.0.2",
-        "@types/node": "^20.0.0",
-        "typescript": "^5.4.5"
-    },
-    "dependencies": {
-        "archiver": "^7.0.1",
-        "axios": "^1.7.2",
-        "commander": "^12.1.0",
-        "form-data": "^4.0.0"
-    }
-}

package/dist/publishApp.d.ts

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

package/dist/publishApp.js

@@ -1,93 +0,0 @@
-import { Command } from "commander";
-import archiver from "archiver";
-import axios from "axios";
-import fs from "fs";
-import path from "path";
-import FormData from "form-data";
-import { fileURLToPath } from 'url';
-export function createPublishAppCommand() {
-    const program = new Command("publish-app");
-    program
-        .arguments("[folder]")
-        .requiredOption("--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")
-        .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) => {
-        try {
-            const folderPath = path.resolve(folder);
-            if (options.incrementVersion) {
-                const appJsonPath = path.join(folderPath, "app.json");
-                if (fs.existsSync(appJsonPath)) {
-                    const appJson = JSON.parse(fs.readFileSync(appJsonPath, "utf-8"));
-                    const now = new Date();
-                    const year = now.getFullYear();
-                    const month = String(now.getMonth() + 1).padStart(2, "0");
-                    const day = String(now.getDate()).padStart(2, "0");
-                    const timestamp = now.getTime();
-                    const version = `${year}.${month}.${day}.${timestamp}`;
-                    appJson.version = version;
-                    fs.writeFileSync(appJsonPath, JSON.stringify(appJson, null, 2));
-                    console.log(`Updated app.json version to ${version}`);
-                }
-                else {
-                    console.error("app.json not found in the specified folder.");
-                    return;
-                }
-            }
-            const currentDir = path.dirname(fileURLToPath(import.meta.url));
-            const zipFilePath = path.join(currentDir, "app.zip");
-            const output = fs.createWriteStream(zipFilePath);
-            const archive = archiver("zip", {
-                zlib: { level: 9 },
-            });
-            output.on("close", async () => {
-                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/`;
-                if (options.dryRun) {
-                    console.log("Dry run mode enabled. The following data would be published:");
-                    console.log("Publish URL:", publishUrl);
-                    console.log("Headers:", {
-                        ...formData.getHeaders(),
-                        "x-api-key": options.apiKey,
-                    });
-                    console.log("app.json content:", fs.readFileSync(path.join(folderPath, "app.json"), "utf-8"));
-                    fs.unlinkSync(zipFilePath);
-                }
-                else {
-                    try {
-                        const response = await axios.post(publishUrl, formData, {
-                            headers: {
-                                ...formData.getHeaders(),
-                                "x-api-key": options.apiKey,
-                            },
-                        });
-                        console.log("Publish response:", response.data);
-                    }
-                    catch (e) {
-                        const error = e;
-                        const errData = error?.response?.data;
-                        console.error("Error publishing:", errData?.detail ?? errData);
-                    }
-                    finally {
-                        fs.unlinkSync(zipFilePath);
-                    }
-                }
-            });
-            archive.on("error", (err) => {
-                throw err;
-            });
-            archive.pipe(output);
-            archive.directory(folderPath, false);
-            await archive.finalize();
-        }
-        catch (error) {
-            console.error("Error zipping or publishing:", error);
-        }
-    });
-    return program;
-}