mcdev 6.0.2 → 7.0.0

package/lib/metadataTypes/ContentArea.js

@@ -1,10 +1,22 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 import cache from '../util/cache.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').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').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
 /**
  * ContentArea MetadataType
  *
@@ -15,16 +27,16 @@ class ContentArea extends MetadataType {
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
         Util.logger.warn(
             ' - Classic Content Areas are deprecated and will be discontinued by SFMC in the near future. Ensure that you migrate any existing Content Areas to Content Builder as soon as possible.'
         );
-        /** @type {TYPE.SoapRequestParams} */
+        /** @type {SoapRequestParams} */
         let requestParams = null;
         if (key) {
             requestParams = {
@@ -38,19 +50,10 @@ class ContentArea extends MetadataType {
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
         return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
-    /**
-     * manages post retrieve steps
-     *
-     * @param {TYPE.MetadataTypeItem} metadata a single item
-     * @returns {TYPE.MetadataTypeItem} parsed item
-     */
-    static postRetrieveTasks(metadata) {
-        return this.parseMetadata(metadata);
-    }
     /**
      * generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single script activity definition
+     * @param {MetadataTypeItem} metadata a single script activity definition
      */
     static setFolderPath(metadata) {
         try {
@@ -76,10 +79,10 @@ class ContentArea extends MetadataType {
     /**
      * parses retrieved Metadata before saving
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single item
-     * @returns {TYPE.MetadataTypeItem} parsed item
+     * @param {MetadataTypeItem} metadata a single item
+     * @returns {MetadataTypeItem} parsed item
      */
-    static parseMetadata(metadata) {
+    static postRetrieveTasks(metadata) {
         // folder
         this.setFolderPath(metadata);