mcdev 9.0.2 → 10.0.0

package/lib/metadataTypes/Event.js

@@ -4,7 +4,7 @@ import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 import File from '../util/file.js';
 import cache from '../util/cache.js';
-import deepEqual from 'deep-equal';
+import { isDeepEqual } from '../util/isDeepEqual.js';
 import pLimit from 'p-limit';
 
 /**
@@ -53,7 +53,6 @@ class Event extends MetadataType {
                 `/interaction/v1/eventDefinitions${
                     key ? '/key:' + encodeURIComponent(key) : ''
                 }?extras=all`,
-                null,
                 key
             );
         } catch (ex) {
@@ -79,64 +78,6 @@ class Event extends MetadataType {
         return this.retrieve(null);
     }
 
-    /**
-     * Retrieve a specific Event Definition by Name
-     *
-     * @deprecated Use `retrieve` followed by `build` instead. `retrieveAsTemplate` will be removed in a future version.
-     * @param {string} templateDir Directory where retrieved metadata directory will be saved
-     * @param {string} name name of the metadata file
-     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<MetadataTypeItemObj>} Promise of metadata
-     */
-    static async retrieveAsTemplate(templateDir, name, templateVariables) {
-        Util.logDeprecated('retrieveAsTemplate', `'retrieve' followed by 'build'`);
-        const res = await this.client.rest.get(
-            '/interaction/v1/eventDefinitions?name=' + encodeURIComponent(name)
-        );
-        const event = res.items.filter((item) => item.name === name);
-        try {
-            if (!event || event.length === 0) {
-                throw new Error(`No Event Definitions Found with name "${name}"`);
-            } else if (event.length > 1) {
-                throw new Error(
-                    `Multiple Event Definitions with name "${name}"` +
-                        `please rename to be unique to avoid issues`
-                );
-            } else if (event?.length === 1) {
-                const originalKey = event[0][this.definition.keyField];
-                const metadataItemTemplated = Util.replaceByObject(
-                    await this.postRetrieveTasks(event[0]),
-                    templateVariables
-                );
-
-                if (!metadataItemTemplated.r__dataExtension_key) {
-                    throw new Error(
-                        `Event.postRetrieveTasks:: No Data Extension found for ${this.definition.type}: ${metadataItemTemplated.name}. This cannot be templated.`
-                    );
-                }
-
-                // remove all fields listed in Definition for templating
-                this.keepTemplateFields(metadataItemTemplated);
-                await File.writeJSONToFile(
-                    [templateDir, this.definition.type].join('/'),
-                    originalKey + '.' + this.definition.type + '-meta',
-                    metadataItemTemplated
-                );
-                Util.logger.info(` - templated ${this.definition.type}: ${name}`);
-                return { metadata: metadataItemTemplated, type: this.definition.type };
-            } else {
-                throw new Error(
-                    `Encountered unknown error when retrieveing ${
-                        this.definition.typeName
-                    } "${name}": ${JSON.stringify(res.body)}`
-                );
-            }
-        } catch (ex) {
-            Util.logger.error('Event.retrieveAsTemplate:: ' + ex);
-            return null;
-        }
-    }
-
     /**
      * Delete a metadata item from the specified business unit
      *
@@ -333,7 +274,7 @@ class Event extends MetadataType {
                         delete field.isDevicePreference;
                         return field;
                     });
-                    if (!deepEqual(metadataItem?.schema?.fields, cacheClone?.schema?.fields)) {
+                    if (!isDeepEqual(metadataItem?.schema?.fields, cacheClone?.schema?.fields)) {
                         Util.logger.warn(
                             ` - ${this.definition.type} ${metadataItem[this.definition.keyField]}: schema fields differ from server version. Resetting as this will not be reflected on dataExtension.`
                         );
@@ -652,11 +593,11 @@ class Event extends MetadataType {
         referencedObjects: {},
         /** @type {Object.<string, Object.<string, SfObjectField>>} object-name > field-name > field data */
         objectFields: {},
-        /** @type {Object.<string, Promise.<any>>} */
+        /** @type {Object.<string, Promise.<void>>} */
         loadingFields: {},
-        /** @type {Object.<string, Promise.<any>>} */
+        /** @type {Object.<string, Promise.<void>>} */
         loadingRelatedObjects: {},
-        /** @type {Promise.<any>} */
+        /** @type {Promise.<void>} */
         loadingWorkflowObjects: null,
     };
 
@@ -880,11 +821,11 @@ class Event extends MetadataType {
             // if the current object is the entry object then relationshipName and referenceObject are set to empty strings because it's not "referencing" a "relationship" but just listing its own fields
             dePrefixRelationshipMap[object.dePrefix] =
                 object.relationshipName === ''
-                    ? object.dePrefix.split(':')[0]
+                    ? object.dePrefix.split(':', 1)[0]
                     : object.relationshipName;
             dePrefixReferenceObjectMap[object.dePrefix] =
                 object.referenceObject === ''
-                    ? object.dePrefix.split(':')[0]
+                    ? object.dePrefix.split(':', 1)[0]
                     : object.referenceObject;
 
             // 1.1 check if fields in eventDataConfig exist in Salesforce

package/lib/metadataTypes/FileLocation.js

@@ -38,7 +38,6 @@ class FileLocation extends MetadataType {
             const dataItems = await super.retrieveREST(
                 null,
                 '/data/v1/filetransferlocation' + (key ? '/' + encodeURIComponent(key) : 's'),
-                null,
                 key
             );
             this.cache[this.buObject.mid] ||= {};
@@ -51,12 +50,7 @@ class FileLocation extends MetadataType {
                 Util.logger.warn(ex.message);
             }
         }
-        const items = await super.retrieveREST(
-            retrieveDir,
-            '/automation/v1/ftplocations/',
-            null,
-            key
-        );
+        const items = await super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', key);
 
         return items;
     }

package/lib/metadataTypes/FileTransfer.js

@@ -2,7 +2,6 @@
 
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
-import File from '../util/file.js';
 import cache from '../util/cache.js';
 
 /**
@@ -35,7 +34,7 @@ class FileTransfer extends MetadataType {
      * @returns {Promise.<MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', key);
     }
 
     /**
@@ -47,60 +46,6 @@ class FileTransfer extends MetadataType {
         return super.retrieveREST(null, '/automation/v1/filetransfers/');
     }
 
-    /**
-     * Retrieve a specific File Transfer Definition by Name
-     *
-     * @deprecated Use `retrieve` followed by `build` instead. `retrieveAsTemplate` will be removed in a future version.
-     * @param {string} templateDir Directory where retrieved metadata directory will be saved
-     * @param {string} name name of the metadata file
-     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<MetadataTypeItemObj>} Promise
-     */
-    static async retrieveAsTemplate(templateDir, name, templateVariables) {
-        Util.logDeprecated('retrieveAsTemplate', `'retrieve' followed by 'build'`);
-        const res = await this.client.rest.get(
-            '/automation/v1/filetransfers/?$filter=name%20eq%20' + encodeURIComponent(name)
-        );
-        if (Array.isArray(res?.items) && res?.items?.length) {
-            // eq-operator returns a similar, not exact match and hence might return more than 1 entry
-            const metadata = res.items.find((item) => item.name === name);
-            if (!metadata) {
-                Util.logger.error(`No ${this.definition.typeName} found with name "${name}"`);
-                return;
-            }
-
-            // get full definition
-            const extended = await this.client.rest.get(
-                '/automation/v1/filetransfers/' + metadata[this.definition.idField]
-            );
-            const originalKey = extended[this.definition.keyField];
-            const val = JSON.parse(
-                Util.replaceByObject(
-                    JSON.stringify(this.postRetrieveTasks(extended)),
-                    templateVariables
-                )
-            );
-
-            // remove all fields listed in Definition for templating
-            this.keepTemplateFields(val);
-            await File.writeJSONToFile(
-                [templateDir, this.definition.type].join('/'),
-                originalKey + '.' + this.definition.type + '-meta',
-                JSON.parse(Util.replaceByObject(JSON.stringify(val), templateVariables))
-            );
-            Util.logger.info(`- templated ${this.definition.type}: ${name}`);
-            return { metadata: val, type: this.definition.type };
-        } else if (res?.items) {
-            Util.logger.error(`No ${this.definition.typeName} found with name "${name}"`);
-        } else {
-            throw new Error(
-                `Encountered unknown error when retrieveing ${
-                    this.definition.typeName
-                } "${name}": ${JSON.stringify(res)}`
-            );
-        }
-    }
-
     /**
      * Creates a single File Transfer
      *

package/lib/metadataTypes/Filter.js

@@ -46,7 +46,7 @@ class Filter extends MetadataType {
      */
     static async retrieve(retrieveDir, _, __, key) {
         const objectId = key ? await this._getObjectIdForSingleRetrieve(key) : '';
-        return super.retrieveREST(retrieveDir, '/automation/v1/filters/' + objectId, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filters/' + objectId, key);
     }
     /**
      * parses retrieved Metadata before saving

package/lib/metadataTypes/Folder.js

@@ -1,7 +1,7 @@
 'use strict';
 
 import MetadataType from './MetadataType.js';
-import toposort from 'toposort';
+import { topologicalSort } from '../util/topological-sort.js';
 import { Util } from '../util/util.js';
 import File from '../util/file.js';
 import cache from '../util/cache.js';
@@ -55,7 +55,7 @@ class Folder extends MetadataType {
             }
         }
 
-        const sortPairs = toposort(queryAllFolders.map((a) => [a.ParentFolder.ID, a.ID]));
+        const sortPairs = topologicalSort(queryAllFolders.map((a) => [a.ParentFolder.ID, a.ID]));
         /** @type {ListIdMap} */
         const idMap = {};
         for (const val of queryAllFolders) {
@@ -69,7 +69,7 @@ class Folder extends MetadataType {
                 val.CustomerKey = [this.buObject.eid, val.ID].join('-');
             }
             // ensure name is a string and not a number (SFMC-SDK workaround)
-            val.Name = val.Name + '';
+            val.Name += '';
 
             idMap[val.ID] = val;
         }
@@ -210,7 +210,7 @@ class Folder extends MetadataType {
         let filteredByPreDeploy = 0;
         /** @type {ListMap} */
         const upsertResults = {};
-        const sortPairs = toposort(
+        const sortPairs = topologicalSort(
             Object.keys(metadata).map((customerKey) => [
                 metadata[customerKey].ParentFolder.Path,
                 metadata[customerKey].Path,
@@ -364,7 +364,7 @@ class Folder extends MetadataType {
      * creates a folder based on metatadata
      *
      * @param {ListItem} metadataEntry metadata of the folder
-     * @returns {Promise.<any>} Promise of api response
+     * @returns {Promise.<object|void>} Promise of api response
      */
     static async create(metadataEntry) {
         if (metadataEntry?.ParentFolder?.ID === 0) {
@@ -486,7 +486,7 @@ class Folder extends MetadataType {
      * Updates a single Folder.
      *
      * @param {MetadataTypeItem} metadataEntry single metadata entry
-     * @returns {Promise.<any>} Promise of api response
+     * @returns {Promise.<object|void>} Promise of api response
      */
     static async update(metadataEntry) {
         if (metadataEntry?.ParentFolder?.ID === 0) {
@@ -631,16 +631,16 @@ class Folder extends MetadataType {
             /** @type {ListMap} */
             const fileName2FileContent = {};
             const directories = File.readDirectoriesSync(dir, 10, true);
-            let newCounter = 0;
             if (!Array.isArray(directories)) {
                 return fileName2FileContent;
             }
+            let newCounter = 0;
             for (const subdir of directories) {
                 // standardise to / and then remove the stem up until folder as this
                 // should not be in the path for the metadata. In case no split then return empty as this is root
 
                 const standardSubDir = File.reverseFilterIllegalFilenames(
-                    subdir.replaceAll('\\', '/').split(/folder\//)[1] || ''
+                    subdir.replaceAll('\\', '/').split(/folder\//, 2)[1] || ''
                 );
                 for (const fileName of await File.readdir(subdir)) {
                     try {
@@ -648,7 +648,7 @@ class Folder extends MetadataType {
                             const fileContent = await File.readJSONFile(subdir, fileName, false);
 
                             const fileNameWithoutEnding = File.reverseFilterIllegalFilenames(
-                                fileName.split(/\.(\w|-)+-meta.json/)[0]
+                                fileName.split(/\.(\w|-)+-meta.json/, 1)[0]
                             );
 
                             if (fileContent.Name === fileNameWithoutEnding) {

package/lib/metadataTypes/ImportFile.js

@@ -2,7 +2,6 @@
 
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
-import File from '../util/file.js';
 import cache from '../util/cache.js';
 
 /**
@@ -88,12 +87,7 @@ class ImportFile extends MetadataType {
             }
         }
 
-        return super.retrieveREST(
-            retrieveDir,
-            '/automation/v1/imports/' + (objectId || ''),
-            null,
-            key
-        );
+        return super.retrieveREST(retrieveDir, '/automation/v1/imports/' + (objectId || ''), key);
     }
 
     /**
@@ -102,7 +96,7 @@ class ImportFile extends MetadataType {
      * @param {SDKError} ex exception
      * @param {string} key id or key of item
      * @param {string} url url to call for retry
-     * @returns {Promise.<any>} can return retry-result
+     * @returns {Promise.<object|null>} retry result or null when the request cannot be recovered
      */
     static async handleRESTErrors(ex, key, url) {
         try {
@@ -112,7 +106,7 @@ class ImportFile extends MetadataType {
                     ` - Connection problem (Code: ${ex.code}). Retrying once${
                         ex.endpoint
                             ? Util.getGrayMsg(
-                                  ' - ' + ex.endpoint.split('rest.marketingcloudapis.com')[1]
+                                  ' - ' + ex.endpoint.split('rest.marketingcloudapis.com', 2)[1]
                               )
                             : ''
                     }`
@@ -140,55 +134,6 @@ class ImportFile extends MetadataType {
         return this.retrieve(null, null, null, key);
     }
 
-    /**
-     * Retrieve a specific Import Definition by Name
-     *
-     * @deprecated Use `retrieve` followed by `build` instead. `retrieveAsTemplate` will be removed in a future version.
-     * @param {string} templateDir Directory where retrieved metadata directory will be saved
-     * @param {string} name name of the metadata file
-     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<MetadataTypeItemObj>} Promise
-     */
-    static async retrieveAsTemplate(templateDir, name, templateVariables) {
-        Util.logDeprecated('retrieveAsTemplate', `'retrieve' followed by 'build'`);
-        // using '?$filter=name%20eq%20' + encodeURIComponent(name) would also work but that just retrieves more data for no reason
-        const cache = await this.retrieveForCache(null, null, 'name:' + name);
-        const metadataArr = Object.values(cache?.metadata);
-        if (Array.isArray(metadataArr) && metadataArr.length) {
-            // eq-operator returns a similar, not exact match and hence might return more than 1 entry
-            const metadata = metadataArr.find((item) => item.name === name);
-            if (!metadata) {
-                Util.logger.error(`No ${this.definition.typeName} found with name "${name}"`);
-                return;
-            }
-            const originalKey = metadata[this.definition.keyField];
-            const val = JSON.parse(
-                Util.replaceByObject(
-                    JSON.stringify(this.postRetrieveTasks(metadata)),
-                    templateVariables
-                )
-            );
-
-            // remove all fields listed in Definition for templating
-            this.keepTemplateFields(val);
-            await File.writeJSONToFile(
-                [templateDir, this.definition.type].join('/'),
-                originalKey + '.' + this.definition.type + '-meta',
-                JSON.parse(Util.replaceByObject(JSON.stringify(val), templateVariables))
-            );
-            Util.logger.info(`- templated ${this.definition.type}: ${name}`);
-            return { metadata: val, type: this.definition.type };
-        } else if (metadataArr) {
-            Util.logger.error(`No ${this.definition.typeName} found with name "${name}"`);
-        } else {
-            throw new Error(
-                `Encountered unknown error when retrieveing ${
-                    this.definition.typeName
-                } "${name}": ${JSON.stringify(metadataArr)}`
-            );
-        }
-    }
-
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -342,7 +287,7 @@ class ImportFile extends MetadataType {
                     // code
                     const codeObj = cache.getByKey(
                         'mobileCode',
-                        metadata.destination.r__mobileKeyword_key.split('.')[0]
+                        metadata.destination.r__mobileKeyword_key.split('.', 1)[0]
                     );
                     if (!codeObj) {
                         throw new Error(