@celonis/content-cli 0.9.0 → 0.11.0

package/interfaces/batch-export-import-constants.js

@@ -12,13 +12,13 @@
     exports.BatchExportImportConstants = void 0;
     var BatchExportImportConstants;
     (function (BatchExportImportConstants) {
-        BatchExportImportConstants["STUDIO_FILE_NAME"] = "studio.yml";
-        BatchExportImportConstants["VARIABLES_FILE_NAME"] = "variables.yml";
-        BatchExportImportConstants["MANIFEST_FILE_NAME"] = "manifest.yml";
+        BatchExportImportConstants["STUDIO_FILE_NAME"] = "studio.json";
+        BatchExportImportConstants["VARIABLES_FILE_NAME"] = "variables.json";
+        BatchExportImportConstants["MANIFEST_FILE_NAME"] = "manifest.json";
         BatchExportImportConstants["STUDIO"] = "STUDIO";
         BatchExportImportConstants["APP_MODE_VIEWER"] = "VIEWER";
         BatchExportImportConstants["ZIP_EXTENSION"] = ".zip";
-        BatchExportImportConstants["YAML_EXTENSION"] = ".yml";
+        BatchExportImportConstants["JSON_EXTENSION"] = ".json";
         BatchExportImportConstants["NODES_FOLDER_NAME"] = "nodes/";
         BatchExportImportConstants["SCENARIO_NODE"] = "SCENARIO";
     })(BatchExportImportConstants || (exports.BatchExportImportConstants = BatchExportImportConstants = {}));

package/lib/interfaces/batch-export-import-constants.d.ts

@@ -1,11 +1,11 @@
 export declare enum BatchExportImportConstants {
-    STUDIO_FILE_NAME = "studio.yml",
-    VARIABLES_FILE_NAME = "variables.yml",
-    MANIFEST_FILE_NAME = "manifest.yml",
+    STUDIO_FILE_NAME = "studio.json",
+    VARIABLES_FILE_NAME = "variables.json",
+    MANIFEST_FILE_NAME = "manifest.json",
     STUDIO = "STUDIO",
     APP_MODE_VIEWER = "VIEWER",
     ZIP_EXTENSION = ".zip",
-    YAML_EXTENSION = ".yml",
+    JSON_EXTENSION = ".json",
     NODES_FOLDER_NAME = "nodes/",
     SCENARIO_NODE = "SCENARIO"
 }

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

@@ -7,12 +7,32 @@ export interface ConfigurationChangeTransport {
 export interface NodeDiffTransport {
     nodeKey: string;
     changes: ConfigurationChangeTransport[];
+    baseConfiguration: NodeConfiguration;
+}
+export interface NodeConfiguration {
+    [key: string]: any;
 }
 export interface PackageDiffTransport {
     packageKey: string;
+    basePackageConfiguration: PackageConfiguration;
     packageChanges: ConfigurationChangeTransport[];
     nodesWithChanges: NodeDiffTransport[];
 }
+export interface PackageConfiguration {
+    variables?: VariableDefinition[];
+    dependencies?: PackageDependency[];
+    [key: string]: any;
+}
+export interface PackageDependency {
+    key: string;
+    version: string;
+    [key: string]: any;
+}
+export interface VariableDefinition {
+    key: string;
+    type: string;
+    [key: string]: any;
+}
 export interface PackageDiffMetadata {
     packageKey: string;
     hasChanges: boolean;

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

@@ -45,14 +45,15 @@ export interface NodeExportTransport {
     name: string;
     type: string;
     exportSerializationType: string;
-    configuration: string;
+    configuration: NodeConfiguration;
     schemaVersion: number;
     spaceId: string;
     invalidContent?: boolean;
     serializedDocument?: Buffer;
 }
-export interface NodeSerializedContent {
-    variables: VariableDefinition[];
+export interface NodeConfiguration {
+    variables?: VariableDefinition[];
+    [key: string]: any;
 }
 export interface StudioPackageManifest {
     packageKey: string;

package/lib/util/json.d.ts

@@ -0,0 +1,2 @@
+export declare function stringify(data: any): string;
+export declare function parse<T>(data: string): T;

package/package.json

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

package/services/package-manager/batch-import-export-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", "../../api/batch-import-export-api", "../../util/logger", "uuid", "../file-service", "../studio/studio.service", "../../util/yaml", "form-data", "../../interfaces/batch-export-import-constants", "../../api/package-api", "stream", "adm-zip"], factory);
+        define(["require", "exports", "../../api/batch-import-export-api", "../../util/logger", "uuid", "../file-service", "../studio/studio.service", "../../util/json", "form-data", "../../interfaces/batch-export-import-constants", "../../api/package-api", "stream", "adm-zip"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -24,7 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const uuid_1 = require("uuid");
     const file_service_1 = require("../file-service");
     const studio_service_1 = require("../studio/studio.service");
-    const yaml_1 = require("../../util/yaml");
+    const json_1 = require("../../util/json");
     const FormData = require("form-data");
     const batch_export_import_constants_1 = require("../../interfaces/batch-export-import-constants");
     const package_api_1 = require("../../api/package-api");
@@ -56,15 +56,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             return __awaiter(this, void 0, void 0, function* () {
                 const exportedPackagesData = yield batch_import_export_api_1.batchImportExportApi.exportPackages(packageKeys, withDependencies);
                 const exportedPackagesZip = new AdmZip(exportedPackagesData);
-                const manifest = (0, yaml_1.parse)(exportedPackagesZip.getEntry(batch_export_import_constants_1.BatchExportImportConstants.MANIFEST_FILE_NAME).getData().toString());
+                const manifest = (0, json_1.parse)(exportedPackagesZip.getEntry(batch_export_import_constants_1.BatchExportImportConstants.MANIFEST_FILE_NAME).getData().toString());
                 const versionsByPackageKey = this.getVersionsByPackageKey(manifest);
                 let exportedVariables = yield this.getVersionedVariablesForPackagesWithKeys(versionsByPackageKey);
                 exportedVariables = studio_service_1.studioService.fixConnectionVariables(exportedVariables);
-                exportedPackagesZip.addFile(batch_export_import_constants_1.BatchExportImportConstants.VARIABLES_FILE_NAME, Buffer.from((0, yaml_1.stringify)(exportedVariables), "utf8"));
+                exportedPackagesZip.addFile(batch_export_import_constants_1.BatchExportImportConstants.VARIABLES_FILE_NAME, Buffer.from((0, json_1.stringify)(exportedVariables), "utf8"));
                 const studioPackageKeys = manifest.filter(packageManifest => packageManifest.flavor === batch_export_import_constants_1.BatchExportImportConstants.STUDIO)
                     .map(packageManifest => packageManifest.packageKey);
                 const studioData = yield studio_service_1.studioService.getStudioPackageManifests(studioPackageKeys);
-                exportedPackagesZip.addFile(batch_export_import_constants_1.BatchExportImportConstants.STUDIO_FILE_NAME, Buffer.from((0, yaml_1.stringify)(studioData), "utf8"));
+                exportedPackagesZip.addFile(batch_export_import_constants_1.BatchExportImportConstants.STUDIO_FILE_NAME, Buffer.from((0, json_1.stringify)(studioData), "utf8"));
                 exportedPackagesZip.getEntries().forEach(entry => {
                     if (entry.name.endsWith(batch_export_import_constants_1.BatchExportImportConstants.ZIP_EXTENSION)) {
                         const lastUnderscoreIndex = entry.name.lastIndexOf("_");
@@ -142,7 +142,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         parseEntryData(configs, fileName) {
             const entry = configs.getEntry(fileName);
             if (entry) {
-                return ((0, yaml_1.parse)(entry.getData().toString()));
+                return ((0, json_1.parse)(entry.getData().toString()));
             }
             return null;
         }

package/services/studio/studio.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", "../../api/package-api", "../../interfaces/package-manager.interfaces", "../package-manager/datamodel-service", "../../util/yaml", "../../api/node-api", "../../api/variables-api", "../../api/space-api", "../package-manager/space-service", "../package-manager/variable-service", "../../interfaces/batch-export-import-constants", "adm-zip"], factory);
+        define(["require", "exports", "../../api/package-api", "../../interfaces/package-manager.interfaces", "../package-manager/datamodel-service", "../../util/json", "../../api/node-api", "../../api/variables-api", "../../api/space-api", "../package-manager/space-service", "../package-manager/variable-service", "../../interfaces/batch-export-import-constants", "adm-zip"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const package_api_1 = require("../../api/package-api");
     const package_manager_interfaces_1 = require("../../interfaces/package-manager.interfaces");
     const datamodel_service_1 = require("../package-manager/datamodel-service");
-    const yaml_1 = require("../../util/yaml");
+    const json_1 = require("../../util/json");
     const node_api_1 = require("../../api/node-api");
     const variables_api_1 = require("../../api/variables-api");
     const space_api_1 = require("../../api/space-api");
@@ -113,9 +113,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             return Object.assign(Object.assign({}, variable), { metadata: Object.assign(Object.assign({}, variable.metadata), { appName: variable.value.appName }) });
         }
         deleteScenarioAssets(packageZip) {
-            packageZip.getEntries().filter(entry => entry.entryName.startsWith(batch_export_import_constants_1.BatchExportImportConstants.NODES_FOLDER_NAME) && entry.entryName.endsWith(batch_export_import_constants_1.BatchExportImportConstants.YAML_EXTENSION))
+            packageZip.getEntries().filter(entry => entry.entryName.startsWith(batch_export_import_constants_1.BatchExportImportConstants.NODES_FOLDER_NAME) && entry.entryName.endsWith(batch_export_import_constants_1.BatchExportImportConstants.JSON_EXTENSION))
                 .forEach(entry => {
-                const node = (0, yaml_1.parse)(entry.getData().toString());
+                const node = (0, json_1.parse)(entry.getData().toString());
                 if (node.type === batch_export_import_constants_1.BatchExportImportConstants.SCENARIO_NODE) {
                     packageZip.deleteFile(entry);
                 }
@@ -127,13 +127,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             if (connectionVariablesByKey.size === 0) {
                 return;
             }
-            const packageEntry = packageZip.getEntry("package.yml");
-            const exportedNode = (0, yaml_1.parse)(packageEntry.getData().toString());
-            const nodeContent = (0, yaml_1.parse)(exportedNode.configuration);
+            const packageEntry = packageZip.getEntry("package.json");
+            const exportedNode = (0, json_1.parse)(packageEntry.getData().toString());
+            const nodeContent = 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.configuration = (0, yaml_1.stringify)(nodeContent);
-            packageZip.updateFile(packageEntry, Buffer.from((0, yaml_1.stringify)(exportedNode)));
+            packageZip.updateFile(packageEntry, Buffer.from((0, json_1.stringify)(exportedNode)));
         }
         getPackageKeyAndVersion(zipName) {
             const lastUnderscoreIndex = zipName.lastIndexOf("_");
@@ -168,7 +167,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                                 studioManifest.space.id = spaceId;
                                 const packageZip = new AdmZip(file.getData());
                                 packageZip.getEntries().forEach(nodeFile => {
-                                    if (nodeFile.entryName.endsWith(batch_export_import_constants_1.BatchExportImportConstants.YAML_EXTENSION)) {
+                                    if (nodeFile.entryName.endsWith(batch_export_import_constants_1.BatchExportImportConstants.JSON_EXTENSION)) {
                                         const updatedNodeFile = this.updateSpaceIdForNode(nodeFile.getData().toString(), spaceId);
                                         packageZip.updateFile(nodeFile, Buffer.from(updatedNodeFile));
                                     }
@@ -210,7 +209,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             });
         }
         updateSpaceIdForNode(nodeContent, spaceId) {
-            const exportedNode = (0, yaml_1.parse)(nodeContent);
+            const exportedNode = (0, json_1.parse)(nodeContent);
             const oldSpaceId = exportedNode.spaceId;
             nodeContent = nodeContent.replace(new RegExp(oldSpaceId, "g"), spaceId);
             return nodeContent;

package/util/json.js

@@ -0,0 +1,27 @@
+(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 });
+    exports.parse = exports.stringify = void 0;
+    function stringify(data) {
+        return JSON.stringify(data, replacer, 2);
+    }
+    exports.stringify = stringify;
+    function parse(data) {
+        return JSON.parse(data);
+    }
+    exports.parse = parse;
+    const replacer = (key, value) => {
+        if (value instanceof Map) {
+            return Object.fromEntries(value);
+        }
+        return value;
+    };
+});