#164: support delete for asset

docs/dist/documentation.md

@@ -891,6 +891,8 @@ FileTransfer MetadataType
     * [.findSubType(templateDir, templateName)](#Asset.findSubType) ⇒ <code>Promise.&lt;TYPE.AssetSubType&gt;</code>
     * [.readSecondaryFolder(templateDir, typeDirArr, templateName, fileName)](#Asset.readSecondaryFolder) ⇒ <code>TYPE.AssetItem</code>
     * [.getFilesToCommit(keyArr)](#Asset.getFilesToCommit) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.deleteByKey(customerKey)](#Asset.deleteByKey) ⇒ <code>boolean</code>
+    * [.postDeleteTasks(customerKey)](#Asset.postDeleteTasks) ⇒ <code>void</code>
 
 <a name="Asset.retrieve"></a>
 
@@ -1266,6 +1268,30 @@ additionally, the documentation for dataExtension and automation should be retur
 | --- | --- | --- |
 | keyArr | <code>Array.&lt;string&gt;</code> | customerkey of the metadata |
 
+<a name="Asset.deleteByKey"></a>
+
+### Asset.deleteByKey(customerKey) ⇒ <code>boolean</code>
+Delete a metadata item from the specified business unit
+
+**Kind**: static method of [<code>Asset</code>](#Asset)  
+**Returns**: <code>boolean</code> - deletion success status  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| customerKey | <code>string</code> | Identifier of data extension |
+
+<a name="Asset.postDeleteTasks"></a>
+
+### Asset.postDeleteTasks(customerKey) ⇒ <code>void</code>
+clean up after deleting a metadata item
+cannot use the generic method due to the complexity of how assets are saved to disk
+
+**Kind**: static method of [<code>Asset</code>](#Asset)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| customerKey | <code>string</code> | Identifier of metadata item |
+
 <a name="AttributeGroup"></a>
 
 ## AttributeGroup ⇐ [<code>MetadataType</code>](#MetadataType)

lib/metadataTypes/Asset.js

@@ -1629,6 +1629,66 @@ class Asset extends MetadataType {
         ).flat();
         return fileList;
     }
+    /**
+     * helper to allow us to select single metadata entries via REST
+     *
+     * @private
+     * @param {string} key customer key
+     * @returns {Promise.<string>} objectId or enpty string
+     */
+    static async _getObjectIdForSingleRetrieve(key) {
+        const name = key.startsWith('name:') ? key.slice(5) : null;
+        const filter = name
+            ? '?$filter=name%20eq%20' + encodeURIComponent(name)
+            : '?$filter=customerKey%20eq%20' + encodeURIComponent(key);
+
+        const results = await this.client.rest.get('/asset/v1/content/assets/' + filter);
+        const items = results?.items || [];
+        const found = items.find((item) =>
+            name ? item[this.definition.nameField] === name : item[this.definition.keyField] === key
+        );
+        return found?.id || null;
+    }
+
+    /**
+     * Delete a metadata item from the specified business unit
+     *
+     * @param {string} customerKey Identifier of data extension
+     * @returns {boolean} deletion success status
+     */
+    static async deleteByKey(customerKey) {
+        // delete only works with the query's object id
+        const objectId = customerKey ? await this._getObjectIdForSingleRetrieve(customerKey) : null;
+        if (!objectId) {
+            Util.logger.error(` - ${this.definition.type} not found`);
+            return false;
+        }
+        return super.deleteByKeyREST('/asset/v1/content/assets/' + objectId, customerKey);
+    }
+
+    /**
+     * clean up after deleting a metadata item
+     * cannot use the generic method due to the complexity of how assets are saved to disk
+     *
+     * @param {string} customerKey Identifier of metadata item
+     * @returns {void}
+     */
+    static async postDeleteTasks(customerKey) {
+        const fileArr = await this.getFilesToCommit([customerKey]);
+
+        // check if asset sits in its own folder
+        const ownFolderIndex =
+            fileArr[0].indexOf(customerKey + '\\') > 0
+                ? fileArr[0].indexOf(customerKey + '\\')
+                : fileArr[0].indexOf(customerKey + '/');
+        if (ownFolderIndex > 0) {
+            fileArr.push(fileArr[0].slice(0, ownFolderIndex + customerKey.length));
+        }
+
+        for (const filePath of fileArr) {
+            await File.remove(filePath);
+        }
+    }
 }
 
 // Assign definition to static attributes

test/resourceFactory.js

@@ -252,8 +252,52 @@ export const handleRESTRequest = async (config) => {
                 config.method + '-response'
             )
             .replace(':', '_'); // replace : with _ for Windows
+        const testPathFilter = filterName
+            ? testPath +
+              '-' +
+              urlObj.searchParams.get('$filter').replaceAll(' eq ', '=').replaceAll(' ', '')
+            : null;
+        if (testPathFilter && (await fs.pathExists(testPathFilter + '.json'))) {
+            // build filter logic to ensure templating works
+            if (filterName) {
+                const response = JSON.parse(
+                    await fs.readFile(testPathFilter + '.json', {
+                        encoding: 'utf8',
+                    })
+                );
+                response.items = response.items.filter((def) => def.name == filterName);
+                response.count = response.items.length;
+                return [200, JSON.stringify(response)];
+            } else {
+                return [
+                    200,
+                    await fs.readFile(testPathFilter + '.json', {
+                        encoding: 'utf8',
+                    }),
+                ];
+            }
+        } else if (testPathFilter && (await fs.pathExists(testPathFilter + '.txt'))) {
+            return [
+                200,
+                await fs.readFile(testPathFilter + '.txt', {
+                    encoding: 'utf8',
+                }),
+            ];
+        } else if (await fs.pathExists(testPath + '.json')) {
+            if (testPathFilter) {
+                /* eslint-disable no-console */
+                console.log(
+                    `${color.bgYellow}${color.fgBlack}TEST-WARNING${
+                        color.reset
+                    }: You are loading your reponse from ${
+                        testPath + '.json'
+                    } instead of the more specific ${
+                        testPathFilter + '.json'
+                    }. Make sure this is intended`
+                );
+                /* eslint-enable no-console */
+            }
 
-        if (await fs.pathExists(testPath + '.json')) {
             // build filter logic to ensure templating works
             if (filterName) {
                 const response = JSON.parse(
@@ -273,6 +317,20 @@ export const handleRESTRequest = async (config) => {
                 ];
             }
         } else if (await fs.pathExists(testPath + '.txt')) {
+            if (testPathFilter) {
+                /* eslint-disable no-console */
+                console.log(
+                    `${color.bgYellow}${color.fgBlack}TEST-WARNING${
+                        color.reset
+                    }: You are loading your reponse from ${
+                        testPath + '.txt'
+                    } instead of the more specific ${
+                        testPathFilter + '.txt'
+                    }. Make sure this is intended`
+                );
+                /* eslint-enable no-console */
+            }
+
             return [
                 200,
                 await fs.readFile(testPath + '.txt', {
@@ -282,7 +340,7 @@ export const handleRESTRequest = async (config) => {
         } else {
             /* eslint-disable no-console */
             console.log(
-                `${color.bgRed}${color.fgBlack}TEST-ERROR${color.reset}: Please create file ${testPath}.json/.txt`
+                `${color.bgRed}${color.fgBlack}TEST-ERROR${color.reset}: Please create file ${testPath}.json/.txt${filterName ? ` or ${testPathFilter}.json/.txt` : ''}`
             );
             /* eslint-enable no-console */
             process.exitCode = 404;

test/resources/9999999/asset/v1/content/assets/950143/delete-response.txt

@@ -0,0 +1 @@
+OK

test/resources/9999999/asset/v1/content/assets/get-response-customerKey=testExisting_asset.json

@@ -0,0 +1,105 @@
+{
+    "count": 1,
+    "page": 1,
+    "pageSize": 50,
+    "links": {},
+    "items": [
+        {
+            "id": 950143,
+            "customerKey": "testExisting_asset",
+            "objectID": "198ad191-59ae-44d1-9981-ffa71b076ad9",
+            "contentType": "text/html",
+            "assetType": {
+                "id": 205,
+                "name": "webpage",
+                "displayName": "Web Page"
+            },
+            "version": 1,
+            "name": "testExisting_asset",
+            "owner": {
+                "id": 717319337,
+                "email": "joern.berkefeld@accenture.com",
+                "name": "Jörn Berkefeld",
+                "userId": "717319337"
+            },
+            "createdDate": "2021-09-13T12:14:02.32-06:00",
+            "createdBy": {
+                "id": 717319337,
+                "email": "joern.berkefeld@accenture.com",
+                "name": "Jörn Berkefeld",
+                "userId": "717319337"
+            },
+            "modifiedDate": "2023-08-02T07:10:29.553-06:00",
+            "modifiedBy": {
+                "id": 700304523,
+                "name": "SFMC DEVOPS app user",
+                "userId": "700304523"
+            },
+            "enterpriseId": 111111,
+            "memberId": 999999,
+            "status": {
+                "id": 1,
+                "name": "Draft"
+            },
+            "thumbnail": {
+                "thumbnailUrl": "/v1/assets/950143/thumbnail"
+            },
+            "category": {
+                "id": 667369
+            },
+            "meta": {
+                "globalStyles": {
+                    "isLocked": false,
+                    "body": {
+                        "max-width": "1280px",
+                        "color": "#000000",
+                        "font-family": "Arial",
+                        "font-size": "12px",
+                        "margin": "0px auto"
+                    },
+                    "template": {
+                        "background-color": "#FFFFFF",
+                        "border": "none",
+                        "box-sizing": "border-box",
+                        "padding": "0px",
+                        "width": "100%"
+                    }
+                }
+            },
+            "views": {
+                "html": {
+                    "thumbnail": {},
+                    "content": "<!DOCTYPE html>\n<html>\n    <head>\n        <meta\n            name=\"viewport\"\n            content=\"width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0\"\n        />\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n        <style class=\"main_style\">\n            .layout-canvas-g {\n                background-color: #ffffff;\n                border: none;\n                box-sizing: border-box;\n                padding: 0px;\n                width: 100%;\n            }\n            .layout-canvas-g > .header,\n            .layout-canvas-g > .section,\n            .layout-canvas-g > .footer {\n                position: relative;\n                overflow: hidden;\n                width: 100%;\n                overflow-wrap: break-word;\n            }\n            .layout-canvas-g > .section {\n                margin: 10px 0px;\n            }\n            .layout-canvas-g > .section > .columns {\n                box-sizing: border-box;\n                overflow-wrap: break-word;\n            }\n            body {\n                color: #000000;\n                font-family: Arial;\n                font-size: 12px;\n                margin: 0px auto;\n                max-width: 1280px;\n            }\n            @media only screen and (max-width: 480px) {\n                .mobile-hidden {\n                    display: none !important;\n                }\n                .responsive-td {\n                    width: 100% !important;\n                    display: block !important;\n                    padding: 0px !important;\n                }\n            }\n            .layout-canvas-g > .section > .columns {\n                width: 100%;\n            }\n        </style>\n    </head>\n    <body>\n        <div class=\"layout layout-canvas-g\">\n            <div class=\"section\">\n                <div class=\"columns col1\">\n                    <div data-type=\"slot\" data-key=\"col1\"></div>\n                </div>\n            </div>\n        </div>\n    </body>\n</html>\n",
+                    "slots": {
+                        "col1": {
+                            "content": "<div data-type=\"block\" data-key=\"bgbqbbx4we9\"></div>",
+                            "design": "<p style=\"font-family:arial;color:#ccc;font-size:11px;text-align:center;vertical-align:middle;font-weight:bold;padding:10px;margin:0;border:#ccc dashed 1px;\">Drop blocks or content here</p>",
+                            "blocks": {
+                                "bgbqbbx4we9": {
+                                    "assetType": {
+                                        "id": 197,
+                                        "name": "htmlblock"
+                                    },
+                                    "content": "<table cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" role=\"presentation\" style=\"min-width: 100%; \" class=\"stylingblock-content-wrapper\"><tr><td class=\"stylingblock-content-wrapper camarker-inner\">\n%%[FOR @I=1 TO 1000 DO\n    SET @a = CONCAT(IIF(MOD(@i, 3)==0, \"Fizz\", \"\"), IIF(MOD(@i,5)==0,\"Buzz\",\"\"), IIF(MOD(@i, 7)==0, \"Boing\", \"\"), IIF(MOD(@i,11)==0,\"Bang\",\"\"))\nOUTPUT(CONCAT(@a, IIF(LENGTH(@a)>0, \"\", @i), \"<br>\"))NEXT @i\n]%%\n</td></tr></table>",
+                                    "design": "<table cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" role=\"presentation\" style=\"min-width: 100%; \" class=\"stylingblock-content-wrapper\"><tr><td class=\"stylingblock-content-wrapper camarker-inner\"><div class=\"default-design\"><div style=\"width:100%;height:150px;background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABtYAAACWBAMAAAC4IKEyAAAAMFBMVEUBAQGZmZmJiYlpaWk5OTmenp56enqUlJShoaFaWlqOjo6Dg4Ojo6P+/v7e3t68vLypNl01AAAADHRSTlMwy5hkQt57tfJXpItm2J+RAAAKc0lEQVR4XuzZMWsTYRzH8Ud7JqR2aAaLSIYQS3HIkDSCFDocdiiIg4LgkkWl4JDJyVGhi5JBqS8go4NDX4BD4nnY0N+LMkHkwMR4mH/D81y/n/HGe+7L/f93LiwAAAAAAAAAAAAAAAAAAADAfstdFgCt4aTjVgC0hprcSoHWaA20BloDrcW0thKgtRatrQRorU5rFwy0RmtY68y1R2u2aA0bmmtEawZoDbRmi9ZAa/ZoDbTmMVpD1GhqrrSxTWv2Hl3a1rCmv0pozd6wgK2B1uzR2kGnq3/+D8IBrS2L1pp5dnl8jt2MK1pg5GFrMa0Zi81bQ0WD8Fs73KQ1Y9vmreGakuBbeyBas7Zl3hqaSuPAW7vfD7617843761bQ0XSIOzWdvsKvrXE2fnkDFRGLr/dRk0TaWPHZTCvqnHQrfX6Eq1l2nq6E7tlXZfLr5nn0cBXSekf19arN7XAWXXL+eNQsmjteWNWPcTW2po4u/XCLaesVnFau7rEUdqJ+pqo53qrZb45b9yTTWs1zRq6VakkpqlNpa/uLvfJrF6c1jY09GSElMbBttZWIVpbS6xTm3p82/23h/lvaanazUaeAa0tGiGlNNTWnqkYrZXOnYmPZpt1T29yT2jKeLk4n+wr2fNkhJROw2ztSAVp7aXqzkLTrLUvGhemtZoX021ZvxyH2Fp0pIK0VpJ+eNZaV+e0ZqqXHUpwrUV3VJTWepKeeNValNVPa6YjpHQaWmtZauG3VtJE+sGn1kpSSmuWyvrtOLTWotcqTGs9Tb3zo7Wsn9jlsV69oYzeVjdpbZ6f7Nwxb9tGGMbxUpLtKukQtUWAAhlUpmhRwAMROpsGdmqHDkFhFAiQgUWXDhkMVCOHwMmYwUs2D16yZQiQNUMkRxITP7G+QEjnA0RwPoCsxBfGeiWZsnkwRR7J978awpHk/QjqDlYDJ/UyZq3iIEZr32BeRnJPPNdWyJoGINrxaFGeUGytcgfj7ExZKzvIjzUHQXtKWKMrssPW4usSqAeZsqYhP9boRX5DHWsNALfYWmjVmsiWvaBULyVrbM0hGpYy1p4DeMnWQitDVJfdQ6Fgp2KNrf0Oal0Zaw6AbpRnvHkTM+2aBls7a62W7nMZkdpla7F/Z4Z7oXX/EoC4rD2M+ETVENKLIlj7Vv9SpCmyjclep2GNra1gsgeKWKue82m2RtWlXyEBIwVrbE3DZLuKWFuGiK2FzxB5a5cx3XpRrZlmA/N6ZhpFtLYCkRGTNbb2B6Z7XVRrOLMXRbS2FHUWsTX8b5rm1jkLSNcw079rbE0EtvYnRBv5tVYxp1uTsyY3/bQwP9m1xtZWgfis3YXoXn7X/EuzB52ONbbG1p5A9CqJvWytNpOdO2vVm6f5rLE1tkZL1OjGYk12FtfzYo3S5swqtga2BhF6SljTx/2aK2tsja3RHOgoYQ3jXCNX1tgaW6OZaKllDV1Vrf2lWwWxxtYaCK11wYOyFbOGDUWtAUZi1thaSZ/sepat0czakTmB/kd5a40IswsUOlYM1giOmtbYmtTNaGfb2jaCbsmcwJG/eGu4nStrbI2tPadzl7B2kIA1186TNbbG1hyJw9EgGgGDt6Phwq2hvRhrndrpmkpau6FThmLWyvpxP7M16a1sif8W7Q98wHs/8IcxWdszKUzXjMNapFxbRWuroFpbalkr0aTLq7Vl3YnVWkXm85qg5vnoH1vzvKGsNek6VlLW0LOUtUZHGDm2toTJuhe4GvFZK0tZE9Q+WxseeZ53uGhruJKENUpNa/LY2FrlGiZzjexZ2z8W5g+x7wEjgS1Ba2wNm5Yy1m7oPypt7RGm28uctSXhC8AbHwG2dwlaY2vYVMbaKqCyteWHmKmZQWuHtL3WT9gaW8PfbC1STyS++qtrzR+Ot9eOErDG1uSxsbXfcLr7GbOmDYKXyMEBglWSD8laY2v4jq2dW/UOQnqaMWsIsHlvMfq8SpL02ghbww9s7bz+m7Ork7a1xwiCezXK4MKY3/feYyCoYUHW2FrVFDkIqcnWzu4SwltP25pDdzna4CNhbYiBdwAsyhpb0zC/JluT+AjVTtvaXTr5iIOP/H1h7RDpWGNr7k+ZtMbWtumyRh28v+8BH5GSNbYGt54La7XalWJZ+xoiuV8+fuNLPJzYWlsX/RKfNXTsPFgDWrUgoxjWVnCSHXnw0SFbk79BcVgjbHmwNq5bDGuXcZIlMXiK1koI2imyNbSMPFlrZ9DaPzXqquT+WuerbFnrWUW2htZWqtbY2ioo1OWstS5kraSHdH2R1nC70NbQs5SxxtZ6CVoLP7/2Qq25xvw/1nNsjbCpYo2t4fscWSNH1F6xrWHTUsUaW+tYcVv7xN4dqzQMxHEcR62CxaGnCBUytFd8ATPaIejqoCgFt9LZwcHRQRQEwaGPoM/QFzCRtsv/oTSN5q5esPHMhVzv9x2v0DbpfUoCyaVa1ujabWt0n/Vrqpm3Bmv0tMzWsv9MttKv5YA16hViDdaOeFpH01pUsrXsWv+0tsGT2qR06bg16rlr7dhP07emTs3IaWsrC1aac9ka7fzFGqnZZi3TRwnWYI0i161R2dYG/DMHrcEa3ZRrDda8eNRFa7A2DsqwBmuwBmv0kNsarKmvtvJYqzOp53i0Y8JazZ8vqJI1WFNvTzgp2hqsqYMUmbC2quzlvNbqjA1LsAZr04zbzCf2WhuzWU1Yy29tn2jkD41bgzW6UJ+6E2paY7M8g9b007fGOW8tqzVRw7w1WBtLxw+blBRoWBNZZS3Xlr4VYA3WYI0e1eXKXuyyBmtrnLerbw3WSF095a7q1mAtZPL7rZLICmuwdkVJk6pagzWR1dZgzRMbY7k1WBv5cd2Cran7waS1Go/r61nTaJsn3Zq3VkuHAqutwZrIWmvikxq/W3tlSXsG5pE5a3UxiWBNsQZrX7N6t1rWPEp6t8raejp0CmtyoZhjLlvzSE7fGqwdSIepU96BNaWF1mAtlM6vYE0t82llkVPWYO3c/66rZ03U0LXm/+xQy5p8lR6sDXha32ZrZ2y+ZpHWPtq7W52GoTAAwwQICajVoOEYDK7cAsGg0BPDo9C9BC4JM5ZmpheFWfaNtBNL01+e1zZpk7ZPKnr6tSdr9QazVtU6au386FLY7HA3rB1etMWErdUbyhpr0RSsvS+rqLxljbUOrLFWO/2bDu/Az3Sg+i1FK9Z2862eWGOt0xas7bb8sMZa61hjrczzvJigNdZYW6f7qViL+rbGGmsX+Z+KsNYu1lhjLVo3HHdM1lhjjTXWWGONNdZYY22b7/tmLWKNtT5ijTXW+o411lhjjTXWWMuybNmlNdZYYy06xRprrL0ObI011mZdWLv+Yq0Pa6yx9lGN0hpr8YnjwyyssXZTjdQaa1Fra8PH2tllMYi1MsZW/Q9rrLH2XA0ea6zNu/hl/KytscaaWItYm2asscaaWGvfhK1d7Ze1xcDmVVgTa+u0bG+NteZn8h1rrDXE2umxxhprrLH2whpr3acyXvmxxprEGmtibZwdnRa46c+axNqkkliTWKtSSkXjhm1Kj9WsE2uSWJNYk/QLCrLZZJTyaZMAAAAASUVORK5CYII=) repeat-x 0 0\"></div></div></td></tr></table>",
+                                    "meta": {
+                                        "wrapperStyles": {
+                                            "mobile": {
+                                                "visible": true
+                                            }
+                                        }
+                                    },
+                                    "modelVersion": 2
+                                }
+                            },
+                            "modelVersion": 2
+                        }
+                    },
+                    "modelVersion": 2
+                }
+            },
+            "availableViews": ["html"],
+            "modelVersion": 2
+        }
+    ]
+}

test/type.asset.test.js

@@ -81,4 +81,18 @@ describe('type: asset', () => {
             return;
         });
     });
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'asset',
+                'testExisting_asset'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
 });