homey-lib 2.22.1 → 2.23.0

package/assets/app/schema.json

@@ -1037,6 +1037,17 @@
         ]
       }
     },
+    "platformLocalRequiredFeatures": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "nfc",
+          "speaker",
+          "ledring"
+        ]
+      }
+    },
     "tags": {
       "$ref": "#/definitions/i18nArray"
     },

package/lib/App/index.js

@@ -127,6 +127,18 @@ class App {
       }
     }
 
+    // validate that there are no platform local required features defined when targetting cloud
+    if ((appJson.platforms || []).includes('cloud') 
+        && (appJson.platformLocalRequiredFeatures || []).length > 0) {
+        throw new Error('The property `platformLocalRequiredFeatures` can not be used in combination with platform: `cloud`.');
+    }
+
+    // validate that platforms includes local when using platformLocalRequiredFeatures
+    if ((appJson.platforms || []).includes('local') === false
+        && (appJson.platformLocalRequiredFeatures || []).length > 0) {
+        console.warn('Warning: using `platformLocalRequiredFeatures` requires `platforms: [local]`.');
+    }
+
     if (levelVerified) {
       if (appJson.platforms === undefined) {
         throw new Error('The property `platforms` is required in order to publish a verified app.');
@@ -298,7 +310,7 @@ class App {
           if (!driver.images) {
             throw new Error(`drivers.${driver.id}: property \`images\` is required in order to publish an app.`);
           }
-          await this._validateImages(driver.images, 'driver');
+          await this._validateImages(driver.images, 'driver', `drivers.${driver.id}`);
         }
 
         if (levelVerified) {
@@ -560,7 +572,7 @@ class App {
     }
   }
 
-  async _validateImages(imagesObj, type) {
+  async _validateImages(imagesObj, type, errorPath) {
     const sizes = ['small', 'large'];
     for (let i = 0; i < sizes.length; i++) {
       const size = sizes[i];
@@ -568,7 +580,7 @@ class App {
       const extension = extname(imagePath);
 
       if (typeof IMAGE_MARKERS[extension] === 'undefined') {
-        throw new Error(`Invalid image extention: ${extension}`);
+        throw new Error(`Invalid image extension (${extension})${ errorPath ? ` ${errorPath}.${size}` : ''}: ${join(this._path, imagePath)}`);
       }
 
       await this._ensureFileExistsCaseSensitive(imagePath);
@@ -577,14 +589,14 @@ class App {
       const imageBytes = await this._readBytes(imagePath, compareBuffer.length);
 
       if (!imageBytes.equals(compareBuffer)) {
-        throw new Error(`Invalid image: ${imagePath}`);
+        throw new Error(`Invalid image${ errorPath ? ` ${errorPath}.${size}` : ''}: ${join(this._path, imagePath)}`);
       }
 
       const requiredSize = IMAGE_SIZES[type][size];
       const imageSize = await imageSizeAsync(join(this._path, imagePath));
       if (imageSize.width !== requiredSize.width
         || imageSize.height !== requiredSize.height) {
-        throw new Error(`Invalid image size (${imageSize.width}x${imageSize.height}): ${imagePath}\nRequired: ${requiredSize.width}x${requiredSize.height}`);
+        throw new Error(`Invalid image size (${imageSize.width}x${imageSize.height})${ errorPath ? ` ${errorPath}.${size}` : ''}: ${join(this._path, imagePath)}\nRequired: ${requiredSize.width}x${requiredSize.height}`);
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-lib",
-  "version": "2.22.1",
+  "version": "2.23.0",
   "description": "Shared Library for Homey",
   "main": "index.js",
   "scripts": {

package/test/validate-base-manifest.js

@@ -329,8 +329,8 @@ describe('HomeyLib.App#validate() base manifest', function() {
 
     await assertValidates(app, {
       debug: true, // debug does not validate images
-      publish: /invalid image extention/i,
-      verified: /invalid image extention/i,
+      publish: /invalid image extension/i,
+      verified: /invalid image extension/i,
     });
   });
 

package/test/validate-driver-manifest.js

@@ -172,8 +172,8 @@ describe('HomeyLib.App#validate() driver manifest', function() {
 
     await assertValidates(app, {
       debug: true, // debug does not validate images
-      publish: /invalid image extention/i,
-      verified: /invalid image extention/i,
+      publish: /invalid image extension/i,
+      verified: /invalid image extension/i,
     });
   });