mcdev 5.0.2 → 5.2.0

package/lib/metadataTypes/MobileKeyword.js

@@ -96,7 +96,7 @@ class MobileKeyword extends MetadataType {
     }
 
     /**
-     * helper for {@link parseResponseBody} that creates a custom key field for this type based on mobileCode and keyword
+     * helper for {@link MobileKeyword.parseResponseBody} that creates a custom key field for this type based on mobileCode and keyword
      *
      * @private
      * @param {TYPE.MetadataType} metadata single item
@@ -106,7 +106,7 @@ class MobileKeyword extends MetadataType {
     }
 
     /**
-     * helper for {@link preDeployTasks} and {@link createOrUpdate} to ensure we have code & keyword properly set
+     * helper for {@link MobileKeyword.preDeployTasks} and {@link MobileKeyword.createOrUpdate} to ensure we have code & keyword properly set
      *
      * @private
      * @param {TYPE.MetadataType} metadata single item
@@ -192,7 +192,7 @@ class MobileKeyword extends MetadataType {
     }
 
     /**
-     * helper for {@link retrieve} and {@link retrieveAsTemplate}
+     * helper for {@link MobileKeyword.retrieve} and {@link MobileKeyword.retrieveAsTemplate}
      *
      * @private
      * @param {string} key customer key of single item to retrieve / name of the metadata file
@@ -281,7 +281,7 @@ class MobileKeyword extends MetadataType {
         }
     }
     /**
-     * helper for {@link parseMetadata} and {@link _buildForNested}
+     * helper for {@link MobileKeyword.postRetrieveTasks} and {@link MobileKeyword._buildForNested}
      *
      * @param {string} metadataScript the code of the file
      * @returns {{fileExt:string,code:string}} returns found extension and file content
@@ -349,7 +349,7 @@ class MobileKeyword extends MetadataType {
     }
 
     /**
-     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
+     * helper for {@link MobileKeyword.buildTemplateForNested} / {@link MobileKeyword.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -445,7 +445,7 @@ class MobileKeyword extends MetadataType {
         return metadata;
     }
     /**
-     * helper for {@link createREST}
+     * helper for {@link MetadataType.createREST}
      *
      * @param {TYPE.MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
@@ -455,7 +455,7 @@ class MobileKeyword extends MetadataType {
         await super.postDeployTasks_legacyApi(metadataEntry, apiResponse);
     }
     /**
-     * helper for {@link updateREST}
+     * helper for {@link MetadataType.updateREST}
      *
      * @param {TYPE.MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
@@ -466,7 +466,7 @@ class MobileKeyword extends MetadataType {
     }
 
     /**
-     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
+     * helper for {@link MobileKeyword.preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {TYPE.MetadataTypeItem} metadata a single definition
      * @param {string} deployDir directory of deploy files

package/lib/metadataTypes/MobileMessage.js

@@ -83,7 +83,7 @@ class MobileMessage extends MetadataType {
         return super.createREST(metadata, '/legacy/v1/beta/mobile/message/');
     }
     /**
-     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
+     * helper for {@link MobileMessage.preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {TYPE.MetadataTypeItem} metadata a single definition
      * @param {string} deployDir directory of deploy files
@@ -110,7 +110,7 @@ class MobileMessage extends MetadataType {
         }
     }
     /**
-     * helper for {@link parseMetadata} and {@link _buildForNested}
+     * helper for {@link MobileMessage.postRetrieveTasks} and {@link MobileMessage._buildForNested}
      *
      * @param {string} code the code of the file
      * @returns {{fileExt:string,code:string}} returns found extension and file content
@@ -304,7 +304,7 @@ class MobileMessage extends MetadataType {
         return metadata;
     }
     /**
-     * helper for {@link createREST}
+     * helper for {@link MetadataType.createREST}
      *
      * @param {TYPE.MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
@@ -314,7 +314,7 @@ class MobileMessage extends MetadataType {
         await super.postDeployTasks_legacyApi(metadataEntry, apiResponse);
     }
     /**
-     * helper for {@link updateREST}
+     * helper for {@link MetadataType.updateREST}
      *
      * @param {TYPE.MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
@@ -380,7 +380,7 @@ class MobileMessage extends MetadataType {
     }
 
     /**
-     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
+     * helper for {@link MobileMessage.buildTemplateForNested} / {@link MobileMessage.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored

package/lib/metadataTypes/Query.js

@@ -38,7 +38,9 @@ class Query extends MetadataType {
             objectId = await this._getObjectIdForSingleRetrieve(key);
             if (!objectId) {
                 // avoid running the rest request below by returning early
-                Util.logger.info(`Downloaded: ${this.definition.type} (0) - Key: ${key}`);
+                Util.logger.info(
+                    `Downloaded: ${this.definition.type} (0)${Util.getKeysString(key)}`
+                );
                 return { metadata: {}, type: this.definition.type };
             }
         }
@@ -50,6 +52,34 @@ class Query extends MetadataType {
             key
         );
     }
+    /**
+     * a function to start query execution via API
+     *
+     * @param {string[]} keyArr customerkey of the metadata
+     * @returns {Promise.<string[]>} Returns list of keys that were executed successfully
+     */
+    static async execute(keyArr) {
+        const results = [];
+        // works only with objectId
+        let objectId;
+        for (const key of keyArr) {
+            if (key) {
+                objectId = await this._getObjectIdForSingleRetrieve(key);
+                if (!objectId) {
+                    Util.logger.info(`Skipping ${key} - did not find an item with such key`);
+                    continue;
+                }
+            }
+            results.push(
+                super.executeREST(`/automation/v1/queries/${objectId}/actions/start/`, key)
+            );
+        }
+        const executedKeyArr = (await Promise.all(results))
+            .filter((r) => r.response === 'OK')
+            .map((r) => r.key);
+        Util.logger.info(`Executed ${executedKeyArr.length} of ${keyArr.length} items`);
+        return executedKeyArr;
+    }
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -224,7 +254,7 @@ class Query extends MetadataType {
         return metadata;
     }
     /**
-     * helper for {@link buildDefinitionForNested}
+     * helper for {@link Query.buildDefinitionForNested}
      * searches extracted SQL file for template variables and applies the market values
      *
      * @param {string} code code from extracted code
@@ -302,7 +332,7 @@ class Query extends MetadataType {
         );
     }
     /**
-     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
+     * helper for {@link Query.buildTemplateForNested} / {@link Query.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @private
@@ -394,11 +424,12 @@ class Query extends MetadataType {
      * @param {object} ex response payload from REST API
      * @returns {string[] | void} formatted Error Message
      */
-    static checkForErrors(ex) {
-        const errors = super.checkForErrors(ex);
+    static getErrorsREST(ex) {
+        const errors = super.getErrorsREST(ex);
         if (errors?.length > 0) {
             return errors.map((msg) => msg.split('Error saving the Query field.').join(''));
         }
+        return errors;
     }
     /**
      * Delete a metadata item from the specified business unit
@@ -426,6 +457,17 @@ class Query extends MetadataType {
         // delete local copy: retrieve/cred/bu/.../...-meta.sql
         await super.postDeleteTasks(customerKey, [`${this.definition.type}-meta.sql`]);
     }
+    /**
+     * Gets executed after deployment of metadata type
+     *
+     * @param {TYPE.MetadataTypeMap} upsertResults metadata mapped by their keyField as returned by update/create
+     */
+    static async postDeployTasks(upsertResults) {
+        if (Util.OPTIONS.execute) {
+            Util.logger.info(`Executing: ${this.definition.type}`);
+            await this.execute(Object.keys(upsertResults));
+        }
+    }
 }
 
 // Assign definition & cache to static attributes

package/lib/metadataTypes/Script.js

@@ -82,7 +82,7 @@ class Script extends MetadataType {
     }
 
     /**
-     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
+     * helper for {@link Script.preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {TYPE.ScriptItem} metadata a single asset definition
      * @param {string} deployDir directory of deploy files
@@ -189,7 +189,7 @@ class Script extends MetadataType {
     }
 
     /**
-     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
+     * helper for {@link Script.buildTemplateForNested} / {@link Script.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -279,7 +279,7 @@ class Script extends MetadataType {
         return { json: metadata, codeArr: codeArr, subFolder: null };
     }
     /**
-     * helper for {@link parseMetadata} and {@link _buildForNested}
+     * helper for {@link Script.parseMetadata} and {@link Script._buildForNested}
      *
      * @param {string} metadataScript the code of the file
      * @param {string} metadataName the name of the metadata

package/lib/metadataTypes/TransactionalSMS.js

@@ -66,7 +66,7 @@ class TransactionalSMS extends TransactionalMessage {
         return metadata;
     }
     /**
-     * helper for {@link preDeployTasks} that loads extracted code content back into JSON
+     * helper for {@link TransactionalSMS.preDeployTasks} that loads extracted code content back into JSON
      *
      * @param {TYPE.MetadataTypeItem} metadata a single definition
      * @param {string} deployDir directory of deploy files
@@ -158,7 +158,7 @@ class TransactionalSMS extends TransactionalMessage {
         return { json: metadata, codeArr: codeArr, subFolder: null };
     }
     /**
-     * helper for {@link parseMetadata} and {@link _buildForNested}
+     * helper for {@link TransactionalSMS.postRetrieveTasks} and {@link TransactionalSMS._buildForNested}
      *
      * @param {string} metadataScript the code of the file
      * @returns {{fileExt:string,code:string}} returns found extension and file content
@@ -189,7 +189,7 @@ class TransactionalSMS extends TransactionalMessage {
         return { fileExt, code };
     }
     /**
-     * helper for {@link MetadataType.buildDefinition}
+     * helper for {@link TransactionalMessage.buildDefinition}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored
@@ -216,7 +216,7 @@ class TransactionalSMS extends TransactionalMessage {
         );
     }
     /**
-     * helper for {@link MetadataType.buildTemplate}
+     * helper for {@link TransactionalMessage.buildTemplate}
      * handles extracted code if any are found for complex types
      *
      * @example scripts are saved as 1 json and 1 ssjs file. both files need to be run through templating
@@ -245,7 +245,7 @@ class TransactionalSMS extends TransactionalMessage {
     }
 
     /**
-     * helper for {@link buildTemplateForNested} / {@link buildDefinitionForNested}
+     * helper for {@link TransactionalSMS.buildTemplateForNested} / {@link TransactionalSMS.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
      *
      * @param {string} templateDir Directory where metadata templates are stored

package/lib/metadataTypes/TriggeredSend.js

@@ -85,51 +85,19 @@ class TriggeredSend extends MetadataType {
         return super.deleteByKeySOAP(customerKey);
     }
 
-    /**
-     * manages post retrieve steps
-     *
-     * @param {TYPE.MetadataTypeItem} metadata a single query
-     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one query string
-     */
-    static postRetrieveTasks(metadata) {
-        return this.parseMetadata(metadata);
-    }
-    /**
-     * generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
-     *
-     * @param {TYPE.MetadataTypeItem} metadata a single script activity definition
-     */
-    static setFolderPath(metadata) {
-        try {
-            metadata.r__folder_Path = cache.searchForField(
-                'folder',
-                metadata[this.definition.folderIdField],
-                'ID',
-                'Path'
-            );
-            delete metadata[this.definition.folderIdField];
-        } catch (ex) {
-            Util.logger.verbose(
-                ` - skipping ${this.definition.type} '${metadata[this.definition.nameField]}' (${
-                    metadata[this.definition.keyField]
-                }): Could not find folder (${ex.message})`
-            );
-            throw ex;
-        }
-    }
     /**
      * parses retrieved Metadata before saving
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single query activity definition
+     * @param {TYPE.MetadataTypeItem} metadata a single item
      * @returns {TYPE.MetadataTypeItem | void} Array with one metadata object and one sql string
      */
-    static parseMetadata(metadata) {
+    static postRetrieveTasks(metadata) {
         // remove IsPlatformObject, always has to be 'false'
         delete metadata.IsPlatformObject;
+
         // folder
-        try {
-            this.setFolderPath(metadata);
-        } catch {
+        this.setFolderPath(metadata);
+        if (!metadata.r__folder_Path) {
             Util.logger.verbose(
                 ` ☇ skipping ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find folder.`
             );
@@ -163,7 +131,7 @@ class TriggeredSend extends MetadataType {
                 delete metadata.Email;
             } catch {
                 Util.logger.verbose(
-                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder. This TSD cannot be replublished but potentially restarted with its cached version of the email.`
+                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder. This TSD cannot be republished but potentially restarted with its cached version of the email.`
                 );
                 // save this TSD because it could be fixed by the user or potentially restarted without a fix; also, it might be used by a journey
             }
@@ -246,7 +214,7 @@ class TriggeredSend extends MetadataType {
      * TSD-specific refresh method that finds active TSDs and refreshes them
      *
      * @param {string[]} [keyArr] metadata keys
-     * @param {boolean} [checkKey=true] whether to check if the key is valid
+     * @param {boolean} [checkKey] whether to check if the key is valid
      * @returns {Promise.<void>} -
      */
     static async refresh(keyArr, checkKey = true) {
@@ -268,7 +236,7 @@ class TriggeredSend extends MetadataType {
     }
 
     /**
-     * helper for {@link refresh} that extracts the keys from the TSD item map and eli
+     * helper for {@link TriggeredSend.refresh} that extracts the keys from the TSD item map and eli
      *
      * @param {TYPE.MetadataTypeMapObj} metadata TSD item map
      * @returns {Promise.<string[]>} keyArr
@@ -282,11 +250,12 @@ class TriggeredSend extends MetadataType {
         return keyArr;
     }
     /**
-     * helper for {@link refresh} that finds active TSDs on the server and filters it by the same rules that {@link retrieve} is using to avoid refreshing TSDs with broken dependencies
+     * helper for {@link TriggeredSend.refresh} that finds active TSDs on the server and filters it by the same rules that {@link TriggeredSend.retrieve} is using to avoid refreshing TSDs with broken dependencies
      *
+     * @param {boolean} [assetLoaded] if run after Asset.deploy via --refresh option this will skip caching assets
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of TSD item map
      */
-    static async findRefreshableItems() {
+    static async findRefreshableItems(assetLoaded = false) {
         Util.logger.info('Finding refreshable items...');
         // cache dependencies to test for broken links
         // skip deprecated classic emails here, assuming they cannot be updated and hence are not relevant for {@link refresh}
@@ -305,14 +274,20 @@ class TriggeredSend extends MetadataType {
             list: null,
         };
         for (const [type, subTypeArr] of Object.entries(requiredCache)) {
-            if (!cache.getCache()?.[type]) {
-                Util.logger.info(` - Caching dependent Metadata: ${type}`);
-                Util.logSubtypes(subTypeArr);
-                cacheTypes[type].client = this.client;
-                cacheTypes[type].buObject = this.buObject;
-                cacheTypes[type].properties = this.properties;
+            if (type === 'asset' && assetLoaded) {
+                continue;
+            }
+            Util.logger.info(` - Caching dependent Metadata: ${type}`);
+            Util.logSubtypes(subTypeArr);
+            cacheTypes[type].client = this.client;
+            cacheTypes[type].buObject = this.buObject;
+            cacheTypes[type].properties = this.properties;
 
-                const result = await cacheTypes[type].retrieveForCache(null, subTypeArr);
+            const result = await cacheTypes[type].retrieveForCache(null, subTypeArr);
+            if (cache.getCache()?.[type]) {
+                // re-run caching to merge with existing cache, assuming we might have missed subtypes
+                cache.mergeMetadata(type, result.metadata);
+            } else {
                 cache.setMetadata(type, result.metadata);
             }
         }
@@ -329,7 +304,7 @@ class TriggeredSend extends MetadataType {
     }
 
     /**
-     * helper for {@link refresh} that pauses, publishes and starts a triggered send
+     * helper for {@link TriggeredSend.refresh} that pauses, publishes and starts a triggered send
      *
      * @param {string} key external key of triggered send item
      * @param {boolean} checkKey whether to check if key exists on the server

package/lib/metadataTypes/User.js

@@ -404,8 +404,11 @@ class User extends MetadataType {
         if (!metadata.Password) {
             metadata.Password = this._generatePassword();
             Util.logger.info(
-                ` - Password for ${metadata.UserID} was not given. Generated password: ${metadata.Password}`
+                ` - Password for ${metadata.UserID} was not given. Generated password:`
             );
+            // use console.log here to print the generated password to bypass the logfile
+            // eslint-disable-next-line no-console
+            console.log(metadata.Password);
         }
     }
 
@@ -510,7 +513,7 @@ class User extends MetadataType {
      * @param {string} roleName role.Name
      * @param {number} userId user.AccountUserID
      * @param {boolean} assignmentOnly if true, only assignment configuration will be returned
-     * @param {boolean} [isRoleRemovale=false] if true, role will be removed from user; otherwise added
+     * @param {boolean} [isRoleRemovale] if true, role will be removed from user; otherwise added
      * @returns {object} format needed by API
      */
     static _getRoleObjectForDeploy(
@@ -737,7 +740,7 @@ class User extends MetadataType {
     }
 
     /**
-     * helper for {@link retrieveSOAP}
+     * helper for {@link User.retrieveSOAP}
      *
      * @private
      * @param {TYPE.SoapRequestParams} [requestParams] required for the specific request (filter for example)
@@ -897,7 +900,7 @@ class User extends MetadataType {
         }
     }
     /**
-     * helper for {@link createOrUpdate} to generate a random initial password for new users
+     * helper for {@link User.createOrUpdate} to generate a random initial password for new users
      * note: possible minimum length values in SFMC are 6, 8, 10, 15 chars. Therefore we should default here to 15 chars.
      *
      * @private

package/lib/metadataTypes/definitions/Asset.definition.js

@@ -13,6 +13,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: 'modifiedBy.name',
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'asset',
     typeDescription: 'Assets from Content Builder grouped into subtypes.',
     typeRetrieveByDefault: ['asset', 'code', 'textfile', 'block', 'message', 'template', 'other'],