mcdev 4.1.6 → 4.1.8

package/docs/dist/documentation.md

@@ -400,7 +400,7 @@ Deploys all metadata located in the 'deploy' directory to the specified business
 <a name="Deployer._deployBU"></a>
 
 ### Deployer.\_deployBU(cred, bu, properties, [typeArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code>
-helper for deploy()
+helper for [deploy](deploy)
 
 **Kind**: static method of [<code>Deployer</code>](#Deployer)  
 **Returns**: <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code> - ensure that BUs are worked on sequentially  
@@ -958,7 +958,7 @@ This method retrieves these and saves them alongside the metadata json
 <a name="Asset._readExtendedFileFromFS"></a>
 
 ### Asset.\_readExtendedFileFromFS(metadata, subType, deployDir, [pathOnly]) ⇒ <code>Promise.&lt;string&gt;</code>
-helper for this.preDeployTasks()
+helper for [preDeployTasks](preDeployTasks)
 Some metadata types store their actual content as a separate file, e.g. images
 This method reads these from the local FS stores them in the metadata object allowing to deploy it
 
@@ -1013,7 +1013,7 @@ find the subType matching the extendedSubType
 <a name="Asset.buildDefinitionForNested"></a>
 
 ### Asset.buildDefinitionForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for buildDefinition
+helper for [buildDefinition](#MetadataType.buildDefinition)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
@@ -1030,7 +1030,7 @@ handles extracted code if any are found for complex types
 <a name="Asset.buildTemplateForNested"></a>
 
 ### Asset.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for buildTemplate
+helper for [buildTemplate](#MetadataType.buildTemplate)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
@@ -1051,7 +1051,7 @@ assets of type codesnippetblock will result in 1 json and 1 amp/html file. both
 <a name="Asset._buildForNested"></a>
 
 ### Asset.\_buildForNested(templateDir, targetDir, metadata, templateVariables, templateName, mode) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for buildDefinition
+helper for [buildDefinition](#MetadataType.buildDefinition)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
@@ -1092,7 +1092,7 @@ parses retrieved Metadata before saving
 <a name="Asset._mergeCode"></a>
 
 ### Asset.\_mergeCode(metadata, deployDir, subType, [templateName], [fileListOnly]) ⇒ <code>Promise.&lt;Array.&lt;TYPE.CodeExtract&gt;&gt;</code>
-helper for this.preDeployTasks() that loads extracted code content back into JSON
+helper for [preDeployTasks](preDeployTasks) that loads extracted code content back into JSON
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
 **Returns**: <code>Promise.&lt;Array.&lt;TYPE.CodeExtract&gt;&gt;</code> - fileList for templating (disregarded during deployment)  
@@ -1108,7 +1108,7 @@ helper for this.preDeployTasks() that loads extracted code content back into JSO
 <a name="Asset._mergeCode_slots"></a>
 
 ### Asset.\_mergeCode\_slots(prefix, metadataSlots, readDirArr, subtypeExtension, subDirArr, fileList, customerKey, [templateName], [fileListOnly]) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for this.preDeployTasks() that loads extracted code content back into JSON
+helper for [preDeployTasks](preDeployTasks) that loads extracted code content back into JSON
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
 **Returns**: <code>Promise.&lt;void&gt;</code> - -  
@@ -1128,7 +1128,7 @@ helper for this.preDeployTasks() that loads extracted code content back into JSO
 <a name="Asset._extractCode"></a>
 
 ### Asset.\_extractCode(metadata) ⇒ <code>TYPE.CodeExtractItem</code>
-helper for this.parseMetadata() that finds code content in JSON and extracts it
+helper for [parseMetadata](parseMetadata) that finds code content in JSON and extracts it
 to allow saving that separately and formatted
 
 **Kind**: static method of [<code>Asset</code>](#Asset)  
@@ -1626,7 +1626,7 @@ if create or update operation is needed.
 <a name="DataExtension._filterUpsertResults"></a>
 
 ### DataExtension.\_filterUpsertResults(res) ⇒ <code>boolean</code>
-helper for upsert()
+helper for [upsert](upsert)
 
 **Kind**: static method of [<code>DataExtension</code>](#DataExtension)  
 **Returns**: <code>boolean</code> - true: keep, false: discard  
@@ -1862,7 +1862,7 @@ Retrieves all records for caching
 <a name="DataExtensionField.convertToSortedArray"></a>
 
 ### DataExtensionField.convertToSortedArray(fieldsObj) ⇒ <code>Array.&lt;TYPE.DataExtensionFieldItem&gt;</code>
-helper for DataExtension.js that sorts the fields into an array
+helper for [DataExtension._retrieveFieldsForSingleDe](DataExtension._retrieveFieldsForSingleDe) that sorts the fields into an array
 
 **Kind**: static method of [<code>DataExtensionField</code>](#DataExtensionField)  
 **Returns**: <code>Array.&lt;TYPE.DataExtensionFieldItem&gt;</code> - sorted array of field objects  
@@ -3482,7 +3482,7 @@ Helper for writing Metadata to disk, used for Retrieve and deploy
 <a name="MetadataType.applyTemplateValues"></a>
 
 ### MetadataType.applyTemplateValues(code, templateVariables) ⇒ <code>string</code>
-helper for buildDefinitionForNested
+helper for [buildDefinitionForNested](buildDefinitionForNested)
 searches extracted file for template variable names and applies the market values
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3496,7 +3496,7 @@ searches extracted file for template variable names and applies the market value
 <a name="MetadataType.applyTemplateNames"></a>
 
 ### MetadataType.applyTemplateNames(code, templateVariables) ⇒ <code>string</code>
-helper for buildTemplateForNested
+helper for [buildTemplateForNested](buildTemplateForNested)
 searches extracted file for template variable values and applies the market variable names
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3510,7 +3510,7 @@ searches extracted file for template variable values and applies the market vari
 <a name="MetadataType.buildDefinitionForNested"></a>
 
 ### MetadataType.buildDefinitionForNested(templateDir, targetDir, metadata, variables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildDefinition
+helper for [buildDefinition](buildDefinition)
 handles extracted code if any are found for complex types (e.g script, asset, query)
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3527,7 +3527,7 @@ handles extracted code if any are found for complex types (e.g script, asset, qu
 <a name="MetadataType.buildTemplateForNested"></a>
 
 ### MetadataType.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildTemplate
+helper for [buildTemplate](buildTemplate)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3903,7 +3903,7 @@ prepares a Query for deployment
 <a name="Query.applyTemplateValues"></a>
 
 ### Query.applyTemplateValues(code, templateVariables) ⇒ <code>string</code>
-helper for buildDefinitionForNested
+helper for [buildDefinitionForNested](buildDefinitionForNested)
 searches extracted SQL file for template variables and applies the market values
 
 **Kind**: static method of [<code>Query</code>](#Query)  
@@ -3917,7 +3917,7 @@ searches extracted SQL file for template variables and applies the market values
 <a name="Query.buildDefinitionForNested"></a>
 
 ### Query.buildDefinitionForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildDefinition
+helper for [buildDefinition](#MetadataType.buildDefinition)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Query</code>](#Query)  
@@ -3934,7 +3934,7 @@ handles extracted code if any are found for complex types
 <a name="Query.buildTemplateForNested"></a>
 
 ### Query.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildTemplate
+helper for [buildTemplate](#MetadataType.buildTemplate)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Query</code>](#Query)  
@@ -4184,7 +4184,7 @@ Creates a single Script
 <a name="Script._mergeCode"></a>
 
 ### Script.\_mergeCode(metadata, deployDir, [templateName]) ⇒ <code>Promise.&lt;string&gt;</code>
-helper for this.preDeployTasks() that loads extracted code content back into JSON
+helper for [preDeployTasks](preDeployTasks) that loads extracted code content back into JSON
 
 **Kind**: static method of [<code>Script</code>](#Script)  
 **Returns**: <code>Promise.&lt;string&gt;</code> - content for metadata.script  
@@ -4211,7 +4211,7 @@ prepares a Script for deployment
 <a name="Script.buildDefinitionForNested"></a>
 
 ### Script.buildDefinitionForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildDefinition
+helper for [buildDefinition](#MetadataType.buildDefinition)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Script</code>](#Script)  
@@ -4228,7 +4228,7 @@ handles extracted code if any are found for complex types
 <a name="Script.buildTemplateForNested"></a>
 
 ### Script.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildTemplate
+helper for [buildTemplate](#MetadataType.buildTemplate)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Script</code>](#Script)  
@@ -4249,7 +4249,7 @@ scripts are saved as 1 json and 1 ssjs file. both files need to be run through t
 <a name="Script._buildForNested"></a>
 
 ### Script.\_buildForNested(templateDir, targetDir, metadata, templateVariables, templateName, mode) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
-helper for buildTemplateForNested / buildDefinitionForNested
+helper for [buildTemplateForNested](buildTemplateForNested) / [buildDefinitionForNested](buildDefinitionForNested)
 handles extracted code if any are found for complex types
 
 **Kind**: static method of [<code>Script</code>](#Script)  
@@ -4604,7 +4604,7 @@ SFMC accepts multiple false values for Boolean attributes for which we are check
 <a name="Util._isValidType"></a>
 
 ### Util.\_isValidType(selectedType) ⇒ <code>boolean</code>
-helper for retrieve, retrieveAsTemplate and deploy
+helper for [retrieve](#Mcdev.retrieve), [retrieveAsTemplate](#Mcdev.retrieveAsTemplate) and [deploy](#Mcdev.deploy)
 
 **Kind**: static method of [<code>Util</code>](#Util)  
 **Returns**: <code>boolean</code> - type ok or not  
@@ -4892,7 +4892,7 @@ helper around _askCredentials
 <a name="Cli._askCredentials"></a>
 
 ### Cli.\_askCredentials(properties, [credName]) ⇒ <code>Promise.&lt;object&gt;</code>
-helper for addExtraCredential()
+helper for [addExtraCredential](#Cli.addExtraCredential)
 
 **Kind**: static method of [<code>Cli</code>](#Cli)  
 **Returns**: <code>Promise.&lt;object&gt;</code> - credential info  
@@ -4918,7 +4918,7 @@ allows updating the metadata types that shall be retrieved
 <a name="Cli._summarizeSubtypes"></a>
 
 ### Cli.\_summarizeSubtypes(responses, type) ⇒ <code>void</code>
-helper for this.selectTypes() that converts subtypes back to main type if all and only defaults were selected
+helper for [selectTypes](#Cli.selectTypes) that converts subtypes back to main type if all and only defaults were selected
 this keeps the config automatically upgradable when we add new subtypes or change what is selected by default
 
 **Kind**: static method of [<code>Cli</code>](#Cli)  
@@ -5190,7 +5190,7 @@ Saves beautified files in the local file system. Will create the parent director
 <a name="File._beautify_prettier"></a>
 
 ### File.\_beautify\_prettier(directory, filename, filetype, content) ⇒ <code>string</code>
-helper for writePrettyToFile, applying prettier onto given stringified content
+helper for [writePrettyToFile](#File.writePrettyToFile), applying prettier onto given stringified content
 ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
 
 **Kind**: static method of [<code>File</code>](#File)  
@@ -5367,7 +5367,7 @@ handles creation/update of all config file from the boilerplate
 <a name="Init._updateLeaf"></a>
 
 ### Init.\_updateLeaf(propertiersCur, defaultPropsCur, fieldName) ⇒ <code>void</code>
-recursive helper for _fixMcdevConfig that adds missing settings
+recursive helper for [fixMcdevConfig](#Init.fixMcdevConfig) that adds missing settings
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 
@@ -5459,7 +5459,7 @@ Creates template file for properties.json
 <a name="Init._downloadAllBUs"></a>
 
 ### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for this.initProject()
+helper for [initProject](#Init.initProject)
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 **Returns**: <code>Promise.&lt;void&gt;</code> - -  
@@ -5574,7 +5574,7 @@ handles creation/update of all config file from the boilerplate
 <a name="Init._updateLeaf"></a>
 
 ### Init.\_updateLeaf(propertiersCur, defaultPropsCur, fieldName) ⇒ <code>void</code>
-recursive helper for _fixMcdevConfig that adds missing settings
+recursive helper for [fixMcdevConfig](#Init.fixMcdevConfig) that adds missing settings
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 
@@ -5666,7 +5666,7 @@ Creates template file for properties.json
 <a name="Init._downloadAllBUs"></a>
 
 ### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for this.initProject()
+helper for [initProject](#Init.initProject)
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 **Returns**: <code>Promise.&lt;void&gt;</code> - -  
@@ -5781,7 +5781,7 @@ handles creation/update of all config file from the boilerplate
 <a name="Init._updateLeaf"></a>
 
 ### Init.\_updateLeaf(propertiersCur, defaultPropsCur, fieldName) ⇒ <code>void</code>
-recursive helper for _fixMcdevConfig that adds missing settings
+recursive helper for [fixMcdevConfig](#Init.fixMcdevConfig) that adds missing settings
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 
@@ -5873,7 +5873,7 @@ Creates template file for properties.json
 <a name="Init._downloadAllBUs"></a>
 
 ### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for this.initProject()
+helper for [initProject](#Init.initProject)
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 **Returns**: <code>Promise.&lt;void&gt;</code> - -  
@@ -5988,7 +5988,7 @@ handles creation/update of all config file from the boilerplate
 <a name="Init._updateLeaf"></a>
 
 ### Init.\_updateLeaf(propertiersCur, defaultPropsCur, fieldName) ⇒ <code>void</code>
-recursive helper for _fixMcdevConfig that adds missing settings
+recursive helper for [fixMcdevConfig](#Init.fixMcdevConfig) that adds missing settings
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 
@@ -6080,7 +6080,7 @@ Creates template file for properties.json
 <a name="Init._downloadAllBUs"></a>
 
 ### Init.\_downloadAllBUs(bu, gitStatus) ⇒ <code>Promise.&lt;void&gt;</code>
-helper for this.initProject()
+helper for [initProject](#Init.initProject)
 
 **Kind**: static method of [<code>Init</code>](#Init)  
 **Returns**: <code>Promise.&lt;void&gt;</code> - -  
@@ -6279,7 +6279,7 @@ SFMC accepts multiple false values for Boolean attributes for which we are check
 <a name="Util._isValidType"></a>
 
 ### Util.\_isValidType(selectedType) ⇒ <code>boolean</code>
-helper for retrieve, retrieveAsTemplate and deploy
+helper for [retrieve](#Mcdev.retrieve), [retrieveAsTemplate](#Mcdev.retrieveAsTemplate) and [deploy](#Mcdev.deploy)
 
 **Kind**: static method of [<code>Util</code>](#Util)  
 **Returns**: <code>boolean</code> - type ok or not  

package/lib/Deployer.js

@@ -173,7 +173,7 @@ class Deployer {
         return buMultiMetadataTypeMap;
     }
     /**
-     * helper for deploy()
+     * helper for {@link deploy}
      *
      * @param {string} cred name of Credential
      * @param {string} bu name of BU
@@ -325,6 +325,7 @@ class Deployer {
     static async createFolderDefinitions(deployDir, metadata, metadataTypeArr) {
         let i = 0;
         const folderMetadata = {};
+        const allowedDeFolderContentTypes = ['dataextension', 'shared_dataextension'];
         for (const metadataType of metadataTypeArr) {
             if (!MetadataTypeInfo[metadataType].definition.dependencies.includes('folder')) {
                 Util.logger.debug(` ☇ skipping ${metadataType}: folder not a dependency`);
@@ -346,23 +347,20 @@ class Deployer {
             }
             Util.logger.debug(`Creating relevant folders for ${metadataType} in deploy dir`);
 
-            let allFolders = Object.keys(metadata[metadataType]).filter(
-                // filter out root folders (which would not have a slash in their path)
-                (key) => metadata[metadataType][key].r__folder_Path.includes('/')
-            );
-            /* eslint-disable unicorn/prefer-ternary */
-            if (metadataType === 'dataExtension') {
-                allFolders = allFolders
-                    .filter(
-                        // filter out any shared / synchronized / salesforce folders
-                        (key) =>
-                            metadata[metadataType][key].r__folder_ContentType === 'dataextension'
-                    )
-                    .map((key) => metadata[metadataType][key].r__folder_Path);
-            } else {
-                allFolders = allFolders.map((key) => metadata[metadataType][key].r__folder_Path);
-            }
-            /* eslint-enable unicorn/prefer-ternary */
+            const allFolders = Object.keys(metadata[metadataType])
+                .filter(
+                    // filter out root folders (which would not have a slash in their path)
+                    (key) => metadata[metadataType][key].r__folder_Path.includes('/')
+                )
+                .filter(
+                    // filter out dataExtension folders other than standard & shared (--> synchronized / salesforce are not allowed)
+                    (key) =>
+                        metadataType !== 'dataExtension' ||
+                        allowedDeFolderContentTypes.includes(
+                            metadata[metadataType][key].r__folder_ContentType
+                        )
+                )
+                .map((key) => metadata[metadataType][key].r__folder_Path);
 
             // deduplicate
             const folderPathSet = new Set(allFolders);
@@ -384,21 +382,31 @@ class Deployer {
 
             for (const folder of folderPathArrExtended) {
                 i++;
+                let contentType = MetadataTypeInfo[metadataType].definition.folderType;
+                if (
+                    metadataType === 'dataExtension' &&
+                    folder.startsWith('Shared Items/Shared Data Extensions')
+                ) {
+                    contentType = 'shared_dataextension';
+                }
                 folderMetadata[`on-the-fly-${i}`] = {
                     Path: folder,
                     Name: folder.split('/').pop(),
                     Description: '',
-                    ContentType: MetadataTypeInfo[metadataType].definition.folderType,
+                    ContentType: contentType,
                     IsActive: true,
                     IsEditable: true,
                     AllowChildren: true,
+                    _generated: true,
                 };
             }
         }
 
         if (i > 0) {
+            MetadataTypeInfo.folder.definition.fields._generated.retrieving = true; // ensure we keep that flag in deploy folder
             // await results to allow us to re-read it right after
             await MetadataTypeInfo.folder.saveResults(folderMetadata, deployDir, null);
+            MetadataTypeInfo.folder.definition.fields._generated.retrieving = false; // reset flag
             Util.logger.info(`Created folders in deploy dir: ${i}`);
 
             // reload from file system to ensure we use the same logic for building the temporary JSON

package/lib/index.js

@@ -189,7 +189,7 @@ class Mcdev {
         }
     }
     /**
-     * helper for retrieve()
+     * helper for {@link retrieve}
      *
      * @private
      * @param {string} cred name of Credential

package/lib/metadataTypes/Asset.js

@@ -99,7 +99,7 @@ class Asset extends MetadataType {
         return { metadata: Object.values(metadata)[0], type: this.definition.type };
     }
     /**
-     * helper for retrieve + retrieveAsTemplate
+     * helper for {@link retrieve} + {@link retrieveAsTemplate}
      *
      * @private
      * @returns {TYPE.AssetSubType[]} subtype array
@@ -443,7 +443,7 @@ class Asset extends MetadataType {
         );
     }
     /**
-     * helper for this.preDeployTasks()
+     * helper for {@link preDeployTasks}
      * Some metadata types store their actual content as a separate file, e.g. images
      * This method reads these from the local FS stores them in the metadata object allowing to deploy it
      *
@@ -607,7 +607,7 @@ class Asset extends MetadataType {
         }
     }
     /**
-     * helper for buildDefinition
+     * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -634,7 +634,7 @@ class Asset extends MetadataType {
         );
     }
     /**
-     * helper for buildTemplate
+     * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
      *
      * @example assets of type codesnippetblock will result in 1 json and 1 amp/html file. both files need to be run through templating
@@ -663,7 +663,7 @@ class Asset extends MetadataType {
     }
 
     /**
-     * helper for buildDefinition
+     * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -792,7 +792,7 @@ class Asset extends MetadataType {
         return metadata;
     }
     /**
-     * helper for this.preDeployTasks() that loads extracted code content back into JSON
+     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {TYPE.AssetItem} metadata a single asset definition
      * @param {string} deployDir directory of deploy files
@@ -1024,7 +1024,7 @@ class Asset extends MetadataType {
         return fileList;
     }
     /**
-     * helper for this.preDeployTasks() that loads extracted code content back into JSON
+     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {string} prefix usually the customerkey
      * @param {object} metadataSlots metadata.views.html.slots or deeper slots.<>.blocks.<>.slots
@@ -1104,7 +1104,7 @@ class Asset extends MetadataType {
         }
     }
     /**
-     * helper for this.parseMetadata() that finds code content in JSON and extracts it
+     * helper for {@link parseMetadata} that finds code content in JSON and extracts it
      * to allow saving that separately and formatted
      *
      * @param {TYPE.AssetItem} metadata a single asset definition

package/lib/metadataTypes/DataExtension.js

@@ -123,7 +123,7 @@ class DataExtension extends MetadataType {
     }
 
     /**
-     * helper for upsert()
+     * helper for {@link upsert}
      *
      * @param {object} res -
      * @returns {boolean} true: keep, false: discard
@@ -964,7 +964,7 @@ class DataExtension extends MetadataType {
                     );
                 }
             } else if (!error) {
-                Util.logger.error(
+                Util.logger.warn(
                     ` - ${this.definition.type} '${metadata[this.definition.nameField]}' (${
                         metadata[this.definition.keyField]
                     }): ${ex.message}`

package/lib/metadataTypes/DataExtensionField.js

@@ -32,7 +32,7 @@ class DataExtensionField extends MetadataType {
         return super.retrieveSOAP(null, null, requestParams, additionalFields);
     }
     /**
-     * helper for DataExtension.js that sorts the fields into an array
+     * helper for {@link DataExtension._retrieveFieldsForSingleDe} that sorts the fields into an array
      *
      * @param {TYPE.DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
      * @returns {TYPE.DataExtensionFieldItem[]} sorted array of field objects

package/lib/metadataTypes/Folder.js

@@ -166,7 +166,9 @@ class Folder extends MetadataType {
      */
     static async upsert(metadata) {
         let updateCount = 0;
+        let updateFailedCount = 0;
         let createCount = 0;
+        let createFailedCount = 0;
         let filteredByPreDeploy = 0;
         const upsertResults = {};
         const sortPairs = toposort(
@@ -206,12 +208,13 @@ class Folder extends MetadataType {
                                 );
                                 if (
                                     existingId &&
-                                    !this.hasChangedGeneric(
-                                        cachedVersion,
-                                        metadata[metadataKey],
-                                        null,
-                                        true
-                                    )
+                                    (metadata[metadataKey]._generated || // of generated, never "update"
+                                        !this.hasChangedGeneric(
+                                            cachedVersion,
+                                            metadata[metadataKey],
+                                            'Path',
+                                            true
+                                        ))
                                 ) {
                                     Util.logger.verbose(
                                         ` - skipping ${this.definition.type} ${
@@ -228,12 +231,13 @@ class Folder extends MetadataType {
                                 existingId = cachedVersion?.ID;
                                 if (
                                     existingId &&
-                                    !this.hasChangedGeneric(
-                                        cachedVersion,
-                                        metadata[metadataKey],
-                                        null,
-                                        true
-                                    )
+                                    (metadata[metadataKey]._generated || // of generated, never "update"
+                                        !this.hasChangedGeneric(
+                                            cachedVersion,
+                                            metadata[metadataKey],
+                                            'Path',
+                                            true
+                                        ))
                                 ) {
                                     Util.logger.verbose(
                                         ` - skipping ${this.definition.type} ${
@@ -253,10 +257,18 @@ class Folder extends MetadataType {
                                 // if an existing folder exists with the same name/path then use that
                                 deployableMetadata.ID = existingId;
                                 result = await this.update(deployableMetadata);
-                                updateCount++;
+                                if (result) {
+                                    updateCount++;
+                                } else {
+                                    updateFailedCount++;
+                                }
                             } else {
                                 result = await this.create(deployableMetadata);
-                                createCount++;
+                                if (result) {
+                                    createCount++;
+                                } else {
+                                    createFailedCount++;
+                                }
                             }
                             if (result?.Results) {
                                 const parsed = this.parseResponseBody({
@@ -293,7 +305,9 @@ class Folder extends MetadataType {
         }
         // Logging
         Util.logger.info(
-            `${this.definition.type} upsert: ${createCount} created / ${updateCount} updated` +
+            `${this.definition.type} upsert: ${createCount} of ${
+                createCount + createFailedCount
+            } created / ${updateCount} of ${updateCount + updateFailedCount} updated` +
                 (filteredByPreDeploy > 0 ? ` / ${filteredByPreDeploy} filtered` : '')
         );
 

package/lib/metadataTypes/MetadataType.js

@@ -1281,7 +1281,7 @@ class MetadataType {
         return savedResults;
     }
     /**
-     * helper for buildDefinitionForNested
+     * helper for {@link buildDefinitionForNested}
      * searches extracted file for template variable names and applies the market values
      *
      * @param {string} code code from extracted code
@@ -1293,7 +1293,7 @@ class MetadataType {
         return Mustache.render(code, templateVariables);
     }
     /**
-     * helper for buildTemplateForNested
+     * helper for {@link buildTemplateForNested}
      * searches extracted file for template variable values and applies the market variable names
      *
      * @param {string} code code from extracted code
@@ -1305,7 +1305,7 @@ class MetadataType {
         return Util.replaceByObject(code, templateVariables);
     }
     /**
-     * helper for buildDefinition
+     * helper for {@link buildDefinition}
      * handles extracted code if any are found for complex types (e.g script, asset, query)
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -1326,7 +1326,7 @@ class MetadataType {
         return null;
     }
     /**
-     * helper for buildTemplate
+     * helper for {@link buildTemplate}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored

package/lib/metadataTypes/Query.js

@@ -136,7 +136,7 @@ class Query extends MetadataType {
         return metadata;
     }
     /**
-     * helper for buildDefinitionForNested
+     * helper for {@link buildDefinitionForNested}
      * searches extracted SQL file for template variables and applies the market values
      *
      * @param {string} code code from extracted code
@@ -159,7 +159,7 @@ class Query extends MetadataType {
         return Mustache.render(code, templateVariables);
     }
     /**
-     * helper for buildDefinition
+     * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -186,7 +186,7 @@ class Query extends MetadataType {
         );
     }
     /**
-     * helper for buildTemplate
+     * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
      *
      * @example queries are saved as 1 json and 1 sql file. both files need to be run through templating
@@ -214,7 +214,7 @@ class Query extends MetadataType {
         );
     }
     /**
-     * helper for buildTemplateForNested / buildDefinitionForNested
+     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @private