Merge pull request #2006 from Accenture/task/2005-resolve-locationtyp…

…eid-on-filelocation task/2005 resolve locationTypeId on fileLocation
Accenture · Jan 21, 2025 · 0062a70 · 0062a70
2 parents 70dd9e9 + 1989c34
commit 0062a70
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 13 deletions.
diff --git a/@types/lib/metadataTypes/FileLocation.d.ts b/@types/lib/metadataTypes/FileLocation.d.ts
diff --git a/@types/lib/metadataTypes/FileLocation.d.ts.map b/@types/lib/metadataTypes/FileLocation.d.ts.map
diff --git a/@types/lib/metadataTypes/definitions/FileLocation.definition.d.ts b/@types/lib/metadataTypes/definitions/FileLocation.definition.d.ts
diff --git a/lib/metadataTypes/FileLocation.js b/lib/metadataTypes/FileLocation.js
@@ -1,6 +1,7 @@
 'use strict';
 
 import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
 
 /**
  * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
@@ -20,10 +21,10 @@ import MetadataType from './MetadataType.js';
  *
  * @augments MetadataType
  */
-class FtpLocation extends MetadataType {
+class FileLocation extends MetadataType {
     /**
-     * Retrieves Metadata of FtpLocation
-     * Endpoint /automation/v1/ftplocations/ return all FtpLocations
+     * Retrieves Metadata of FileLocation
+     * Endpoint /automation/v1/ftplocations/ return all FileLocations
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void | string[]} [_] unused parameter
@@ -43,10 +44,47 @@ class FtpLocation extends MetadataType {
     static async retrieveForCache() {
         return super.retrieveREST(null, '/automation/v1/ftplocations/');
     }
+
+    /**
+     * prepares a import definition for deployment
+     *
+     * @param {MetadataTypeItem} metadata a single importDef
+     * @returns {Promise.<MetadataTypeItem>} Promise
+     */
+    static async preDeployTasks(metadata) {
+        if (metadata.c__locationType) {
+            metadata.locationTypeId = this.definition.locationTypeMapping[metadata.c__locationType];
+        }
+        return metadata;
+    }
+
+    /**
+     * manages post retrieve steps
+     *
+     * @param {MetadataTypeItem} metadata a single item
+     * @returns {MetadataTypeItem} parsed metadata
+     */
+    static postRetrieveTasks(metadata) {
+        if (metadata.locationTypeId) {
+            try {
+                metadata.c__locationType = Util.inverseGet(
+                    this.definition.locationTypeMapping,
+                    metadata.locationTypeId
+                );
+                delete metadata.locationTypeId;
+            } catch {
+                Util.logger.info(
+                    'Please report this new & unknown locationTypeId to the mcdev developer team via github: ' +
+                        metadata.locationTypeId
+                );
+            }
+        }
+        return metadata;
+    }
 }
 
 // Assign definition to static attributes
 import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
-FtpLocation.definition = MetadataTypeDefinitions.fileLocation;
+FileLocation.definition = MetadataTypeDefinitions.fileLocation;
 
-export default FtpLocation;
+export default FileLocation;
diff --git a/lib/metadataTypes/definitions/FileLocation.definition.js b/lib/metadataTypes/definitions/FileLocation.definition.js
@@ -17,6 +17,20 @@ export default {
         'Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation.',
     typeRetrieveByDefault: true,
     typeName: 'File Location',
+    locationTypeMapping: {
+        'Enhanced FTP Site Import Directory': 0,
+        'External FTP Site': 1,
+        'External SFTP Site': 2,
+        'External FTPS Site': 3,
+        'Salesforce Objects and Reports': 4,
+        Safehouse: 5,
+        'Enhanced FTP Site Export Directory': 6,
+        'Legacy Import Directory': 8,
+        'Relative location under FTP Site': 9,
+        'Amazon Simple Storage Service': 13,
+        'Azure Blob Storage': 15,
+        'Google Cloud Storage': 16,
+    },
     fields: {
         id: {
             isCreateable: false,
@@ -34,19 +48,25 @@ export default {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
-            template: false,
+            template: true,
         },
         name: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
-            template: false,
+            template: true,
         },
         relPath: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
             template: true,
         },
+        c__locationType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };