@umbraco/playwright-testhelpers 2.0.0-beta.9 → 15.0.0-beta.2

package/dist/lib/helpers/MediaApiHelper.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaApiHelper = void 0;
+const json_models_builders_1 = require("@umbraco/json-models-builders");
+class MediaApiHelper {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    async ensureNameNotExists(name) {
+        const rootMedia = await this.getAllAtRoot();
+        const jsonMedia = await rootMedia.json();
+        for (const media of jsonMedia.items) {
+            if (media.variants[0].name === name) {
+                if (media.hasChildren) {
+                    return await this.recurseDeleteChildren(media);
+                }
+                return await this.delete(media.id);
+            }
+            else if (media.hasChildren) {
+                await this.recurseChildren(name, media.id, true);
+            }
+        }
+        return null;
+    }
+    async getAllAtRoot() {
+        return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/tree/media/root?skip=0&take=10000');
+    }
+    async recurseChildren(name, id, toDelete) {
+        const items = await this.getChildren(id);
+        for (const child of items) {
+            if (child.variants[0].name === name) {
+                if (!toDelete) {
+                    return await this.get(child.id);
+                }
+                if (child.hasChildren) {
+                    return await this.recurseDeleteChildren(child);
+                }
+                return await this.delete(child.id);
+            }
+            else if (child.hasChildren) {
+                return await this.recurseChildren(name, child.id, toDelete);
+            }
+        }
+        return false;
+    }
+    async recurseDeleteChildren(media) {
+        if (!media.hasChildren) {
+            return await this.delete(media.id);
+        }
+        const items = await this.getChildren(media.id);
+        for (const child of items) {
+            if (child.hasChildren) {
+                await this.recurseDeleteChildren(child);
+            }
+            else {
+                await this.delete(child.id);
+            }
+        }
+        return await this.delete(media.id);
+    }
+    async get(id) {
+        const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/media/' + id);
+        return await response.json();
+    }
+    async delete(id) {
+        return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/media/' + id);
+    }
+    async getChildren(id) {
+        const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/tree/media/children?parentId=' + id + '&skip=0&take=10000');
+        const items = await response.json();
+        return items.items;
+    }
+    async create(media) {
+        if (media == null) {
+            return;
+        }
+        const response = await this.api.post(this.api.baseUrl + '/umbraco/management/api/v1/media', media);
+        return response.headers().location.split("/").pop();
+    }
+    async doesNameExist(name) {
+        return await this.getByName(name);
+    }
+    async getByName(name) {
+        const rootMedia = await this.getAllAtRoot();
+        const jsonMedia = await rootMedia.json();
+        for (const media of jsonMedia.items) {
+            if (media.variants[0].name === name) {
+                return await this.get(media.id);
+            }
+            else if (media.hasChildren) {
+                await this.recurseChildren(name, media.id, false);
+            }
+        }
+        return null;
+    }
+    async getRecycleBinItems() {
+        return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/recycle-bin/media/root?skip=0&take=10000');
+    }
+    async emptyRecycleBin() {
+        return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/recycle-bin/media');
+    }
+    async doesMediaItemExistInRecycleBin(mediaItemName) {
+        const recycleBin = await this.getRecycleBinItems();
+        const jsonRecycleBin = await recycleBin.json();
+        for (const media of jsonRecycleBin.items) {
+            if (media.variants[0].name === mediaItemName) {
+                return true;
+            }
+        }
+        return false;
+    }
+    async trashMediaItem(mediaItemName) {
+        const media = await this.getByName(mediaItemName);
+        return await this.api.put(this.api.baseUrl + '/umbraco/management/api/v1/media/' + media.id + '/move-to-recycle-bin');
+    }
+    async getMediaPathByName(name) {
+        const media = await this.getByName(name);
+        if (media && media.urls && media.urls.length > 0) {
+            const mediaUrl = media.urls[0].url;
+            // Gets the random mediaPath for the media
+            const mediaPath = mediaUrl.split('/media/').pop()?.split('/')[0];
+            // Gets the file name from the mediaUrl
+            const fileName = mediaUrl.split('/').pop();
+            return {
+                mediaPath: mediaPath,
+                fileName: fileName
+            };
+        }
+        return null;
+    }
+    async createDefaultMediaFile(mediaName) {
+        const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryFile();
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(temporaryFile.mediaTypeId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .addValue()
+            .withAlias('umbracoFile')
+            .withValue(temporaryFile.temporaryFileId)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaFileAndParentId(mediaName, parentId) {
+        const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryFile();
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(temporaryFile.mediaTypeId)
+            .withParentId(parentId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .addValue()
+            .withAlias('umbracoFile')
+            .withValue(temporaryFile.temporaryFileId)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaFolder(mediaFolderName) {
+        const mediaType = await this.api.mediaType.getByName('Folder');
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(mediaType.id)
+            .addVariant()
+            .withName(mediaFolderName)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaFolderAndParentId(mediaName, parentId) {
+        const mediaType = await this.api.mediaType.getByName('Folder');
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(mediaType.id)
+            .withParentId(parentId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaWithImage(mediaName) {
+        const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryImageFile();
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(temporaryFile.mediaTypeId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .addValue()
+            .withAlias('umbracoFile')
+            .withValue(temporaryFile.temporaryFileId)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaWithArticle(mediaName) {
+        const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryArticleFile();
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(temporaryFile.mediaTypeId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .addValue()
+            .withAlias('umbracoFile')
+            .withValue(temporaryFile.temporaryFileId)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async createDefaultMediaWithImageAndParentId(mediaName, parentId) {
+        const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryImageFile();
+        const media = new json_models_builders_1.MediaBuilder()
+            .withMediaTypeId(temporaryFile.mediaTypeId)
+            .withParentId(parentId)
+            .addVariant()
+            .withName(mediaName)
+            .done()
+            .addValue()
+            .withAlias('umbracoFile')
+            .withValue(temporaryFile.mediaTypeId)
+            .done()
+            .build();
+        return await this.create(media);
+    }
+    async getAllMediaNames(orderBy = 'updateDate', orderDirection = 'Descending') {
+        let mediaNames = [];
+        const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/collection/media?id=&dataTypeId=&orderBy=' + orderBy + '&orderDirection=' + orderDirection + '&skip=0&take=100');
+        const mediaItems = await response.json();
+        for (const media of mediaItems.items) {
+            mediaNames.push(media.variants[0].name);
+        }
+        return mediaNames;
+    }
+    async doesMediaItemHaveChildName(mediaId, childName) {
+        const childrenItems = await this.getChildren(mediaId);
+        for (const child of childrenItems) {
+            if (child.variants[0].name === childName) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+exports.MediaApiHelper = MediaApiHelper;
+//# sourceMappingURL=MediaApiHelper.js.map

package/dist/lib/helpers/MediaApiHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaApiHelper.js","sourceRoot":"","sources":["../../../lib/helpers/MediaApiHelper.ts"],"names":[],"mappings":";;;AACA,wEAA2D;AAE3D,MAAa,cAAc;IACzB,GAAG,CAAY;IAEf,YAAY,GAAe;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAY;QACpC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;QAEzC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,KAAK,EAAE;YACnC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE;gBACnC,IAAI,KAAK,CAAC,WAAW,EAAE;oBACrB,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;iBAChD;gBACD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aACpC;iBAAM,IAAI,KAAK,CAAC,WAAW,EAAE;gBAC5B,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;aAClD;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,8DAA8D,CAAC,CAAC;IAC/G,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,EAAU,EAAE,QAAiB;QACvE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzC,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE;YACzB,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE;gBACnC,IAAI,CAAC,QAAQ,EAAE;oBACb,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACjC;gBACD,IAAI,KAAK,CAAC,WAAW,EAAE;oBACrB,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;iBAChD;gBACD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aACpC;iBAAM,IAAI,KAAK,CAAC,WAAW,EAAE;gBAC5B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,KAAK;QACvC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YACtB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SACpC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAE/C,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE;YACzB,IAAI,KAAK,CAAC,WAAW,EAAE;gBACrB,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACzC;iBAAM;gBACL,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aAC7B;SACF;QACD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,mCAAmC,GAAG,EAAE,CAAC,CAAC;QACjG,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,mCAAmC,GAAG,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,EAAU;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,0DAA0D,GAAG,EAAE,GAAG,oBAAoB,CAAC,CAAC;QAC/I,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAK;QAChB,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,OAAO;SACR;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,kCAAkC,EAAE,KAAK,CAAC,CAAC;QACnG,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;QAEzC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,KAAK,EAAE;YACnC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE;gBACnC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aACjC;iBAAM,IAAI,KAAK,CAAC,WAAW,EAAE;gBAC5B,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;aACnD;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,qEAAqE,CAAC,CAAC;IACtH,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,8CAA8C,CAAC,CAAC;IAClG,CAAC;IAED,KAAK,CAAC,8BAA8B,CAAC,aAAqB;QACxD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACnD,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,MAAM,KAAK,IAAI,cAAc,CAAC,KAAK,EAAE;YACxC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,EAAE;gBAC5C,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,aAAqB;QACxC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,mCAAmC,GAAG,KAAK,CAAC,EAAE,GAAG,sBAAsB,CAAC,CAAC;IACxH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAY;QACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YACnC,0CAA0C;YAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACjE,uCAAuC;YACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YAE3C,OAAO;gBACL,SAAS,EAAE,SAAS;gBACpB,QAAQ,EAAE,QAAQ;aACnB,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,SAAiB;QAC5C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,0BAA0B,EAAE,CAAC;QAEhF,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;aAC1C,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,QAAQ,EAAE;aACR,SAAS,CAAC,aAAa,CAAC;aACxB,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC;aACxC,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,iCAAiC,CAAC,SAAiB,EAAE,QAAgB;QACzE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,0BAA0B,EAAE,CAAC;QAEhF,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;aAC1C,YAAY,CAAC,QAAQ,CAAC;aACtB,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,QAAQ,EAAE;aACR,SAAS,CAAC,aAAa,CAAC;aACxB,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC;aACxC,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,eAAuB;QACpD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAE/D,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;aAC7B,UAAU,EAAE;aACV,QAAQ,CAAC,eAAe,CAAC;aACzB,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,mCAAmC,CAAC,SAAiB,EAAE,QAAgB;QAC3E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAE/D,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;aAC7B,YAAY,CAAC,QAAQ,CAAC;aACtB,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,SAAiB;QACjD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,+BAA+B,EAAE,CAAC;QAErF,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;aAC1C,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,QAAQ,EAAE;aACR,SAAS,CAAC,aAAa,CAAC;aACxB,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC;aACxC,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,6BAA6B,CAAC,SAAiB;QACnD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,iCAAiC,EAAE,CAAC;QAEvF,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;aAC1C,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,QAAQ,EAAE;aACR,SAAS,CAAC,aAAa,CAAC;aACxB,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC;aACxC,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,sCAAsC,CAAC,SAAiB,EAAE,QAAgB;QAC9E,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,+BAA+B,EAAE,CAAC;QAErF,MAAM,KAAK,GAAG,IAAI,mCAAY,EAAE;aAC7B,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;aAC1C,YAAY,CAAC,QAAQ,CAAC;aACtB,UAAU,EAAE;aACV,QAAQ,CAAC,SAAS,CAAC;aACnB,IAAI,EAAE;aACR,QAAQ,EAAE;aACR,SAAS,CAAC,aAAa,CAAC;aACxB,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC;aACpC,IAAI,EAAE;aACR,KAAK,EAAE,CAAC;QAEX,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB,YAAY,EAAE,iBAAyB,YAAY;QAC1F,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,sEAAsE,GAAG,OAAO,GAAG,kBAAkB,GAAG,cAAc,GAAG,kBAAkB,CAAC,CAAC;QACpM,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzC,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,KAAK,EAAE;YACpC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACzC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,OAAe,EAAE,SAAiB;QACjE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACtD,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE;YACjC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,EAAE;gBACxC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAxRD,wCAwRC","sourcesContent":["import {ApiHelpers} from \"./ApiHelpers\";\nimport {MediaBuilder} from \"@umbraco/json-models-builders\";\n\nexport class MediaApiHelper {\n  api: ApiHelpers\n\n  constructor(api: ApiHelpers) {\n    this.api = api;\n  }\n\n  async ensureNameNotExists(name: string) {\n    const rootMedia = await this.getAllAtRoot();\n    const jsonMedia = await rootMedia.json();\n\n    for (const media of jsonMedia.items) {\n      if (media.variants[0].name === name) {\n        if (media.hasChildren) {\n          return await this.recurseDeleteChildren(media);\n        }\n        return await this.delete(media.id);\n      } else if (media.hasChildren) {\n        await this.recurseChildren(name, media.id, true);\n      }\n    }\n    return null;\n  }\n\n  async getAllAtRoot() {\n    return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/tree/media/root?skip=0&take=10000');\n  }\n\n  private async recurseChildren(name: string, id: string, toDelete: boolean) {\n    const items = await this.getChildren(id);\n\n    for (const child of items) {\n      if (child.variants[0].name === name) {\n        if (!toDelete) {\n          return await this.get(child.id);\n        }\n        if (child.hasChildren) {\n          return await this.recurseDeleteChildren(child);\n        }\n        return await this.delete(child.id);\n      } else if (child.hasChildren) {\n        return await this.recurseChildren(name, child.id, toDelete);\n      }\n    }\n    return false;\n  }\n\n  private async recurseDeleteChildren(media) {\n    if (!media.hasChildren) {\n      return await this.delete(media.id);\n    }\n    const items = await this.getChildren(media.id);\n\n    for (const child of items) {\n      if (child.hasChildren) {\n        await this.recurseDeleteChildren(child);\n      } else {\n        await this.delete(child.id);\n      }\n    }\n    return await this.delete(media.id);\n  }\n\n  async get(id: string) {\n    const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/media/' + id);\n    return await response.json();\n  }\n\n  async delete(id: string) {\n    return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/media/' + id);\n  }\n\n  async getChildren(id: string) {\n    const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/tree/media/children?parentId=' + id + '&skip=0&take=10000');\n    const items = await response.json();\n    return items.items;\n  }\n\n  async create(media) {\n    if (media == null) {\n      return;\n    }\n    const response = await this.api.post(this.api.baseUrl + '/umbraco/management/api/v1/media', media);\n    return response.headers().location.split(\"/\").pop();\n  }\n\n  async doesNameExist(name: string) {\n    return await this.getByName(name);\n  }\n\n  async getByName(name: string) {\n    const rootMedia = await this.getAllAtRoot();\n    const jsonMedia = await rootMedia.json();\n\n    for (const media of jsonMedia.items) {\n      if (media.variants[0].name === name) {\n        return await this.get(media.id);\n      } else if (media.hasChildren) {\n        await this.recurseChildren(name, media.id, false);\n      }\n    }\n    return null;\n  }\n\n  async getRecycleBinItems() {\n    return await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/recycle-bin/media/root?skip=0&take=10000');\n  }\n\n  async emptyRecycleBin() {\n    return await this.api.delete(this.api.baseUrl + '/umbraco/management/api/v1/recycle-bin/media');\n  }\n\n  async doesMediaItemExistInRecycleBin(mediaItemName: string) {\n    const recycleBin = await this.getRecycleBinItems();\n    const jsonRecycleBin = await recycleBin.json();\n    for (const media of jsonRecycleBin.items) {\n      if (media.variants[0].name === mediaItemName) {\n        return true;\n      }\n    }\n    return false;\n  }\n\n  async trashMediaItem(mediaItemName: string) {\n    const media = await this.getByName(mediaItemName);\n    return await this.api.put(this.api.baseUrl + '/umbraco/management/api/v1/media/' + media.id + '/move-to-recycle-bin');\n  }\n\n  async getMediaPathByName(name: string) {\n    const media = await this.getByName(name);\n\n    if (media && media.urls && media.urls.length > 0) {\n      const mediaUrl = media.urls[0].url;\n      // Gets the random mediaPath for the media\n      const mediaPath = mediaUrl.split('/media/').pop()?.split('/')[0];\n      // Gets the file name from the mediaUrl\n      const fileName = mediaUrl.split('/').pop();\n\n      return {\n        mediaPath: mediaPath,\n        fileName: fileName\n      };\n    }\n\n    return null;\n  }\n\n  async createDefaultMediaFile(mediaName: string) {\n    const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryFile();\n\n    const media = new MediaBuilder()\n      .withMediaTypeId(temporaryFile.mediaTypeId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .addValue()\n        .withAlias('umbracoFile')\n        .withValue(temporaryFile.temporaryFileId)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n\n  async createDefaultMediaFileAndParentId(mediaName: string, parentId: string) {\n    const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryFile();\n    \n    const media = new MediaBuilder()\n      .withMediaTypeId(temporaryFile.mediaTypeId)\n      .withParentId(parentId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .addValue()\n        .withAlias('umbracoFile')\n        .withValue(temporaryFile.temporaryFileId)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n\n  async createDefaultMediaFolder(mediaFolderName: string) {\n    const mediaType = await this.api.mediaType.getByName('Folder');\n    \n    const media = new MediaBuilder()\n      .withMediaTypeId(mediaType.id)\n      .addVariant()\n        .withName(mediaFolderName)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n\n  async createDefaultMediaFolderAndParentId(mediaName: string, parentId: string) {\n    const mediaType = await this.api.mediaType.getByName('Folder');\n    \n    const media = new MediaBuilder()\n      .withMediaTypeId(mediaType.id)\n      .withParentId(parentId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n  \n  async createDefaultMediaWithImage(mediaName: string) {\n    const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryImageFile();\n    \n    const media = new MediaBuilder()\n      .withMediaTypeId(temporaryFile.mediaTypeId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .addValue()\n        .withAlias('umbracoFile')\n        .withValue(temporaryFile.temporaryFileId)\n        .done()\n      .build();\n    \n    return await this.create(media);\n  }\n\n  async createDefaultMediaWithArticle(mediaName: string) {\n    const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryArticleFile();\n\n    const media = new MediaBuilder()\n      .withMediaTypeId(temporaryFile.mediaTypeId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .addValue()\n        .withAlias('umbracoFile')\n        .withValue(temporaryFile.temporaryFileId)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n  \n  async createDefaultMediaWithImageAndParentId(mediaName: string, parentId: string) {\n    const temporaryFile = await this.api.temporaryFile.createDefaultTemporaryImageFile();\n    \n    const media = new MediaBuilder()\n      .withMediaTypeId(temporaryFile.mediaTypeId)\n      .withParentId(parentId)\n      .addVariant()\n        .withName(mediaName)\n        .done()\n      .addValue()\n        .withAlias('umbracoFile')\n        .withValue(temporaryFile.mediaTypeId)\n        .done()\n      .build();\n\n    return await this.create(media);\n  }\n\n  async getAllMediaNames(orderBy: string = 'updateDate', orderDirection: string = 'Descending') {\n    let mediaNames: string[] = [];\n    const response = await this.api.get(this.api.baseUrl + '/umbraco/management/api/v1/collection/media?id=&dataTypeId=&orderBy=' + orderBy + '&orderDirection=' + orderDirection + '&skip=0&take=100');\n    const mediaItems = await response.json();\n    for (const media of mediaItems.items) {\n      mediaNames.push(media.variants[0].name);\n    }\n    return mediaNames;\n  }\n\n  async doesMediaItemHaveChildName(mediaId: string, childName: string) {\n    const childrenItems = await this.getChildren(mediaId);\n    for (const child of childrenItems) {\n      if (child.variants[0].name === childName) {\n        return true;\n      }\n    }\n    return false;\n  }\n}"]}

package/dist/lib/helpers/MediaTypeApiHelper.d.ts

@@ -0,0 +1,32 @@
+import { ApiHelpers } from "./ApiHelpers";
+export declare class MediaTypeApiHelper {
+    api: ApiHelpers;
+    constructor(api: ApiHelpers);
+    ensureNameNotExists(name: string): Promise<number | import("playwright-core").APIResponse | null | undefined>;
+    getAllAtRoot(): Promise<import("playwright-core").APIResponse>;
+    private recurseChildren;
+    private recurseDeleteChildren;
+    getChildren(id: string): Promise<any>;
+    create(mediaType: any): Promise<string | undefined>;
+    delete(id: string): Promise<number | undefined>;
+    getByName(name: string): Promise<any>;
+    doesNameExist(name: string): Promise<any>;
+    get(id: string): Promise<any>;
+    getFolder(id: string): Promise<any>;
+    deleteFolder(id: string): Promise<import("playwright-core").APIResponse>;
+    createFolder(name: string, parentId?: string): Promise<string | undefined>;
+    renameFolder(folderId: string, folderName: string): Promise<import("playwright-core").APIResponse>;
+    createDefaultMediaType(mediaTypeName: string): Promise<string | undefined>;
+    createMediaTypeWithPropertyEditor(mediaTypeName: string, dataTypeName: string, dataTypeId: string, groupName?: string): Promise<string | undefined>;
+    createMediaTypeWithTwoPropertyEditors(mediaTypeName: string, dataTypeNameOne: string, dataTypeIdOne: string, dataTypeNameTwo: string, dataTypeIdTwo: string, groupName?: string): Promise<string | undefined>;
+    createMediaTypeWithPropertyEditorInTab(mediaTypeName: string, dataTypeName: string, dataTypeId: string, tabName: string, groupName?: string, varyByCulture?: boolean): Promise<string | undefined>;
+    createMediaTypeWithTwoGroups(mediaTypeName: string, dataType: string, dataTypeId: string, groupNameOne: string, groupNameTwo: string): Promise<string | undefined>;
+    createMediaTypeWithTwoTabs(mediaTypeName: string, dataType: string, dataTypeId: string, tabNameOne: string, tabNameTwo: string): Promise<string | undefined>;
+    createMediaTypeWithAllowedChildNode(mediaTypeName: string, allowedChildNodeId: string): Promise<string | undefined>;
+    doesGroupContainCorrectPropertyEditor(mediaTypeName: string, dataTypeName: string, dataTypeId: string, groupName: string): Promise<any>;
+    doesTabContainCorrectPropertyEditorInGroup(mediaTypeName: string, dataTypeName: string, dataTypeId: string, tabName: string, groupName: string): Promise<any>;
+    doesMediaTypeGroupNameContainCorrectSortOrder(mediaTypeName: string, groupName: string, sortOrder: number): Promise<boolean>;
+    doesMediaTypeTabNameContainCorrectSortOrder(mediaTypeName: string, tabName: string, sortOrder: number): Promise<boolean>;
+    doesTabContainerCorrectPropertyEditor(mediaTypeName: string, tabName: string, dataTypeId: string): Promise<any>;
+    doesMediaTypeContainAllowedChildNodeIds(mediaTypeName: string, allowedChildNodeIds: string[]): Promise<any>;
+}