npm - @mhome/app-facade-protocol - Versions diffs - 1.20.0 → 1.21.0 - Mend

@mhome/app-facade-protocol 1.20.0 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/fixtures/capability-descriptor.conformance.json +117 -0
package/manifest/app-facade.v1.json +10 -1
package/manifest/hub-targets.v1.json +1 -1
package/manifest/routing.v1.json +1 -1
package/manifest/targets.v1.json +1 -1
package/package.json +1 -1
package/protocol.json +3 -1
package/schema/capability-descriptor.v1.schema.json +49 -0

package/fixtures/capability-descriptor.conformance.json ADDED Viewed

@@ -0,0 +1,117 @@
+{
+  "valid": [
+    {
+      "name": "main definition",
+      "value": {
+        "capabilityId": "basic.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "on/off"
+      }
+    },
+    {
+      "name": "provider implementation",
+      "value": {
+        "capabilityId": "mlinkHue.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "on/off",
+        "parentCapabilityId": "basic.device.command.onOff"
+      }
+    },
+    {
+      "name": "no primary tag",
+      "value": {
+        "capabilityId": "basic.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full"
+      }
+    },
+    {
+      "name": "parent without tag",
+      "value": {
+        "capabilityId": "mlinkHue.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "parentCapabilityId": "basic.device.command.onOff"
+      }
+    },
+    {
+      "name": "data capability",
+      "value": {
+        "capabilityId": "basic.time.data.now",
+        "type": "DATA",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "time"
+      }
+    }
+  ],
+  "invalid": [
+    {
+      "name": "null tag",
+      "value": {
+        "capabilityId": "basic.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": null
+      }
+    },
+    {
+      "name": "empty tag",
+      "value": {
+        "capabilityId": "basic.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": ""
+      }
+    },
+    {
+      "name": "partial ID",
+      "value": {
+        "capabilityId": "command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "on/off"
+      }
+    },
+    {
+      "name": "obsolete definitionId",
+      "value": {
+        "capabilityId": "basic.device.command.onOff",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "on/off",
+        "definitionId": "basic.device.command.onOff"
+      }
+    },
+    {
+      "name": "whitespace in ID",
+      "value": {
+        "capabilityId": "basic.device.command.on Off",
+        "type": "COMMAND",
+        "displayName": "Power on / off",
+        "description": "Controls the device on/off state.",
+        "visibility": "full",
+        "tag": "on/off"
+      }
+    }
+  ]
+}

package/manifest/app-facade.v1.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "manifest": "mhome.app-facade.v1",
-  "contractVersion": "1.20.0",
+  "contractVersion": "1.21.0",
   "callSchema": "schema/facade-call.v1.schema.json",
   "routing": "manifest/routing.v1.json",
   "routingSchema": "schema/routing.v1.schema.json",
@@ -82,6 +82,15 @@
         "/app/system/hosts/runtime",
         "/app/system/hosts/claim"
       ]
+    },
+    "integration": {
+      "capabilitySchema": "schema/capability-descriptor.v1.schema.json",
+      "requestTargets": [
+        "/app/integration/detail/get",
+        "/app/integration/installed/list",
+        "/app/integration/capability/detail/get"
+      ],
+      "includeDocumentationDefault": true
     }
   }
 }

package/manifest/hub-targets.v1.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "manifest": "mhome.hub.targets.v1",
-  "contractVersion": "1.20.0",
+  "contractVersion": "1.21.0",
   "appTargets": [
     "/app/hub/get",
     "/app/hub/remove",

package/manifest/routing.v1.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "manifest": "mhome.app-facade.routing.v1",
-  "contractVersion": "1.20.0",
+  "contractVersion": "1.21.0",
   "targetPrefix": "/app/",
   "default": {
     "execution": "scopeMode",

package/manifest/targets.v1.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "manifest": "mhome.messaging.targets.v1",
-  "contractVersion": "1.20.0",
+  "contractVersion": "1.21.0",
   "requestTargets": [
     "/app/messaging/provider/list",
     "/app/messaging/provider-account/list",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@mhome/app-facade-protocol",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "Build-time protocol artifacts for mhome.app-facade",
   "license": "MIT",
   "repository": {

package/protocol.json CHANGED Viewed

@@ -1,8 +1,9 @@
 {
   "protocol": "mhome.app-facade",
-  "contractVersion": "1.20.0",
+  "contractVersion": "1.21.0",
   "manifest": "manifest/app-facade.v1.json",
   "schemas": {
+    "capabilityDescriptor": "schema/capability-descriptor.v1.schema.json",
     "call": "schema/facade-call.v1.schema.json",
     "frame": "schema/messaging-frame.v3.schema.json",
     "interactionFlow": "schema/interaction-flow-app.v1.schema.json",
@@ -18,6 +19,7 @@
   "fixtures": {
     "valid": "fixtures",
     "invalid": "fixtures/invalid",
+    "capabilityDescriptor": "fixtures/capability-descriptor.conformance.json",
     "interactionFlow": "fixtures/interaction-flow.conformance.json"
   }
 }

package/schema/capability-descriptor.v1.schema.json ADDED Viewed

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mhome.ai/schema/capability-descriptor.v1.schema.json",
+  "title": "CapabilityDescriptor",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "capabilityId",
+    "type",
+    "displayName",
+    "description",
+    "visibility"
+  ],
+  "properties": {
+    "capabilityId": {
+      "type": "string",
+      "pattern": "^[^.\\s]+\\.[^.\\s]+\\.(command|state|event|data)\\.[^.\\s]+$"
+    },
+    "parentCapabilityId": {
+      "type": "string",
+      "pattern": "^[^.\\s]+\\.[^.\\s]+\\.(command|state|event|data)\\.[^.\\s]+$"
+    },
+    "type": {
+      "enum": [
+        "COMMAND",
+        "STATE",
+        "EVENT",
+        "DATA"
+      ]
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "visibility": {
+      "enum": [
+        "full",
+        "internal"
+      ]
+    },
+    "tag": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^\\S(?:.*\\S)?$"
+    }
+  }
+}