@celonis/content-cli 0.8.2 → 0.8.4

package/api/diff-api.js

@@ -0,0 +1,37 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(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", "../services/http-client-service.v2"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.diffApi = void 0;
+    const http_client_service_v2_1 = require("../services/http-client-service.v2");
+    class DiffApi {
+        diffPackages(data) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return http_client_service_v2_1.httpClientV2.postFile("/package-manager/api/core/packages/diff/configuration", data);
+            });
+        }
+        hasChanges(data) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return http_client_service_v2_1.httpClientV2.postFile("/package-manager/api/core/packages/diff/configuration/has-changes", data);
+            });
+        }
+    }
+    DiffApi.INSTANCE = new DiffApi();
+    exports.diffApi = DiffApi.INSTANCE;
+});

package/commands/config.command.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", "../services/package-manager/batch-import-export-service", "../services/package-manager/variable-service"], factory);
+        define(["require", "exports", "../services/package-manager/batch-import-export-service", "../services/package-manager/variable-service", "../services/package-manager/diff-service"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -21,6 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     exports.ConfigCommand = void 0;
     const batch_import_export_service_1 = require("../services/package-manager/batch-import-export-service");
     const variable_service_1 = require("../services/package-manager/variable-service");
+    const diff_service_1 = require("../services/package-manager/diff-service");
     class ConfigCommand {
         listActivePackages(jsonResponse, flavors, withDependencies, packageKeys) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -48,6 +49,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         batchImportPackages(file, overwrite) {
             return batch_import_export_service_1.batchImportExportService.batchImportPackages(file, overwrite);
         }
+        diffPackages(file, hasChanges, jsonResponse) {
+            return diff_service_1.diffService.diffPackages(file, hasChanges, jsonResponse);
+        }
     }
     exports.ConfigCommand = ConfigCommand;
 });

package/content-cli-config.js

@@ -81,6 +81,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             }));
             return program;
         }
+        static diff(program) {
+            program
+                .command("diff")
+                .description("Command to diff configs of packages")
+                .option("-p, --profile <profile>", "Profile of the team/realm which you want to use to diff the packages with")
+                .option("--hasChanges", "Flag to return only the information if the package has changes without the actual changes")
+                .option("--json", "Return the response as a JSON file")
+                .requiredOption("-f, --file <file>", "Exported packages file (relative or absolute path)")
+                .action((cmd) => __awaiter(this, void 0, void 0, function* () {
+                yield new config_command_1.ConfigCommand().diffPackages(cmd.file, cmd.hasChanges, cmd.json);
+                process.exit();
+            }));
+            return program;
+        }
     }
     exports.Config = Config;
     const loadAllCommands = () => {
@@ -88,6 +102,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         Config.listVariables(commander);
         Config.export(commander);
         Config.import(commander);
+        Config.diff(commander);
         commander.parse(process.argv);
     };
     context_initializer_1.ContextInitializer.initContext()

package/interfaces/diff-package.transport.js

@@ -0,0 +1,12 @@
+(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"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/lib/api/diff-api.d.ts

@@ -0,0 +1,9 @@
+import { PackageDiffTransport } from "../interfaces/diff-package.transport";
+import * as FormData from "form-data";
+declare class DiffApi {
+    static readonly INSTANCE: DiffApi;
+    diffPackages(data: FormData): Promise<PackageDiffTransport[]>;
+    hasChanges(data: FormData): Promise<PackageDiffTransport[]>;
+}
+export declare const diffApi: DiffApi;
+export {};

package/lib/commands/config.command.d.ts

@@ -3,4 +3,5 @@ export declare class ConfigCommand {
     listVariables(jsonResponse: boolean, keysByVersion: string[], keysByVersionFile: string): Promise<void>;
     batchExportPackages(packageKeys: string[], withDependencies?: boolean): Promise<void>;
     batchImportPackages(file: string, overwrite: boolean): Promise<void>;
+    diffPackages(file: string, hasChanges: boolean, jsonResponse: boolean): Promise<void>;
 }

package/lib/content-cli-config.d.ts

@@ -5,5 +5,6 @@ export declare class Config {
     static listVariables(program: CommanderStatic): CommanderStatic;
     static export(program: CommanderStatic): CommanderStatic;
     static import(program: CommanderStatic): CommanderStatic;
+    static diff(program: CommanderStatic): CommanderStatic;
 }
 export {};

package/lib/interfaces/diff-package.transport.d.ts

@@ -0,0 +1,16 @@
+export interface ConfigurationChangeTransport {
+    op: string;
+    path: string;
+    from: string;
+    value: object;
+}
+export interface NodeDiffTransport {
+    nodeKey: string;
+    changes: ConfigurationChangeTransport[];
+}
+export interface PackageDiffTransport {
+    packageKey: string;
+    hasChanges: boolean;
+    packageChanges: ConfigurationChangeTransport[];
+    nodesWithChanges: NodeDiffTransport[];
+}

package/lib/interfaces/package-export-transport.d.ts

@@ -42,16 +42,14 @@ export interface PackageKeyAndVersionPair {
 export interface NodeExportTransport {
     key: string;
     parentNodeKey: string;
-    packageNodeKey: string;
     name: string;
     type: string;
     exportSerializationType: string;
-    serializedContent: string;
+    configuration: string;
     schemaVersion: number;
-    unversionedMetadata: any;
-    versionedMetdata: object;
+    spaceId: string;
     invalidContent?: boolean;
-    serializedDocument: Buffer;
+    serializedDocument?: Buffer;
 }
 export interface NodeSerializedContent {
     variables: VariableDefinition[];

package/lib/services/package-manager/diff-service.d.ts

@@ -0,0 +1,11 @@
+declare class DiffService {
+    diffPackages(file: string, hasChanges: boolean, jsonResponse: boolean): Promise<void>;
+    private hasChanges;
+    private diffPackagesAndReturnDiff;
+    private buildBodyForDiff;
+    private getReadableStream;
+    private exportListOfPackageDiffs;
+    private buildStringResponse;
+}
+export declare const diffService: DiffService;
+export {};

package/package.json

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

package/services/package-manager/diff-service.js

@@ -0,0 +1,90 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(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", "adm-zip", "stream", "form-data", "../../api/diff-api", "../file-service", "../../util/logger", "uuid"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.diffService = void 0;
+    const AdmZip = require("adm-zip");
+    const stream_1 = require("stream");
+    const FormData = require("form-data");
+    const diff_api_1 = require("../../api/diff-api");
+    const file_service_1 = require("../file-service");
+    const logger_1 = require("../../util/logger");
+    const uuid_1 = require("uuid");
+    class DiffService {
+        diffPackages(file, hasChanges, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (hasChanges) {
+                    yield this.hasChanges(file, jsonResponse);
+                }
+                else {
+                    yield this.diffPackagesAndReturnDiff(file, jsonResponse);
+                }
+            });
+        }
+        hasChanges(file, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const packages = new AdmZip(file);
+                const formData = this.buildBodyForDiff(packages);
+                const returnedHasChangesData = yield diff_api_1.diffApi.hasChanges(formData);
+                if (jsonResponse) {
+                    this.exportListOfPackageDiffs(returnedHasChangesData);
+                }
+                else {
+                    logger_1.logger.info(this.buildStringResponse(returnedHasChangesData));
+                }
+            });
+        }
+        diffPackagesAndReturnDiff(file, jsonResponse) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const packages = new AdmZip(file);
+                const formData = this.buildBodyForDiff(packages);
+                const returnedHasChangesData = yield diff_api_1.diffApi.diffPackages(formData);
+                if (jsonResponse) {
+                    this.exportListOfPackageDiffs(returnedHasChangesData);
+                }
+                else {
+                    logger_1.logger.info(this.buildStringResponse(returnedHasChangesData));
+                }
+            });
+        }
+        buildBodyForDiff(packages) {
+            const formData = new FormData();
+            const readableStream = this.getReadableStream(packages);
+            formData.append("file", readableStream, { filename: "packages.zip" });
+            return formData;
+        }
+        getReadableStream(packages) {
+            return new stream_1.Readable({
+                read() {
+                    this.push(packages.toBuffer());
+                    this.push(null);
+                }
+            });
+        }
+        exportListOfPackageDiffs(packageDiffs) {
+            const filename = (0, uuid_1.v4)() + ".json";
+            file_service_1.fileService.writeToFileWithGivenName(JSON.stringify(packageDiffs), filename);
+            logger_1.logger.info(file_service_1.FileService.fileDownloadedMessage + filename);
+        }
+        buildStringResponse(packageDiffs) {
+            return "\n" + JSON.stringify(packageDiffs, null, 2);
+        }
+    }
+    exports.diffService = new DiffService();
+});

package/services/studio/studio.service.js

@@ -129,10 +129,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             }
             const packageEntry = packageZip.getEntry("package.yml");
             const exportedNode = (0, yaml_1.parse)(packageEntry.getData().toString());
-            const nodeContent = (0, yaml_1.parse)(exportedNode.serializedContent);
+            const nodeContent = (0, yaml_1.parse)(exportedNode.configuration);
             nodeContent.variables = nodeContent.variables.map(variable => (Object.assign(Object.assign({}, variable), { metadata: variable.type === package_manager_interfaces_1.PackageManagerVariableType.CONNECTION ?
                     connectionVariablesByKey.get(variable.key).metadata : variable.metadata })));
-            exportedNode.serializedContent = (0, yaml_1.stringify)(nodeContent);
+            exportedNode.configuration = (0, yaml_1.stringify)(nodeContent);
             packageZip.updateFile(packageEntry, Buffer.from((0, yaml_1.stringify)(exportedNode)));
         }
         getPackageKeyAndVersion(zipName) {
@@ -211,7 +211,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         }
         updateSpaceIdForNode(nodeContent, spaceId) {
             const exportedNode = (0, yaml_1.parse)(nodeContent);
-            const oldSpaceId = exportedNode.unversionedMetadata.spaceId;
+            const oldSpaceId = exportedNode.spaceId;
             nodeContent = nodeContent.replace(new RegExp(oldSpaceId, "g"), spaceId);
             return nodeContent;
         }