mcdev 4.3.4 → 5.0.0

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

@@ -7,6 +7,7 @@ module.exports = {
     },
     hasExtended: false,
     idField: 'queryDefinitionId',
+    keyIsFixed: false,
     keyField: 'key',
     nameField: 'name',
     folderIdField: 'categoryId',
@@ -86,8 +87,8 @@ module.exports = {
             template: false,
         },
         targetId: {
-            isCreateable: false,
-            isUpdateable: false,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: false,
             template: false,
         },

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

@@ -16,6 +16,7 @@ module.exports = {
     documentInOneFile: true,
     hasExtended: true,
     idField: 'ObjectID',
+    keyIsFixed: false,
     keyField: 'CustomerKey',
     nameField: 'Name',
     createdDateField: 'CreatedDate',
@@ -77,6 +78,10 @@ module.exports = {
         },
         PermissionSets: {
             retrieving: true,
+            skipCache: true,
+            skipValidation: true,
+        },
+        c__notAssignable: {
             skipValidation: true,
         },
     },

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

@@ -4,6 +4,7 @@ module.exports = {
     folderType: 'ssjsactivity',
     hasExtended: false,
     idField: 'ssjsActivityId',
+    keyIsFixed: false,
     keyField: 'key',
     nameField: 'name',
     folderIdField: 'categoryId',

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

@@ -0,0 +1,114 @@
+// https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/sendclassification.html
+module.exports = {
+    bodyIteratorField: 'Results',
+    dependencies: [],
+    filter: {},
+    hasExtended: false,
+    idField: 'ObjectID',
+    keyIsFixed: null,
+    keyField: 'CustomerKey',
+    nameField: 'Name',
+    createdDateField: 'CreatedDate',
+    createdNameField: null,
+    lastmodDateField: 'ModifiedDate',
+    lastmodNameField: null,
+    restPagination: false,
+    type: 'sendClassification',
+    typeDescription:
+        'Lets admins define Delivery Profile, Sender Profile and CAN-SPAM for an email job in a central location.',
+    typeRetrieveByDefault: false,
+    typeName: 'Send Classification',
+    fields: {
+        'Client.ID': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        CreatedDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        ModifiedDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        CustomerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        ObjectID: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        Name: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        Description: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        PartnerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        PartnerProperties: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+
+        ArchiveEmail: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        DeliveryProfile: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        HonorPublicationListOptOutsForTransactionalSends: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        SendClassificationType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        SenderProfile: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        SendPriority: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+    },
+};

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

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: [], // future may have dependency on Data Extensions
     hasExtended: false,
     idField: 'definitionID',
+    keyIsFixed: null,
     keyField: 'definitionKey',
     nameField: 'name',
     createdDateField: 'createDate',

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

@@ -1,8 +1,9 @@
 module.exports = {
     bodyIteratorField: 'definitions',
-    dependencies: ['asset-message', 'dataExtension', 'list', 'interaction'],
+    dependencies: ['asset-message', 'dataExtension', 'list', 'journey'],
     hasExtended: false,
     idField: 'definitionId',
+    keyIsFixed: true, // sending definitionKey in update call not allowed by API
     keyField: 'definitionKey',
     nameField: 'name',
     createdDateField: 'createdDate',

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

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: ['asset-asset'],
     hasExtended: false,
     idField: 'definitionId',
+    keyIsFixed: true, // sending definitionKey in update call not allowed by API
     keyField: 'definitionKey',
     nameField: 'name',
     createdDateField: 'createdDate',

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

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: ['mobileCode', 'mobileKeyword'],
     hasExtended: false,
     idField: 'definitionId',
+    keyIsFixed: true, // sending definitionKey in update call not allowed by API
     keyField: 'definitionKey',
     nameField: 'name',
     createdDateField: 'createdDate',

package/lib/metadataTypes/definitions/{TriggeredSendDefinition.definition.js → TriggeredSend.definition.js}

@@ -12,6 +12,7 @@ module.exports = {
     hasExtended: false,
     idField: 'ObjectID',
     keepId: true,
+    keyIsFixed: false,
     keyField: 'CustomerKey',
     nameField: 'Name',
     folderIdField: 'CategoryID',
@@ -20,7 +21,8 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
-    type: 'triggeredSendDefinition',
+    type: 'triggeredSend',
+    soapType: 'triggeredSendDefinition',
     typeDescription: 'DEPRECATED: Sends emails via API or DataExtension Event.',
     typeRetrieveByDefault: true,
     typeName: 'Triggered Send',
@@ -303,7 +305,7 @@ module.exports = {
         },
         ObjectID: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: false,
             templating: false,
         },
@@ -530,7 +532,7 @@ module.exports = {
             templating: false,
         },
         r__folder_Path: { skipValidation: true },
-        r__assetMessage_Name: { skipValidation: true },
+        r__assetMessage_Name_readOnly: { skipValidation: true },
         r__assetMessage_Key: { skipValidation: true },
         r__list_PathName: { skipValidation: true },
     },

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

@@ -0,0 +1,365 @@
+module.exports = {
+    bodyIteratorField: 'Results',
+    dependencies: ['role'],
+    folderType: null,
+    hasExtended: false,
+    idField: 'AccountUserID', // ID contains the same value as AccountUserID but is not required by API
+    keepId: true,
+    keyIsFixed: false,
+    keyField: 'CustomerKey',
+    nameField: 'Name',
+    createdDateField: 'CreatedDate',
+    createdNameField: null,
+    lastmodDateField: 'ModifiedDate',
+    lastmodNameField: 'Client.ModifiedBy',
+    type: 'user',
+    soapType: 'AccountUser',
+    typeDescription: 'Marketing Cloud users',
+    typeName: 'User',
+    typeRetrieveByDefault: false,
+    stringifyFieldsBeforeTemplate: ['DefaultBusinessUnit', 'c__AssociatedBusinessUnits'],
+    fields: {
+        AccountUserID: {
+            // numeric id, cannot be changed but identifies the useruniquely
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: true,
+            template: false,
+        },
+        ActiveFlag: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        AssociatedBusinessUnits: {
+            // not supported by API
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        BusinessUnit: {
+            // not supported by API
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        ChallengeAnswer: {
+            // alwasy empty
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        ChallengePhrase: {
+            // alwasy empty
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'Client.ID': { isCreateable: true, isUpdateable: true, retrieving: false, template: false },
+        'Client.ModifiedBy': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        'Client.PartnerClientKey': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        CorrelationID: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        CreatedDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        CustomerKey: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        DefaultApplication: {
+            // not supported by API
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        DefaultBusinessUnit: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        DefaultBusinessUnitObject: {
+            // more complex version of DefaultBusinessUnit thats not needed for deployment
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        Delete: { isCreateable: false, isUpdateable: false, retrieving: false, template: false },
+        Email: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        ID: { isCreateable: false, isUpdateable: false, retrieving: false, template: false },
+        IsAPIUser: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        IsLocked: {
+            // Indicates if account user can or cannot log into their account
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        'LanguageLocale.LocaleCode': {
+            // seems to always return en-US
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        LastSuccessfulLogin: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        'Locale.LocaleCode': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'Locale.ObjectID': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'Locale.PartnerKey': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        ModifiedDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        MustChangePassword: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        Name: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        NotificationEmailAddress: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        ObjectID: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        ObjectState: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        Owner: { isCreateable: false, isUpdateable: false, retrieving: false, template: false },
+        PartnerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        PartnerProperties: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        Password: { isCreateable: true, isUpdateable: true, retrieving: false, template: false },
+        Roles: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        'Roles.Role': {
+            skipValidation: true,
+        },
+        'Roles.Role[].Client': {
+            skipValidation: false,
+        },
+        SsoIdentities: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false, // retrieve not supported by API
+            template: false,
+        },
+        'SsoIdentities[]': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'SsoIdentities[].IsActive': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'SsoIdentities[].FederatedID': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'TimeZone.ID': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: false,
+        },
+        'TimeZone.Name': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'TimeZone.ObjectID': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'TimeZone.PartnerKey': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        Unlock: {
+            // do not retrieve it but also do not remove it from retrieve as we are adding it manually
+            skipValidation: true,
+            isCreateable: false,
+            isUpdateable: true,
+            template: true,
+        },
+        UserID: { isCreateable: true, isUpdateable: true, retrieving: true, template: true },
+        UserPermissions: {
+            // not sure what to do with the reponse yet. might become interesting for the future
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.PartnerKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.ID': {
+            skipValidation: true,
+        },
+        'UserPermissions.ObjectID': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Name': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Value': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Description': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Delete': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].PartnerKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].ID': {
+            skipValidation: true,
+        },
+        'UserPermissions[].ObjectID': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Name': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Value': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Description': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Delete': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        c__type: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieve: null, // handled via script
+            template: false,
+        },
+        c__AssociatedBusinessUnits: {
+            skipValidation: true,
+        },
+        c__RoleNamesGlobal: {
+            skipValidation: true,
+        },
+        c__LocaleCode: {
+            skipValidation: true,
+        },
+        c__TimeZoneName: {
+            skipValidation: true,
+        },
+        c__AccountUserID: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieve: null, // handled via script
+            template: false,
+        },
+        c__IsLocked_readOnly: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieve: null, // handled via script
+            template: false,
+        },
+    },
+};

package/lib/retrieveChangelog.js

@@ -43,8 +43,7 @@ const customDefinition = {
 };
 (async function () {
     // get userid>name mapping
-    const userList = (await mcdev.retrieve('ACN-Learning/_ParentBU_', 'accountUser', true))
-        .accountUser;
+    const userList = (await mcdev.retrieve('ACN-Learning/_ParentBU_', 'user', true)).user;
     // reduce userList to simple id-name map
     for (const key of Object.keys(userList)) {
         userList[userList[key].ID] = userList[key].Name;

package/lib/util/auth.js

@@ -59,7 +59,7 @@ const Auth = {
             return initializedSDKs[credentialKey];
         } else {
             // check existing credentials cached
-            authfile = authfile || File.readJsonSync(Util.authFileName);
+            authfile ||= File.readJsonSync(Util.authFileName);
             const newAuthObj = authfile[buObject.credential];
             // use client_id + MID to ensure a unique combination across instances
             const sessionKey = newAuthObj.client_id + '|' + buObject.mid;
@@ -93,7 +93,9 @@ function setupSDK(sessionKey, authObject) {
         eventHandlers: {
             onLoop: (type, accumulator) => {
                 Util.logger.info(
-                    ` - Requesting next batch (currently ${accumulator?.length} records)`
+                    Util.getGrayMsg(
+                        ` - Requesting next batch (currently ${accumulator?.length} records)`
+                    )
                 );
             },
             onRefresh: (authObject) => {
@@ -114,13 +116,31 @@ function setupSDK(sessionKey, authObject) {
                 );
                 Util.logger.errorStack(ex);
             },
-            // logRequest: (req) =>
-            //     console.log(`${Util.color.fgMagenta}request${Util.color.reset}`, req), // uncomment to log requests
-            // logResponse: (res) =>
-            //     console.log(
-            //         `${Util.color.bgMagenta}response${Util.color.reset}:`,
-            //         typeof res.data == 'string' && res.data.length > 10000 ? res.data : res
-            //     ), // uncomment to log responses
+            logRequest: (req) => {
+                const msg = JSON.parse(JSON.stringify(req));
+                if (msg.url === '/Service.asmx') {
+                    msg.data = msg.data.replaceAll(
+                        /<fueloauth(.*)<\/fueloauth>/gim,
+                        '<fueloauth>*** TOKEN REMOVED ***</fueloauth>'
+                    );
+                } else if (msg.headers?.Authorization) {
+                    msg.headers.Authorization = 'Bearer *** TOKEN REMOVED ***';
+                }
+                if (Util.OPTIONS.api === 'cli') {
+                    console.log(`${Util.color.fgMagenta}API REQUEST >>${Util.color.reset}`, msg); // eslint-disable-line no-console
+                } else if (Util.OPTIONS.api === 'log') {
+                    Util.logger.debug('API REQUEST >> ' + JSON.stringify(msg, null, 2));
+                }
+            },
+            logResponse: (res) => {
+                const msg =
+                    typeof res.data == 'string' ? res.data : JSON.stringify(res.data, null, 2);
+                if (Util.OPTIONS.api === 'cli') {
+                    console.log(`${Util.color.fgMagenta}API RESPONSE <<${Util.color.reset}`, msg); // eslint-disable-line no-console
+                } else if (Util.OPTIONS.api === 'log') {
+                    Util.logger.debug('API RESPONSE << ' + msg);
+                }
+            },
         },
         requestAttempts: 4,
         retryOnConnectionError: true,

package/lib/util/businessUnit.js

@@ -62,9 +62,9 @@ const BusinessUnit = {
                         currentCredentials.eid = element.ID;
                         Util.logger.info(` - ${Util.parentBuName} (${element.Name})`);
                     } else {
-                        const equalizedName = element.Name.replace(/[^\w\s]/gi, '') // remove special chars
-                            .replace(/ +/g, '_') // convert spaces to underscore
-                            .replace(/__+/g, '_'); // make sure we never have more than one underscore in a row
+                        const equalizedName = element.Name.replaceAll(/[^\w\s]/gi, '') // remove special chars
+                            .replaceAll(/ +/g, '_') // convert spaces to underscore
+                            .replaceAll(/__+/g, '_'); // make sure we never have more than one underscore in a row
                         myBuList[equalizedName] = element.ID;
                         Util.logger.info(
                             ` - ${element.Name} ${