homey-api 3.0.0 → 3.0.1

package/assets/types/homey-api.d.ts

@@ -267,6 +267,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
       createAppAPI(
         
           
@@ -348,6 +361,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV2 extends HomeyAPI {
@@ -379,6 +405,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3 extends HomeyAPIV2 {
@@ -419,6 +458,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3Cloud extends HomeyAPIV3 {
@@ -455,6 +507,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3Local extends HomeyAPIV3 {
@@ -491,6 +556,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
 

package/assets/types/homey-api.private.d.ts

@@ -5382,6 +5382,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
       createAppAPI(
         
           
@@ -5463,6 +5476,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV2 extends HomeyAPI {
@@ -5494,6 +5520,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3 extends HomeyAPIV2 {
@@ -5534,6 +5573,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3Cloud extends HomeyAPIV3 {
@@ -5570,6 +5622,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyAPIV3Local extends HomeyAPIV3 {
@@ -5606,6 +5671,19 @@
       ):
         string | null;
     
+      hasRole(
+        
+          
+  
+    
+      roleId: string,
+    
+  
+
+        
+      ):
+        any;
+    
   }
 
   export class HomeyCloudAPI  {

package/lib/AthomCloudAPI/User.js

@@ -59,6 +59,10 @@ class User extends APIDefinition {
     return homey;
   }
 
+  hasRole(roleId) {
+    return this.roleIds.includes(roleId);
+  }
+
 }
 
 module.exports = User;

package/lib/HomeyAPI/HomeyAPI.js

@@ -80,8 +80,15 @@ class HomeyAPI {
     });
 
     // Set Language
-    Object.defineProperty(this, 'Language', {
-      value: properties.Language ?? null,
+    Object.defineProperty(this, 'language', {
+      value: properties.language ?? null,
+      enumerable: true,
+      writable: true,
+    });
+
+    // Set Role
+    Object.defineProperty(this, 'role', {
+      value: properties.role ?? null,
       enumerable: true,
       writable: true,
     });
@@ -158,6 +165,14 @@ class HomeyAPI {
     return null;
   }
 
+  /**
+   * Check the current role.
+   * @param {string} roleId - The role ID, e.g. `owner`, `manager`, `user` or `guest`.
+   */
+  hasRole(roleId) {
+    return this.role === roleId;
+  }
+
   /**
    * Creates a {@link HomeyAPIV3Local} or {@link HomeyAPIV2} instance for use in the Apps SDK.
    * @param {Object} opts

package/lib/HomeyAPI/HomeyAPIV2/ManagerDevkit.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const ManagerDevkitV3 = require('../HomeyAPIV3Local/ManagerDevkit');
+
+class ManagerDevkit extends ManagerDevkitV3 {
+
+}
+
+module.exports = ManagerDevkit;

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -5,6 +5,7 @@ const ManagerFlow = require('./HomeyAPIV2/ManagerFlow');
 const ManagerFlowToken = require('./HomeyAPIV2/ManagerFlowToken');
 const ManagerDevices = require('./HomeyAPIV2/ManagerDevices');
 const ManagerDrivers = require('./HomeyAPIV2/ManagerDrivers');
+const ManagerDevkit = require('./HomeyAPIV2/ManagerDevkit');
 const ManagerInsights = require('./HomeyAPIV2/ManagerInsights');
 
 /**
@@ -22,6 +23,7 @@ class HomeyAPIV2 extends HomeyAPIV3 {
     ManagerFlowToken,
     ManagerDevices,
     ManagerDrivers,
+    ManagerDevkit,
     ManagerInsights,
   };
 

package/lib/HomeyAPI/HomeyAPIV3Local/ManagerDevkit.js

@@ -16,7 +16,7 @@ class ManagerDevkit extends Manager {
     form.append('app', app);
     form.append('env', JSON.stringify(env));
     form.append('debug', debug ? 'true' : 'false');
-    form.append('purgseSettings', clean ? 'true' : 'false');
+    form.append('purgeSettings', clean ? 'true' : 'false');
 
     return this.homey.call({
       $timeout: 1000 * 60 * 5, // 5 minutes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Homey API",
   "main": "index.js",
   "files": [