@celonis/content-cli 1.0.5 → 1.0.7

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

@@ -67,6 +67,25 @@ 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();
+                packageKeys.forEach(packageKey => queryParams.append("packageKeys", packageKey));
+                return this.httpClient().get(`/package-manager/api/core/packages/metadata/export?${queryParams.toString()}`).catch(e => {
+                    throw new logger_1.FatalError(`Problem exporting packages metadata: ${e}`);
+                });
+            });
+        }
         importPackages(data, overwrite) {
             return __awaiter(this, void 0, void 0, function* () {
                 return this.httpClient().postFile("/package-manager/api/core/packages/import/batch", data, { overwrite });

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);
@@ -86,6 +92,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 logger_1.logger.info(fileDownloadedMessage + filename);
             });
         }
+        batchExportPackagesMetadata(packageKeys, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const exportedPackagesMetadata = yield this.batchImportExportApi.batchExportPackagesMetadata(packageKeys);
+                if (jsonResponse) {
+                    this.exportListOfPackagesMetadata(exportedPackagesMetadata);
+                }
+                else {
+                    exportedPackagesMetadata.forEach(pkg => {
+                        logger_1.logger.info(`${pkg.key} - Has Unpublished Changes: ${pkg.hasUnpublishedChanges}`);
+                    });
+                }
+            });
+        }
         batchImportPackages(file, overwrite) {
             return __awaiter(this, void 0, void 0, function* () {
                 let configs = new AdmZip(file);
@@ -140,6 +159,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             });
             return this.batchImportExportApi.findVariablesWithValuesByPackageKeysAndVersion(variableExportRequest);
         }
+        exportListOfPackagesMetadata(packagesMetadata) {
+            const filename = (0, uuid_1.v4)() + ".json";
+            file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(packagesMetadata), filename);
+            logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
+        }
         buildBodyForImport(configs, variablesManifests) {
             const formData = new FormData();
             const readableStream = this.getReadableStream(configs);

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

@@ -52,8 +52,11 @@ 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);
         }
         batchImportPackages(file, overwrite) {
             return this.batchImportExportService.batchImportPackages(file, overwrite);

package/commands/configuration-management/module.js

@@ -37,9 +37,18 @@ 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")
+                .description("Commands related to package metadata");
+            metadataCommand
+                .command("export")
+                .description("Command to show whether packages have unpublished changes")
+                .requiredOption("--packageKeys <packageKeys...>", "Keys of packages to find the metadata of")
+                .option("--json", "Return response as json type", "")
+                .action(this.batchExportPackagesMetadata);
             configCommand.command("import")
                 .description("Command to import package configs")
                 .option("--overwrite", "Flag to allow overwriting of packages")
@@ -74,7 +83,15 @@ 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) {
+            return __awaiter(this, void 0, void 0, function* () {
+                yield new config_command_service_1.ConfigCommandService(context).batchExportPackagesMetadata(options.packageKeys, options.json);
             });
         }
         batchImportPackages(context, command, options) {

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as FormData from "form-data";
-import { PackageExportTransport, PackageKeyAndVersionPair, PostPackageImportData, VariableManifestTransport } from "../interfaces/package-export.interfaces";
+import { PackageExportTransport, PackageKeyAndVersionPair, PackageMetadataExportTransport, PostPackageImportData, VariableManifestTransport } from "../interfaces/package-export.interfaces";
 import { Context } from "../../../core/command/cli-context";
 export declare class BatchImportExportApi {
     private httpClient;
@@ -9,6 +9,8 @@ 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,13 +6,15 @@ 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>;
     listActivePackagesByVariableValue(flavors: string[], variableValue: string, variableType: string): Promise<void>;
     private exportListOfPackages;
     private getVersionsByPackageKey;
     private getVersionedVariablesForPackagesWithKeys;
+    private exportListOfPackagesMetadata;
     private buildBodyForImport;
     private getReadableStream;
     private parseEntryData;

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

@@ -6,7 +6,8 @@ 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>;
     private listPackagesByVariableValue;

package/lib/commands/configuration-management/interfaces/package-export.interfaces.d.ts

@@ -18,6 +18,10 @@ export interface PackageExportTransport {
     spaceId?: string;
     datamodels?: StudioComputeNodeDescriptor[];
 }
+export interface PackageMetadataExportTransport {
+    key: string;
+    hasUnpublishedChanges: boolean;
+}
 export interface PackageManifestTransport {
     packageKey: string;
     flavor: string;

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

@@ -7,6 +7,7 @@ declare class Module extends IModule {
     register(context: Context, configurator: Configurator): void;
     private listActivePackages;
     private batchExportPackages;
+    private batchExportPackagesMetadata;
     private batchImportPackages;
     private diffPackages;
     private listVariables;

package/package.json

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