@celonis/content-cli 1.0.6 → 1.0.8

package/commands/configuration-management/api/batch-import-export-api.js

@@ -67,6 +67,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             });
         }
+        exportPackagesByVersions(packageKeysWithVersion, withDependencies = false) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const queryParams = new URLSearchParams();
+                packageKeysWithVersion.forEach(packageKeyByVersion => queryParams.append("packageKeysWithVersion", packageKeyByVersion));
+                queryParams.set("withDependencies", withDependencies.toString());
+                return this.httpClient().getFile(`/package-manager/api/core/packages/versions/export/batch?${queryParams.toString()}`).catch(e => {
+                    throw new logger_1.FatalError(`Problem exporting packages by versions: ${e}`);
+                });
+            });
+        }
         batchExportPackagesMetadata(packageKeys) {
             return __awaiter(this, void 0, void 0, function* () {
                 const queryParams = new URLSearchParams();

package/commands/configuration-management/batch-import-export.service.js

@@ -57,9 +57,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 this.exportListOfPackages(packagesToExport);
             });
         }
-        batchExportPackages(packageKeys, withDependencies = false) {
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies = false) {
             return __awaiter(this, void 0, void 0, function* () {
-                const exportedPackagesData = yield this.batchImportExportApi.exportPackages(packageKeys, withDependencies);
+                let exportedPackagesData;
+                if (packageKeys) {
+                    exportedPackagesData = yield this.batchImportExportApi.exportPackages(packageKeys, withDependencies);
+                }
+                else {
+                    exportedPackagesData = yield this.batchImportExportApi.exportPackagesByVersions(packageKeysByVersion, withDependencies);
+                }
                 const exportedPackagesZip = new AdmZip(exportedPackagesData);
                 const manifest = (0, json_1.parse)(exportedPackagesZip.getEntry(batch_export_import_constants_1.BatchExportImportConstants.MANIFEST_FILE_NAME).getData().toString());
                 const versionsByPackageKey = this.getVersionsByPackageKey(manifest);

package/commands/configuration-management/config-command.service.js

@@ -52,8 +52,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
-        batchExportPackages(packageKeys, withDependencies = false) {
-            return this.batchImportExportService.batchExportPackages(packageKeys, withDependencies);
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies = false) {
+            return this.batchImportExportService.batchExportPackages(packageKeys, packageKeysByVersion, withDependencies);
         }
         batchExportPackagesMetadata(packageKeys, jsonResponse) {
             return this.batchImportExportService.batchExportPackagesMetadata(packageKeys, jsonResponse);

package/commands/configuration-management/module.js

@@ -37,7 +37,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .action(this.listActivePackages);
             configCommand.command("export")
                 .description("Command to export package configs")
-                .requiredOption("--packageKeys <packageKeys...>", "Keys of packages to export")
+                .option("--packageKeys <packageKeys...>", "Keys of packages to export. Exports the latest deployed version only")
+                .option("--keysByVersion <keysByVersion...>", "Keys of packages to export by version")
                 .option("--withDependencies", "Include variables and dependencies", "")
                 .action(this.batchExportPackages);
             const metadataCommand = configCommand.command("metadata")
@@ -82,7 +83,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         batchExportPackages(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                yield new config_command_service_1.ConfigCommandService(context).batchExportPackages(options.packageKeys, options.withDependencies);
+                if ((options.packageKeys && options.keysByVersion) || (!options.packageKeys && !options.keysByVersion)) {
+                    throw new Error("Please provide either --packageKeys or --keysByVersion, but not both.");
+                }
+                yield new config_command_service_1.ConfigCommandService(context).batchExportPackages(options.packageKeys, options.keysByVersion, options.withDependencies);
             });
         }
         batchExportPackagesMetadata(context, command, options) {

package/commands/configuration-management/studio.service.js

@@ -116,7 +116,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             });
         }
         fixConnectionVariable(variable) {
-            if (!variable.value.appName) {
+            var _a;
+            if (!((_a = variable.value) === null || _a === void 0 ? void 0 : _a.appName)) {
                 return variable;
             }
             return Object.assign(Object.assign({}, variable), { metadata: Object.assign(Object.assign({}, variable.metadata), { appName: variable.value.appName }) });

package/content-cli.js

@@ -14,7 +14,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "semver/functions/satisfies", "commander", "./core/command/module-handler", "./core/command/cli-context", "./core/utils/version", "./core/utils/logger"], factory);
+        define(["require", "exports", "semver/functions/satisfies", "commander", "./core/command/module-handler", "./core/command/cli-context", "./core/utils/version", "./core/utils/logger", "./core/command/CustomHelp"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -25,6 +25,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const cli_context_1 = require("./core/command/cli-context");
     const version_1 = require("./core/utils/version");
     const logger_1 = require("./core/utils/logger");
+    const CustomHelp_1 = require("./core/command/CustomHelp");
     /**
      * Celonis Content CLI.
      *
@@ -38,6 +39,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     }
     // Global configuration options
     const program = new commander_1.Command();
+    program.configureHelp({
+        formatHelp: (cmd, helper) => new CustomHelp_1.ContentCLIHelp().formatHelp(cmd, helper),
+        subcommandTerm: cmd => new CustomHelp_1.ContentCLIHelp().subcommandTerm(cmd),
+        optionTerm: opt => new CustomHelp_1.ContentCLIHelp().optionTerm(opt),
+    });
     program.version(version_1.VersionUtils.getCurrentCliVersion());
     program.option("-q, --quietmode", "Reduce output to a minimum", false);
     program.option("-p, --profile [profile]");

package/core/command/CustomHelp.js

@@ -0,0 +1,30 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "commander", "chalk"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ContentCLIHelp = void 0;
+    const commander_1 = require("commander");
+    const chalk = require("chalk");
+    class ContentCLIHelp extends commander_1.Help {
+        subcommandTerm(cmd) {
+            const base = super.subcommandTerm(cmd);
+            return cmd.isBeta === true
+                ? `${base} ${chalk.yellow("(beta)")}`
+                : base;
+        }
+        optionTerm(option) {
+            const term = super.optionTerm(option);
+            return option.isBeta === true
+                ? `${term} ${chalk.yellow("(beta)")}`
+                : term;
+        }
+    }
+    exports.ContentCLIHelp = ContentCLIHelp;
+});

package/core/command/module-handler.js

@@ -13,7 +13,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "path", "fs", "../utils/logger"], factory);
+        define(["require", "exports", "path", "fs", "commander", "../utils/logger", "chalk"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -21,7 +21,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     exports.CommandConfig = exports.Configurator = exports.ModuleHandler = exports.IModule = void 0;
     const path = require("path");
     const fs = require("fs");
+    const commander_1 = require("commander");
     const logger_1 = require("../utils/logger");
+    const chalk = require("chalk");
     class IModule {
     }
     exports.IModule = IModule;
@@ -171,6 +173,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             this.cmd.option(flags, description, defaultValue);
             return this;
         }
+        betaOption(flags, description, defaultValue) {
+            const option = new commander_1.Option(flags, description).default(defaultValue);
+            option.isBeta = true;
+            this.cmd.addOption(option);
+            return this;
+        }
         requiredOption(flags, description, defaultValue) {
             this.cmd.requiredOption(flags, description, defaultValue);
             return this;
@@ -179,9 +187,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             this.deprecationMessage = deprecationMessage;
             return this;
         }
+        beta() {
+            this.cmd.isBeta = true;
+            return this;
+        }
         action(handler) {
             this.cmd.action(() => __awaiter(this, void 0, void 0, function* () {
                 try {
+                    this.printBetaNoticeIfBetaCommand();
+                    this.printBetaNoticeIfBetaOptions();
                     this.printDeprecationNoticeIfDeprecated();
                     yield handler(this.ctx, this.cmd, this.cmd.opts());
                 }
@@ -195,6 +209,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 logger_1.logger.warn("⚠️  [DEPRECATION NOTICE] \n" + this.deprecationMessage);
             }
         }
+        printBetaNoticeIfBetaCommand() {
+            if (this.cmd.isBeta) {
+                logger_1.logger.info(chalk.yellow("This command is in beta and may change in future releases."));
+            }
+        }
+        printBetaNoticeIfBetaOptions() {
+            if (this.cmd.isBeta) {
+                return;
+            }
+            for (const option of this.cmd.options) {
+                if (option.isBeta) {
+                    logger_1.logger.info(chalk.yellow(`The option '${option.long}' is in beta and may change in future releases.`));
+                }
+            }
+        }
     }
     exports.CommandConfig = CommandConfig;
 });

package/lib/commands/configuration-management/api/batch-import-export-api.d.ts

@@ -9,6 +9,7 @@ export declare class BatchImportExportApi {
     findActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<PackageExportTransport[]>;
     findActivePackagesByKeys(packageKeys: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
     exportPackages(packageKeys: string[], withDependencies?: boolean): Promise<Buffer>;
+    exportPackagesByVersions(packageKeysWithVersion: string[], withDependencies?: boolean): Promise<Buffer>;
     batchExportPackagesMetadata(packageKeys: string[]): Promise<PackageMetadataExportTransport[]>;
     importPackages(data: FormData, overwrite: boolean): Promise<PostPackageImportData[]>;
     findVariablesWithValuesByPackageKeysAndVersion(packagesByKeyAndVersion: PackageKeyAndVersionPair[]): Promise<VariableManifestTransport[]>;

package/lib/commands/configuration-management/batch-import-export.service.d.ts

@@ -6,7 +6,7 @@ export declare class BatchImportExportService {
     constructor(context: Context);
     listActivePackages(flavors: string[]): Promise<void>;
     findAndExportListOfActivePackages(flavors: string[], packageKeys: string[], withDependencies: boolean): Promise<void>;
-    batchExportPackages(packageKeys: string[], withDependencies?: boolean): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies?: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;
     batchImportPackages(file: string, overwrite: boolean): Promise<void>;
     findAndExportListOfActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;

package/lib/commands/configuration-management/config-command.service.d.ts

@@ -6,7 +6,7 @@ export declare class ConfigCommandService {
     constructor(context: Context);
     listActivePackages(jsonResponse: boolean, flavors: string[], withDependencies: boolean, packageKeys: string[], variableValue: string, variableType: string): Promise<void>;
     listVariables(jsonResponse: boolean, keysByVersion: string[], keysByVersionFile: string): Promise<void>;
-    batchExportPackages(packageKeys: string[], withDependencies?: boolean): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies?: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;
     batchImportPackages(file: string, overwrite: boolean): Promise<void>;
     diffPackages(file: string, hasChanges: boolean, jsonResponse: boolean): Promise<void>;

package/lib/core/command/CustomHelp.d.ts

@@ -0,0 +1,5 @@
+import { Command, Help } from "commander";
+export declare class ContentCLIHelp extends Help {
+    subcommandTerm(cmd: Command): string;
+    optionTerm(option: any): string;
+}

package/lib/core/command/module-handler.d.ts

@@ -49,9 +49,13 @@ export declare class CommandConfig {
     description(description: string): CommandConfig;
     argument(name: string, description?: string, defaultValue?: unknown): CommandConfig;
     option(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
+    betaOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
     requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
     deprecationNotice(deprecationMessage: string): CommandConfig;
+    beta(): CommandConfig;
     action(handler: CommandHandler): void;
     private printDeprecationNoticeIfDeprecated;
+    private printBetaNoticeIfBetaCommand;
+    private printBetaNoticeIfBetaOptions;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "CLI Tool to help manage content in Celonis Platform",
   "main": "content-cli.js",
   "bin": {