Feature/817 breaking change rename interaction to journey

.eslintrc.json

@@ -42,6 +42,7 @@
         }
     },
     "rules": {
+        "logical-assignment-operators": ["error", "always"],
         "unicorn/better-regex": "off",
         "unicorn/catch-error-name": [
             "error",
@@ -65,6 +66,7 @@
         "unicorn/prefer-array-some": "off",
         "unicorn/prefer-set-has": "off",
         "unicorn/prefer-spread": "off",
+        "unicorn/prefer-string-replace-all": "error",
         "unicorn/unicorn/no-lonely-if": "off",
         "arrow-body-style": ["error", "as-needed"],
         "curly": "error",

.prettierrc

@@ -27,7 +27,7 @@
             "options": {
                 "formatter": "sql-formatter",
                 "language": "tsql",
-                "uppercase": true
+                "keywordCase": "upper"
             }
         }
     ]

boilerplate/files/.prettierrc

@@ -17,7 +17,7 @@
             "options": {
                 "formatter": "sql-formatter",
                 "language": "tsql",
-                "uppercase": true
+                "keywordCase": "upper"
             }
         }
     ]

boilerplate/forcedUpdates.json

@@ -1,4 +1,8 @@
 [
+    {
+        "version": "5.0.0",
+        "files": [".vscode/settings.json", ".prettierrc"]
+    },
     {
         "version": "4.3.4",
         "files": [".vscode/settings.json"]

docs/dist/documentation.md

@@ -70,8 +70,8 @@ as this is a configuration in the EID</p>
 <dt><a href="#ImportFile">ImportFile</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
 <dd><p>ImportFile MetadataType</p>
 </dd>
-<dt><a href="#Interaction">Interaction</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
-<dd><p>Interaction MetadataType
+<dt><a href="#Journey">Journey</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
+<dd><p>Journey MetadataType
 ! BETA RELEASE of journey support (v4.3.0); it so far only resolves a limited amount of dependencies and will likely break during cross-BU deployments!
 id: A unique id of the journey assigned by the journey’s API during its creation
 key: A unique id of the journey within the MID. Can be generated by the developer
@@ -2908,10 +2908,10 @@ parses retrieved Metadata before saving
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single import definition |
 
-<a name="Interaction"></a>
+<a name="Journey"></a>
 
-## Interaction ⇐ [<code>MetadataType</code>](#MetadataType)
-Interaction MetadataType
+## Journey ⇐ [<code>MetadataType</code>](#MetadataType)
+Journey MetadataType
 ! BETA RELEASE of journey support (v4.3.0); it so far only resolves a limited amount of dependencies and will likely break during cross-BU deployments!
 id: A unique id of the journey assigned by the journey’s API during its creation
 key: A unique id of the journey within the MID. Can be generated by the developer
@@ -2920,24 +2920,24 @@ definitionId: A unique UUID provided by Salesforce Marketing Cloud. Each version
 **Kind**: global class  
 **Extends**: [<code>MetadataType</code>](#MetadataType)  
 
-* [Interaction](#Interaction) ⇐ [<code>MetadataType</code>](#MetadataType)
-    * [.retrieve(retrieveDir, [_], [__], [key])](#Interaction.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
-    * [.deleteByKey(key)](#Interaction.deleteByKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
-    * [.deploy(metadata, deployDir, retrieveDir, [isRefresh])](#Interaction.deploy) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
-    * [.update(metadata)](#Interaction.update) ⇒ <code>Promise</code>
-    * [.create(metadata)](#Interaction.create) ⇒ <code>Promise</code>
-    * [.saveResults(results, retrieveDir, [overrideType], [templateVariables])](#Interaction.saveResults) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
-    * [._postRetrieveTasksBulk(metadataMap)](#Interaction._postRetrieveTasksBulk)
-    * [.postRetrieveTasks(metadata)](#Interaction.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
-    * [.preDeployTasks(metadata)](#Interaction.preDeployTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
-    * [.createOrUpdate(metadata, metadataKey, hasError, metadataToUpdate, metadataToCreate)](#Interaction.createOrUpdate)
+* [Journey](#Journey) ⇐ [<code>MetadataType</code>](#MetadataType)
+    * [.retrieve(retrieveDir, [_], [__], [key])](#Journey.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
+    * [.deleteByKey(key)](#Journey.deleteByKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
+    * [.deploy(metadata, deployDir, retrieveDir, [isRefresh])](#Journey.deploy) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
+    * [.update(metadata)](#Journey.update) ⇒ <code>Promise</code>
+    * [.create(metadata)](#Journey.create) ⇒ <code>Promise</code>
+    * [.saveResults(results, retrieveDir, [overrideType], [templateVariables])](#Journey.saveResults) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
+    * [._postRetrieveTasksBulk(metadataMap)](#Journey._postRetrieveTasksBulk)
+    * [.postRetrieveTasks(metadata)](#Journey.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
+    * [.preDeployTasks(metadata)](#Journey.preDeployTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
+    * [.createOrUpdate(metadata, metadataKey, hasError, metadataToUpdate, metadataToCreate)](#Journey.createOrUpdate)
 
-<a name="Interaction.retrieve"></a>
+<a name="Journey.retrieve"></a>
 
-### Interaction.retrieve(retrieveDir, [_], [__], [key]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
-Retrieves Metadata of Interaction
+### Journey.retrieve(retrieveDir, [_], [__], [key]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
+Retrieves Metadata of Journey
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code> - Promise  
 
 | Param | Type | Description |
@@ -2947,24 +2947,24 @@ Retrieves Metadata of Interaction
 | [__] | <code>void</code> | unused parameter |
 | [key] | <code>string</code> | customer key of single item to retrieve |
 
-<a name="Interaction.deleteByKey"></a>
+<a name="Journey.deleteByKey"></a>
 
-### Interaction.deleteByKey(key) ⇒ <code>Promise.&lt;boolean&gt;</code>
+### Journey.deleteByKey(key) ⇒ <code>Promise.&lt;boolean&gt;</code>
 Delete a metadata item from the specified business unit
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise.&lt;boolean&gt;</code> - deletion success status  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | key | <code>string</code> | Identifier of item |
 
-<a name="Interaction.deploy"></a>
+<a name="Journey.deploy"></a>
 
-### Interaction.deploy(metadata, deployDir, retrieveDir, [isRefresh]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
+### Journey.deploy(metadata, deployDir, retrieveDir, [isRefresh]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
 Deploys metadata - merely kept here to be able to print [logBeta](#Util.logBeta) once per deploy
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code> - Promise of keyField => metadata map  
 
 | Param | Type | Description |
@@ -2974,36 +2974,36 @@ Deploys metadata - merely kept here to be able to print [logBeta](#Util.logBeta)
 | retrieveDir | <code>string</code> | directory where metadata after deploy should be saved |
 | [isRefresh] | <code>boolean</code> | optional flag - so far not used by interaction |
 
-<a name="Interaction.update"></a>
+<a name="Journey.update"></a>
 
-### Interaction.update(metadata) ⇒ <code>Promise</code>
+### Journey.update(metadata) ⇒ <code>Promise</code>
 Updates a single item
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise</code> - Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single item |
 
-<a name="Interaction.create"></a>
+<a name="Journey.create"></a>
 
-### Interaction.create(metadata) ⇒ <code>Promise</code>
+### Journey.create(metadata) ⇒ <code>Promise</code>
 Creates a single item
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise</code> - Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single item |
 
-<a name="Interaction.saveResults"></a>
+<a name="Journey.saveResults"></a>
 
-### Interaction.saveResults(results, retrieveDir, [overrideType], [templateVariables]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
+### Journey.saveResults(results, retrieveDir, [overrideType], [templateVariables]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
 Helper for writing Metadata to disk, used for Retrieve and deploy
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code> - Promise of saved metadata  
 
 | Param | Type | Description |
@@ -3013,47 +3013,47 @@ Helper for writing Metadata to disk, used for Retrieve and deploy
 | [overrideType] | <code>string</code> | for use when there is a subtype (such as folder-queries) |
 | [templateVariables] | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |
 
-<a name="Interaction._postRetrieveTasksBulk"></a>
+<a name="Journey._postRetrieveTasksBulk"></a>
 
-### Interaction.\_postRetrieveTasksBulk(metadataMap)
-helper for Interaction's [saveResults](saveResults). Gets executed after retreive of metadata type and
+### Journey.\_postRetrieveTasksBulk(metadataMap)
+helper for Journey's [saveResults](saveResults). Gets executed after retreive of metadata type and
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadataMap | <code>TYPE.MetadataTypeMap</code> | key=customer key, value=metadata |
 
-<a name="Interaction.postRetrieveTasks"></a>
+<a name="Journey.postRetrieveTasks"></a>
 
-### Interaction.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+### Journey.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
 manages post retrieve steps
 ! BETA RELEASE of journey support (v4.3.0); it so far only resolves a limited amount of dependencies and will likely break during cross-BU deployments!
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>TYPE.MetadataTypeItem</code> - Array with one metadata object  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single item |
 
-<a name="Interaction.preDeployTasks"></a>
+<a name="Journey.preDeployTasks"></a>
 
-### Interaction.preDeployTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+### Journey.preDeployTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
 prepares a TSD for deployment
 ! BETA RELEASE of journey support (v4.3.0); it so far only resolves a limited amount of dependencies and will likely break during cross-BU deployments!
 
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 **Returns**: <code>TYPE.MetadataTypeItem</code> - metadata object  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | of a single TSD |
 
-<a name="Interaction.createOrUpdate"></a>
+<a name="Journey.createOrUpdate"></a>
 
-### Interaction.createOrUpdate(metadata, metadataKey, hasError, metadataToUpdate, metadataToCreate)
-**Kind**: static method of [<code>Interaction</code>](#Interaction)  
+### Journey.createOrUpdate(metadata, metadataKey, hasError, metadataToUpdate, metadataToCreate)
+**Kind**: static method of [<code>Journey</code>](#Journey)  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -6508,6 +6508,7 @@ File extends fs-extra. It adds logger and util methods for file handling
     * [.normalizePath(denormalizedPath)](#File.normalizePath) ⇒ <code>string</code>
     * [.writeJSONToFile(directory, filename, content)](#File.writeJSONToFile) ⇒ <code>Promise</code>
     * [.writePrettyToFile(directory, filename, filetype, content, [templateVariables])](#File.writePrettyToFile) ⇒ <code>Promise.&lt;boolean&gt;</code>
+    * [._beautify_beautyAmp(content)](#File._beautify_beautyAmp) ⇒ <code>string</code>
     * [._beautify_prettier(directory, filename, filetype, content)](#File._beautify_prettier) ⇒ <code>string</code>
     * [.writeToFile(directory, filename, filetype, content, [encoding])](#File.writeToFile) ⇒ <code>Promise.&lt;boolean&gt;</code>
     * [.readJSONFile(directory, filename, sync, cleanPath)](#File.readJSONFile) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>object</code> \| <code>void</code>
@@ -6609,6 +6610,18 @@ Saves beautified files in the local file system. Will create the parent director
 | content | <code>string</code> | filecontent |
 | [templateVariables] | <code>TYPE.TemplateMap</code> | templating variables to be replaced in the metadata |
 
+<a name="File._beautify_beautyAmp"></a>
+
+### File.\_beautify\_beautyAmp(content) ⇒ <code>string</code>
+helper for [writePrettyToFile](#File.writePrettyToFile), applying beautyAmp onto given stringified content
+
+**Kind**: static method of [<code>File</code>](#File)  
+**Returns**: <code>string</code> - original string on error; formatted string on success  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| content | <code>string</code> | filecontent |
+
 <a name="File._beautify_prettier"></a>
 
 ### File.\_beautify\_prettier(directory, filename, filetype, content) ⇒ <code>string</code>

lib/MetadataTypeDefinitions.js

@@ -23,7 +23,7 @@ const MetadataTypeDefinitions = {
     filter: require('./metadataTypes/definitions/Filter.definition'),
     folder: require('./metadataTypes/definitions/Folder.definition'),
     importFile: require('./metadataTypes/definitions/ImportFile.definition'),
-    interaction: require('./metadataTypes/definitions/Interaction.definition'),
+    journey: require('./metadataTypes/definitions/Journey.definition'),
     list: require('./metadataTypes/definitions/List.definition'),
     mobileCode: require('./metadataTypes/definitions/MobileCode.definition'),
     mobileKeyword: require('./metadataTypes/definitions/MobileKeyword.definition'),

lib/MetadataTypeInfo.js

@@ -23,7 +23,7 @@ const MetadataTypeInfo = {
     filter: require('./metadataTypes/Filter'),
     folder: require('./metadataTypes/Folder'),
     importFile: require('./metadataTypes/ImportFile'),
-    interaction: require('./metadataTypes/Interaction'),
+    journey: require('./metadataTypes/Journey'),
     list: require('./metadataTypes/List'),
     mobileCode: require('./metadataTypes/MobileCode'),
     mobileKeyword: require('./metadataTypes/MobileKeyword'),

lib/metadataTypes/Asset.js

@@ -25,7 +25,7 @@ class Asset extends MetadataType {
      */
     static async retrieve(retrieveDir, _, subTypeArr, key) {
         const items = [];
-        subTypeArr = subTypeArr || this._getSubTypes();
+        subTypeArr ||= this._getSubTypes();
         await File.initPrettier();
         // loop through subtypes and return results of each subType for caching (saving is handled per subtype)
         for (const subType of subTypeArr) {

lib/metadataTypes/Automation.js

@@ -867,7 +867,7 @@ class Automation extends MetadataType {
                 row1.push(
                     `| ${column.title}${
                         column.description
-                            ? `<br>_<small>${column.description.replace(/\n/g, '<br>')}</small>_`
+                            ? `<br>_<small>${column.description.replaceAll('\n', '<br>')}</small>_`
                             : ''
                     } `
                 );

lib/metadataTypes/DataExtension.js

@@ -230,7 +230,7 @@ class DataExtension extends MetadataType {
         // Modify columns for update call
         DataExtensionField.client = this.client;
         DataExtensionField.properties = this.properties;
-        DataExtension.oldFields = DataExtension.oldFields || {};
+        DataExtension.oldFields ||= {};
         DataExtension.oldFields[metadata[this.definition.keyField]] =
             await DataExtensionField.prepareDeployColumnsOnUpdate(
                 metadata.Fields,

lib/metadataTypes/Folder.js

@@ -465,7 +465,7 @@ class Folder extends MetadataType {
                 // should not be in the path for the metadata. In case no split then return empty as this is root
 
                 const standardSubDir = File.reverseFilterIllegalFilenames(
-                    subdir.replace(/\\/g, '/').split(/folder\//)[1] || ''
+                    subdir.replaceAll('\\', '/').split(/folder\//)[1] || ''
                 );
                 for (const fileName of File.readdirSync(subdir)) {
                     try {