@fastybird/smart-panel-backend 1.0.0-beta.2 → 1.1.0-alpha.0

package/dist/plugins/devices-homey/mappings/schema/mapping-schema.json

@@ -0,0 +1,302 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "oneOf": [
+    { "$ref": "#/definitions/deviceFile" },
+    { "$ref": "#/definitions/channelFile" },
+    { "$ref": "#/definitions/propertyFile" }
+  ],
+  "definitions": {
+    "nonEmptyString": {
+      "type": "string",
+      "minLength": 1
+    },
+    "uniqueStrings": {
+      "type": "array",
+      "items": { "$ref": "#/definitions/nonEmptyString" },
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "name": { "$ref": "#/definitions/nonEmptyString" },
+        "description": { "$ref": "#/definitions/nonEmptyString" },
+        "priority": { "type": "integer", "minimum": -100000, "maximum": 100000 },
+        "exclusive": { "type": "boolean" },
+        "conflict": { "enum": ["first", "warn", "error"] }
+      },
+      "required": ["name"],
+      "additionalProperties": true
+    },
+    "deviceMatch": {
+      "type": "object",
+      "properties": {
+        "classes": { "$ref": "#/definitions/uniqueStrings" },
+        "all_capabilities": { "$ref": "#/definitions/uniqueStrings" },
+        "any_capabilities": { "$ref": "#/definitions/uniqueStrings" },
+        "driver_ids": { "$ref": "#/definitions/uniqueStrings" },
+        "manufacturers": { "$ref": "#/definitions/uniqueStrings" },
+        "models": { "$ref": "#/definitions/uniqueStrings" }
+      },
+      "required": ["classes"],
+      "anyOf": [{ "required": ["all_capabilities"] }, { "required": ["any_capabilities"] }],
+      "additionalProperties": false
+    },
+    "propertyMatch": {
+      "type": "object",
+      "properties": {
+        "classes": { "$ref": "#/definitions/uniqueStrings" },
+        "capability_base_ids": { "$ref": "#/definitions/uniqueStrings" },
+        "all_capabilities": { "$ref": "#/definitions/uniqueStrings" },
+        "none_capabilities": { "$ref": "#/definitions/uniqueStrings" },
+        "driver_ids": { "$ref": "#/definitions/uniqueStrings" },
+        "manufacturers": { "$ref": "#/definitions/uniqueStrings" },
+        "models": { "$ref": "#/definitions/uniqueStrings" }
+      },
+      "required": ["classes", "capability_base_ids"],
+      "additionalProperties": false
+    },
+    "deviceMapping": {
+      "allOf": [
+        { "$ref": "#/definitions/metadata" },
+        {
+          "type": "object",
+          "properties": {
+            "name": true,
+            "description": true,
+            "priority": true,
+            "exclusive": true,
+            "conflict": true,
+            "match": { "$ref": "#/definitions/deviceMatch" },
+            "device": {
+              "type": "object",
+              "properties": { "category": { "$ref": "#/definitions/nonEmptyString" } },
+              "required": ["category"],
+              "additionalProperties": false
+            }
+          },
+          "required": ["name", "match", "device"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "channelMapping": {
+      "allOf": [
+        { "$ref": "#/definitions/metadata" },
+        {
+          "type": "object",
+          "properties": {
+            "name": true,
+            "description": true,
+            "priority": true,
+            "exclusive": true,
+            "conflict": true,
+            "match": { "$ref": "#/definitions/deviceMatch" },
+            "channel": {
+              "type": "object",
+              "properties": {
+                "identifier": { "$ref": "#/definitions/nonEmptyString" },
+                "category": { "$ref": "#/definitions/nonEmptyString" },
+                "name": { "$ref": "#/definitions/nonEmptyString" }
+              },
+              "required": ["identifier", "category"],
+              "additionalProperties": false
+            }
+          },
+          "required": ["name", "match", "channel"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "range": {
+      "type": "object",
+      "properties": {
+        "minimum": { "type": "number" },
+        "maximum": { "type": "number" },
+        "step": { "type": "number", "exclusiveMinimum": 0 }
+      },
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "scalar": {
+      "type": ["boolean", "number", "string", "null"]
+    },
+    "numberPair": {
+      "type": "array",
+      "items": { "type": "number" },
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "transform": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "scale" },
+            "input_range": { "$ref": "#/definitions/numberPair" },
+            "output_range": { "$ref": "#/definitions/numberPair" },
+            "clamp": { "type": "boolean" }
+          },
+          "required": ["type", "input_range", "output_range"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "map" },
+            "read": {
+              "type": "object",
+              "additionalProperties": { "$ref": "#/definitions/scalar" },
+              "minProperties": 1
+            },
+            "write": {
+              "type": "object",
+              "additionalProperties": { "$ref": "#/definitions/scalar" },
+              "minProperties": 1
+            }
+          },
+          "required": ["type"],
+          "anyOf": [{ "required": ["read"] }, { "required": ["write"] }],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "boolean" },
+            "true_value": { "$ref": "#/definitions/scalar" },
+            "false_value": { "$ref": "#/definitions/scalar" },
+            "invert": { "type": "boolean" }
+          },
+          "required": ["type", "true_value", "false_value"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "clamp" },
+            "minimum": { "type": "number" },
+            "maximum": { "type": "number" }
+          },
+          "required": ["type", "minimum", "maximum"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "round" },
+            "precision": { "type": "integer", "minimum": 0, "maximum": 12 }
+          },
+          "required": ["type"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "constant" },
+            "value": { "$ref": "#/definitions/scalar" }
+          },
+          "required": ["type", "value"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "threshold" },
+            "threshold": { "type": "number" },
+            "less_than_or_equal": { "$ref": "#/definitions/scalar" },
+            "greater_than": { "$ref": "#/definitions/scalar" }
+          },
+          "required": ["type", "threshold", "less_than_or_equal", "greater_than"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": { "const": "thresholds" },
+            "thresholds": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "minimum": { "type": "number" },
+                  "value": { "$ref": "#/definitions/scalar" }
+                },
+                "required": ["minimum", "value"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "default": { "$ref": "#/definitions/scalar" }
+          },
+          "required": ["type", "thresholds", "default"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "propertyMapping": {
+      "allOf": [
+        { "$ref": "#/definitions/metadata" },
+        {
+          "type": "object",
+          "properties": {
+            "name": true,
+            "description": true,
+            "priority": true,
+            "exclusive": true,
+            "conflict": true,
+            "match": { "$ref": "#/definitions/propertyMatch" },
+            "property": {
+              "type": "object",
+              "properties": {
+                "channel": { "$ref": "#/definitions/nonEmptyString" },
+                "category": { "$ref": "#/definitions/nonEmptyString" },
+                "data_type": {
+                  "enum": ["char", "uchar", "short", "ushort", "int", "uint", "float", "bool", "string", "enum", "unknown"]
+                },
+                "direction": { "enum": ["read_only", "write_only", "bidirectional"] },
+                "write_strategy": { "enum": ["thermostat_heater_mode", "thermostat_cooler_mode"] },
+                "unit": { "$ref": "#/definitions/nonEmptyString" },
+                "range": { "$ref": "#/definitions/range" },
+                "transform": { "$ref": "#/definitions/transform" }
+              },
+              "required": ["channel", "category", "data_type", "direction"],
+              "additionalProperties": false
+            }
+          },
+          "required": ["name", "match", "property"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "deviceFile": {
+      "type": "object",
+      "properties": {
+        "version": { "const": 1 },
+        "kind": { "const": "devices" },
+        "mappings": { "type": "array", "items": { "$ref": "#/definitions/deviceMapping" } }
+      },
+      "required": ["version", "kind", "mappings"],
+      "additionalProperties": false
+    },
+    "channelFile": {
+      "type": "object",
+      "properties": {
+        "version": { "const": 1 },
+        "kind": { "const": "channels" },
+        "mappings": { "type": "array", "items": { "$ref": "#/definitions/channelMapping" } }
+      },
+      "required": ["version", "kind", "mappings"],
+      "additionalProperties": false
+    },
+    "propertyFile": {
+      "type": "object",
+      "properties": {
+        "version": { "const": 1 },
+        "kind": { "const": "properties" },
+        "mappings": { "type": "array", "items": { "$ref": "#/definitions/propertyMapping" } }
+      },
+      "required": ["version", "kind", "mappings"],
+      "additionalProperties": false
+    }
+  }
+}

package/dist/plugins/devices-homey/models/adoption.model.d.ts

@@ -0,0 +1,30 @@
+import { BaseSuccessResponseModel } from '../../../modules/api/models/api-response.model';
+export declare enum HomeyAdoptionStatus {
+    CREATED = "created",
+    UPDATED = "updated",
+    SKIPPED = "skipped",
+    FAILED = "failed"
+}
+export declare enum HomeyAdoptionFailureCode {
+    UNAVAILABLE = "unavailable",
+    DEVICE_NOT_FOUND = "device_not_found",
+    UNSUPPORTED_MAPPING = "unsupported_mapping",
+    PERSISTENCE_FAILED = "persistence_failed",
+    ROLLBACK_FAILED = "rollback_failed"
+}
+export declare class HomeyAdoptionResultModel {
+    deviceId: string;
+    status: HomeyAdoptionStatus;
+    panelDeviceId: string | null;
+    failureCode: HomeyAdoptionFailureCode | null;
+    message: string | null;
+}
+export declare class HomeyBatchAdoptionModel {
+    results: HomeyAdoptionResultModel[];
+}
+export declare class HomeyAdoptionResponseModel extends BaseSuccessResponseModel<HomeyAdoptionResultModel> {
+    data: HomeyAdoptionResultModel;
+}
+export declare class HomeyBatchAdoptionResponseModel extends BaseSuccessResponseModel<HomeyBatchAdoptionModel> {
+    data: HomeyBatchAdoptionModel;
+}

package/dist/plugins/devices-homey/models/adoption.model.js

@@ -0,0 +1,122 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HomeyBatchAdoptionResponseModel = exports.HomeyAdoptionResponseModel = exports.HomeyBatchAdoptionModel = exports.HomeyAdoptionResultModel = exports.HomeyAdoptionFailureCode = exports.HomeyAdoptionStatus = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const swagger_1 = require("@nestjs/swagger");
+const api_response_model_1 = require("../../../modules/api/models/api-response.model");
+var HomeyAdoptionStatus;
+(function (HomeyAdoptionStatus) {
+    HomeyAdoptionStatus["CREATED"] = "created";
+    HomeyAdoptionStatus["UPDATED"] = "updated";
+    HomeyAdoptionStatus["SKIPPED"] = "skipped";
+    HomeyAdoptionStatus["FAILED"] = "failed";
+})(HomeyAdoptionStatus || (exports.HomeyAdoptionStatus = HomeyAdoptionStatus = {}));
+var HomeyAdoptionFailureCode;
+(function (HomeyAdoptionFailureCode) {
+    HomeyAdoptionFailureCode["UNAVAILABLE"] = "unavailable";
+    HomeyAdoptionFailureCode["DEVICE_NOT_FOUND"] = "device_not_found";
+    HomeyAdoptionFailureCode["UNSUPPORTED_MAPPING"] = "unsupported_mapping";
+    HomeyAdoptionFailureCode["PERSISTENCE_FAILED"] = "persistence_failed";
+    HomeyAdoptionFailureCode["ROLLBACK_FAILED"] = "rollback_failed";
+})(HomeyAdoptionFailureCode || (exports.HomeyAdoptionFailureCode = HomeyAdoptionFailureCode = {}));
+let HomeyAdoptionResultModel = class HomeyAdoptionResultModel {
+};
+exports.HomeyAdoptionResultModel = HomeyAdoptionResultModel;
+__decorate([
+    (0, swagger_1.ApiProperty)({ name: 'device_id', description: 'Authoritative full Homey device identifier' }),
+    (0, class_transformer_1.Expose)({ name: 'device_id' }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], HomeyAdoptionResultModel.prototype, "deviceId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Idempotent adoption outcome', enum: HomeyAdoptionStatus }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsEnum)(HomeyAdoptionStatus),
+    __metadata("design:type", String)
+], HomeyAdoptionResultModel.prototype, "status", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        name: 'panel_device_id',
+        description: 'Smart Panel device identifier when adoption succeeded',
+        type: 'string',
+        format: 'uuid',
+        nullable: true,
+    }),
+    (0, class_transformer_1.Expose)({ name: 'panel_device_id' }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsUUID)('4'),
+    __metadata("design:type", String)
+], HomeyAdoptionResultModel.prototype, "panelDeviceId", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        name: 'failure_code',
+        description: 'Stable sanitized failure category',
+        enum: HomeyAdoptionFailureCode,
+        nullable: true,
+    }),
+    (0, class_transformer_1.Expose)({ name: 'failure_code' }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(HomeyAdoptionFailureCode),
+    __metadata("design:type", String)
+], HomeyAdoptionResultModel.prototype, "failureCode", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Sanitized failure message', nullable: true }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], HomeyAdoptionResultModel.prototype, "message", void 0);
+exports.HomeyAdoptionResultModel = HomeyAdoptionResultModel = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesHomeyPluginDataAdoptionResult' })
+], HomeyAdoptionResultModel);
+let HomeyBatchAdoptionModel = class HomeyBatchAdoptionModel {
+};
+exports.HomeyBatchAdoptionModel = HomeyBatchAdoptionModel;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Per-device results in request order', type: [HomeyAdoptionResultModel] }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => HomeyAdoptionResultModel),
+    __metadata("design:type", Array)
+], HomeyBatchAdoptionModel.prototype, "results", void 0);
+exports.HomeyBatchAdoptionModel = HomeyBatchAdoptionModel = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesHomeyPluginDataBatchAdoption' })
+], HomeyBatchAdoptionModel);
+let HomeyAdoptionResponseModel = class HomeyAdoptionResponseModel extends api_response_model_1.BaseSuccessResponseModel {
+};
+exports.HomeyAdoptionResponseModel = HomeyAdoptionResponseModel;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Homey adoption result', type: HomeyAdoptionResultModel }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => HomeyAdoptionResultModel),
+    __metadata("design:type", HomeyAdoptionResultModel)
+], HomeyAdoptionResponseModel.prototype, "data", void 0);
+exports.HomeyAdoptionResponseModel = HomeyAdoptionResponseModel = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesHomeyPluginResAdoption' })
+], HomeyAdoptionResponseModel);
+let HomeyBatchAdoptionResponseModel = class HomeyBatchAdoptionResponseModel extends api_response_model_1.BaseSuccessResponseModel {
+};
+exports.HomeyBatchAdoptionResponseModel = HomeyBatchAdoptionResponseModel;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Homey batch adoption results', type: HomeyBatchAdoptionModel }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => HomeyBatchAdoptionModel),
+    __metadata("design:type", HomeyBatchAdoptionModel)
+], HomeyBatchAdoptionResponseModel.prototype, "data", void 0);
+exports.HomeyBatchAdoptionResponseModel = HomeyBatchAdoptionResponseModel = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesHomeyPluginResBatchAdoption' })
+], HomeyBatchAdoptionResponseModel);
+//# sourceMappingURL=adoption.model.js.map

package/dist/plugins/devices-homey/models/adoption.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adoption.model.js","sourceRoot":"","sources":["../../../../src/plugins/devices-homey/models/adoption.model.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAiD;AACjD,qDAAgG;AAEhG,6CAA8E;AAE9E,uFAA0F;AAE1F,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC9B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,wCAAiB,CAAA;AAClB,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAED,IAAY,wBAMX;AAND,WAAY,wBAAwB;IACnC,uDAA2B,CAAA;IAC3B,iEAAqC,CAAA;IACrC,uEAA2C,CAAA;IAC3C,qEAAyC,CAAA;IACzC,+DAAmC,CAAA;AACpC,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC;AAGM,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;CAuCpC,CAAA;AAvCY,4DAAwB;AAIpC;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,4CAA4C,EAAE,CAAC;IAC7F,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;;0DACM;AAKjB;IAHC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,6BAA6B,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;IACtF,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAM,EAAC,mBAAmB,CAAC;;wDACA;AAY5B;IAVC,IAAA,6BAAmB,EAAC;QACpB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,uDAAuD;QACpE,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,IAAI;KACd,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;IACnC,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAM,EAAC,GAAG,CAAC;;+DACiB;AAW7B;IATC,IAAA,6BAAmB,EAAC;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,mCAAmC;QAChD,IAAI,EAAE,wBAAwB;QAC9B,QAAQ,EAAE,IAAI;KACd,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;IAChC,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAM,EAAC,wBAAwB,CAAC;;6DACY;AAM7C;IAJC,IAAA,6BAAmB,EAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjF,IAAA,0BAAM,GAAE;IACR,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;yDACY;mCAtCX,wBAAwB;IADpC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,sCAAsC,EAAE,CAAC;GAC/C,wBAAwB,CAuCpC;AAGM,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;CAOnC,CAAA;AAPY,0DAAuB;AAMnC;IALC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,qCAAqC,EAAE,IAAI,EAAE,CAAC,wBAAwB,CAAC,EAAE,CAAC;IACrG,IAAA,0BAAM,GAAE;IACR,IAAA,yBAAO,GAAE;IACT,IAAA,gCAAc,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC;;wDACD;kCANxB,uBAAuB;IADnC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;GAC9C,uBAAuB,CAOnC;AAGM,IAAM,0BAA0B,GAAhC,MAAM,0BAA2B,SAAQ,6CAAkD;CAMjG,CAAA;AANY,gEAA0B;AAK9B;IAJP,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC;IACrF,IAAA,0BAAM,GAAE;IACR,IAAA,gCAAc,GAAE;IAChB,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC;8BACvB,wBAAwB;wDAAC;qCAL3B,0BAA0B;IADtC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;GACxC,0BAA0B,CAMtC;AAGM,IAAM,+BAA+B,GAArC,MAAM,+BAAgC,SAAQ,6CAAiD;CAMrG,CAAA;AANY,0EAA+B;AAKnC;IAJP,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;IAC3F,IAAA,0BAAM,GAAE;IACR,IAAA,gCAAc,GAAE;IAChB,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC;8BACtB,uBAAuB;6DAAC;0CAL1B,+BAA+B;IAD3C,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,oCAAoC,EAAE,CAAC;GAC7C,+BAA+B,CAM3C"}

package/dist/plugins/devices-homey/models/config.model.d.ts

@@ -0,0 +1,9 @@
+import { PluginConfigModel } from '../../../modules/config/models/config.model';
+export declare class HomeyConfigModel extends PluginConfigModel {
+    type: string;
+    url: string | null;
+    apiKey: string | null;
+    apiKeyConfigured?: boolean;
+    connectionTimeout: number;
+    reconciliationInterval: number;
+}

package/dist/plugins/devices-homey/models/config.model.js

@@ -0,0 +1,107 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HomeyConfigModel = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const swagger_1 = require("@nestjs/swagger");
+const config_model_1 = require("../../../modules/config/models/config.model");
+const devices_homey_constants_1 = require("../devices-homey.constants");
+const homey_url_validator_1 = require("../validators/homey-url.validator");
+let HomeyConfigModel = class HomeyConfigModel extends config_model_1.PluginConfigModel {
+    constructor() {
+        super(...arguments);
+        this.type = devices_homey_constants_1.DEVICES_HOMEY_PLUGIN_NAME;
+        this.url = null;
+        this.apiKey = null;
+        this.connectionTimeout = devices_homey_constants_1.DEFAULT_HOMEY_CONNECTION_TIMEOUT_MS;
+        this.reconciliationInterval = devices_homey_constants_1.DEFAULT_HOMEY_RECONCILIATION_INTERVAL_MS;
+    }
+};
+exports.HomeyConfigModel = HomeyConfigModel;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Plugin type identifier',
+        example: devices_homey_constants_1.DEVICES_HOMEY_PLUGIN_NAME,
+    }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], HomeyConfigModel.prototype, "type", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Homey local API base URL',
+        example: 'http://homey.local:4859',
+        maxLength: homey_url_validator_1.MAX_HOMEY_URL_LENGTH,
+        nullable: true,
+    }),
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.ValidateIf)((config) => config.url !== null),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, homey_url_validator_1.IsSafeHomeyUrl)(),
+    __metadata("design:type", String)
+], HomeyConfigModel.prototype, "url", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Homey local API key. This value is accepted on write and never returned.',
+        writeOnly: true,
+        nullable: true,
+        name: 'api_key',
+    }),
+    (0, class_transformer_1.Expose)({ name: 'api_key' }),
+    (0, class_validator_1.ValidateIf)((config) => config.apiKey !== null),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/\S/),
+    __metadata("design:type", String)
+], HomeyConfigModel.prototype, "apiKey", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Whether a Homey local API key is configured',
+        name: 'api_key_configured',
+    }),
+    (0, class_transformer_1.Expose)({ name: 'api_key_configured' }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], HomeyConfigModel.prototype, "apiKeyConfigured", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Connection timeout in milliseconds',
+        example: devices_homey_constants_1.DEFAULT_HOMEY_CONNECTION_TIMEOUT_MS,
+        minimum: devices_homey_constants_1.MIN_HOMEY_CONNECTION_TIMEOUT_MS,
+        maximum: devices_homey_constants_1.MAX_HOMEY_CONNECTION_TIMEOUT_MS,
+        name: 'connection_timeout',
+    }),
+    (0, class_transformer_1.Expose)({ name: 'connection_timeout' }),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(devices_homey_constants_1.MIN_HOMEY_CONNECTION_TIMEOUT_MS),
+    (0, class_validator_1.Max)(devices_homey_constants_1.MAX_HOMEY_CONNECTION_TIMEOUT_MS),
+    __metadata("design:type", Number)
+], HomeyConfigModel.prototype, "connectionTimeout", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Authoritative inventory reconciliation interval in milliseconds',
+        example: devices_homey_constants_1.DEFAULT_HOMEY_RECONCILIATION_INTERVAL_MS,
+        minimum: devices_homey_constants_1.MIN_HOMEY_RECONCILIATION_INTERVAL_MS,
+        maximum: devices_homey_constants_1.MAX_HOMEY_RECONCILIATION_INTERVAL_MS,
+        name: 'reconciliation_interval',
+    }),
+    (0, class_transformer_1.Expose)({ name: 'reconciliation_interval' }),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(devices_homey_constants_1.MIN_HOMEY_RECONCILIATION_INTERVAL_MS),
+    (0, class_validator_1.Max)(devices_homey_constants_1.MAX_HOMEY_RECONCILIATION_INTERVAL_MS),
+    __metadata("design:type", Number)
+], HomeyConfigModel.prototype, "reconciliationInterval", void 0);
+exports.HomeyConfigModel = HomeyConfigModel = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesHomeyPluginDataConfig' })
+], HomeyConfigModel);
+//# sourceMappingURL=config.model.js.map

package/dist/plugins/devices-homey/models/config.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.model.js","sourceRoot":"","sources":["../../../../src/plugins/devices-homey/models/config.model.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA2C;AAC3C,qDAAoH;AAEpH,6CAA8E;AAE9E,8EAAgF;AAChF,wEAQoC;AACpC,2EAAyF;AAGlF,IAAM,gBAAgB,GAAtB,MAAM,gBAAiB,SAAQ,gCAAiB;IAAhD;;QAON,SAAI,GAAW,mDAAyB,CAAC;QAYzC,QAAG,GAAkB,IAAI,CAAC;QAa1B,WAAM,GAAkB,IAAI,CAAC;QAsB7B,sBAAiB,GAAW,6DAAmC,CAAC;QAahE,2BAAsB,GAAW,kEAAwC,CAAC;IAC3E,CAAC;CAAA,CAAA;AApEY,4CAAgB;AAO5B;IANC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,wBAAwB;QACrC,OAAO,EAAE,mDAAyB;KAClC,CAAC;IACD,IAAA,0BAAM,GAAE;IACR,IAAA,0BAAQ,GAAE;;8CAC8B;AAYzC;IAVC,IAAA,6BAAmB,EAAC;QACpB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,yBAAyB;QAClC,SAAS,EAAE,0CAAoB;QAC/B,QAAQ,EAAE,IAAI;KACd,CAAC;IACD,IAAA,0BAAM,GAAE;IACR,IAAA,4BAAU,EAAC,CAAC,MAAwB,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC;IAC7D,IAAA,4BAAU,GAAE;IACZ,IAAA,oCAAc,GAAE;;6CACS;AAa1B;IAXC,IAAA,6BAAmB,EAAC;QACpB,WAAW,EAAE,0EAA0E;QACvF,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,SAAS;KACf,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC3B,IAAA,4BAAU,EAAC,CAAC,MAAwB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC;IAChE,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,yBAAO,EAAC,IAAI,CAAC;;gDACe;AAS7B;IAPC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,6CAA6C;QAC1D,IAAI,EAAE,oBAAoB;KAC1B,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;IACtC,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,GAAE;;0DACe;AAa3B;IAXC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE,6DAAmC;QAC5C,OAAO,EAAE,yDAA+B;QACxC,OAAO,EAAE,yDAA+B;QACxC,IAAI,EAAE,oBAAoB;KAC1B,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;IACtC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,yDAA+B,CAAC;IACpC,IAAA,qBAAG,EAAC,yDAA+B,CAAC;;2DAC2B;AAahE;IAXC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,iEAAiE;QAC9E,OAAO,EAAE,kEAAwC;QACjD,OAAO,EAAE,8DAAoC;QAC7C,OAAO,EAAE,8DAAoC;QAC7C,IAAI,EAAE,yBAAyB;KAC/B,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;IAC3C,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,8DAAoC,CAAC;IACzC,IAAA,qBAAG,EAAC,8DAAoC,CAAC;;gEACgC;2BAnE9D,gBAAgB;IAD5B,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC;GACvC,gBAAgB,CAoE5B"}

package/dist/plugins/devices-homey/models/homey-capability.model.d.ts

@@ -0,0 +1,31 @@
+export type HomeyCapabilityValue = boolean | number | string | null;
+export declare enum HomeyCapabilityType {
+    BOOLEAN = "boolean",
+    NUMBER = "number",
+    STRING = "string",
+    ENUM = "enum",
+    UNKNOWN = "unknown"
+}
+export interface HomeyCapabilityEnumValue {
+    readonly id: string;
+    readonly title: string;
+}
+export interface HomeyCapability {
+    readonly id: string;
+    readonly baseId: string;
+    readonly title: string;
+    readonly value: HomeyCapabilityValue;
+    readonly type: HomeyCapabilityType;
+    readonly unit: string | null;
+    readonly minimum: number | null;
+    readonly maximum: number | null;
+    readonly step: number | null;
+    readonly enumValues: readonly HomeyCapabilityEnumValue[];
+    readonly readable: boolean;
+    readonly writable: boolean;
+    readonly available: boolean | null;
+    readonly lastUpdatedAt: string | null;
+}
+export type HomeyCapabilityInput = Omit<HomeyCapability, 'baseId'>;
+export declare function getHomeyCapabilityBaseId(capabilityId: string): string;
+export declare function createHomeyCapability(capability: HomeyCapabilityInput): HomeyCapability;

package/dist/plugins/devices-homey/models/homey-capability.model.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HomeyCapabilityType = void 0;
+exports.getHomeyCapabilityBaseId = getHomeyCapabilityBaseId;
+exports.createHomeyCapability = createHomeyCapability;
+var HomeyCapabilityType;
+(function (HomeyCapabilityType) {
+    HomeyCapabilityType["BOOLEAN"] = "boolean";
+    HomeyCapabilityType["NUMBER"] = "number";
+    HomeyCapabilityType["STRING"] = "string";
+    HomeyCapabilityType["ENUM"] = "enum";
+    HomeyCapabilityType["UNKNOWN"] = "unknown";
+})(HomeyCapabilityType || (exports.HomeyCapabilityType = HomeyCapabilityType = {}));
+function getHomeyCapabilityBaseId(capabilityId) {
+    const suffixSeparator = capabilityId.indexOf('.');
+    return suffixSeparator === -1 ? capabilityId : capabilityId.slice(0, suffixSeparator);
+}
+function createHomeyCapability(capability) {
+    return {
+        ...capability,
+        baseId: getHomeyCapabilityBaseId(capability.id),
+    };
+}
+//# sourceMappingURL=homey-capability.model.js.map

package/dist/plugins/devices-homey/models/homey-capability.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"homey-capability.model.js","sourceRoot":"","sources":["../../../../src/plugins/devices-homey/models/homey-capability.model.ts"],"names":[],"mappings":";;;AAuCA,4DAIC;AAMD,sDAKC;AApDD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC9B,0CAAmB,CAAA;IACnB,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,oCAAa,CAAA;IACb,0CAAmB,CAAA;AACpB,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA+BD,SAAgB,wBAAwB,CAAC,YAAoB;IAC5D,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElD,OAAO,eAAe,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AACvF,CAAC;AAMD,SAAgB,qBAAqB,CAAC,UAAgC;IACrE,OAAO;QACN,GAAG,UAAU;QACb,MAAM,EAAE,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;KAC/C,CAAC;AACH,CAAC"}