@celonis/content-cli 1.17.0 → 1.18.0

package/commands/configuration-management/api/package-version-api.js

@@ -24,6 +24,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         constructor(context) {
             this.httpClient = () => context.httpClient;
         }
+        findAll(packageKey) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.httpClient()
+                    .get(`/pacman/api/core/packages/${packageKey}/versions`)
+                    .catch(e => {
+                    throw new logger_1.FatalError(`Problem listing versions of Package with key '${packageKey}': ${e}`);
+                });
+            });
+        }
         findOne(packageKey, version) {
             return __awaiter(this, void 0, void 0, function* () {
                 return this.httpClient()

package/commands/configuration-management/module.js

@@ -202,6 +202,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .requiredOption("--packageVersion <packageVersion>", "Version of the package. Can be a specific version or \"LATEST\" keyword, which will return the most recently created version.")
                 .option("--json", "Return the response as a JSON file")
                 .action(this.getPackageVersion);
+            configVersionCommand.command("list")
+                .description("List all created versions of a package or branch")
+                .requiredOption("--packageKey <packageKey>", "Identifier of the package. Use <projectKey>@<branchKey> for a branch.")
+                .option("--json", "Return the response as a JSON file")
+                .action(this.listPackageVersions);
             configVersionCommand.command("create")
                 .description("Create a new version for a package")
                 .requiredOption("--packageKey <packageKey>", "Identifier of the package")
@@ -421,6 +426,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield new package_version_command_service_1.PackageVersionCommandService(context).getPackageVersion(options.packageKey, options.packageVersion, options.json);
             });
         }
+        listPackageVersions(context, command, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new package_version_command_service_1.PackageVersionCommandService(context).listPackageVersions(options.packageKey, options.json);
+            });
+        }
         createPackageVersion(context, command, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 const hasExplicitVersion = !!options.packageVersion;

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

@@ -29,6 +29,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 yield this.packageVersionService.findPackageVersion(packageKey, version, jsonResponse);
             });
         }
+        listPackageVersions(packageKey, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield this.packageVersionService.listPackageVersions(packageKey, jsonResponse);
+            });
+        }
         createPackageVersion(packageKey, version, versionBumpOption, summaryOfChanges, nodeFilterKeys, jsonResponse) {
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.packageVersionService.createPackageVersion(packageKey, version, versionBumpOption, summaryOfChanges, nodeFilterKeys, jsonResponse);

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

@@ -42,6 +42,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
+        listPackageVersions(packageKey, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const packageVersions = yield this.packageVersionApi.findAll(packageKey);
+                if (jsonResponse) {
+                    const filename = (0, uuid_1.v4)() + ".json";
+                    const writtenFilename = yield this.cuiFileService.writeToFileWithGivenName(JSON.stringify(packageVersions, null, 2), filename);
+                    logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + writtenFilename);
+                }
+                else if (packageVersions.length === 0) {
+                    logger_1.logger.info(`Package ${packageKey} has no versions.`);
+                }
+                else {
+                    packageVersions.forEach(packageVersion => logger_1.logger.info(JSON.stringify(packageVersion)));
+                }
+            });
+        }
         createPackageVersion(packageKey, version, versionBumpOption, summaryOfChanges, nodeFilterKeys, jsonResponse) {
             return __awaiter(this, void 0, void 0, function* () {
                 const request = {

package/commands/t2tc/api/t2tc-package-api.js

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

package/commands/t2tc/batch-export-import.constants.js

@@ -21,5 +21,6 @@
         BatchExportImportConstants["JSON_EXTENSION"] = ".json";
         BatchExportImportConstants["NODES_FOLDER_NAME"] = "nodes/";
         BatchExportImportConstants["SCENARIO_NODE"] = "SCENARIO";
+        BatchExportImportConstants["STAGING_VERSION"] = "staging";
     })(BatchExportImportConstants || (exports.BatchExportImportConstants = BatchExportImportConstants = {}));
 });

package/commands/t2tc/module.js

@@ -45,6 +45,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 .option("--unzip", "Unzip the exported file", "")
                 .option("--gitProfile <gitProfile>", "Git profile which you want to use for the Git operations")
                 .option("--gitBranch <gitBranch>", "Git branch in which you want to push the exported file")
+                .option("--staging", "Export the staging state of the given --packageKeys (including branch packages) instead of the latest deployed version", false)
                 .action(this.batchExportPackages);
             t2tcPackageCommand.command("import")
                 .description("Import packages from a Team-to-Team Copy archive produced by 't2tc package export'. To import a single standalone package, use 'config package import'.")
@@ -83,8 +84,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 if (options.gitProfile && !options.gitBranch) {
                     throw new Error("Please specify a branch using --gitBranch when using a Git profile.");
                 }
+                if (options.staging && options.keysByVersion) {
+                    throw new Error("Staging parameter is only supported with --packageKeys, not --keysByVersion.");
+                }
                 options.withDependencies = (_a = options.withDependencies) !== null && _a !== void 0 ? _a : false;
-                yield new t2tc_command_service_1.T2tcCommandService(context).batchExportPackages(options.packageKeys, options.keysByVersion, options.withDependencies, options.gitBranch, options.unzip);
+                yield new t2tc_command_service_1.T2tcCommandService(context).batchExportPackages(options.packageKeys, options.keysByVersion, options.withDependencies, options.gitBranch, options.unzip, options.staging);
             });
         }
         batchImportPackages(context, command, options) {

package/commands/t2tc/t2tc-command.service.js

@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 }
             });
         }
-        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip) {
-            return this.t2tcPackageService.batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip);
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip, staging = false) {
+            return this.t2tcPackageService.batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip, staging);
         }
         batchImportPackages(file, directory, overwrite, gitBranch, performValidation = false) {
             if ((directory || file) && gitBranch) {

package/commands/t2tc/t2tc-package.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", "uuid", "form-data", "stream", "adm-zip", "./batch-export-import.constants", "../../core/utils/file-service", "../../core/utils/cui-file-service", "../../core/utils/logger", "../../core/utils/json", "../studio/api/package-api", "./api/t2tc-package-api", "../configuration-management/api/variable-api", "../configuration-management/connection-variable.helper", "./studio.service", "../../core/git-profile/git/git.service", "fs", "../../core/utils/file.constants"], factory);
+        define(["require", "exports", "uuid", "form-data", "stream", "adm-zip", "./batch-export-import.constants", "../../core/utils/file-service", "../../core/utils/cui-file-service", "../../core/utils/logger", "../../core/utils/json", "../studio/api/package-api", "./api/t2tc-package-api", "../configuration-management/api/variable-api", "../configuration-management/api/staging-package-variables-api", "../configuration-management/connection-variable.helper", "./studio.service", "../../core/git-profile/git/git.service", "fs", "../../core/utils/file.constants"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -31,6 +31,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const package_api_1 = require("../studio/api/package-api");
     const t2tc_package_api_1 = require("./api/t2tc-package-api");
     const variable_api_1 = require("../configuration-management/api/variable-api");
+    const staging_package_variables_api_1 = require("../configuration-management/api/staging-package-variables-api");
     const connection_variable_helper_1 = require("../configuration-management/connection-variable.helper");
     const studio_service_1 = require("./studio.service");
     const git_service_1 = require("../../core/git-profile/git/git.service");
@@ -40,6 +41,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         constructor(context) {
             this.t2tcPackageApi = new t2tc_package_api_1.T2tcPackageApi(context);
             this.variableApi = new variable_api_1.VariableApi(context);
+            this.stagingPackageVariablesApi = new staging_package_variables_api_1.StagingPackageVariablesApi(context);
             this.studioPackageApi = new package_api_1.PackageApi(context);
             this.studioService = new studio_service_1.StudioService(context);
             this.gitService = new git_service_1.GitService(context);
@@ -77,10 +79,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 });
             });
         }
-        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip) {
+        batchExportPackages(packageKeys, packageKeysByVersion, withDependencies, gitBranch, unzip, staging = false) {
             return __awaiter(this, void 0, void 0, function* () {
                 let exportedPackagesData;
-                if (packageKeys) {
+                if (staging) {
+                    exportedPackagesData = yield this.t2tcPackageApi.exportStagingPackages(packageKeys, withDependencies);
+                }
+                else if (packageKeys) {
                     exportedPackagesData = yield this.t2tcPackageApi.exportPackages(packageKeys, withDependencies);
                 }
                 else {
@@ -178,16 +183,40 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             return versionsByPackageKey;
         }
         getVersionedVariablesForPackagesWithKeys(versionsByPackageKey) {
-            const variableExportRequest = [];
-            versionsByPackageKey === null || versionsByPackageKey === void 0 ? void 0 : versionsByPackageKey.forEach((versions, key) => {
-                versions === null || versions === void 0 ? void 0 : versions.forEach(version => {
-                    variableExportRequest.push({
-                        packageKey: key,
-                        version: version,
+            return __awaiter(this, void 0, void 0, function* () {
+                const variableExportRequest = [];
+                const stagingPackageKeys = [];
+                versionsByPackageKey === null || versionsByPackageKey === void 0 ? void 0 : versionsByPackageKey.forEach((versions, key) => {
+                    versions === null || versions === void 0 ? void 0 : versions.forEach(version => {
+                        if (version === batch_export_import_constants_1.BatchExportImportConstants.STAGING_VERSION) {
+                            stagingPackageKeys.push(key);
+                            return;
+                        }
+                        variableExportRequest.push({
+                            packageKey: key,
+                            version: version,
+                        });
+                    });
+                });
+                const versionedVariables = yield this.variableApi.findVariablesWithValuesByPackageKeysAndVersion(variableExportRequest);
+                const stagingVariables = stagingPackageKeys.length
+                    ? yield this.getStagingVariablesForPackagesWithKeys(stagingPackageKeys)
+                    : [];
+                return [...versionedVariables, ...stagingVariables];
+            });
+        }
+        getStagingVariablesForPackagesWithKeys(packageKeys) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const stagingVariables = yield this.stagingPackageVariablesApi.findAllByPackageKeys(packageKeys);
+                return stagingVariables.map(stagingVariable => {
+                    var _a;
+                    return ({
+                        packageKey: stagingVariable.packageKey,
+                        version: batch_export_import_constants_1.BatchExportImportConstants.STAGING_VERSION,
+                        variables: (_a = stagingVariable.variables) !== null && _a !== void 0 ? _a : [],
                     });
                 });
             });
-            return this.variableApi.findVariablesWithValuesByPackageKeysAndVersion(variableExportRequest);
         }
         buildBodyForImport(configs, sourcePath, variablesManifests) {
             const formData = new FormData();

package/lib/commands/configuration-management/api/package-version-api.d.ts

@@ -3,6 +3,7 @@ import { PackageVersionCreatedTransport, PackageVersionTransport, SavePackageVer
 export declare class PackageVersionApi {
     private httpClient;
     constructor(context: Context);
+    findAll(packageKey: string): Promise<PackageVersionTransport[]>;
     findOne(packageKey: string, version: string): Promise<PackageVersionTransport>;
     createVersion(packageKey: string, request: SavePackageVersionTransport): Promise<PackageVersionCreatedTransport>;
 }

package/lib/commands/configuration-management/module.d.ts

@@ -18,6 +18,7 @@ declare class Module extends IModule {
     private batchExportPackages;
     private exportPackagesMetadata;
     private getPackageVersion;
+    private listPackageVersions;
     private createPackageVersion;
     private batchImportPackages;
     private importSinglePackage;

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

@@ -3,5 +3,6 @@ export declare class PackageVersionCommandService {
     private packageVersionService;
     constructor(context: Context);
     getPackageVersion(packageKey: string, version: string, jsonResponse: boolean): Promise<void>;
+    listPackageVersions(packageKey: string, jsonResponse: boolean): Promise<void>;
     createPackageVersion(packageKey: string, version: string | undefined, versionBumpOption: string, summaryOfChanges: string | undefined, nodeFilterKeys: string[] | undefined, jsonResponse: boolean): Promise<void>;
 }

package/lib/commands/configuration-management/package-version.service.d.ts

@@ -4,6 +4,7 @@ export declare class PackageVersionService {
     private readonly cuiFileService;
     constructor(context: Context);
     findPackageVersion(packageKey: string, version: string, jsonResponse: boolean): Promise<void>;
+    listPackageVersions(packageKey: string, jsonResponse: boolean): Promise<void>;
     createPackageVersion(packageKey: string, version: string | undefined, versionBumpOption: string, summaryOfChanges: string | undefined, nodeFilterKeys: string[] | undefined, jsonResponse: boolean): Promise<void>;
     private printPackageVersionTransport;
     private printPackageVersionCreatedTransport;

package/lib/commands/t2tc/api/t2tc-package-api.d.ts

@@ -10,6 +10,7 @@ export declare class T2tcPackageApi {
     findActivePackagesByKeys(packageKeys: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
     findPackagesByKeysAndVersion(packageKeysWithVersion: string[], withDependencies?: boolean): Promise<PackageExportTransport[]>;
     exportPackages(packageKeys: string[], withDependencies: boolean): Promise<Buffer>;
+    exportStagingPackages(packageKeys: string[], withDependencies: boolean): Promise<Buffer>;
     exportPackagesByVersions(packageKeysWithVersion: string[], withDependencies: boolean): Promise<Buffer>;
     importPackages(data: FormData, overwrite: boolean, performValidation: boolean): Promise<PostPackageImportData[]>;
 }

package/lib/commands/t2tc/batch-export-import.constants.d.ts

@@ -7,5 +7,6 @@ export declare enum BatchExportImportConstants {
     ZIP_EXTENSION = ".zip",
     JSON_EXTENSION = ".json",
     NODES_FOLDER_NAME = "nodes/",
-    SCENARIO_NODE = "SCENARIO"
+    SCENARIO_NODE = "SCENARIO",
+    STAGING_VERSION = "staging"
 }

package/lib/commands/t2tc/t2tc-command.service.d.ts

@@ -5,7 +5,7 @@ export declare class T2tcCommandService {
     private stagingPackageService;
     constructor(context: Context);
     listPackages(jsonResponse: boolean, flavors: string[], withDependencies: boolean, packageKeys: string[], keysByVersion: string[], variableValue: string, variableType: string, includeBranches: boolean, staging: boolean): Promise<void>;
-    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean, staging?: boolean): Promise<void>;
     batchImportPackages(file: string, directory: string, overwrite: boolean, gitBranch: string, performValidation?: boolean): Promise<void>;
     diffPackages(file: string, hasChanges: boolean, baseVersion: string, jsonResponse: boolean): Promise<void>;
     private listPackagesByVariableValue;

package/lib/commands/t2tc/t2tc-package.service.d.ts

@@ -2,6 +2,7 @@ import { Context } from "../../core/command/cli-context";
 export declare class T2tcPackageService {
     private t2tcPackageApi;
     private variableApi;
+    private stagingPackageVariablesApi;
     private studioPackageApi;
     private studioService;
     private gitService;
@@ -10,13 +11,14 @@ export declare class T2tcPackageService {
     listActivePackages(flavors: string[], includeBranches: boolean): Promise<void>;
     findAndExportListOfPackages(flavors: string[], packageKeys: string[], keysByVersion: string[], withDependencies: boolean, includeBranches: boolean): Promise<void>;
     listPackagesByKeysWithVersion(keysByVersion: string[], withDependencies: boolean): Promise<void>;
-    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean): Promise<void>;
+    batchExportPackages(packageKeys: string[], packageKeysByVersion: string[], withDependencies: boolean, gitBranch: string, unzip: boolean, staging?: boolean): Promise<void>;
     batchImportPackages(sourcePath: string, overwrite: boolean, gitBranch: string, performValidation?: boolean): Promise<void>;
     findAndExportListOfActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string, includeBranches: boolean): Promise<void>;
     listActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string, includeBranches: boolean): Promise<void>;
     private exportListOfPackages;
     private getVersionsByPackageKey;
     private getVersionedVariablesForPackagesWithKeys;
+    private getStagingVariablesForPackagesWithKeys;
     private buildBodyForImport;
     private assertUncompressedSizeWithinLimit;
     private getReadableStream;

package/package.json

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