@c8y/ngx-components 1017.0.92 → 1017.0.93

package/fesm2020/c8y-ngx-components-ecosystem-shared.mjs

@@ -37,6 +37,8 @@ var ERROR_TYPE;
     ERROR_TYPE["INVALID_PACKAGE"] = "INVALID_PACKAGE";
     ERROR_TYPE["INVALID_APPLICATION"] = "INVALID_APPLICATION";
     ERROR_TYPE["MICROSERVICE_NAME_TOO_LONG"] = "MICROSERVICE_NAME_TOO_LONG";
+    ERROR_TYPE["APPLICATION_CREATION_FAILED"] = "APPLICATION_CREATION_FAILED";
+    ERROR_TYPE["KEY_OR_CONTEXT_PATH_MISMATCH"] = "KEY_OR_CONTEXT_PATH_MISMATCH";
 })(ERROR_TYPE || (ERROR_TYPE = {}));
 const PRODUCT_EXPERIENCE = {
     APPLICATIONS: {
@@ -95,7 +97,9 @@ const ERROR_MESSAGES = {
     [ERROR_TYPE.INVALID_PACKAGE]: gettext('You have not uploaded a valid package.'),
     [ERROR_TYPE.INVALID_APPLICATION]: gettext('You have not uploaded a valid application.'),
     [ERROR_TYPE.INTERNAL_ERROR]: gettext('An internal error occurred, try to upload again.'),
-    [ERROR_TYPE.MICROSERVICE_NAME_TOO_LONG]: gettext('Microservice name "{{ name }}" must not be longer than {{ maxChars }} characters.')
+    [ERROR_TYPE.MICROSERVICE_NAME_TOO_LONG]: gettext('Microservice name "{{ name }}" must not be longer than {{ maxChars }} characters.'),
+    [ERROR_TYPE.APPLICATION_CREATION_FAILED]: gettext('Application creation failed.'),
+    [ERROR_TYPE.KEY_OR_CONTEXT_PATH_MISMATCH]: gettext('The contextPath or key of the uploaded archive do not match with the existing app.')
 };
 const APP_STATE = {
     SUBSCRIBED: {
@@ -159,6 +163,13 @@ const packageProperties = [
     }
 ];
 
+class EcosystemError extends Error {
+    constructor(type) {
+        super(ERROR_MESSAGES[type]);
+        this.type = type;
+    }
+}
+
 const CUMULOCITY_JSON = 'cumulocity.json';
 const MICROSERVICE_NAME_MAX_LENGTH = 23;
 class EcosystemService {
@@ -396,10 +407,10 @@ class EcosystemService {
             return await this.applicationService.update(app);
         }
         catch (ex) {
-            this.alertService.addServerFailure(ex);
+            this.alertError(ex);
             if (deleteOnFailure) {
                 await this.applicationService.delete(app.id);
-                throw new Error('Application creation failed.');
+                throw new EcosystemError(ERROR_TYPE.APPLICATION_CREATION_FAILED);
             }
         }
     }
@@ -426,7 +437,7 @@ class EcosystemService {
             this.alertService.success(gettext('Successfully subscribed to application.'));
         }
         catch (ex) {
-            this.alertService.addServerFailure(ex);
+            this.alertError(ex);
         }
     }
     async unsubscribeApp(app) {
@@ -436,14 +447,14 @@ class EcosystemService {
             this.alertService.success(gettext('Successfully unsubscribed from application.'));
         }
         catch (ex) {
-            this.alertService.addServerFailure(ex);
+            this.alertError(ex);
         }
     }
     async isValidAppType(archive, appType) {
         try {
             const currentType = await this.getAppType(archive);
             if (currentType !== appType) {
-                throw new Error(ERROR_TYPE.TYPE_VALIDATION);
+                throw new EcosystemError(ERROR_TYPE.TYPE_VALIDATION);
             }
             else {
                 this.progress.next(this.progress.value + 10);
@@ -451,7 +462,7 @@ class EcosystemService {
             }
         }
         catch (ex) {
-            throw new Error(ERROR_TYPE.TYPE_VALIDATION);
+            throw new EcosystemError(ERROR_TYPE.TYPE_VALIDATION);
         }
     }
     async uploadArchiveToApp(archive, app, isNewVersion = false) {
@@ -469,15 +480,29 @@ class EcosystemService {
         // }
         return (await this.setAppActiveVersion(app, (binaryMo.binaryId || binaryMo.id))).data;
     }
-    async validatePackageKeyAndContextPath(archive, app) {
-        const manifest = await this.getCumulocityJson(archive).toPromise();
-        const contextPath = get(manifest, 'contextPath');
-        const appKey = get(manifest, 'key');
-        if (contextPath !== app.contextPath || appKey !== app.key) {
-            const error = {
-                data: { message: this.translateService.instant(ERROR_MESSAGES.INVALID_PACKAGE) }
-            };
-            throw error;
+    async validateArchiveToAppCompatibility(archive, app) {
+        const appType = await this.getAppType(archive);
+        if (appType !== app.type) {
+            throw new EcosystemError(ERROR_TYPE.INVALID_APPLICATION);
+        }
+        else {
+            this.progress.next(this.progress.value + 10);
+        }
+        const manifest = await this.getCumulocityJson(archive);
+        // A user can upload an app without a Cumulocity JSON file (e.g. a react app).
+        // This is allowed and should not trigger a validation error.
+        if (!manifest) {
+            return;
+        }
+        await this.validatePackageKeyAndContextPath(manifest, app);
+    }
+    async getCumulocityJson(archive) {
+        try {
+            const c8yManifest = await this.getCumulocityJson$(archive).toPromise();
+            return c8yManifest;
+        }
+        catch (ex) {
+            return null;
         }
     }
     async createAppForArchive(archive, isPackageTypeArchive = false) {
@@ -487,7 +512,7 @@ class EcosystemService {
         const supportedAppTypes = [ApplicationType.HOSTED, ApplicationType.MICROSERVICE];
         if (supportedAppTypes.includes(appType)) {
             try {
-                appModel = await this.getCumulocityJson(archive).toPromise();
+                appModel = await this.getCumulocityJson$(archive).toPromise();
                 isPackage = appModel.isPackage;
             }
             catch (e) {
@@ -506,10 +531,10 @@ class EcosystemService {
             contextPath
         };
         if (isPackageTypeArchive && !isPackage) {
-            throw new Error(ERROR_TYPE.INVALID_PACKAGE);
+            throw new EcosystemError(ERROR_TYPE.INVALID_PACKAGE);
         }
         else if (!isPackageTypeArchive && isPackage) {
-            throw new Error(ERROR_TYPE.INVALID_APPLICATION);
+            throw new EcosystemError(ERROR_TYPE.INVALID_APPLICATION);
         }
         else if (this.isNameLengthExceeded(name, appType)) {
             const error = new Error();
@@ -534,7 +559,7 @@ class EcosystemService {
             this.alertService.success(gettext('Application reactivated.'));
         }
         catch (ex) {
-            this.alertService.addServerFailure(ex);
+            this.alertError(ex);
         }
     }
     async removeOldestArchive(app, archives) {
@@ -545,7 +570,7 @@ class EcosystemService {
             this.alertService.success(gettext('Archive deleted.'));
         }
         catch (ex) {
-            this.alertService.addServerFailure(ex);
+            this.alertError(ex);
         }
     }
     getAppState(app) {
@@ -612,6 +637,25 @@ class EcosystemService {
         app.availability = ApplicationAvailability.PRIVATE;
         return app;
     }
+    /**
+     * Shows an error dialog.
+     * @param error Either a server error or an internal [[EcosystemError]].
+     */
+    alertError(error) {
+        if (error instanceof EcosystemError) {
+            this.alertService.danger(error.message);
+        }
+        else {
+            this.alertService.addServerFailure(error);
+        }
+    }
+    async validatePackageKeyAndContextPath(manifest, app) {
+        const contextPath = get(manifest, 'contextPath');
+        const appKey = get(manifest, 'key');
+        if (contextPath !== app.contextPath || appKey !== app.key) {
+            throw new EcosystemError(ERROR_TYPE.KEY_OR_CONTEXT_PATH_MISMATCH);
+        }
+    }
     getAppKey(appModel, name) {
         let key = appModel?.key;
         if (!key) {
@@ -629,13 +673,13 @@ class EcosystemService {
         const currentApp = this.appStateService.state.app;
         return currentApp.contextPath === app.contextPath;
     }
-    getCumulocityJson(archive) {
+    getCumulocityJson$(archive) {
         return this.zipService.getJsonData(archive, {
             filename: CUMULOCITY_JSON
         });
     }
     getAppType(archive) {
-        return this.getCumulocityJson(archive)
+        return this.getCumulocityJson$(archive)
             .toPromise()
             .then(data => get(data, 'type') ||
             (get(data, 'apiVersion') ? ApplicationType.MICROSERVICE : ApplicationType.HOSTED))
@@ -663,7 +707,7 @@ class EcosystemService {
         return tempApp;
     }
     async getUploadOverrides(archive, app) {
-        const { version } = await this.getCumulocityJson(archive).toPromise();
+        const { version } = await this.getCumulocityJson$(archive).toPromise();
         const isInitialPackage = app.applicationVersions?.length === 0;
         return {
             listUrl: 'versions',
@@ -980,7 +1024,7 @@ class UploadArchiveComponent {
     }
     async onFile(file) {
         try {
-            await this.ecosystemService.isValidAppType(file, this.application.type);
+            await this.ecosystemService.validateArchiveToAppCompatibility(file, this.application);
             const isCustomMicroservice = this.ecosystemService.isCustomMicroservice(this.application);
             this.archives = isCustomMicroservice
                 ? []
@@ -993,9 +1037,6 @@ class UploadArchiveComponent {
             if (this.archives.length === 6 && !isCustomMicroservice) {
                 await this.ecosystemService.removeOldestArchive(this.application, this.archives);
             }
-            if (this.uploadNewVersion) {
-                await this.ecosystemService.validatePackageKeyAndContextPath(file, this.application);
-            }
             const app = await this.ecosystemService.uploadArchiveToApp(file, this.application, this.uploadNewVersion);
             this.applicationChange.emit(app);
             this.uploadProgress.next(100);
@@ -1008,15 +1049,15 @@ class UploadArchiveComponent {
         }
         catch (ex) {
             this.uploadInProgress = false;
-            this.alertService.addServerFailure(ex);
+            this.ecosystemService.alertError(ex);
         }
     }
 }
 UploadArchiveComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "14.0.6", ngImport: i0, type: UploadArchiveComponent, deps: [{ token: EcosystemService }, { token: i2.AlertService }], target: i0.ɵɵFactoryTarget.Component });
-UploadArchiveComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "14.0.6", type: UploadArchiveComponent, selector: "c8y-upload-archive", inputs: { application: "application", uploadNewVersion: "uploadNewVersion", preUploadCallback: "preUploadCallback" }, outputs: { applicationChange: "applicationChange", refresh: "refresh" }, ngImport: i0, template: "<c8y-drop-area\n  (dropped)=\"onFileDroppedEvent($event)\"\n  [accept]=\"'.zip'\"\n  [files]=\"fileList\"\n  [loading]=\"uploadInProgress\"\n  [maxAllowedFiles]=\"1\"\n  [message]=\"'Upload a *.zip file' | translate\"\n  [progress]=\"uploadProgress | async\"\n  [forceHideList]=\"true\"\n  class=\"drop-area-sm\"\n>\n</c8y-drop-area>\n", dependencies: [{ kind: "component", type: i2.DropAreaComponent, selector: "c8y-drop-area", inputs: ["formControl", "title", "message", "icon", "loadingMessage", "forceHideList", "alwaysShow", "clickToOpen", "loading", "progress", "maxAllowedFiles", "files", "accept"], outputs: ["dropped"] }, { kind: "pipe", type: i2.C8yTranslatePipe, name: "translate" }, { kind: "pipe", type: i3$1.AsyncPipe, name: "async" }] });
+UploadArchiveComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "14.0.6", type: UploadArchiveComponent, selector: "c8y-upload-archive", inputs: { application: "application", uploadNewVersion: "uploadNewVersion", preUploadCallback: "preUploadCallback" }, outputs: { applicationChange: "applicationChange", refresh: "refresh" }, ngImport: i0, template: "<c8y-drop-area\n  (dropped)=\"onFileDroppedEvent($event)\"\n  [accept]=\"'.zip'\"\n  [loading]=\"uploadInProgress\"\n  [maxAllowedFiles]=\"1\"\n  [message]=\"'Upload a *.zip file' | translate\"\n  [progress]=\"uploadProgress | async\"\n  [forceHideList]=\"true\"\n  class=\"drop-area-sm\"\n>\n</c8y-drop-area>\n", dependencies: [{ kind: "component", type: i2.DropAreaComponent, selector: "c8y-drop-area", inputs: ["formControl", "title", "message", "icon", "loadingMessage", "forceHideList", "alwaysShow", "clickToOpen", "loading", "progress", "maxAllowedFiles", "files", "accept"], outputs: ["dropped"] }, { kind: "pipe", type: i2.C8yTranslatePipe, name: "translate" }, { kind: "pipe", type: i3$1.AsyncPipe, name: "async" }] });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.0.6", ngImport: i0, type: UploadArchiveComponent, decorators: [{
             type: Component,
-            args: [{ selector: 'c8y-upload-archive', template: "<c8y-drop-area\n  (dropped)=\"onFileDroppedEvent($event)\"\n  [accept]=\"'.zip'\"\n  [files]=\"fileList\"\n  [loading]=\"uploadInProgress\"\n  [maxAllowedFiles]=\"1\"\n  [message]=\"'Upload a *.zip file' | translate\"\n  [progress]=\"uploadProgress | async\"\n  [forceHideList]=\"true\"\n  class=\"drop-area-sm\"\n>\n</c8y-drop-area>\n" }]
+            args: [{ selector: 'c8y-upload-archive', template: "<c8y-drop-area\n  (dropped)=\"onFileDroppedEvent($event)\"\n  [accept]=\"'.zip'\"\n  [loading]=\"uploadInProgress\"\n  [maxAllowedFiles]=\"1\"\n  [message]=\"'Upload a *.zip file' | translate\"\n  [progress]=\"uploadProgress | async\"\n  [forceHideList]=\"true\"\n  class=\"drop-area-sm\"\n>\n</c8y-drop-area>\n" }]
         }], ctorParameters: function () { return [{ type: EcosystemService }, { type: i2.AlertService }]; }, propDecorators: { application: [{
                 type: Input
             }], uploadNewVersion: [{