mcdev 6.0.1 → 7.0.0

package/@types/types/mcdev.d.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcdev.d.d.ts","sourceRoot":"","sources":["../../types/mcdev.d.js"],"names":[],"mappings":";;;;;;eAEc,MAAM;;;;mBACN,MAAM;;;;aACN,MAAM;;;;UACN,MAAM;;;;UACN,MAAM;;;;mBACN,MAAM;;;;iBACN,MAAM;;;QAGC,MAAM,GAAE,MAAM;;qCACtB,OAAO,GAAC,eAAe,GAAC,aAAa,GAAC,aAAa,GAAC,aAAa,GAAC,YAAY,GAAC,gBAAgB,GAAC,aAAa,GAAC,eAAe,GAAC,aAAa,GAAC,gBAAgB,GAAC,gBAAgB,GAAC,gBAAgB,GAAC,aAAa,GAAC,gBAAgB,GAAC,cAAc,GAAC,YAAY,GAAC,UAAU,GAAC,aAAa,GAAC,eAAe,GAAC,oBAAoB,GAAC,uBAAuB,GAAC,aAAa,GAAC,iBAAiB,GAAC,WAAW,GAAC,iBAAiB,GAAC,OAAO,GAAC,WAAW,GAAC,OAAO,GAAC,cAAc,GAAC,cAAc,GAAC,QAAQ,GAAC,QAAQ,GAAC,YAAY,GAAC,SAAS,GAAC,MAAM,GAAC,YAAY,GAAC,eAAe,GAAC,eAAe,GAAC,OAAO,GAAC,MAAM,GAAC,QAAQ,GAAC,oBAAoB,GAAC,eAAe,GAAC,oBAAoB,GAAC,mBAAmB,GAAC,kBAAkB,GAAC,eAAe,GAAC,MAAM,GAAC,cAAc;;;;;QAC3rB,MAAM,GAAE,MAAM,EAAE,GAAG,IAAI;;;;;;;;;;QAKvB,MAAM,GAAE,gBAAgB;;;;;;QACxB,MAAM,GAAE,eAAe;;;;;;QACvB,MAAM,GAAE,gBAAgB,EAAE;;iCAClC;IAAC,QAAQ,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC;kCACzC;IAAC,QAAQ,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC;;;;;QAClC,MAAM,GAAE,oBAAoB;;;;;mCACpC;IAAC,MAAM,EAAE,gBAAgB,CAAC;IAAC,KAAK,EAAE,gBAAgB,CAAA;CAAC;;;;;UAKlD,gBAAgB;;;;aAChB,WAAW,EAAE;;;;eACb,MAAM,EAAE;;;;;;eAIR,MAAM,EAAE;;;;cACR,MAAM;;;;aACN,MAAM;;;;aACN,MAAM;;;;eACN,QAAQ;;;;;;UAIR,MAAM;;;;SACN,MAAM;;;;iBACN,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;0BACN,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;0BACN,WAAW,GAAC,QAAQ,GAAC,QAAQ;;;;yBAC7B,MAAM;;;;wBACN,MAAM;;;;cACN,OAAO;;;;gBACP,MAAM;;;;iBACN,MAAM;;;;oBACN,MAAM;;;;wBACN,MAAM;;;QACC,MAAM,GAAE,SAAS;;;;;;UAIxB,MAAM;;;;SACN,MAAM;;;;iBACN,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;aACN,MAAM;;;;iBACN,MAAM;;;;oBACN,MAAM;;;QACC,MAAM,GAAE,UAAU;;;QAGlB,MAAM,GAAE,GAAG;;;QACX,MAAM,GAAE,SAAS;;2BACzB,SAAS,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,UAAU,GAAC,OAAO,GAAC,SAAS,GAAC,OAAO,GAAC,UAAU,GAAC,UAAU,GAAC,UAAU,GAAC,OAAO;;;;;eAIrH,MAAM;;;;kBACN,MAAM;;;;;QAEgB,WAAW,EAAjC,MAAM;;;;;UACN,MAAM;;;;eACN,MAAM;;;;kBACN,MAAM;;;;gBACN,IAAI,GAAC,KAAK;;;;iBACV,IAAI,GAAC,KAAK;;;;kBACV,IAAI,GAAC,KAAK;;;;aACV,MAAM;;;;eACN,MAAM,GAAC,QAAQ,GAAC,MAAM,GAAC,SAAS,GAAC,SAAS,GAAC,cAAc,GAAC,OAAO,GAAC,QAAQ;;;;eAC1E,MAAM,GAAC,MAAM;;;;WACb,MAAM;;;QAGC,MAAM,GAAE,sBAAsB;;;;;;iBAIrC,MAAM;;;;UACN,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;mBACN,MAAM;;;;gBACN,IAAI,GAAC,KAAK;;;;gBACV,IAAI,GAAC,KAAK;;;;;QAEyB,IAAI,EAAvC,MAAM;;;;;;QAE0B,IAAI,EAApC,MAAM;;;;;YACN,sBAAsB,EAAE;;;;2BACxB,eAAe,GAAC,yBAAyB,GAAC,2BAA2B,GAAC,sBAAsB,GAAC,gCAAgC;;;;oBAC7H,MAAM;;;;iBACN,MAAM;;;;oCACN,MAAM;;;;;QAEY,WAAW,GAA7B,MAAM;;;;;iBACN,MAAM;;;;oBACN,MAAM;;;;yBACN,MAAM,GAAC,4BAA4B,GAAC,YAAY,GAAC,mBAAmB;;;;gCACpE,MAAM;;;;uCACN,MAAM;;;;0CACN,MAAM;;;;wBACN,OAAO;;;;kCACP,OAAO;;;;mCACP,OAAO;;;QAGA,MAAM,GAAE,iBAAiB;;;;;;UAIhC,MAAM,GAAC,mBAAmB,GAAC,kBAAkB;;;;SAC7C,MAAM;;;;YACN,MAAM;;;;oBACN,MAAM;;;;sBACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;8BACN,MAAM;;;;gBACN,OAAO;;;;eACP,OAAO;;;;wBACP,OAAO;;;;yBACP,MAAM;;;;gCACN,MAAM,EAAE;;;;;QAES,IAAI,GAArB,MAAM,EAAE;;;;;wBACR,MAAM,EAAE;;;;qBACR,MAAM,EAAE;;;;yBACR,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;;QAEU,EAAE,GAAlB,MAAM;QACU,UAAU,GAA1B,MAAM;;;;;aACN,MAAM,GAAC,mBAAmB;;;;eAC1B,OAAO,GAAC,MAAM;;;;aACd,OAAO;;;;0BACP,OAAO;;;;qBACP,MAAM;;;;;QAEY,IAAI,GAAtB,MAAM;QACY,EAAE,GAApB,MAAM;;;;;eACN,MAAM;;;;mBACN,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,QAAQ,GAAC,OAAO;;;;;QAEU,UAAU,GAA5F,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,QAAQ,GAAC,OAAO;;;;;kBACxE,MAAM;;;;oBACN,QAAM,MAAM;;+BAGb;IAAC,MAAM,EAAC,YAAY,CAAC;IAAA,KAAK,EAAC,YAAY,CAAA;CAAC;;;;;QAChC,MAAM,GAAE,YAAY;;mCAG5B,YAAY,GAAG,MAAM;;;;;;QASL,EAAE,EAAjB,MAAM;;;;;iBACN,MAAM;;;;QACN,MAAM,GAAG,MAAM;;;;eACf,MAAM;;;;aACN,MAAM;;;;yCACN,mCAAmC;;;;;;;QAGF,cAAc,EAA/C,MAAM,EAAE,GAAC,MAAM;;;;;cACf,OAAO;;;;;;YAKP,MAAM;;;;WACN,MAAM;;;;mBACN,MAAM;;;;uBACN,MAAM;;;;mBACN,MAAM;;;;aACN,MAAM;;;;;;UAIN,MAAM;;;;iBACN,MAAM;;;;WACN,MAAM;;;;iBACN,MAAM;;;;gBACN,kBAAkB,EAAE;;;;;;;;;YAIpB,MAAM;;;;qBACN,MAAM;;;;eACN,MAAM;;;;aACN,MAAM;;;;eACN,MAAM;;;;kBACN,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;cACN,GAAG;;;;oBACH,GAAG;;;;sBACH,MAAM;;;;;;;;;qBAIN,MAAM;;;;;QAEc,CAAC,GAArB,MAAM;QACgB,2BAA2B,GAAjD,QAAQ;QACe,4BAA4B,GAAnD,SAAS;QACa,2BAA2B,GAAjD,QAAQ;QACa,0BAA0B,GAA/C,OAAO;QACiB,6BAA6B,GAArD,UAAU;QACc,2BAA2B,GAAnD,UAAU;QACU,YAAY,GAAhC,MAAM;QACc,aAAa,GAAjC,MAAM;QACc,YAAY,GAAhC,MAAM;QACc,WAAW,GAA/B,MAAM;QACc,YAAY,GAAhC,MAAM;QACc,cAAc,GAAlC,MAAM;;;;;gBACN,MAAM;;;;;QAEW,EAAE,EAAnB,MAAM;QACU,WAAW,GAA3B,IAAI;;;;;sBACJ,MAAM;;;;mBACN,MAAM;;;;qBACN,MAAM;;;;kBACN,MAAM;;;;yBACN,OAAO,GAAC,UAAU;;;;kBAClB,MAAM;;;;;;QAIN,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;SACN,MAAM;;;;kBACN,MAAM;;;;WACN,MAAM;;;;WACN,MAAM;;;;oBACN,GAAG;;;;kBACH,MAAM;;;;WACN,WAAW,GAAC,WAAW;;;;aACvB,WAAW,GAAC,SAAS,GAAC,OAAO,GAAC,UAAU,GAAC,gBAAgB,GAAC,iBAAiB;;;;eAC3E,MAAM;;;;eACN,kBAAkB;;;;;QAEE,iBAAiB,EAArC,MAAM;QACc,qBAAqB,EAAzC,MAAM;QACc,kBAAkB,EAAtC,MAAM;QACe,WAAW,EAAhC,OAAO;QACc,UAAU,EAA/B,OAAO;QACc,aAAa,EAAlC,OAAO;;;;;;QAE0B,QAAQ,GAAzC,kBAAkB;QACG,QAAQ;YACA,eAAe,EAA5C,MAAM;YACuB,qBAAqB,EAAlD,MAAM;YACuB,cAAc,EAA3C,MAAM;YACwB,UAAU,EAAxC,OAAO;;QACa,MAAM,EAA1B,MAAM;;;;;YACN,cAAc,EAAE;;;;qBAChB,MAAM;;;;iBACN,MAAM;;;;;;kCAIN,MAAM;;;;sBACN,WAAW,GAAC,YAAY,GAAC,eAAe,GAAC,gBAAgB,GAAC,eAAe,GAAC,cAAc,GAAC,eAAe,GAAC,kBAAkB,GAAC,mBAAmB,GAAC,kBAAkB;;;;YAClK,MAAM;;;;YACN,MAAM;;;;yBACN,OAAO;;;;0BACP,OAAO;;;;8BACP,MAAM;;;;8BACN,MAAM;;;;eACN,MAAM;;;;qBACN,MAAM;;;;0BACN,MAAM;;;QAIC,MAAM,GAAE,cAAc;;+BAC9B;IAAC,QAAQ,EAAC,aAAa,CAAC;IAAA,IAAI,EAAC,MAAM,CAAA;CAAC;gCACpC;IAAC,QAAQ,EAAC,MAAM,GAAG,cAAc,CAAC;IAAA,IAAI,EAAC,MAAM,CAAA;CAAC;;;;;UAE7C,MAAM;;;;aACN,MAAM;;;;gBACN,MAAM;;;;eACN,MAAM;;;;YACN,OAAO;;;;WACP,OAAO;;;;eACP,MAAM;;;;UACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;;;eACN,MAAM,GAAC,YAAY,GAAC,QAAQ;;;;iBAC5B,MAAM;;;;mBACN,MAAM;;2BACP,OAAO,YAAY,EAAE,kBAAkB,GAAG,iBAAiB;;;;;;uBAQ3D,SAAS,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;gBASpB,MAAM;;;;oBACN,MAAM;;;;eACN,MAAM;;;;iBACN,MAAM;;;;qBACN,MAAM;;;;mBACN,MAAM;;;;wBACN,OAAO;;;;cACP,MAAM;;;;oBACN,MAAM;;;;kBACN,MAAM;;;;;;eAKN,MAAM;;;;mBACN,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;;;sBAKN,MAAM;;;;cACN,MAAM;;;;;;;;;aAEN,aAAa;;;;uBAEb,OAAO;;;;;;cAIP,MAAM;;;;oBACN,QAAQ,GAAC,WAAW,GAAC,QAAQ,GAAC,WAAW,GAAC,aAAa,GAAC,UAAU,GAAC,oBAAoB,GAAC,iBAAiB,GAAC,SAAS,GAAC,IAAI,GAAC,IAAI,GAAC,MAAM;;;;YACpI,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE;;;;;;iBAI/C,aAAa;;;;qBACb,KAAK,GAAC,IAAI;;;;kBACV,aAAa;;;;;;iBAIb,gBAAgB,CAAC,UAAU,CAAC;;;;cAC5B,gBAAgB,CAAC,gBAAgB,CAAC;;;;mBAClC,gBAAgB,CAAC,OAAO,CAAC;;;;;;iBAIzB,iBAAiB,CAAC,aAAa,CAAC;;;;cAChC,iBAAiB,CAAC,iBAAiB,CAAC;;;;kBACpC,iBAAiB,CAAC,cAAc,CAAC;;4BAGlC,mBAAmB,GAAG,oBAAoB;;;;;sBAKzC,MAAM;;;;cACN,MAAM;;;;;;;;;WAGN,MAAM;;;;aACN,MAAM,EAAE;;;;WACR;QAAC,QAAQ,EAAC,MAAM,CAAC;QAAC,SAAS,EAAE,KAAK,GAAC,MAAM,CAAA;KAAC,EAAE;;;;YAC5C,WAAW,GAAG,iBAAiB;;;;;;iBAK/B,WAAW,GAAG,iBAAiB;;;;qBAC/B,KAAK,GAAC,IAAI;;;;mBACV,aAAa,GAAG,iBAAiB;;;;;;cAIjC,MAAM;;;;oBACN,OAAO,GAAC,WAAW,GAAC,QAAQ,GAAC,WAAW,GAAC,aAAa,GAAC,UAAU,GAAC,oBAAoB,GAAC,iBAAiB,GAAC,SAAS,GAAC,IAAI,GAAC,IAAI,GAAC,MAAM;;;;WACnI,MAAM,GAAG,MAAM,GAAG,OAAO,QAAQ;;;;;;iBAKjC,MAAM;;;;aACN,MAAM;;;;;QAEc,aAAa,EAAjC,MAAM;QACc,MAAM,EAA1B,MAAM;QACc,IAAI,EAAxB,MAAM;QACc,QAAQ,EAA5B,MAAM;QACc,QAAQ,EAA5B,MAAM;QACc,cAAc,EAAlC,MAAM;;;;;;YACE,MAAM,GAAE,MAAM;;;;;gBACtB,MAAM;;;;;QAEkB,QAAQ,EAAhC,MAAM,EAAE;QACgB,kBAAkB,EAA1C,MAAM,EAAE;;;;;aACR,MAAM;;0BAIP,OAAO,GAAC,SAAS,GAAC,MAAM,GAAC,OAAO;;;;;YAE/B,WAAW;;;;;;;;;;qBAGZ,OAAO,SAAS,EAAE,MAAM,GAAG,WAAW;8BAGtC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC;;QAC/B,MAAM,GAAE,eAAe;;;QACvB,MAAM,GAAE,eAAe;;0CAC/B,IAAI,GAAC,KAAK,GAAC,MAAM;;;;;UAIhB,MAAM;;;;aACN,MAAM;;;;iBACN,MAAM;;;;uBACN,OAAO,GAAG,MAAM,EAAE;;;;;QAEA,QAAQ,EAA1B,OAAO;QACW,MAAM,EAAxB,OAAO;QACW,MAAM,EAAxB,OAAO;QACW,MAAM,EAAxB,OAAO;QACW,SAAS,EAA3B,OAAO;QACW,aAAa,EAA/B,OAAO;QACW,kBAAkB,EAApC,OAAO"}

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Accenture
+Copyright (c) 2020-2024 Accenture
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -19,6 +19,10 @@ Run the following to install Accenture SFMC DevTools on your computer:
 npm install -g mcdev
 ```
 
+### VSCode Extension
+
+We also provide a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=Accenture-oss.sfmc-devtools-vscode) that integrates SFMC DevTools into your IDE. You can install it from the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Accenture-oss.sfmc-devtools-vscode).
+
 ### Include in your package
 
 First, install it as dependency:
@@ -27,10 +31,10 @@ First, install it as dependency:
 npm install mcdev --save
 ```
 
-You can then include it in your code with:
+You can then include it in your code with JavaScript/ES module imports:
 
 ```javascript
-const mcdev = require('mcdev');
+import mcdev from 'mcdev';
 ```
 
 That will load `node_packages/mcdev/lib/index.js`. It can make sense to directly include other files if you have a special scenario. We've done that in our example for [retrieveChangelog.js](https://github.com/Accenture/sfmc-devtools/blob/main/lib/retrieveChangelog.js) or in more detail, in our child-project [sfmc-devtools-copado](https://github.com/Accenture/sfmc-devtools-copado) to get full control over certain aspects.
@@ -69,4 +73,4 @@ The people that lead this project:
 
 ## Copyright
 
-Copyright (c) 2020-2023 Accenture. [MIT licensed](https://github.com/Accenture/sfmc-devtools/blob/main/LICENSE).
+Copyright (c) 2020-2024 Accenture. [MIT licensed](https://github.com/Accenture/sfmc-devtools/blob/main/LICENSE).

package/boilerplate/files/.beautyamp.json

@@ -0,0 +1,13 @@
+{
+    "ampscript": {
+        "capitalizeAndOrNot": true,
+        "capitalizeIfFor": true,
+        "capitalizeSet": true,
+        "capitalizeVar": true,
+        "maxParametersPerLine": 4
+    },
+    "editor": {
+        "insertSpaces": true,
+        "tabSize": 4
+    }
+}

package/boilerplate/files/.prettierrc

@@ -17,6 +17,9 @@
             "options": {
                 "formatter": "sql-formatter",
                 "language": "tsql",
+                "identifierCase": "preserve",
+                "dataTypeCase": "preserve",
+                "functionCase": "upper",
                 "keywordCase": "upper"
             }
         }

package/boilerplate/files/.vscode/extensions.json

@@ -5,7 +5,6 @@
     // List of extensions which should be recommended for users of this workspace.
     "recommendations": [
         // collaboration
-        "gruntfuggly.todo-tree",
         "aaron-bond.better-comments",
 
         // Linters
@@ -17,6 +16,12 @@
         "xnerd.ampscript-language",
         "FiB.beautyAmp",
 
+        // coding helper
+        "MarketingThibs.ampscriptsnippets",
+
+        // file icons for ampscript
+        "vscode-icons-team.vscode-icons",
+
         // Markdown / Readme.md
         "joernberkefeld.markdown-preview-bitbucket-innersource"
     ]

package/boilerplate/files/.vscode/settings.json

@@ -32,11 +32,12 @@
         "*.txt": "${capture}.asset-textfile-meta.json"
     },
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true
+        "source.fixAll.eslint": "explicit"
     },
     "editor.formatOnSave": true,
     "files.associations": {
-        "*.ssjs": "javascript"
+        "*.ssjs": "javascript",
+        "*.html": "ampscript"
     },
     "files.eol": "\n",
     "files.exclude": {
@@ -47,7 +48,7 @@
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[html]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
+        "editor.defaultFormatter": "FiB.beautyAmp"
     },
     "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
@@ -63,5 +64,16 @@
     },
     "[AMPscript]": {
         "editor.defaultFormatter": "FiB.beautyAmp"
-    }
+    },
+    "vsicons.associations.files": [
+        {
+            "icon": "apex",
+            "languages": [
+                { "ids": "ampscript", "defaultExtension": "amp" },
+                { "ids": "AMPscript", "defaultExtension": "amp" }
+            ],
+            "light": true,
+            "format": "FileFormat.svg"
+        }
+    ]
 }

package/boilerplate/forcedUpdates.json

@@ -1,4 +1,13 @@
 [
+    {
+        "version": "7.0.0",
+        "files": [
+            ".vscode/extensions.json",
+            ".vscode/settings.json",
+            ".beautyamp.json",
+            ".prettierrc"
+        ]
+    },
     {
         "version": "5.0.0",
         "files": [".vscode/settings.json", ".prettierrc"]

package/jsconfig.json

@@ -1,7 +1,12 @@
 {
     "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
+    "exclude": ["node_modules"],
     "compilerOptions": {
-        "module": "es6",
-        "target": "esnext"
+        "module": "NodeNext",
+        "moduleResolution": "nodenext",
+        "target": "es2022",
+        "checkJs": true,
+        "skipLibCheck": true,
+        "noEmit": true
     }
 }

package/lib/Builder.js

@@ -1,13 +1,26 @@
 'use strict';
 
-import TYPE from '../types/mcdev.d.js';
 import { Util } from './util/util.js';
 import File from './util/file.js';
 import config from './util/config.js';
 import Cli from './util/cli.js';
 import auth from './util/auth.js';
 import MetadataTypeInfo from './MetadataTypeInfo.js';
-// @ts-ignore
+
+/**
+ * @typedef {import('../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
 
 /**
  * Builds metadata from a template using market specific customisation
@@ -16,9 +29,9 @@ class Builder {
     /**
      * Creates a Builder, uses v2 auth if v2AuthOptions are passed.
      *
-     * @param {TYPE.Mcdevrc} properties properties for auth
+     * @param {Mcdevrc} properties properties for auth
 saved
-     * @param {TYPE.BuObject} buObject properties for auth
+     * @param {BuObject} buObject properties for auth
      */
     constructor(properties, buObject) {
         this.properties = properties;
@@ -40,7 +53,7 @@ saved
         );
 
         /**
-         * @type {TYPE.MultiMetadataTypeList}
+         * @type {MultiMetadataTypeList}
          */
         this.metadata = {};
     }
@@ -49,23 +62,11 @@ saved
      * Builds a specific metadata file by name
      *
      * @param {string} metadataType metadata type to build
-     * @param {string} name name of metadata to build
-     * @param {TYPE.TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<TYPE.MultiMetadataTypeList>} Promise
+     * @param {string[]} nameArr name of metadata to build
+     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
+     * @returns {Promise.<MultiMetadataTypeList>} Promise
      */
-    async _buildDefinition(metadataType, name, templateVariables) {
-        let nameArr;
-        /* eslint-disable unicorn/prefer-ternary */
-        if (name.includes(',')) {
-            nameArr = name.split(',').map((item) =>
-                // allow whitespace in comma-separated lists
-                item.trim()
-            );
-        } else {
-            nameArr = [name.trim()];
-        }
-        /* eslint-enable unicorn/prefer-ternary */
-
+    async _buildDefinition(metadataType, nameArr, templateVariables) {
         const type = metadataType;
         try {
             const result = await Promise.all(
@@ -85,11 +86,9 @@ saved
                     );
                 })
             );
-            if (result) {
-                this.metadata[result[0].type] = [];
-                for (const element of result) {
-                    this.metadata[result[0].type].push(element.metadata);
-                }
+            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);
             }
         } catch (ex) {
             Util.logger.errorStack(ex, 'mcdev.buildDefinition');
@@ -103,7 +102,7 @@ saved
      * @param {string} selectedType supported metadata type
      * @param {string[]} keyArr customerkey of the metadata
      * @param {string} market market localizations
-     * @returns {Promise.<TYPE.MultiMetadataTypeList>} -
+     * @returns {Promise.<MultiMetadataTypeList>} -
      */
     static async buildTemplate(businessUnit, selectedType, keyArr, market) {
         const properties = await config.getProperties();
@@ -132,20 +131,19 @@ saved
      *
      * @param {string} metadataType metadata type to create a template of
      * @param {string[]} keyArr customerkey of metadata to create a template of
-     * @param {TYPE.TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<TYPE.MultiMetadataTypeList>} Promise
+     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
+     * @returns {Promise.<MultiMetadataTypeList>} Promise
      */
     async _buildTemplate(metadataType, keyArr, templateVariables) {
         const type = metadataType;
         try {
-            /** @type {TYPE.MetadataTypeItemObj[]} */
+            /** @type {MetadataTypeItemObj[]} */
             const result = await Promise.all(
                 keyArr.map((key) => {
-                    MetadataTypeInfo[type].client = this.client;
                     MetadataTypeInfo[type].properties = this.properties;
                     MetadataTypeInfo[type].buObject = this.buObject;
 
-                    /** @type {TYPE.MetadataTypeItemObj} */
+                    /** @type {MetadataTypeItemObj} */
                     return MetadataTypeInfo[type].buildTemplate(
                         this.retrieveDir,
                         this.templateDir,
@@ -154,8 +152,9 @@ saved
                     );
                 })
             );
-            if (result) {
-                this.metadata[result[0].type] = result.map((element) => element.metadata);
+            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);
             }
         } catch (ex) {
             Util.logger.errorStack(ex, 'mcdev.buildTemplate');
@@ -167,11 +166,11 @@ saved
      *
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} selectedType supported metadata type
-     * @param {string} name name of the metadata
+     * @param {string[]} nameArr name of the metadata
      * @param {string} market market localizations
-     * @returns {Promise.<TYPE.MultiMetadataTypeList>} -
+     * @returns {Promise.<MultiMetadataTypeList>} -
      */
-    static async buildDefinition(businessUnit, selectedType, name, market) {
+    static async buildDefinition(businessUnit, selectedType, nameArr, market) {
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -189,7 +188,7 @@ saved
         if (buObject !== null) {
             const builder = new Builder(properties, buObject);
             if (Util.checkMarket(market, properties)) {
-                return builder._buildDefinition(selectedType, name, properties.markets[market]);
+                return builder._buildDefinition(selectedType, nameArr, properties.markets[market]);
             }
         }
     }
@@ -198,10 +197,10 @@ saved
      *
      * @param {string} listName name of list of BU-market combos
      * @param {string} type supported metadata type
-     * @param {string} name name of the metadata
-     * @returns {Promise.<TYPE.MultiMetadataTypeList[]>} -
+     * @param {string[]} nameArr name of the metadata
+     * @returns {Promise.<object>} -
      */
-    static async buildDefinitionBulk(listName, type, name) {
+    static async buildDefinitionBulk(listName, type, nameArr) {
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -217,8 +216,8 @@ saved
             return;
         }
         let i = 0;
-        const bdPromises = [];
 
+        const responseObj = {};
         for (const businessUnit in properties.marketList[listName]) {
             if (businessUnit === 'description') {
                 // skip, it's just a metadata on this list and not a BU
@@ -236,16 +235,21 @@ saved
                 if (Util.checkMarket(market, properties)) {
                     Util.logger.info(`Executing for '${businessUnit}': '${market}'`);
                     // omitting "await" to speed up creation
-                    bdPromises.push(this.buildDefinition(businessUnit, type, name, market));
+                    responseObj[businessUnit] ||= {};
+                    responseObj[businessUnit][market] = await this.buildDefinition(
+                        businessUnit,
+                        type,
+                        nameArr,
+                        market
+                    );
                 }
             }
         }
-        const response = await Promise.all(bdPromises);
 
         if (!i) {
             Util.logger.error('Please define properties.marketList in your config');
         }
-        return response;
+        return responseObj;
     }
 }
 

package/lib/Deployer.js

@@ -1,6 +1,5 @@
 'use strict';
 
-import TYPE from '../types/mcdev.d.js';
 import MetadataTypeInfo from './MetadataTypeInfo.js';
 import path from 'node:path';
 import Cli from './util/cli.js';
@@ -10,6 +9,23 @@ import config from './util/config.js';
 import cache from './util/cache.js';
 import auth from './util/auth.js';
 
+/**
+ * @typedef {import('../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ */
+
 /**
  * Reads metadata from local directory and deploys it to specified target business unit.
  * Source and target business units are also compared before the deployment to apply metadata specific patches.
@@ -18,8 +34,8 @@ class Deployer {
     /**
      * Creates a Deployer, uses v2 auth if v2AuthOptions are passed.
      *
-     * @param {TYPE.Mcdevrc} properties General configuration to be used in retrieve
-     * @param {TYPE.BuObject} buObject properties for auth
+     * @param {Mcdevrc} properties General configuration to be used in retrieve
+     * @param {BuObject} buObject properties for auth
      */
     constructor(properties, buObject) {
         this.buObject = buObject;
@@ -42,12 +58,13 @@ class Deployer {
      * Deploys all metadata located in the 'deploy' directory to the specified business unit
      *
      * @param {string} businessUnit references credentials from properties.json
-     * @param {TYPE.SupportedMetadataTypes[]} [selectedTypesArr] limit deployment to given metadata type
+     * @param {string[] | TypeKeyCombo} [selectedTypesArr] limit deployment to given metadata type
      * @param {string[]} [keyArr] limit deployment to given metadata keys
-     * @returns {Promise.<Object.<string,TYPE.MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
+     * @returns {Promise.<Object.<string, MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
      */
     static async deploy(businessUnit, selectedTypesArr, keyArr) {
         Util.logger.info('mcdev:: Deploy');
+        /** @type {Object.<string, MultiMetadataTypeMap>} */
         const buMultiMetadataTypeMap = {};
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -57,25 +74,45 @@ class Deployer {
         if (Util.OPTIONS.fromRetrieve) {
             properties.directories.deploy = properties.directories.retrieve;
         }
-        if (Array.isArray(selectedTypesArr)) {
-            // types and keys can be provided but for each type all provided keys are applied as filter
-            for (const selectedType of selectedTypesArr) {
+        if (selectedTypesArr) {
+            for (const selectedType of Array.isArray(selectedTypesArr)
+                ? selectedTypesArr
+                : Object.keys(selectedTypesArr)) {
                 if (!Util._isValidType(selectedType)) {
                     return;
                 }
             }
         }
-        if (
-            Util.OPTIONS.fromRetrieve &&
-            (!selectedTypesArr ||
-                !Array.isArray(selectedTypesArr) ||
-                !selectedTypesArr.length ||
-                !keyArr ||
-                !Array.isArray(keyArr) ||
-                !keyArr.length)
-        ) {
-            Util.logger.error('type & key need to be defined to deploy from retrieve folder');
-            return;
+        if (Util.OPTIONS.fromRetrieve) {
+            // check if either type & key or typeKeyCombo including keys was supplied
+            // we dont want to allow deploying without key from the retrieve dir for safety reasons
+            let keysFound = false;
+            if (
+                Array.isArray(selectedTypesArr) &&
+                selectedTypesArr.length &&
+                Array.isArray(keyArr) &&
+                keyArr.length
+            ) {
+                // check legacy way of passing in type(s) and key(s)
+                keysFound = true;
+            } else if (
+                selectedTypesArr &&
+                !Array.isArray(selectedTypesArr) &&
+                Object.values(selectedTypesArr).length
+            ) {
+                // TypeKeyCombo - a single null value (== no keys for one type) should lead to the error
+                keysFound = true;
+                for (const keys of Object.values(selectedTypesArr)) {
+                    if (keys === null) {
+                        keysFound = false;
+                        break;
+                    }
+                }
+            }
+            if (!keysFound) {
+                Util.logger.error('type & key need to be defined to deploy from retrieve folder');
+                return;
+            }
         }
         let counter_credBu = 0;
         if (businessUnit === '*') {
@@ -184,10 +221,10 @@ class Deployer {
      *
      * @param {string} cred name of Credential
      * @param {string} bu name of BU
-     * @param {TYPE.Mcdevrc} properties General configuration to be used in retrieve
-     * @param {TYPE.SupportedMetadataTypes[]} [typeArr] limit deployment to given metadata type
+     * @param {Mcdevrc} properties General configuration to be used in retrieve
+     * @param {string[] | TypeKeyCombo} [typeArr] limit deployment to given metadata type
      * @param {string[]} [keyArr] limit deployment to given metadata keys
-     * @returns {Promise.<TYPE.MultiMetadataTypeMap>} ensure that BUs are worked on sequentially
+     * @returns {Promise.<MultiMetadataTypeMap>} ensure that BUs are worked on sequentially
      */
     static async _deployBU(cred, bu, properties, typeArr, keyArr) {
         const buPath = `${cred}/${bu}`;
@@ -211,20 +248,32 @@ class Deployer {
     /**
      * Deploy all metadata that is located in the deployDir
      *
-     * @param {TYPE.SupportedMetadataTypes[]} [typeArr] limit deployment to given metadata type (can include subtype)
+     * @param {string[] | TypeKeyCombo} [types] limit deployment to given metadata type (can include subtype)
      * @param {string[]} [keyArr] limit deployment to given metadata keys
-     * @returns {Promise.<TYPE.MultiMetadataTypeMap>} Promise of all deployed metadata
+     * @returns {Promise.<MultiMetadataTypeMap>} Promise of all deployed metadata
      */
-    async _deploy(typeArr, keyArr) {
+    async _deploy(types, keyArr) {
+        const typeArr = !types || Array.isArray(types) ? types : Object.keys(types);
+        const typeKeyCombo = Array.isArray(types)
+            ? Util.createTypeKeyCombo(typeArr, keyArr, true)
+            : types;
         if (await File.pathExists(this.deployDir)) {
-            /** @type {TYPE.MultiMetadataTypeMap} */
-            this.metadata = Deployer.readBUMetadata(this.deployDir, typeArr);
-
+            /** @type {MultiMetadataTypeMap} */
+            this.metadata = await Deployer.readBUMetadata(this.deployDir, typeArr);
             // filter found metadata by key if given
-            if (typeArr && Array.isArray(keyArr)) {
+            if (typeArr && Array.isArray(typeArr)) {
                 for (const selectedType of typeArr) {
                     const type = selectedType.split('-')[0];
-                    this.metadata[type] = Util.filterObjByKeys(this.metadata[type], keyArr);
+                    this.metadata[type] = Util.filterObjByKeys(
+                        this.metadata[type],
+                        typeKeyCombo[selectedType]
+                    );
+                    if (!Object.keys(this.metadata[type]).length) {
+                        Util.logger.warn(
+                            `No deployable metadata found for type ${type} for selected keys`
+                        );
+                        delete this.metadata[type];
+                    }
                 }
             }
         } else {
@@ -282,7 +331,7 @@ class Deployer {
             const result = await MetadataTypeInfo[type].retrieveForCache(null, subTypeArr);
             cache.setMetadata(type, result.metadata);
         }
-        /** @type {TYPE.MultiMetadataTypeMap} */
+        /** @type {MultiMetadataTypeMap} */
         const multiMetadataTypeMap = {};
         // deploy metadata files, extending cache once deploys
         for (const metadataType in deployOrder) {
@@ -313,21 +362,21 @@ class Deployer {
      * @param {string} deployDir root directory of metadata.
      * @param {string[]} [typeArr] limit deployment to given metadata type
      * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
-     * @returns {TYPE.MultiMetadataTypeMap} Metadata of BU in local directory
+     * @returns {Promise.<MultiMetadataTypeMap>} Metadata of BU in local directory
      */
-    static readBUMetadata(deployDir, typeArr, listBadKeys) {
-        /** @type {TYPE.MultiMetadataTypeMap} */
+    static async readBUMetadata(deployDir, typeArr, listBadKeys) {
+        /** @type {MultiMetadataTypeMap} */
         const buMetadata = {};
         try {
-            File.ensureDirSync(deployDir);
-            const metadataTypes = File.readdirSync(deployDir);
+            await File.ensureDir(deployDir);
+            const metadataTypes = await File.readdir(deployDir);
             for (const metadataType of metadataTypes) {
                 if (
                     MetadataTypeInfo[metadataType] &&
                     (!typeArr || Util.includesStartsWith(typeArr, metadataType))
                 ) {
                     // check if folder name is a valid metadataType, then check if the user limited to a certain type in the command params
-                    buMetadata[metadataType] = MetadataTypeInfo[metadataType].getJsonFromFS(
+                    buMetadata[metadataType] = await MetadataTypeInfo[metadataType].getJsonFromFS(
                         File.normalizePath([deployDir, metadataType]),
                         listBadKeys,
                         typeArr
@@ -347,9 +396,9 @@ class Deployer {
      * parses asset metadata to auto-create folders in target folder
      *
      * @param {string} deployDir root directory of metadata.
-     * @param {TYPE.MultiMetadataTypeMap} metadata list of metadata
-     * @param {TYPE.SupportedMetadataTypes[]} metadataTypeArr list of metadata types
-     * @returns {void}
+     * @param {MultiMetadataTypeMap} metadata list of metadata
+     * @param {string[]} metadataTypeArr list of metadata types
+     * @returns {Promise.<object>} folder metadata
      */
     static async createFolderDefinitions(deployDir, metadata, metadataTypeArr) {
         let i = 0;
@@ -426,14 +475,20 @@ class Deployer {
                 ) {
                     contentType = 'shared_dataextension';
                 }
+                if (
+                    metadataType === 'triggeredSend' &&
+                    folder.startsWith('Journey Builder Sends/')
+                ) {
+                    contentType = 'triggered_send_journeybuilder';
+                }
                 folderMetadata[`on-the-fly-${i}`] = {
                     Path: folder,
                     Name: folder.split('/').pop(),
-                    Description: '',
+                    Description: '', // required for Create, omitted for update via definition file
                     ContentType: contentType,
-                    IsActive: true,
-                    IsEditable: true,
-                    AllowChildren: true,
+                    IsActive: true, // would be auto-updated for existing folders if needed
+                    IsEditable: true, // would be auto-updated for existing folders if needed
+                    AllowChildren: true, // would be auto-updated for existing folders if needed
                     _generated: true,
                 };
             }
@@ -447,7 +502,7 @@ class Deployer {
             Util.logger.info(`Created folders in deploy dir: ${i}`);
 
             // reload from file system to ensure we use the same logic for building the temporary JSON
-            metadata.folder = MetadataTypeInfo.folder.getJsonFromFS(
+            metadata.folder = await MetadataTypeInfo.folder.getJsonFromFS(
                 File.normalizePath([deployDir, 'folder'])
             );
         }