@celonis/content-cli 1.1.0 → 1.1.2

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

@@ -60,7 +60,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 this.exportListOfPackages(packagesToExport);
             });
         }
-        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch) {
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip) {
             return __awaiter(this, void 0, void 0, function* () {
                 let exportedPackagesData;
                 if (packageKeys) {
@@ -93,12 +93,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     const extractedDirectory = file_service_1.fileService.extractExportedZipWithNestedZips(exportedPackagesZip);
                     yield this.gitService.pushToBranch(extractedDirectory, gitBranch);
                     logger_1.logger.info("Successfully exported packages to branch: " + gitBranch);
+                    fs.rmSync(extractedDirectory, { recursive: true });
                 }
                 else {
-                    const fileDownloadedMessage = "File downloaded successfully. New filename: ";
-                    const filename = `export_${(0, uuid_1.v4)()}.zip`;
-                    exportedPackagesZip.writeZip(filename);
-                    logger_1.logger.info(fileDownloadedMessage + filename);
+                    this.downloadZip(exportedPackagesZip, unzip);
                 }
             });
         }
@@ -115,17 +113,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
-        batchImportPackages(file, overwrite, gitBranch) {
+        batchImportPackages(sourcePath, overwrite, gitBranch) {
             return __awaiter(this, void 0, void 0, function* () {
-                let fileToBeImported;
+                let sourceToBeImported;
                 if (gitBranch) {
-                    fileToBeImported = yield this.gitService.pullFromBranch(gitBranch);
-                    fileToBeImported = file_service_1.fileService.zipDirectoryInBatchExportFormat(fileToBeImported);
+                    sourceToBeImported = yield this.gitService.pullFromBranch(gitBranch);
                 }
                 else {
-                    fileToBeImported = file;
+                    sourceToBeImported = sourcePath;
+                    if (file_service_1.fileService.isDirectory(sourcePath)) {
+                        sourceToBeImported = file_service_1.fileService.zipDirectoryInBatchExportFormat(sourceToBeImported);
+                    }
                 }
-                let configs = new AdmZip(fileToBeImported);
+                let configs = new AdmZip(sourceToBeImported);
                 const studioManifests = this.parseEntryData(configs, batch_export_import_constants_1.BatchExportImportConstants.STUDIO_FILE_NAME);
                 const variablesManifests = this.parseEntryData(configs, batch_export_import_constants_1.BatchExportImportConstants.VARIABLES_FILE_NAME);
                 configs = yield this.studioService.mapSpaces(configs, studioManifests);
@@ -134,7 +134,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 const postPackageImportData = yield this.batchImportExportApi.importPackages(formData, overwrite);
                 yield this.studioService.processImportedPackages(configs, existingStudioPackages, studioManifests);
                 if (gitBranch) {
-                    fs.rmSync(fileToBeImported);
+                    fs.rmSync(sourceToBeImported);
                 }
                 const reportFileName = "config_import_report_" + (0, uuid_1.v4)() + ".json";
                 file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(postPackageImportData), reportFileName);
@@ -211,6 +211,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             }
             return null;
         }
+        downloadZip(exportedZip, unzip) {
+            if (unzip) {
+                const fileDownloadedMessage = "Successful download. Downloaded directory: ";
+                const targetDirectoryName = `export_${(0, uuid_1.v4)()}`;
+                file_service_1.fileService.extractExportedZipWithNestedZipsToDir(exportedZip, targetDirectoryName);
+                logger_1.logger.info(fileDownloadedMessage + targetDirectoryName);
+            }
+            else {
+                const fileDownloadedMessage = "File downloaded successfully. New filename: ";
+                const filename = `export_${(0, uuid_1.v4)()}.zip`;
+                exportedZip.writeZip(filename);
+                logger_1.logger.info(fileDownloadedMessage + filename);
+            }
+        }
     }
     exports.BatchImportExportService = BatchImportExportService;
 });

package/commands/configuration-management/config-command.service.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", "./batch-import-export.service", "./variable.service", "./diff.service"], factory);
+        define(["require", "exports", "./batch-import-export.service", "./variable.service", "./diff.service", "../../core/utils/file-service"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -22,6 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const batch_import_export_service_1 = require("./batch-import-export.service");
     const variable_service_1 = require("./variable.service");
     const diff_service_1 = require("./diff.service");
+    const file_service_1 = require("../../core/utils/file-service");
     class ConfigCommandService {
         constructor(context) {
             this.batchImportExportService = new batch_import_export_service_1.BatchImportExportService(context);
@@ -52,20 +53,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
-        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch) {
-            return this.batchImportExportService.batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch);
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip) {
+            return this.batchImportExportService.batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip);
         }
         batchExportPackagesMetadata(packageKeys, jsonResponse) {
             return this.batchImportExportService.batchExportPackagesMetadata(packageKeys, jsonResponse);
         }
-        batchImportPackages(file, overwrite, gitBranch) {
-            if (file && gitBranch) {
-                throw new Error("You cannot use both file and gitBranch options at the same time. Only one import source can be defined.");
+        batchImportPackages(file, directory, overwrite, gitBranch) {
+            if ((directory || file) && gitBranch) {
+                throw new Error("You cannot use both file/directory and gitBranch options at the same time. Only one import source can be defined.");
             }
-            if (!file && !gitBranch) {
-                throw new Error("You must provide either a file or a gitBranch option to import packages.");
+            if (!directory && !file && !gitBranch) {
+                throw new Error("You must provide either a file/directory or a gitBranch option to import packages.");
             }
-            return this.batchImportExportService.batchImportPackages(file, overwrite, gitBranch);
+            if (file && directory) {
+                throw new Error("You cannot use both file and directory options at the same time. Only one import source can be defined.");
+            }
+            if (file && file_service_1.fileService.isDirectory(file)) {
+                throw new Error("The file option accepts only zip files.");
+            }
+            if (directory && !file_service_1.fileService.isDirectory(directory)) {
+                throw new Error("The directory option accepts only directories.");
+            }
+            const sourcePath = file !== null && file !== void 0 ? file : directory;
+            return this.batchImportExportService.batchImportPackages(sourcePath, overwrite, gitBranch);
         }
         diffPackages(file, hasChanges, jsonResponse) {
             return this.diffService.diffPackages(file, hasChanges, jsonResponse);

package/commands/configuration-management/module.js

@@ -40,6 +40,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .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", "")
+                .option("--unzip", "Unzip the exported file", "")
                 .betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
                 .betaOption("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
                 .action(this.batchExportPackages);
@@ -57,6 +58,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .betaOption("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
                 .betaOption("--gitBranch <gitBranch>", "Git branch from which you want to pull the exported file and import")
                 .option("-f, --file <file>", "Exported packages file (relative path)")
+                .option("-d, --directory <directory>", "Exported packages directory (relative path)")
                 .action(this.batchImportPackages);
             configCommand.command("diff")
                 .description("Command to diff configs of packages")
@@ -92,7 +94,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     throw new Error("Please provide either --packageKeys or --keysByVersion, but not both.");
                 }
                 options.withDependencies = (_a = options.withDependencies) !== null && _a !== void 0 ? _a : false;
-                yield new config_command_service_1.ConfigCommandService(context).batchExportPackages(options.packageKeys, options.keysByVersion, options.withDependencies, options.gitBranch);
+                yield new config_command_service_1.ConfigCommandService(context).batchExportPackages(options.packageKeys, options.keysByVersion, options.withDependencies, options.gitBranch, options.unzip);
             });
         }
         batchExportPackagesMetadata(context, command, options) {
@@ -102,7 +104,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         batchImportPackages(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                yield new config_command_service_1.ConfigCommandService(context).batchImportPackages(options.file, options.overwrite, options.gitBranch);
+                yield new config_command_service_1.ConfigCommandService(context).batchImportPackages(options.file, options.directory, options.overwrite, options.gitBranch);
             });
         }
         diffPackages(context, command, options) {

package/core/command/module-handler.js

@@ -218,8 +218,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             if (this.cmd.isBeta) {
                 return;
             }
+            const providedOptions = this.cmd.opts();
             for (const option of this.cmd.options) {
-                if (option.isBeta) {
+                const optionName = option.attributeName();
+                if (option.isBeta && Object.hasOwn(providedOptions, optionName)) {
                     logger_1.logger.info(chalk.yellow(`The option '${option.long}' is in beta and may change in future releases.`));
                 }
             }

package/core/utils/file-service.js

@@ -31,9 +31,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 encoding: "utf-8",
             });
         }
-        createDirectoryWithGivenName(dirName) {
-            fs.mkdirSync(path.resolve(process.cwd(), dirName));
-        }
         readFileToJson(fileName) {
             return __awaiter(this, void 0, void 0, function* () {
                 const fileContent = this.readFile(fileName);
@@ -49,10 +46,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         extractExportedZipWithNestedZips(zipFile) {
             const tempDir = path.join(os.tmpdir(), `${(0, uuid_1.v4)()}`);
             fs.mkdirSync(tempDir, { recursive: true });
-            zipFile.extractAllTo(tempDir, true);
-            const files = fs.readdirSync(tempDir);
+            return this.extractExportedZipWithNestedZipsToDir(zipFile, tempDir);
+        }
+        extractExportedZipWithNestedZipsToDir(zipFile, targetDir) {
+            zipFile.extractAllTo(targetDir, true);
+            const files = fs.readdirSync(targetDir);
             for (const file of files) {
-                const innerZipPath = path.join(tempDir, file);
+                const innerZipPath = path.join(targetDir, file);
                 if (file.endsWith(".zip")) {
                     const nestedZip = new AdmZip(innerZipPath);
                     const nestedDir = innerZipPath.replace(/\.zip$/, "");
@@ -61,7 +61,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                     fs.rmSync(innerZipPath); // Optionally remove the inner zip
                 }
             }
-            return tempDir;
+            return targetDir;
+        }
+        copyDirectoryToCurrentLocation(sourceDir, targetName) {
+            fs.mkdirSync(targetName, { recursive: true });
+            fs.cpSync(sourceDir, targetName, { recursive: true });
+        }
+        isDirectory(sourcePath) {
+            var _a;
+            return (_a = fs.statSync(sourcePath)) === null || _a === void 0 ? void 0 : _a.isDirectory();
         }
         zipDirectoryInBatchExportFormat(sourceDir) {
             const files = fs.readdirSync(sourceDir);

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

@@ -7,9 +7,9 @@ export declare class BatchImportExportService {
     constructor(context: Context);
     listActivePackages(flavors: string[]): Promise<void>;
     findAndExportListOfActivePackages(flavors: string[], packageKeys: string[], withDependencies: boolean): Promise<void>;
-    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;
-    batchImportPackages(file: string, overwrite: boolean, gitBranch: string): Promise<void>;
+    batchImportPackages(sourcePath: string, overwrite: boolean, gitBranch: string): Promise<void>;
     findAndExportListOfActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;
     listActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;
     private exportListOfPackages;
@@ -19,4 +19,5 @@ export declare class BatchImportExportService {
     private buildBodyForImport;
     private getReadableStream;
     private parseEntryData;
+    private downloadZip;
 }

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

@@ -6,9 +6,9 @@ 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[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
     batchExportPackagesMetadata(packageKeys: string[], jsonResponse: boolean): Promise<void>;
-    batchImportPackages(file: string, overwrite: boolean, gitBranch: string): Promise<void>;
+    batchImportPackages(file: string, directory: string, overwrite: boolean, gitBranch: string): Promise<void>;
     diffPackages(file: string, hasChanges: boolean, jsonResponse: boolean): Promise<void>;
     private listPackagesByVariableValue;
 }

package/lib/core/utils/file-service.d.ts

@@ -2,10 +2,12 @@ import AdmZip = require("adm-zip");
 export declare class FileService {
     static readonly fileDownloadedMessage = "File downloaded successfully. New filename: ";
     writeToFileWithGivenName(data: any, filename: string): void;
-    createDirectoryWithGivenName(dirName: string): void;
     readFileToJson<T>(fileName: string): Promise<T>;
     readFile(filename: string): string;
     extractExportedZipWithNestedZips(zipFile: AdmZip): string;
+    extractExportedZipWithNestedZipsToDir(zipFile: AdmZip, targetDir: string): string;
+    copyDirectoryToCurrentLocation(sourceDir: string, targetName: string): void;
+    isDirectory(sourcePath: string): boolean;
     zipDirectoryInBatchExportFormat(sourceDir: string): string;
     private getSerializedFileContent;
 }

package/package.json

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