DXCDT-372: Traverse assets tree for preservable fields

src/keywordPreservation.ts

@@ -12,3 +12,33 @@ export const shouldFieldBePreserved = (
     return !hasArrayMarker && !hasStringMarker;
   });
 };
+
+export const getPreservableFieldsFromAssets = (
+  asset: any,
+  keywordMappings: KeywordMappings
+): string[] => {
+  if (typeof asset === 'string') {
+    if (shouldFieldBePreserved(asset, keywordMappings)) {
+      return [asset];
+    }
+    return [];
+  }
+  if (Array.isArray(asset)) {
+    return asset
+      .map((arrayItem) => {
+        return getPreservableFieldsFromAssets(arrayItem, keywordMappings);
+      })
+      .flat();
+  }
+  if (typeof asset === 'object') {
+    return Object.keys(asset)
+      .map((key: string): string[] => {
+        const value = asset[key];
+
+        if (value === undefined || value === null) return [];
+        return getPreservableFieldsFromAssets(value, keywordMappings);
+      })
+      .flat();
+  }
+  return [];
+};

test/keywordPreservation.test.ts

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { shouldFieldBePreserved } from '../src/keywordPreservation';
+import { shouldFieldBePreserved, getPreservableFieldsFromAssets } from '../src/keywordPreservation';
 
 describe('#Keyword Preservation', () => {
   describe('shouldFieldBePreserved', () => {
@@ -38,4 +38,47 @@ describe('#Keyword Preservation', () => {
       ).to.be.true;
     });
   });
+
+  describe('getPreservableFieldsFromAssets', () => {
+    it('should retrieve all preservable fields from assets tree', () => {
+      const fieldsToPreserve = getPreservableFieldsFromAssets(
+        {
+          object: {
+            friendly_name: 'Friendly name ##KEYWORD##',
+            notInKeywordMapping: '##NOT_IN_KEYWORD_MAPPING##',
+            number: 5,
+            boolean: true,
+            nested: {
+              nestedProperty: 'Nested property ##KEYWORD##',
+            },
+          },
+          array: [
+            {
+              nestedArray: ['Nested array value 1 ##KEYWORD##', 'Nested array value 2 ##KEYWORD##'],
+              notInKeywordMapping: '##NOT_IN_KEYWORD_MAPPING##',
+              nested: {
+                nestedProperty: 'Another nested array property ##KEYWORD##',
+              },
+            },
+          ],
+          arrayReplace: '@@ARRAY_REPLACE_KEYWORD@@',
+          nullField: null,
+          undefinedField: undefined,
+        },
+        {
+          KEYWORD: 'Travel0',
+          ARRAY_REPLACE_KEYWORD: ['this value', 'that value'],
+        }
+      );
+
+      expect(fieldsToPreserve).to.have.members([
+        'Friendly name ##KEYWORD##',
+        'Nested property ##KEYWORD##',
+        'Nested array value 1 ##KEYWORD##',
+        'Nested array value 2 ##KEYWORD##',
+        'Another nested array property ##KEYWORD##',
+        '@@ARRAY_REPLACE_KEYWORD@@',
+      ]);
+    });
+  });
 });