Added mapped property support

FastyBird · Apr 2, 2022 · cc84847 · cc84847
1 parent fb15313
commit cc84847
Show file tree

Hide file tree

Showing 8 changed files with 142 additions and 47 deletions.
diff --git a/fastybird_metadata/__init__.py b/fastybird_metadata/__init__.py
@@ -18,4 +18,4 @@
 Metadata loader and validator and sets of useful enums
 """
 
-__version__ = "0.49.0"
+__version__ = "0.50.0"
diff --git a/fastybird_metadata/devices_module.py b/fastybird_metadata/devices_module.py
@@ -38,6 +38,7 @@ class PropertyType(ExtendedEnum):
 
     DYNAMIC: str = "dynamic"
     STATIC: str = "static"
+    MAPPED: str = "mapped"
 
     # -----------------------------------------------------------------------------
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name" : "@fastybird/metadata",
-  "version" : "0.49.0",
+  "version" : "0.50.0",
   "description" : "FastyBird metadata reader & validator for modules, plugins & etc. used by FastyBird applications",
   "keywords" : [
     "fastybird",

diff --git a/public/lib/types/devices-module.ts b/public/lib/types/devices-module.ts
@@ -3,6 +3,7 @@ import { ButtonPayload, DataType, SwitchPayload } from '@/lib/types/types'
 export enum PropertyType {
   DYNAMIC = 'dynamic',
   STATIC = 'static',
+  MAPPED = 'mapped',
 }
 
 export enum ConnectionState {

diff --git a/resources/schemas/modules/devices-module/entity.channel.property.json b/resources/schemas/modules/devices-module/entity.channel.property.json
@@ -112,7 +112,8 @@
       "type" : "string",
       "enum" : [
         "static",
-        "dynamic"
+        "dynamic",
+        "mapped"
       ]
     },
     "datatype" : {
@@ -233,29 +234,74 @@
     ]
   },
   "else" : {
-    "properties" : {
-      "value" : {
-        "$ref" : "#/definitions/types/string_number_boolean_null"
-      },
-      "default" : {
-        "$ref" : "#/definitions/types/string_number_boolean_null"
+    "if" : {
+      "properties" : {
+        "type" : {
+          "const" : "dynamic"
+        }
       }
     },
-    "required" : [
-      "id",
-      "type",
-      "identifier",
-      "settable",
-      "queryable",
-      "data_type",
-      "unit",
-      "format",
-      "invalid",
-      "number_of_decimals",
-      "value",
-      "default",
-      "channel",
-      "children"
-    ]
+    "then" : {
+      "properties" : {
+        "value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "default" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        }
+      },
+      "required" : [
+        "id",
+        "type",
+        "identifier",
+        "settable",
+        "queryable",
+        "data_type",
+        "unit",
+        "format",
+        "invalid",
+        "number_of_decimals",
+        "value",
+        "default",
+        "channel",
+        "children"
+      ]
+    },
+    "else" : {
+      "properties" : {
+        "actual_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "previous_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "expected_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "pending" : {
+          "type" : "boolean"
+        },
+        "value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "default" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        }
+      },
+      "required" : [
+        "id",
+        "type",
+        "identifier",
+        "settable",
+        "queryable",
+        "data_type",
+        "unit",
+        "format",
+        "invalid",
+        "number_of_decimals",
+        "channel",
+        "children"
+      ]
+    }
   }
 }
diff --git a/resources/schemas/modules/devices-module/entity.connector.property.json b/resources/schemas/modules/devices-module/entity.connector.property.json
@@ -224,28 +224,73 @@
     ]
   },
   "else" : {
-    "properties" : {
-      "value" : {
-        "$ref" : "#/definitions/types/string_number_boolean_null"
-      },
-      "default" : {
-        "$ref" : "#/definitions/types/string_number_boolean_null"
+    "if" : {
+      "properties" : {
+        "type" : {
+          "const" : "dynamic"
+        }
       }
     },
-    "required" : [
-      "id",
-      "type",
-      "identifier",
-      "settable",
-      "queryable",
-      "data_type",
-      "unit",
-      "format",
-      "invalid",
-      "number_of_decimals",
-      "value",
-      "default",
-      "connector"
-    ]
+    "then" : {
+      "properties" : {
+        "value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "default" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        }
+      },
+      "required" : [
+        "id",
+        "type",
+        "identifier",
+        "settable",
+        "queryable",
+        "data_type",
+        "unit",
+        "format",
+        "invalid",
+        "number_of_decimals",
+        "value",
+        "default",
+        "connector"
+      ]
+    },
+    "else" : {
+      "properties" : {
+        "actual_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "previous_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "expected_value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "pending" : {
+          "type" : "boolean"
+        },
+        "value" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        },
+        "default" : {
+          "$ref" : "#/definitions/types/string_number_boolean_null"
+        }
+      },
+      "required" : [
+        "id",
+        "type",
+        "identifier",
+        "settable",
+        "queryable",
+        "data_type",
+        "unit",
+        "format",
+        "invalid",
+        "number_of_decimals",
+        "channel",
+        "children"
+      ]
+    }
   }
 }
diff --git a/resources/schemas/modules/devices-module/entity.device.property.json b/resources/schemas/modules/devices-module/entity.device.property.json
@@ -112,7 +112,8 @@
       "type" : "string",
       "enum" : [
         "static",
-        "dynamic"
+        "dynamic",
+        "mapped"
       ]
     },
     "datatype" : {

diff --git a/src/Types/PropertyTypeType.php b/src/Types/PropertyTypeType.php
@@ -33,6 +33,7 @@ class PropertyTypeType extends Consistence\Enum\Enum
 	 */
 	public const TYPE_STATIC = 'static';
 	public const TYPE_DYNAMIC = 'dynamic';
+	public const TYPE_MAPPED = 'mapped';
 
 	/**
 	 * @return string