Merge pull request #183 from celonis/promeris/ta-2977-rename-properties

TA-2977: Rename config export properties to match API
celonis · May 22, 2024 · 1807f22 · 1807f22
2 parents 4198c61 + 1c32ab5
commit 1807f22
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 23 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "description": "CLI Tool to help manage content in Celonis EMS",
   "main": "content-cli.js",
   "bin": {

diff --git a/src/interfaces/package-export-transport.ts b/src/interfaces/package-export-transport.ts
@@ -48,18 +48,16 @@ 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 {

diff --git a/src/services/studio/studio.service.ts b/src/services/studio/studio.service.ts
@@ -160,15 +160,15 @@ class StudioService {
         const packageEntry = packageZip.getEntry("package.yml");
 
         const exportedNode: NodeExportTransport = parse(packageEntry.getData().toString());
-        const nodeContent: NodeSerializedContent = parse(exportedNode.serializedContent);
+        const nodeContent: NodeSerializedContent = parse(exportedNode.configuration);
 
         nodeContent.variables = nodeContent.variables.map(variable => ({
             ...variable,
             metadata: variable.type === PackageManagerVariableType.CONNECTION ?
                 connectionVariablesByKey.get(variable.key).metadata : variable.metadata
         }));
 
-        exportedNode.serializedContent = stringify(nodeContent);
+        exportedNode.configuration = stringify(nodeContent);
         packageZip.updateFile(packageEntry, Buffer.from(stringify(exportedNode)));
     }
 
@@ -254,9 +254,10 @@ class StudioService {
             await variableService.assignVariableValues(manifest.packageKey, manifest.runtimeVariableAssignments);
         }
     }
+
     private updateSpaceIdForNode(nodeContent: string, spaceId: string): string {
         const exportedNode: NodeExportTransport = parse(nodeContent);
-        const oldSpaceId = exportedNode.unversionedMetadata.spaceId;
+        const oldSpaceId = exportedNode.spaceId;
 
         nodeContent = nodeContent.replace(new RegExp(oldSpaceId, "g"), spaceId);
         return nodeContent;

diff --git a/tests/config/config-export.spec.ts b/tests/config/config-export.spec.ts
@@ -405,7 +405,7 @@ describe("Config export", () => {
         const firstPackageExportedZip = new AdmZip(actualZip.getEntry("key-1_1.0.0.zip").getData());
         const firstPackageExportedNode: NodeExportTransport = parse(firstPackageExportedZip.getEntry("package.yml").getData().toString());
         expect(firstPackageExportedNode).toBeTruthy();
-        const firstPackageContent: NodeSerializedContent = parse(firstPackageExportedNode.serializedContent);
+        const firstPackageContent: NodeSerializedContent = parse(firstPackageExportedNode.configuration);
         expect(firstPackageContent.variables).toHaveLength(2);
         expect(firstPackageContent.variables).toEqual([
             {
@@ -422,7 +422,7 @@ describe("Config export", () => {
         const secondPackageExportedZip = new AdmZip(actualZip.getEntry("key-2_1.0.0.zip").getData());
         const secondPackageExportedNode: NodeExportTransport = parse(secondPackageExportedZip.getEntry("package.yml").getData().toString());
         expect(secondPackageExportedNode).toBeTruthy();
-        const secondPackageContent: NodeSerializedContent = parse(secondPackageExportedNode.serializedContent);
+        const secondPackageContent: NodeSerializedContent = parse(secondPackageExportedNode.configuration);
         expect(secondPackageContent.variables).toHaveLength(2);
         expect(secondPackageContent.variables).toEqual([{
                 ...secondPackageVariableDefinition[0],
@@ -513,7 +513,7 @@ describe("Config export", () => {
         const firstPackageExportedZip = new AdmZip(actualZip.getEntry("key_with_underscores_1_1.0.0.zip").getData());
         const firstPackageExportedNode: NodeExportTransport = parse(firstPackageExportedZip.getEntry("package.yml").getData().toString());
         expect(firstPackageExportedNode).toBeTruthy();
-        const firstPackageContent: NodeSerializedContent = parse(firstPackageExportedNode.serializedContent);
+        const firstPackageContent: NodeSerializedContent = parse(firstPackageExportedNode.configuration);
         expect(firstPackageContent.variables).toHaveLength(3);
         expect(firstPackageContent.variables).toEqual([
             {

diff --git a/tests/utls/config-utils.ts b/tests/utls/config-utils.ts
@@ -59,37 +59,33 @@ export class ConfigUtils {
         };
     }
 
-    public static buildPackageNode(key: string, serializedContent: string): NodeExportTransport {
+    public static buildPackageNode(key: string, configuration: string): NodeExportTransport {
         return {
             key,
             parentNodeKey: key,
-            packageNodeKey: key,
             name: "name",
             type: "PACKAGE",
             exportSerializationType: "YAML",
-            serializedContent,
+            configuration: configuration,
             schemaVersion: 1,
-            unversionedMetadata: {},
-            versionedMetdata: {},
             invalidContent: false,
-            serializedDocument: null
+            serializedDocument: null,
+            spaceId: null
         };
     }
 
     public static buildChildNode(key: string, parentKey: string, type: string): NodeExportTransport {
         return {
             key,
             parentNodeKey: parentKey,
-            packageNodeKey: parentKey,
             name: "name",
             type: type,
             exportSerializationType: "YAML",
-            serializedContent: "",
+            configuration: "",
             schemaVersion: 1,
-            unversionedMetadata: {},
-            versionedMetdata: {},
             invalidContent: false,
-            serializedDocument: null
+            serializedDocument: null,
+            spaceId: null
         };
     }