mcdev 7.6.3 → 7.7.1

package/boilerplate/config.json

@@ -13,6 +13,17 @@
             "sourceTargetMapping": {
                 "deployment-source": "deployment-target"
             },
+            "branchSourceTargetMapping": {
+                "sit": {
+                    "deployment-sit-source": "deployment-sit-target"
+                },
+                "uat": {
+                    "deployment-uat-source": "deployment-uat-target"
+                },
+                "prod": {
+                    "deployment-prod-source": "deployment-prod-target"
+                }
+            },
             "targetBranchBuMapping": {
                 "release/*": "MySandbox/QA-DE",
                 "master": ["MyProduction/PROD-DE", "MyProduction/PROD-NL"]

package/boilerplate/files/eslint.config.js

@@ -1,16 +1,18 @@
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
 import jsdoc from 'eslint-plugin-jsdoc';
 import js from '@eslint/js';
 import sfmcSsjs from 'eslint-config-ssjs';
-import globals from 'globals';
 
 export default [
     {
         ignores: ['deploy/**/*', 'docs/**/*', 'logs/**/*', 'node_modules/**/*', 'template/**/*']
     },
-    js.configs['recommended'],
+    js.configs.recommended,
     eslintPluginPrettierRecommended,
     jsdoc.configs['flat/recommended'],
+    eslintPluginUnicorn.configs['flat/recommended'],
     {
         plugins: { jsdoc },
         rules: {
@@ -66,7 +68,7 @@ export default [
         }
     },
     {
-        files: ['.mcdev-validations.js'],
+        files: ['lib/**.js', '.mcdev-validations.js'],
 
         languageOptions: {
             globals: {
@@ -76,8 +78,101 @@ export default [
             ecmaVersion: 2022,
             sourceType: 'module'
         },
+        settings: {
+            jsdoc: {
+                mode: 'typescript',
+
+                preferredTypes: {
+                    array: 'Array',
+                    'array.<>': '[]',
+                    'Array.<>': '[]',
+                    'array<>': '[]',
+                    'Array<>': '[]',
+                    Object: 'object',
+                    'object.<>': 'Object.<>',
+                    'object<>': 'Object.<>',
+                    'Object<>': 'Object.<>',
+                    set: 'Set',
+                    'set.<>': 'Set.<>',
+                    'set<>': 'Set.<>',
+                    'Set<>': 'Set.<>',
+                    promise: 'Promise',
+                    'promise.<>': 'Promise.<>',
+                    'promise<>': 'Promise.<>',
+                    'Promise<>': 'Promise.<>'
+                }
+            }
+        },
 
         rules: {
+            'logical-assignment-operators': ['error', 'always'],
+            'unicorn/better-regex': 'off',
+
+            'unicorn/catch-error-name': [
+                'error',
+                {
+                    name: 'ex'
+                }
+            ],
+
+            'unicorn/explicit-length-check': 'off',
+            'unicorn/no-null': 'off',
+            'unicorn/prefer-module': 'off',
+            'unicorn/prevent-abbreviations': 'off',
+            'unicorn/filename-case': 'off',
+            'unicorn/no-array-callback-reference': 'off',
+            'unicorn/no-array-reduce': 'off',
+            'unicorn/no-await-expression-member': 'off',
+            'unicorn/no-hex-escape': 'off',
+            'unicorn/no-nested-ternary': 'off',
+            'unicorn/no-static-only-class': 'off',
+            'unicorn/no-unused-properties': 'warn',
+            'unicorn/numeric-separators-style': 'off',
+            'unicorn/prefer-array-some': 'off',
+            'unicorn/prefer-set-has': 'off',
+            'unicorn/prefer-spread': 'off',
+            'unicorn/prefer-string-replace-all': 'error',
+            'arrow-body-style': ['error', 'as-needed'],
+            curly: 'error',
+
+            'jsdoc/check-line-alignment': 2,
+
+            'jsdoc/require-jsdoc': [
+                'warn',
+                {
+                    require: {
+                        FunctionDeclaration: true,
+                        MethodDefinition: true,
+                        ClassDeclaration: true,
+                        ArrowFunctionExpression: false,
+                        FunctionExpression: true
+                    }
+                }
+            ],
+
+            'jsdoc/require-param-type': 'error',
+
+            'jsdoc/tag-lines': [
+                'warn',
+                'any',
+                {
+                    startLines: 1
+                }
+            ],
+
+            'jsdoc/no-undefined-types': 'off',
+            'jsdoc/valid-types': 'off',
+
+            'spaced-comment': [
+                'warn',
+                'always',
+                {
+                    block: {
+                        exceptions: ['*'],
+                        balanced: true
+                    }
+                }
+            ],
             'no-var': 'error',
             'prefer-const': 'error',
             'prettier/prettier': 'warn'

package/boilerplate/forcedUpdates.json

@@ -1,4 +1,8 @@
 [
+    {
+        "version": "7.7.0",
+        "files": [".gitignore"]
+    },
     {
         "version": "7.6.2",
         "files": [".vscode/extensions.json"]

package/boilerplate/gitignore-template

@@ -2,9 +2,9 @@
 node_modules/
 /deploy/
 /docs/badKeys/
-/docs/deltaPackage/
 /logs/
 **/QueryStudioResults at*
 .mcdev-auth.json
+.mcdev/template/
 *.error.log
 *.BAK

package/boilerplate/npm-dependencies.json

@@ -4,6 +4,7 @@
     "eslint-config-ssjs",
     "eslint-plugin-jsdoc",
     "eslint-plugin-prettier",
+    "eslint-plugin-unicorn",
     "eslint",
     "globals",
     "prettier-plugin-sql",

package/eslint.config.js

@@ -64,22 +64,23 @@ export default [
             ],
 
             'unicorn/explicit-length-check': 'off',
-            'unicorn/no-null': 'off',
-            'unicorn/prefer-module': 'off',
-            'unicorn/prevent-abbreviations': 'off',
             'unicorn/filename-case': 'off',
             'unicorn/no-array-callback-reference': 'off',
             'unicorn/no-array-reduce': 'off',
             'unicorn/no-await-expression-member': 'off',
+            'unicorn/no-empty-file': 'off',
             'unicorn/no-hex-escape': 'off',
             'unicorn/no-nested-ternary': 'off',
+            'unicorn/no-null': 'off',
             'unicorn/no-static-only-class': 'off',
             'unicorn/no-unused-properties': 'warn',
             'unicorn/numeric-separators-style': 'off',
             'unicorn/prefer-array-some': 'off',
+            'unicorn/prefer-module': 'off',
             'unicorn/prefer-set-has': 'off',
             'unicorn/prefer-spread': 'off',
             'unicorn/prefer-string-replace-all': 'error',
+            'unicorn/prevent-abbreviations': 'off',
             'arrow-body-style': ['error', 'as-needed'],
             curly: 'error',
             'no-console': 'error',

package/lib/Builder.js

@@ -72,26 +72,28 @@ saved
     async _buildDefinition(metadataType, nameArr, templateVariables) {
         const type = metadataType;
         try {
-            const result = await Promise.all(
-                nameArr.map((name) => {
-                    // with npx and powershell spaces are not parsed correctly as part of a string
-                    // we hence require users to put %20 in their stead and have to convert that back
-                    name = name.split('%20').join(' ');
+            const result = (
+                await Promise.all(
+                    nameArr.map((name) => {
+                        // with npx and powershell spaces are not parsed correctly as part of a string
+                        // we hence require users to put %20 in their stead and have to convert that back
+                        name = name.split('%20').join(' ');
 
-                    MetadataTypeInfo[type].client = auth.getSDK(this.buObject);
-                    MetadataTypeInfo[type].properties = this.properties;
-                    MetadataTypeInfo[type].buObject = this.buObject;
-                    return MetadataTypeInfo[type].buildDefinition(
-                        this.templateDir,
-                        this.targetDir,
-                        name,
-                        templateVariables
-                    );
-                })
-            );
+                        MetadataTypeInfo[type].client = auth.getSDK(this.buObject);
+                        MetadataTypeInfo[type].properties = this.properties;
+                        MetadataTypeInfo[type].buObject = this.buObject;
+                        return MetadataTypeInfo[type].buildDefinition(
+                            this.templateDir,
+                            this.targetDir,
+                            name,
+                            templateVariables
+                        );
+                    })
+                )
+            ).filter(Boolean);
             if (result && type === result[0]?.type) {
                 // result elements can be undefined for each key that we did not find
-                this.metadata[type] = result.filter(Boolean).map((element) => element.metadata);
+                this.metadata[type] = result.map((element) => element.metadata);
             }
         } catch (ex) {
             Util.logger.errorStack(ex, 'mcdev.buildDefinition');
@@ -110,8 +112,8 @@ saved
      */
     static async buildTemplate(businessUnit, selectedType, keyArr, marketArr) {
         const properties = await config.getProperties();
-        if (!(await config.checkProperties(properties))) {
-            return null;
+        if (!properties) {
+            return;
         }
         if (!Util._isValidType(selectedType)) {
             return;
@@ -124,12 +126,15 @@ saved
         }
         /** @type {TemplateMap} */
         const templateVariables = {};
-        for (const market of marketArr) {
-            if (Util.checkMarket(market, properties)) {
-                Object.assign(templateVariables, properties.markets[market]);
-            } else {
-                // do not execute the rest of this method if a market was invalid
-                return;
+        if (marketArr[0] !== '__clone__') {
+            // if __clone__ is passed, we don't want to actually change anything but simply clone the metadata as-is
+            for (const market of marketArr) {
+                if (Util.checkMarket(market, properties)) {
+                    Object.assign(templateVariables, properties.markets[market]);
+                } else {
+                    // do not execute the rest of this method if a market was invalid
+                    return;
+                }
             }
         }
         const buObject = await Cli.getCredentialObject(properties, businessUnit);
@@ -151,28 +156,30 @@ saved
         const type = metadataType;
         try {
             /** @type {MetadataTypeItemObj[]} */
-            const result = await Promise.all(
-                keyArr.map(async (key) => {
-                    MetadataTypeInfo[type].properties = this.properties;
-                    MetadataTypeInfo[type].buObject = this.buObject;
+            const result = (
+                await Promise.all(
+                    keyArr.map(async (key) => {
+                        MetadataTypeInfo[type].properties = this.properties;
+                        MetadataTypeInfo[type].buObject = this.buObject;
 
-                    try {
-                        /** @type {MetadataTypeItemObj} */
-                        const response = await MetadataTypeInfo[type].buildTemplate(
-                            this.retrieveDir,
-                            this.templateDir,
-                            key,
-                            templateVariables
-                        );
-                        return response;
-                    } catch (ex) {
-                        Util.logger.errorStack(ex, ` ☇ skipping template asset: ${key}`);
-                    }
-                })
-            );
+                        try {
+                            /** @type {MetadataTypeItemObj} */
+                            const response = await MetadataTypeInfo[type].buildTemplate(
+                                this.retrieveDir,
+                                this.templateDir,
+                                key,
+                                templateVariables
+                            );
+                            return response;
+                        } catch (ex) {
+                            Util.logger.errorStack(ex, ` ☇ skipping template asset: ${key}`);
+                        }
+                    })
+                )
+            ).filter(Boolean);
             if (result && type === result[0]?.type) {
                 // result elements can be undefined for each key that we did not find
-                this.metadata[type] = result.filter(Boolean).map((element) => element.metadata);
+                this.metadata[type] = result.map((element) => element.metadata);
             }
         } catch (ex) {
             Util.logger.errorStack(ex, 'mcdev.buildTemplate');
@@ -191,8 +198,8 @@ saved
      */
     static async buildDefinition(businessUnit, selectedType, nameArr, marketArr) {
         const properties = await config.getProperties();
-        if (!(await config.checkProperties(properties))) {
-            return null;
+        if (!properties) {
+            return;
         }
         if (!Util._isValidType(selectedType)) {
             return;
@@ -205,12 +212,15 @@ saved
         }
         /** @type {TemplateMap} */
         const templateVariables = {};
-        for (const market of marketArr) {
-            if (Util.checkMarket(market, properties)) {
-                Object.assign(templateVariables, properties.markets[market]);
-            } else {
-                // do not execute the rest of this method if a market was invalid
-                return;
+        if (marketArr[0] !== '__clone__') {
+            // if __clone__ is passed, we don't want to actually change anything but simply clone the metadata as-is
+            for (const market of marketArr) {
+                if (Util.checkMarket(market, properties)) {
+                    Object.assign(templateVariables, properties.markets[market]);
+                } else {
+                    // do not execute the rest of this method if a market was invalid
+                    return;
+                }
             }
         }
         const buObject = await Cli.getCredentialObject(properties, businessUnit);
@@ -231,8 +241,8 @@ saved
      */
     static async buildDefinitionBulk(listName, type, nameArr) {
         const properties = await config.getProperties();
-        if (!(await config.checkProperties(properties))) {
-            return null;
+        if (!properties) {
+            return;
         }
         try {
             Util.verifyMarketList(listName, properties);
@@ -283,6 +293,56 @@ saved
         }
         return responseObj;
     }
+    /**
+     * helper for buildDefinitionBulk, createDeltaPkg
+     *
+     * @param {string} listName market list name
+     * @returns {Promise.<void>} -
+     */
+    static async purgeDeployFolderList(listName) {
+        const properties = await config.getProperties();
+        if (!properties) {
+            return;
+        }
+        for (const businessUnit in properties.marketList[listName]) {
+            if (businessUnit === 'description') {
+                // skip, it's just a metadata on this list and not a BU
+                continue;
+            }
+            if (!Util.isValidBU(properties, businessUnit, true)) {
+                throw new Error(`'${businessUnit}' in Market ${listName} is not defined.`);
+            }
+            await this.purgeDeployFolder(businessUnit);
+        }
+    }
+    /**
+     * helper for buildDefiniton, purgeDeployFolderList
+     *
+     * @param {string} businessUnit cred/bu combo
+     * @returns {Promise.<void>} -
+     */
+    static async purgeDeployFolder(businessUnit) {
+        const properties = await config.getProperties();
+        if (!properties) {
+            return;
+        }
+        if (!Util.isValidBU(properties, businessUnit, true)) {
+            throw new Error(`'${businessUnit}' does not exist.`);
+        }
+        const deployDir = File.normalizePath([
+            properties.directories.deploy,
+            ...businessUnit.split('/'),
+        ]);
+        // Clear output folder structure for selected sub-type
+        // only run this if the standard deploy folder is a target of buildDefinition (which technically could be changed)
+        Util.logger.info(` - 🚮 purging folder ${deployDir}`);
+        try {
+            await File.remove(deployDir);
+        } catch {
+            // sometimes the first attempt is not successful for some operating system reason. Trying again mostly solves this
+            await File.remove(deployDir);
+        }
+    }
 }
 
 export default Builder;

package/lib/Deployer.js

@@ -71,8 +71,8 @@ class Deployer {
         /** @type {Object.<string, MultiMetadataTypeMap>} */
         const buMultiMetadataTypeMap = {};
         const properties = await config.getProperties();
-        if (!(await config.checkProperties(properties))) {
-            return null;
+        if (!properties) {
+            return;
         }
         const deployDirBak = properties.directories.deploy;
         if (Util.OPTIONS.fromRetrieve) {

package/lib/MetadataTypeDefinitions.js

@@ -13,6 +13,7 @@ import dataExtract from './metadataTypes/definitions/DataExtract.definition.js';
 import dataExtractType from './metadataTypes/definitions/DataExtractType.definition.js';
 import deliveryProfile from './metadataTypes/definitions/DeliveryProfile.definition.js';
 import discovery from './metadataTypes/definitions/Discovery.definition.js';
+import domainVerification from './metadataTypes/definitions/DomainVerification.definition.js';
 import email from './metadataTypes/definitions/Email.definition.js';
 import emailSend from './metadataTypes/definitions/EmailSend.definition.js';
 import event from './metadataTypes/definitions/Event.definition.js';
@@ -56,6 +57,7 @@ export default {
     dataExtractType,
     deliveryProfile,
     discovery,
+    domainVerification,
     email,
     emailSend,
     event,

package/lib/MetadataTypeInfo.js

@@ -13,6 +13,7 @@ import dataExtract from './metadataTypes/DataExtract.js';
 import dataExtractType from './metadataTypes/DataExtractType.js';
 import deliveryProfile from './metadataTypes/DeliveryProfile.js';
 import discovery from './metadataTypes/Discovery.js';
+import domainVerification from './metadataTypes/DomainVerification.js';
 import email from './metadataTypes/Email.js';
 import emailSend from './metadataTypes/EmailSend.js';
 import event from './metadataTypes/Event.js';
@@ -55,6 +56,7 @@ export default {
     dataExtractType,
     deliveryProfile,
     discovery,
+    domainVerification,
     email,
     emailSend,
     event,