mcdev 8.3.1 → 9.0.0

package/lib/metadataTypes/Journey.js

@@ -50,6 +50,11 @@ class Journey extends MetadataType {
 
         let singleKey = '';
         let mode = 'all';
+        const additionalParams = new URLSearchParams();
+        if (Util.OPTIONS.onlyPublished) {
+            Util.logger.info(' - Retrieving only published versions of journeys');
+            additionalParams.set('status', 'Published');
+        }
         if (key) {
             if (key.startsWith('%23')) {
                 // correct the format
@@ -74,7 +79,7 @@ class Journey extends MetadataType {
                 }
                 mode = 'id';
             } else if (key.startsWith('name:')) {
-                singleKey = '?nameOrDescription=' + encodeURIComponent(key.slice(5));
+                additionalParams.set('nameOrDescription', key.slice(5));
                 mode = 'name';
             } else {
                 // assume actual key was provided
@@ -85,7 +90,10 @@ class Journey extends MetadataType {
 
         try {
             const uri = `/interaction/v1/interactions/`;
-            if ((singleKey && (mode === 'key' || mode === 'id')) || !retrieveDir) {
+            if (
+                (!Util.OPTIONS.onlyPublished && singleKey && (mode === 'key' || mode === 'id')) ||
+                !retrieveDir
+            ) {
                 // full details for retrieve, only base data for caching; reduces caching time from minutes to seconds
                 const extras = retrieveDir && singleKey ? extrasDefault : '';
 
@@ -97,13 +105,12 @@ class Journey extends MetadataType {
                     key
                 );
             } else {
+                const url =
+                    uri + (additionalParams.size > 0 ? '?' + additionalParams.toString() : '');
                 // retrieve all
                 const results = this.definition.restPagination
-                    ? await this.client.rest.getBulk(
-                          uri + (mode === 'name' ? singleKey : ''),
-                          this.definition.restPageSize || 500
-                      )
-                    : await this.client.rest.get(uri + (mode === 'name' ? singleKey : ''));
+                    ? await this.client.rest.getBulk(url, this.definition.restPageSize || 500)
+                    : await this.client.rest.get(url);
 
                 if (results.items?.length) {
                     // empty results will come back without "items" defined
@@ -115,51 +122,71 @@ class Journey extends MetadataType {
                 }
                 // full details for retrieve
                 const extras = extrasDefault;
+                let details = [];
                 let parsed;
                 if (retrieveDir) {
                     const searchName = mode === 'name' ? key.slice(5) : null;
                     const foundKey = [];
+                    let journey;
                     // get extra details for saving this
-                    const details = results.items
-                        ? await Promise.all(
-                              results.items.map(async (a) => {
-                                  if (mode === 'name') {
-                                      // when filtering by name, the API in fact does a LIKE search with placeholders left and right of the search term - and also searches the description field.
-                                      if (searchName === a[this.definition.nameField]) {
-                                          foundKey.push(a[this.definition.keyField]);
-                                      } else {
-                                          // skip because the name does not match
+                    if (Util.OPTIONS.onlyPublished && mode === 'key') {
+                        journey = results.items.find(
+                            (a) => a[this.definition.keyField] === singleKey.slice(4)
+                        );
+                    } else if (Util.OPTIONS.onlyPublished && mode === 'id') {
+                        journey = results.items.find(
+                            (a) => a[this.definition.idField] === singleKey
+                        );
+                    } else {
+                        details = results.items
+                            ? await Promise.all(
+                                  results.items.map(async (a) => {
+                                      if (mode === 'name') {
+                                          // when filtering by name, the API in fact does a LIKE search with placeholders left and right of the search term - and also searches the description field.
+                                          if (searchName === a[this.definition.nameField]) {
+                                              foundKey.push(a[this.definition.keyField]);
+                                          } else {
+                                              // skip because the name does not match
+                                              return null;
+                                          }
+                                      }
+                                      try {
+                                          return await this.client.rest.get(
+                                              `${uri}key:${a[this.definition.keyField]}?extras=${extras}` +
+                                                  `&versionNumber=${a.version}`
+                                          );
+                                      } catch (ex) {
+                                          // if we do get here, we should log the error and continue instead of failing to download all automations
+                                          Util.logger.warn(
+                                              ` ☇ skipping ${this.definition.type} ${
+                                                  a[this.definition.nameField]
+                                              } (${a[this.definition.keyField]}): ${ex.message} (${
+                                                  ex.code
+                                              })${
+                                                  ex.endpoint
+                                                      ? Util.getGrayMsg(
+                                                            ' - ' +
+                                                                ex.endpoint.split(
+                                                                    'rest.marketingcloudapis.com'
+                                                                )[1]
+                                                        )
+                                                      : ''
+                                              }`
+                                          );
                                           return null;
                                       }
-                                  }
-                                  try {
-                                      return await this.client.rest.get(
-                                          `${uri}key:${a[this.definition.keyField]}?extras=${extras}` +
-                                              `&versionNumber=${a.version}`
-                                      );
-                                  } catch (ex) {
-                                      // if we do get here, we should log the error and continue instead of failing to download all automations
-                                      Util.logger.warn(
-                                          ` ☇ skipping ${this.definition.type} ${
-                                              a[this.definition.nameField]
-                                          } (${a[this.definition.keyField]}): ${ex.message} (${
-                                              ex.code
-                                          })${
-                                              ex.endpoint
-                                                  ? Util.getGrayMsg(
-                                                        ' - ' +
-                                                            ex.endpoint.split(
-                                                                'rest.marketingcloudapis.com'
-                                                            )[1]
-                                                    )
-                                                  : ''
-                                          }`
-                                      );
-                                      return null;
-                                  }
-                              })
-                          )
-                        : [];
+                                  })
+                              )
+                            : [];
+                    }
+                    if (Util.OPTIONS.onlyPublished && journey) {
+                        details.push(
+                            await this.client.rest.get(
+                                `${uri}${singleKey}?extras=${extras}` +
+                                    `&versionNumber=${journey.version}`
+                            )
+                        );
+                    }
                     parsed = this.parseResponseBody({ items: details.filter(Boolean) });
                     // * retrieveDir is mandatory in this method as it is not used for caching (there is a seperate method for that)
                     const savedMetadata = await this.saveResults(parsed, retrieveDir, null, null);
@@ -1296,7 +1323,7 @@ class Journey extends MetadataType {
         }
 
         // apply sorting by activity key to work around the API shuffling activities around
-        metadata.activities = metadata.activities.sort((a, b) => a.key.localeCompare(b.key));
+        metadata.activities = metadata.activities.toSorted((a, b) => a.key.localeCompare(b.key));
     }
 
     /**
@@ -2335,7 +2362,7 @@ class Journey extends MetadataType {
         }
 
         // good practice to return the published keys in alphabetical order
-        return executedKeyArr.filter(Boolean).sort();
+        return executedKeyArr.filter(Boolean).toSorted();
     }
 
     /**

package/lib/metadataTypes/List.js

@@ -92,7 +92,7 @@ class List extends MetadataType {
     }
 
     /**
-     * helper for @link retrieveForCache and @link retrieve
+     * helper for {@link retrieveForCache} and {@link retrieve}
      *
      * @private
      * @param {MetadataTypeMapObj} results metadata from retrieve for current BU

package/lib/metadataTypes/MetadataType.js

@@ -108,7 +108,7 @@ class MetadataType {
         } catch (ex) {
             // this will catch issues with readdirSync
             Util.metadataLogger('debug', this.definition.type, 'getJsonFromFS', ex);
-            throw new Error(ex);
+            throw ex;
         }
         return fileName2FileContent;
     }
@@ -229,7 +229,8 @@ class MetadataType {
             // postRetrieveTasks will be run automatically on this via super.saveResult
         } catch (ex) {
             throw new Error(
-                `Could not get details for new ${this.definition.type} ${id} from server (${ex.message})`
+                `Could not get details for new ${this.definition.type} ${id} from server (${ex.message})`,
+                { cause: ex }
             );
         }
     }
@@ -451,7 +452,7 @@ class MetadataType {
 
             return { metadata: metadata, type: this.definition.type };
         } catch (ex) {
-            throw new Error(`${this.definition.type}:: ${ex.message}`);
+            throw new Error(`${this.definition.type}:: ${ex.message}`, { cause: ex });
         }
     }
 
@@ -845,8 +846,7 @@ class MetadataType {
 
                                 // make this newly created item available in cache for other itmes that might reference it
                                 /** @type {MetadataTypeMap} */
-                                const newObject = {};
-                                newObject[metadataKey] = metadataMap[metadataKey];
+                                const newObject = { [metadataKey]: metadataMap[metadataKey] };
                                 cache.mergeMetadata(this.definition.type, newObject);
                             }
                         } else if (action === 'update' && !Util.OPTIONS.noUpdate) {
@@ -872,8 +872,10 @@ class MetadataType {
                                 updateResults.push(result);
 
                                 // make this newly created item available in cache for other itmes that might reference it
-                                const newObject = {};
-                                newObject[metadataKey] = structuredClone(metadataMap[metadataKey]);
+                                const newObject = {
+                                    [metadataKey]: structuredClone(metadataMap[metadataKey]),
+                                };
+
                                 if (result.objectID) {
                                     // required for assets
                                     newObject[metadataKey].objectID = result.objectID;
@@ -1704,8 +1706,7 @@ class MetadataType {
                 (typeof singleRetrieve === 'string' || typeof singleRetrieve === 'number')
             ) {
                 // in case we really just wanted one entry but couldnt do so in the api call, filter it here
-                const single = {};
-                single[singleRetrieve] = metadataStructure[singleRetrieve];
+                const single = { [singleRetrieve]: metadataStructure[singleRetrieve] };
                 return single;
             } else if (singleRetrieve) {
                 return {};
@@ -2547,8 +2548,7 @@ class MetadataType {
      * @returns {Promise.<boolean>} deletion success flag
      */
     static async deleteByKeySOAP(key, overrideKeyField, codeNotFound, handleOutside) {
-        const metadata = {};
-        metadata[overrideKeyField || this.definition.keyField] = key;
+        const metadata = { [overrideKeyField || this.definition.keyField]: key };
         const soapType = this.definition.soapType || this.definition.type;
         try {
             await this.client.soap.delete(Util.capitalizeFirstLetter(soapType), metadata, null);
@@ -2639,16 +2639,12 @@ class MetadataType {
     static async readBUMetadataForType(readDir, listBadKeys, buMetadata) {
         buMetadata ||= {};
         readDir = File.normalizePath([readDir, this.definition.type]);
-        try {
-            if (await File.pathExists(readDir)) {
-                // check if folder name is a valid metadataType, then check if the user limited to a certain type in the command params
-                buMetadata[this.definition.type] = await this.getJsonFromFS(readDir, listBadKeys);
-                return buMetadata;
-            } else {
-                throw new Error(`Directory '${readDir}' does not exist.`);
-            }
-        } catch (ex) {
-            throw new Error(ex.message);
+        if (await File.pathExists(readDir)) {
+            // check if folder name is a valid metadataType, then check if the user limited to a certain type in the command params
+            buMetadata[this.definition.type] = await this.getJsonFromFS(readDir, listBadKeys);
+            return buMetadata;
+        } else {
+            throw new Error(`Directory '${readDir}' does not exist.`);
         }
     }
 

package/lib/metadataTypes/Script.js

@@ -83,6 +83,22 @@ class Script extends MetadataType {
         return super.updateREST(script, '/automation/v1/scripts/' + script.ssjsActivityId);
     }
 
+    /**
+     * helper for {@link MetadataType.updateREST} and {@link MetadataType.updateSOAP}
+     *
+     * @param {MetadataTypeItem} metadataEntry a single metadata Entry
+     * @param {object} apiResponse varies depending on the API call
+     * @returns {Promise.<object>} apiResponse, potentially modified
+     */
+    static async postUpdateTasks(metadataEntry, apiResponse) {
+        // script update endpoint returns wrong values for createdDate and modifiedDate - need to re-retrieve to get correct values
+        const ssjsActivityId = apiResponse?.ssjsActivityId;
+        if (ssjsActivityId) {
+            apiResponse = await this.client.rest.get('/automation/v1/scripts/' + ssjsActivityId);
+        }
+        return apiResponse;
+    }
+
     /**
      * Creates a single Script
      *

package/lib/metadataTypes/User.js

@@ -1055,7 +1055,7 @@ class User extends MetadataType {
                 associatedBus = [
                     ...new Set(user.c__AssociatedBusinessUnits.map((mid) => this._getBuName(mid))),
                 ]
-                    .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
+                    .toSorted((a, b) => (a < b ? -1 : a > b ? 1 : 0))
                     .join(',<br> ');
             }
             const defaultBUName = this._getBuName(user.DefaultBusinessUnit);
@@ -1215,7 +1215,7 @@ class User extends MetadataType {
                     // individual role (which are not manageable nor visible in the GUI)
                     (roleName) => !roleName.startsWith('Individual role for ')
                 )
-                .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));
+                .toSorted((a, b) => (a < b ? -1 : a > b ? 1 : 0));
         } else {
             // set to empty array
             roles = [];

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

@@ -23,6 +23,7 @@ export default {
     soapType: 'FilterDefinition',
     typeDescription: 'Defines an audience based on specified rules. Used by Filter Activities.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Data Filter',
     fields: {
         // the GUI seems to ONLY send fields during update that are actually changed. It has yet to be tested if that also works with sending other fiedls as well

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

@@ -24,6 +24,7 @@ export default {
     typeDescription:
         'Defines an audience based on specified rules. Auto-generated by filtered DEs and filtered Lists.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Data Filter (auto-generated)',
     fields: {
         // the GUI seems to ONLY send fields during update that are actually changed. It has yet to be tested if that also works with sending other fiedls as well

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

@@ -5,13 +5,14 @@ export default {
     hasExtended: false,
     idField: 'id',
     keyIsFixed: true,
-    keyField: 'name',
+    keyField: 'customerKey',
     nameField: 'name',
     createdDateField: null,
     createdNameField: null,
     lastmodDateField: null,
     lastmodNameField: null,
     restPagination: false,
+    maxKeyLength: 36, // confirmed max length
     type: 'fileLocation',
     typeDescription:
         'Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation.',
@@ -32,37 +33,81 @@ export default {
         'Azure Blob Storage': 15,
         'Google Cloud Storage': 16,
     },
+    locationTypeMappingDeployable: {
+        'External SFTP Site': 'ExternalSftp',
+        'Amazon Simple Storage Service': 'AmazonSimpleStorage',
+        'Azure Blob Storage': 'AzureBlobStorage',
+        'Google Cloud Storage': 'GcpBlobStorage',
+    },
+    locationTypeIdMappingDeployable: {
+        2: 'ExternalSftp',
+        13: 'AmazonSimpleStorage',
+        15: 'AzureBlobStorage',
+        16: 'GcpBlobStorage',
+    },
     fields: {
         id: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         locationTypeId: {
+            // automation endpoint
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
+            template: false,
+        },
+        locationType: {
+            // data endpoint
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
             template: false,
         },
         locationUrl: {
             isCreateable: false,
             isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        name: {
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
-        name: {
-            isCreateable: false,
-            isUpdateable: false,
+        customerKey: {
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
-        relPath: {
+        description: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
             template: true,
         },
+        relPath: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        awsFileTransferLocation: {
+            skipValidation: true,
+        },
+        azureFileTransferLocation: {
+            skipValidation: true,
+        },
+        gcpFileTransferLocation: {
+            skipValidation: true,
+        },
+        sFtpFileTransferLocation: {
+            skipValidation: true,
+        },
         c__locationType: {
             isCreateable: false,
             isUpdateable: false,

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

@@ -1188,6 +1188,12 @@ export default {
             retrieving: true,
             template: true,
         },
+        campaigns: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         metaData: {
             skipValidation: true,
         },

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

@@ -100,6 +100,12 @@ export default {
             retrieving: false,
             template: false,
         },
+        parentCategoryId: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         r__folder_Path: { skipValidation: true },
     },
 };

package/lib/util/auth.js

@@ -40,32 +40,28 @@ const Auth = {
      */
     async saveCredential(authObject, credential) {
         const sdk = setupSDK(credential, authObject);
-        try {
-            // check credentials to allow clear log output and stop execution
-            const test = await sdk.auth.getAccessToken();
-            if (test.error) {
-                throw new Error(test.error_description);
-            } else if (test.scope) {
-                // find missing rights
-                const missingAccess = sdk.auth
-                    .getSupportedScopes()
-                    .filter((element) => !test.scope.includes(element));
+        // check credentials to allow clear log output and stop execution
+        const test = await sdk.auth.getAccessToken();
+        if (test.error) {
+            throw new Error(test.error_description);
+        } else if (test.scope) {
+            // find missing rights
+            const missingAccess = sdk.auth
+                .getSupportedScopes()
+                .filter((element) => !test.scope.includes(element));
 
-                if (missingAccess.length) {
-                    Util.logger.warn(
-                        'Installed package has insufficient access. You might encounter malfunctions!'
-                    );
-                    Util.logger.warn('Missing scope: ' + missingAccess.join(', '));
-                }
-                const existingAuth = (await File.pathExists(Util.authFileName))
-                    ? await File.readJSON(Util.authFileName)
-                    : {};
-                existingAuth[credential] = authObject;
-                await File.writeJSONToFile('./', Util.authFileName.split('.json')[0], existingAuth);
-                authfile = existingAuth;
+            if (missingAccess.length) {
+                Util.logger.warn(
+                    'Installed package has insufficient access. You might encounter malfunctions!'
+                );
+                Util.logger.warn('Missing scope: ' + missingAccess.join(', '));
             }
-        } catch (ex) {
-            throw new Error(ex.message);
+            const existingAuth = (await File.pathExists(Util.authFileName))
+                ? await File.readJSON(Util.authFileName)
+                : {};
+            existingAuth[credential] = authObject;
+            await File.writeJSONToFile('./', Util.authFileName.split('.json')[0], existingAuth);
+            authfile = existingAuth;
         }
     },
 

package/lib/util/businessUnit.js

@@ -60,7 +60,7 @@ const BusinessUnit = {
                     element.ID = Number.parseInt(element.ID);
                     element.ParentID = Number.parseInt(element.ParentID);
                     return element;
-                }).sort((a, b) => {
+                }).toSorted((a, b) => {
                     if (a.ParentID === 0) {
                         return -1;
                     }

package/lib/util/cli.js

@@ -304,7 +304,8 @@ const Cli = {
     async _setCredential(properties, credName, refreshBUs = true) {
         const skipInteraction = Util.skipInteraction;
         // Get user input
-        let credentialsGood = null;
+        /** @type {boolean} */
+        let credentialsGood;
         let inputData;
         do {
             if (skipInteraction) {

package/lib/util/file.js

@@ -271,7 +271,8 @@ const File = {
      */
     _beautify_prettier: async function (directory, filename, filetype, content) {
         const properties = await config.getProperties();
-        let formatted = '';
+        /** @type {string} */
+        let formatted;
         try {
             if (!FileFs.prettierConfig) {
                 // either no prettier config in project directory or initPrettier was not run before this

package/lib/util/init.config.js

@@ -444,13 +444,15 @@ const Init = {
         );
         boilerplateFileContent ||= await File.readFile(boilerplateFileName, 'utf8');
 
-        let todo = null;
+        /** @type {string} */
+        let todo;
 
         if (await File.pathExists(fileName)) {
             if (relevantForced.deletes.includes(path.normalize(fileName))) {
                 Util.logger.info(
                     `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
                 );
+                // eslint-disable-next-line no-useless-assignment
                 todo = 'delete';
             } else {
                 const existingFileContent = await File.readFile(fileName, 'utf8');

package/lib/util/init.git.js

@@ -30,7 +30,8 @@ const Init = {
         }
         // 3. test if in git repo
         const gitRepoFoundInCWD = await File.pathExists('.git');
-        let newRepoInitialized = null;
+        /** @type {boolean} */
+        let newRepoInitialized;
         if (gitRepoFoundInCWD) {
             Util.logger.info(`✔️  Git repository found`);
             newRepoInitialized = false;

package/lib/util/init.js

@@ -91,6 +91,7 @@ const Init = {
                     }
                 } while (error && !skipInteraction);
                 Util.logger.debug('reloading config');
+                // eslint-disable-next-line no-useless-assignment
                 properties = await config.getProperties(true);
             } else if (missingCredentials.length) {
                 // forced update-credential mode - user likely cloned repo and is missing mcdev-auth.json
@@ -284,7 +285,7 @@ const Init = {
     },
 
     /**
-     * helper for @initProject that optionally creates markets and market lists for all BUs
+     * helper for {@link Init.initProject} that optionally creates markets and market lists for all BUs
      */
     async _initMarkets() {
         const skipInteraction = Util.skipInteraction;

package/lib/util/util.js

@@ -1018,7 +1018,7 @@ export const Util = {
         if (subTypeArr && subTypeArr.length > 0) {
             Util.logger.info(
                 Util.getGrayMsg(
-                    `${indent} - Subtype${subTypeArr.length > 1 ? 's' : ''}: ${[...subTypeArr].sort().join(', ')}`
+                    `${indent} - Subtype${subTypeArr.length > 1 ? 's' : ''}: ${[...subTypeArr].toSorted().join(', ')}`
                 )
             );
         }
@@ -1341,7 +1341,7 @@ export const Util = {
                 values.push(...this.findLeafVals(object[k], key));
             }
         });
-        return [...new Set(values.sort())];
+        return [...new Set(values.toSorted())];
     },
     /**
      * helper that returns a new object with sorted attributes of the given object
@@ -1351,7 +1351,7 @@ export const Util = {
      */
     sortObjectAttributes(obj) {
         return Object.keys(obj)
-            .sort()
+            .toSorted()
             .reduce((acc, key) => {
                 acc[key] = obj[key];
                 return acc;