mcdev 9.0.2 → 10.0.0

package/lib/Builder.js

@@ -25,7 +25,7 @@ import MetadataTypeInfo from './MetadataTypeInfo.js';
 /**
  * Builds metadata from a template using market specific customisation
  */
-class Builder {
+export default class Builder {
     /**
      * Creates a Builder, uses v2 auth if v2AuthOptions are passed.
      *
@@ -77,7 +77,7 @@ saved
                     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(' ');
+                        name = name.replaceAll('%20', ' ');
 
                         MetadataTypeInfo[type].client = auth.getSDK(this.buObject);
                         MetadataTypeInfo[type].properties = this.properties;
@@ -112,10 +112,7 @@ saved
      */
     static async buildTemplate(businessUnit, selectedType, keyArr, marketArr) {
         const properties = await config.getProperties();
-        if (!properties) {
-            return;
-        }
-        if (!Util._isValidType(selectedType)) {
+        if (!properties || !Util._isValidType(selectedType)) {
             return;
         }
         if (selectedType.includes('-')) {
@@ -205,10 +202,7 @@ saved
      */
     static async buildDefinition(businessUnit, selectedType, nameArr, marketArr) {
         const properties = await config.getProperties();
-        if (!properties) {
-            return;
-        }
-        if (!Util._isValidType(selectedType)) {
+        if (!properties || !Util._isValidType(selectedType)) {
             return;
         }
         if (selectedType.includes('-')) {
@@ -351,5 +345,3 @@ saved
         }
     }
 }
-
-export default Builder;

package/lib/Deployer.js

@@ -32,7 +32,7 @@ import auth from './util/auth.js';
  * 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.
  */
-class Deployer {
+export default class Deployer {
     /**
      * Creates a Deployer, uses v2 auth if v2AuthOptions are passed.
      *
@@ -271,18 +271,20 @@ class Deployer {
             // filter found metadata by key if given
             if (typeArr && Array.isArray(typeArr)) {
                 for (const selectedType of typeArr) {
-                    const type = selectedType.split('-')[0];
+                    const type = selectedType.split('-', 1)[0];
                     this.metadata[type] = Util.filterObjByKeys(
                         this.metadata[type],
                         typeKeyCombo[selectedType]
                     );
-                    if (!this.metadata[type] || !Object.keys(this.metadata[type]).length) {
-                        // the type array is not set if the folder wasnt there. it is set but empty if the folder was there but no metadata was found
-                        Util.logger.warn(
-                            `No deployable metadata found for type ${type} ${keyArr?.length ? 'with keys ' + keyArr.join(', ') : ''}`
-                        );
-                        delete this.metadata[type];
+                    if (this.metadata[type] && Object.keys(this.metadata[type]).length) {
+                        continue;
                     }
+
+                    // the type array is not set if the folder wasnt there. it is set but empty if the folder was there but no metadata was found
+                    Util.logger.warn(
+                        `No deployable metadata found for type ${type} ${keyArr?.length ? 'with keys ' + keyArr.join(', ') : ''}`
+                    );
+                    delete this.metadata[type];
                 }
             }
         } else {
@@ -356,23 +358,24 @@ class Deployer {
         for (const metadataType in deployOrder) {
             // TODO rewrite to allow deploying only a specific sub-type; currently, subtypes are ignored when executing deploy
             const type = metadataType;
-            if (this.metadata[type]) {
-                Util.logger.info(
-                    'Deploying: ' +
-                        metadataType +
-                        (Util.OPTIONS.fromRetrieve ? ' (from retrieve folder)' : '')
-                );
-
-                const result = await MetadataTypeInfo[type].deploy(
-                    this.metadata[type],
-                    this.deployDir,
-                    type === 'folder' && (!typeArr || !typeArr.includes('folder'))
-                        ? null
-                        : this.retrieveDir
-                );
-                multiMetadataTypeMap[type] = result;
-                cache.mergeMetadata(type, result);
+            if (!this.metadata[type]) {
+                continue;
             }
+            Util.logger.info(
+                'Deploying: ' +
+                    metadataType +
+                    (Util.OPTIONS.fromRetrieve ? ' (from retrieve folder)' : '')
+            );
+
+            const result = await MetadataTypeInfo[type].deploy(
+                this.metadata[type],
+                this.deployDir,
+                type === 'folder' && (!typeArr || !typeArr.includes('folder'))
+                    ? null
+                    : this.retrieveDir
+            );
+            multiMetadataTypeMap[type] = result;
+            cache.mergeMetadata(type, result);
         }
         return multiMetadataTypeMap;
     }
@@ -394,7 +397,9 @@ class Deployer {
             for (const metadataType of metadataTypes) {
                 if (
                     MetadataTypeInfo[metadataType] &&
-                    (!typeArr || Util.includesStartsWith(typeArr, metadataType))
+                    (!typeArr ||
+                        typeArr.includes(metadataType) ||
+                        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] = await MetadataTypeInfo[metadataType].getJsonFromFS(
@@ -430,8 +435,8 @@ class Deployer {
             // check if folder or folder-like metadata type is in dependencies
             if (
                 !MetadataTypeInfo[metadataType].definition.dependencies.includes('folder') &&
-                !MetadataTypeInfo[metadataType].definition.dependencies.some((dep) =>
-                    dep.startsWith('folder-')
+                MetadataTypeInfo[metadataType].definition.dependencies.every(
+                    (dep) => !dep.startsWith('folder-')
                 )
             ) {
                 Util.logger.debug(` ☇ skipping ${metadataType} folders: folder not a dependency`);
@@ -535,5 +540,3 @@ class Deployer {
         return folderMetadata;
     }
 }
-
-export default Deployer;

package/lib/MetadataTypeDefinitions.js

@@ -26,9 +26,11 @@ import folder from './metadataTypes/definitions/Folder.definition.js';
 import importFile from './metadataTypes/definitions/ImportFile.definition.js';
 import journey from './metadataTypes/definitions/Journey.definition.js';
 import list from './metadataTypes/definitions/List.definition.js';
+import mobilePushApp from './metadataTypes/definitions/MobilePushApp.definition.js';
 import mobileCode from './metadataTypes/definitions/MobileCode.definition.js';
 import mobileKeyword from './metadataTypes/definitions/MobileKeyword.definition.js';
 import mobileMessage from './metadataTypes/definitions/MobileMessage.definition.js';
+import mobilePush from './metadataTypes/definitions/MobilePush.definition.js';
 import query from './metadataTypes/definitions/Query.definition.js';
 import role from './metadataTypes/definitions/Role.definition.js';
 import script from './metadataTypes/definitions/Script.definition.js';
@@ -76,6 +78,8 @@ export default {
     mobileCode,
     mobileKeyword,
     mobileMessage,
+    mobilePush,
+    mobilePushApp,
     query,
     role,
     script,

package/lib/MetadataTypeInfo.js

@@ -26,9 +26,11 @@ import folder from './metadataTypes/Folder.js';
 import importFile from './metadataTypes/ImportFile.js';
 import journey from './metadataTypes/Journey.js';
 import list from './metadataTypes/List.js';
+import mobilePushApp from './metadataTypes/MobilePushApp.js';
 import mobileCode from './metadataTypes/MobileCode.js';
 import mobileKeyword from './metadataTypes/MobileKeyword.js';
 import mobileMessage from './metadataTypes/MobileMessage.js';
+import mobilePush from './metadataTypes/MobilePush.js';
 import query from './metadataTypes/Query.js';
 import role from './metadataTypes/Role.js';
 import script from './metadataTypes/Script.js';
@@ -72,9 +74,11 @@ export default {
     importFile,
     journey,
     list,
+    mobilePushApp,
     mobileCode,
     mobileKeyword,
     mobileMessage,
+    mobilePush,
     query,
     role,
     script,

package/lib/Retriever.js

@@ -20,14 +20,13 @@ import auth from './util/auth.js';
  * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
  * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
  * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
- * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
  * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
  */
 
 /**
  * Retrieves metadata from a business unit and saves it to the local filesystem.
  */
-class Retriever {
+export default class Retriever {
     /**
      * Creates a Retriever, uses v2 auth if v2AuthOptions are passed.
      *
@@ -38,7 +37,6 @@ class Retriever {
         this.buObject = buObject;
         this.properties = properties;
         this.retrieveDir = properties.directories.retrieve;
-        this.templateDir = properties.directories.template;
         this.savePath = File.normalizePath([
             properties.directories.retrieve,
             buObject.credential,
@@ -50,12 +48,11 @@ class Retriever {
      * Retrieve metadata of specified types into local file system and Retriever.metadata
      *
      * @param {string[]} metadataTypes list of metadata types to retrieve; can include subtypes!
-     * @param {string[] | TypeKeyCombo} [namesOrKeys] name of Metadata to retrieveAsTemplate or list of keys for normal retrieval
-     * @param {TemplateMap} [templateVariables] Object of values which can be replaced (in case of templating)
+     * @param {string[] | TypeKeyCombo} [namesOrKeys] list of keys or type-key map for retrieval
      * @param {boolean} [changelogOnly] skip saving, only create json in memory
      * @returns {Promise.<MultiMetadataTypeList>} Promise of a list of retrieved items grouped by type {automation:[...], query:[...]}
      */
-    async retrieve(metadataTypes, namesOrKeys, templateVariables, changelogOnly) {
+    async retrieve(metadataTypes, namesOrKeys, changelogOnly) {
         /**
          * @type {MultiMetadataTypeList}
          */
@@ -102,28 +99,8 @@ class Retriever {
                     Util.logger.info(`Caching dependent Metadata: ${type}`);
                     Util.logSubtypes(subTypeArr);
                     result = await MetadataTypeInfo[type].retrieveForCache(null, subTypeArr);
-                } else if (templateVariables) {
-                    // type is in list of types to retrieve and we have template variables
-                    Util.logger.info(`Retrieving as Template: ${type}`);
-                    if (subTypeArr?.length > 1) {
-                        Util.logger.warn(
-                            `retrieveAsTemplate only works with one subtype, ignoring all but first subtype from your list: ${subTypeArr.join(
-                                ', '
-                            )}`
-                        );
-                    }
-                    result = await Promise.all(
-                        typeKeyMap[type].map((name) =>
-                            MetadataTypeInfo[type].retrieveAsTemplate(
-                                this.templateDir,
-                                name,
-                                templateVariables,
-                                subTypeArr?.[0]
-                            )
-                        )
-                    );
                 } else {
-                    // type is in list of types to retrieve and we don't have template variables
+                    // type is in list of types to retrieve
                     let cacheResult = null;
                     if (
                         (typeKeyMap[type].length > 1 || typeKeyMap[type][0] !== null) &&
@@ -144,9 +121,10 @@ class Retriever {
                         )
                     ) {
                         // some types exist locally and shared from other BUs (parent and siblings). those need to be put into the cache or else we wont find them when looking for dependencies
+                        // note: retrieveSharedForCache() returns a plain metadata map, not a {metadata: ...} wrapper
                         const cacheSharedResult =
                             await MetadataTypeInfo[type].retrieveSharedForCache();
-                        cache.mergeMetadata(type, cacheSharedResult.metadata);
+                        cache.mergeMetadata(type, cacheSharedResult);
                     }
                     Util.logger.info(
                         `Retrieving: ${type}` +
@@ -227,11 +205,11 @@ class Retriever {
     _getTypeDependencies(metadataTypes) {
         let dependencies = [];
         for (const metadataType of metadataTypes) {
-            const type = metadataType.split('-')[0];
+            const type = metadataType.split('-', 1)[0];
             // if they have dependencies then add a dependency pair for each type
             if (MetadataDefinitions[type].dependencies.length > 0) {
                 dependencies.push(
-                    ...MetadataDefinitions[type].dependencies.map((dep) => dep.split('-')[0])
+                    ...MetadataDefinitions[type].dependencies.map((dep) => dep.split('-', 1)[0])
                 );
             }
         }
@@ -239,5 +217,3 @@ class Retriever {
         return dependencies;
     }
 }
-
-export default Retriever;