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

package/dist/plugins/devices-virtual/entities/devices-virtual.entity.js

@@ -0,0 +1,153 @@
+"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.VirtualChannelPropertyEntity = exports.VirtualChannelEntity = exports.VirtualDeviceEntity = exports.isUnsupportedOwnedPermissionsPair = exports.isUnsupportedValueOriginPair = exports.VirtualValueOrigin = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const typeorm_1 = require("typeorm");
+const swagger_1 = require("@nestjs/swagger");
+const devices_constants_1 = require("../../../modules/devices/devices.constants");
+const devices_entity_1 = require("../../../modules/devices/entities/devices.entity");
+const devices_virtual_constants_1 = require("../devices-virtual.constants");
+var VirtualValueOrigin;
+(function (VirtualValueOrigin) {
+    VirtualValueOrigin["SOURCE"] = "source";
+    VirtualValueOrigin["LOCAL"] = "local";
+})(VirtualValueOrigin || (exports.VirtualValueOrigin = VirtualValueOrigin = {}));
+const isUnsupportedValueOriginPair = (valueOrigin, sourcePropertyId) => valueOrigin === VirtualValueOrigin.LOCAL && !!sourcePropertyId;
+exports.isUnsupportedValueOriginPair = isUnsupportedValueOriginPair;
+const WRITABLE_PERMISSIONS = [devices_constants_1.PermissionType.READ_WRITE, devices_constants_1.PermissionType.WRITE_ONLY];
+const isUnsupportedOwnedPermissionsPair = (valueOrigin, permissions) => valueOrigin === VirtualValueOrigin.LOCAL &&
+    !!permissions?.some((permission) => WRITABLE_PERMISSIONS.includes(permission));
+exports.isUnsupportedOwnedPermissionsPair = isUnsupportedOwnedPermissionsPair;
+let VirtualDeviceEntity = class VirtualDeviceEntity extends devices_entity_1.DeviceEntity {
+    get type() {
+        return devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE;
+    }
+};
+exports.VirtualDeviceEntity = VirtualDeviceEntity;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Device type',
+        type: 'string',
+        default: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+        example: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+    }),
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String),
+    __metadata("design:paramtypes", [])
+], VirtualDeviceEntity.prototype, "type", null);
+exports.VirtualDeviceEntity = VirtualDeviceEntity = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesVirtualPluginDataDevice' }),
+    (0, typeorm_1.ChildEntity)()
+], VirtualDeviceEntity);
+let VirtualChannelEntity = class VirtualChannelEntity extends devices_entity_1.ChannelEntity {
+    get type() {
+        return devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE;
+    }
+};
+exports.VirtualChannelEntity = VirtualChannelEntity;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Channel type',
+        type: 'string',
+        default: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+        example: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+    }),
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String),
+    __metadata("design:paramtypes", [])
+], VirtualChannelEntity.prototype, "type", null);
+exports.VirtualChannelEntity = VirtualChannelEntity = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesVirtualPluginDataChannel' }),
+    (0, typeorm_1.ChildEntity)()
+], VirtualChannelEntity);
+let VirtualChannelPropertyEntity = class VirtualChannelPropertyEntity extends devices_entity_1.ChannelPropertyEntity {
+    get type() {
+        return devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE;
+    }
+    get isProjecting() {
+        return this.valueOrigin !== VirtualValueOrigin.LOCAL;
+    }
+    get isOrphaned() {
+        return this.isProjecting && this.sourcePropertyId === null;
+    }
+    get isLinked() {
+        return this.isProjecting && this.sourcePropertyId !== null;
+    }
+};
+exports.VirtualChannelPropertyEntity = VirtualChannelPropertyEntity;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        name: 'value_origin',
+        description: 'Whether the value comes from a source property or is stored by this property itself',
+        enum: VirtualValueOrigin,
+        example: VirtualValueOrigin.SOURCE,
+    }),
+    (0, class_transformer_1.Expose)({ name: 'value_origin' }),
+    (0, class_validator_1.IsEnum)(VirtualValueOrigin),
+    (0, class_transformer_1.Transform)(({ obj }) => obj.value_origin ?? obj.valueOrigin, { toClassOnly: true }),
+    (0, typeorm_1.Column)({ type: 'text', enum: VirtualValueOrigin, default: VirtualValueOrigin.SOURCE }),
+    __metadata("design:type", String)
+], VirtualChannelPropertyEntity.prototype, "valueOrigin", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        name: 'source_property',
+        description: 'Property whose value this one projects. Null once the source has been deleted.',
+        type: 'string',
+        format: 'uuid',
+        nullable: true,
+        example: '550e8400-e29b-41d4-a716-446655440000',
+    }),
+    (0, class_transformer_1.Expose)({ name: 'source_property' }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsUUID)('4', {
+        message: '[{"field":"source_property","reason":"Source property must be a valid UUID (version 4)."}]',
+    }),
+    (0, class_transformer_1.Transform)(({ obj }) => obj.source_property !== undefined ? obj.source_property : obj.sourcePropertyId, { toClassOnly: true }),
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", String)
+], VirtualChannelPropertyEntity.prototype, "sourcePropertyId", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => devices_entity_1.ChannelPropertyEntity, { nullable: true, onDelete: 'SET NULL' }),
+    (0, typeorm_1.JoinColumn)({ name: 'sourcePropertyId' }),
+    __metadata("design:type", devices_entity_1.ChannelPropertyEntity)
+], VirtualChannelPropertyEntity.prototype, "sourceProperty", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", String)
+], VirtualChannelPropertyEntity.prototype, "energyClaimPropertyId", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => devices_entity_1.ChannelPropertyEntity, { nullable: true, onDelete: 'SET NULL' }),
+    (0, typeorm_1.JoinColumn)({ name: 'energyClaimPropertyId' }),
+    __metadata("design:type", devices_entity_1.ChannelPropertyEntity)
+], VirtualChannelPropertyEntity.prototype, "energyClaim", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Channel property type',
+        type: 'string',
+        default: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+        example: devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE,
+    }),
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String),
+    __metadata("design:paramtypes", [])
+], VirtualChannelPropertyEntity.prototype, "type", null);
+exports.VirtualChannelPropertyEntity = VirtualChannelPropertyEntity = __decorate([
+    (0, swagger_1.ApiSchema)({ name: 'DevicesVirtualPluginDataChannelProperty' }),
+    (0, typeorm_1.Index)('UQ_channels_properties_energyClaim', ['energyClaimPropertyId'], {
+        unique: true,
+        where: '"energyClaimPropertyId" IS NOT NULL',
+    }),
+    (0, typeorm_1.ChildEntity)()
+], VirtualChannelPropertyEntity);
+//# sourceMappingURL=devices-virtual.entity.js.map

package/dist/plugins/devices-virtual/entities/devices-virtual.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices-virtual.entity.js","sourceRoot":"","sources":["../../../../src/plugins/devices-virtual/entities/devices-virtual.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAsD;AACtD,qDAA6D;AAC7D,qCAA4E;AAE5E,6CAA8E;AAE9E,kFAA4E;AAC5E,qFAAsH;AACtH,4EAAoE;AAEpE,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAE7B,uCAAiB,CAAA;IAEjB,qCAAe,CAAA;AAChB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AA8BM,MAAM,4BAA4B,GAAG,CAC3C,WAA2C,EAC3C,gBAA2C,EACjC,EAAE,CAAC,WAAW,KAAK,kBAAkB,CAAC,KAAK,IAAI,CAAC,CAAC,gBAAgB,CAAC;AAHhE,QAAA,4BAA4B,gCAGoC;AAG7E,MAAM,oBAAoB,GAA8B,CAAC,kCAAc,CAAC,UAAU,EAAE,kCAAc,CAAC,UAAU,CAAC,CAAC;AA2BxG,MAAM,iCAAiC,GAAG,CAChD,WAA2C,EAC3C,WAAgD,EACtC,EAAE,CACZ,WAAW,KAAK,kBAAkB,CAAC,KAAK;IACxC,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;AALnE,QAAA,iCAAiC,qCAKkC;AAIzE,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,6BAAY;IACpD,IAOI,IAAI;QACP,OAAO,gDAAoB,CAAC;IAC7B,CAAC;CACD,CAAA;AAXY,kDAAmB;AAC/B;IAAC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,aAAa;QAC1B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,gDAAoB;QAC7B,OAAO,EAAE,gDAAoB;KAC7B,CAAC;IACD,IAAA,0BAAM,GAAE;;;+CAGR;8BAVW,mBAAmB;IAF/B,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,gCAAgC,EAAE,CAAC;IACrD,IAAA,qBAAW,GAAE;GACD,mBAAmB,CAW/B;AAIM,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,8BAAa;IACtD,IAOI,IAAI;QACP,OAAO,gDAAoB,CAAC;IAC7B,CAAC;CACD,CAAA;AAXY,oDAAoB;AAChC;IAAC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,cAAc;QAC3B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,gDAAoB;QAC7B,OAAO,EAAE,gDAAoB;KAC7B,CAAC;IACD,IAAA,0BAAM,GAAE;;;gDAGR;+BAVW,oBAAoB;IAFhC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC;IACtD,IAAA,qBAAW,GAAE;GACD,oBAAoB,CAWhC;AAkBM,IAAM,4BAA4B,GAAlC,MAAM,4BAA6B,SAAQ,sCAAqB;IA+EtE,IAOI,IAAI;QACP,OAAO,gDAAoB,CAAC;IAC7B,CAAC;IAaD,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,WAAW,KAAK,kBAAkB,CAAC,KAAK,CAAC;IACtD,CAAC;IAGD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,IAAI,CAAC;IAC5D,CAAC;IAGD,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,IAAI,CAAC;IAC5D,CAAC;CACD,CAAA;AAlHY,oEAA4B;AAwBxC;IAvBC,IAAA,qBAAW,EAAC;QACZ,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,qFAAqF;QAClG,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,kBAAkB,CAAC,MAAM;KAClC,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;IAChC,IAAA,wBAAM,EAAC,kBAAkB,CAAC;IAC1B,IAAA,6BAAS,EACT,CAAC,EAAE,GAAG,EAAoF,EAAE,EAAE,CAC7F,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,WAAW,EACpC,EAAE,WAAW,EAAE,IAAI,EAAE,CACrB;IAUA,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,CAAC;;iEACvD;AAsBhC;IApBC,IAAA,6BAAmB,EAAC;QACpB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,gFAAgF;QAC7F,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,sCAAsC;KAC/C,CAAC;IACD,IAAA,0BAAM,EAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;IACnC,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAM,EAAC,GAAG,EAAE;QACZ,OAAO,EAAE,4FAA4F;KACrG,CAAC;IACD,IAAA,6BAAS,EACT,CAAC,EAAE,GAAG,EAAkF,EAAE,EAAE,CAC3F,GAAG,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAC/E,EAAE,WAAW,EAAE,IAAI,EAAE,CACrB;IACA,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;sEACV;AAIhC;IAFC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,sCAAqB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAChF,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;8BACzB,sCAAqB;oEAAQ;AAuB7C;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;2EACL;AAIrC;IAFC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,sCAAqB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAChF,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;8BACjC,sCAAqB;iEAAQ;AAE1C;IAAC,IAAA,qBAAW,EAAC;QACZ,WAAW,EAAE,uBAAuB;QACpC,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,gDAAoB;QAC7B,OAAO,EAAE,gDAAoB;KAC7B,CAAC;IACD,IAAA,0BAAM,GAAE;;;wDAGR;uCAxFW,4BAA4B;IAhBxC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,yCAAyC,EAAE,CAAC;IAW9D,IAAA,eAAK,EAAC,oCAAoC,EAAE,CAAC,uBAAuB,CAAC,EAAE;QACvE,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,qCAAqC;KAC5C,CAAC;IACD,IAAA,qBAAW,GAAE;GACD,4BAA4B,CAkHxC"}

package/dist/plugins/devices-virtual/listeners/virtual-device-information.listener.d.ts

@@ -0,0 +1,20 @@
+import { ChannelPropertyEntity, DeviceEntity } from '../../../modules/devices/entities/devices.entity';
+import { ChannelsPropertiesService } from '../../../modules/devices/services/channels.properties.service';
+import { ChannelsService } from '../../../modules/devices/services/channels.service';
+import { VirtualStatusListener } from './virtual-status.listener';
+export declare class VirtualDeviceInformationListener {
+    private readonly channelsService;
+    private readonly channelsPropertiesService;
+    private readonly statusListener;
+    private readonly logger;
+    private static readonly MAX_CONNECTION_STATE_ATTEMPTS;
+    private static readonly MAX_DEVICE_INFORMATION_CHANNEL_ATTEMPTS;
+    constructor(channelsService: ChannelsService, channelsPropertiesService: ChannelsPropertiesService, statusListener: VirtualStatusListener);
+    handleDeviceCreated(device: DeviceEntity): Promise<void>;
+    claimDeviceInformationProperty(property: ChannelPropertyEntity): Promise<ChannelPropertyEntity>;
+    private ensureDeviceInformationChannel;
+    private ensureConnectionStateProperty;
+    private claimProperty;
+    private ownedPropertyDefinitions;
+    private ensureOwnedProperty;
+}

package/dist/plugins/devices-virtual/listeners/virtual-device-information.listener.js

@@ -0,0 +1,191 @@
+"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);
+};
+var VirtualDeviceInformationListener_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VirtualDeviceInformationListener = void 0;
+const common_1 = require("@nestjs/common");
+const event_emitter_1 = require("@nestjs/event-emitter");
+const extension_logger_service_1 = require("../../../common/logger/extension-logger.service");
+const devices_constants_1 = require("../../../modules/devices/devices.constants");
+const devices_entity_1 = require("../../../modules/devices/entities/devices.entity");
+const channels_properties_service_1 = require("../../../modules/devices/services/channels.properties.service");
+const channels_service_1 = require("../../../modules/devices/services/channels.service");
+const devices_virtual_constants_1 = require("../devices-virtual.constants");
+const devices_virtual_entity_1 = require("../entities/devices-virtual.entity");
+const virtual_status_listener_1 = require("./virtual-status.listener");
+let VirtualDeviceInformationListener = VirtualDeviceInformationListener_1 = class VirtualDeviceInformationListener {
+    constructor(channelsService, channelsPropertiesService, statusListener) {
+        this.channelsService = channelsService;
+        this.channelsPropertiesService = channelsPropertiesService;
+        this.statusListener = statusListener;
+        this.logger = (0, extension_logger_service_1.createExtensionLogger)(devices_virtual_constants_1.DEVICES_VIRTUAL_PLUGIN_NAME, 'VirtualDeviceInformationListener');
+    }
+    async handleDeviceCreated(device) {
+        if (device.type !== devices_virtual_constants_1.DEVICES_VIRTUAL_TYPE) {
+            return;
+        }
+        try {
+            const channel = await this.ensureDeviceInformationChannel(device);
+            if (!channel) {
+                this.logger.warn(`Device information channel missing for virtual device id=${device.id}, cannot synthesize its properties`);
+                return;
+            }
+            await this.ensureConnectionStateProperty(channel);
+            await this.statusListener.recompute(device.id, 'virtual device created');
+            for (const definition of this.ownedPropertyDefinitions(device)) {
+                await this.ensureOwnedProperty(channel, definition);
+            }
+            this.logger.debug(`Synthesized device information properties for virtual device id=${device.id}`);
+        }
+        catch (error) {
+            this.logger.warn(`Failed to synthesize device information for virtual device id=${device.id}: ${error}`);
+        }
+    }
+    async claimDeviceInformationProperty(property) {
+        if (!(property instanceof devices_virtual_entity_1.VirtualChannelPropertyEntity) || !property.isOrphaned) {
+            return property;
+        }
+        const channel = property.channel;
+        if (!channel || typeof channel === 'string') {
+            this.logger.warn(`Could not resolve the channel of property id=${property.id}, cannot decide whether it is device information`);
+            return property;
+        }
+        if (channel.category !== devices_constants_1.ChannelCategory.DEVICE_INFORMATION) {
+            return property;
+        }
+        await this.claimProperty(property);
+        return property;
+    }
+    async ensureDeviceInformationChannel(device) {
+        for (let attempt = 1; attempt <= VirtualDeviceInformationListener_1.MAX_DEVICE_INFORMATION_CHANNEL_ATTEMPTS; attempt++) {
+            const existing = await this.channelsService.findOneBy('category', devices_constants_1.ChannelCategory.DEVICE_INFORMATION, device.id);
+            if (existing) {
+                return existing;
+            }
+            try {
+                return await this.channelsService.create({
+                    device: device.id,
+                    type: device.type,
+                    identifier: 'device_information',
+                    category: devices_constants_1.ChannelCategory.DEVICE_INFORMATION,
+                    name: 'Device Information',
+                });
+            }
+            catch (error) {
+                this.logger.debug(`Attempt ${attempt} to create the device information channel for device id=${device.id} failed, re-reading: ${error}`);
+            }
+        }
+        return null;
+    }
+    async ensureConnectionStateProperty(channel) {
+        for (let attempt = 1;; attempt++) {
+            const existing = await this.channelsPropertiesService.findOneBy('category', devices_constants_1.PropertyCategory.STATUS, channel.id);
+            if (existing) {
+                await this.claimProperty(existing);
+                return;
+            }
+            try {
+                await this.channelsPropertiesService.create(channel.id, {
+                    type: channel.type,
+                    identifier: 'connection_state',
+                    name: 'Connection State',
+                    category: devices_constants_1.PropertyCategory.STATUS,
+                    permissions: [devices_constants_1.PermissionType.READ_ONLY],
+                    data_type: devices_constants_1.DataTypeType.ENUM,
+                    format: Object.values(devices_constants_1.ConnectionState),
+                    value_origin: devices_virtual_entity_1.VirtualValueOrigin.LOCAL,
+                });
+                return;
+            }
+            catch (error) {
+                if (attempt >= VirtualDeviceInformationListener_1.MAX_CONNECTION_STATE_ATTEMPTS) {
+                    throw error;
+                }
+                this.logger.debug(`Lost the race to create the connection state property in channel id=${channel.id}, re-reading to claim the row that won: ${error}`);
+            }
+        }
+    }
+    async claimProperty(property) {
+        if (!property.isProjecting) {
+            return;
+        }
+        await this.channelsPropertiesService.update(property.id, {
+            type: property.type,
+            value_origin: devices_virtual_entity_1.VirtualValueOrigin.LOCAL,
+            source_property: null,
+            permissions: (0, devices_virtual_entity_1.isUnsupportedOwnedPermissionsPair)(devices_virtual_entity_1.VirtualValueOrigin.LOCAL, property.permissions)
+                ? [devices_constants_1.PermissionType.READ_ONLY]
+                : undefined,
+        });
+        this.logger.debug(`Marked property id=${property.id} as owned by its virtual device`);
+    }
+    ownedPropertyDefinitions(device) {
+        return [
+            {
+                identifier: 'manufacturer',
+                name: 'Manufacturer',
+                category: devices_constants_1.PropertyCategory.MANUFACTURER,
+                value: 'FastyBird',
+            },
+            { identifier: 'model', name: 'Model', category: devices_constants_1.PropertyCategory.MODEL, value: 'Virtual Device' },
+            {
+                identifier: 'serial_number',
+                name: 'Serial Number',
+                category: devices_constants_1.PropertyCategory.SERIAL_NUMBER,
+                value: device.id,
+            },
+        ];
+    }
+    async ensureOwnedProperty(channel, definition) {
+        if (!channel.id) {
+            this.logger.error(`Refusing to synthesize '${definition.identifier}' into a channel with no id; the device information channel was not resolved`);
+            return;
+        }
+        const existing = await this.channelsPropertiesService.findOneBy('category', definition.category, channel.id);
+        if (existing) {
+            return;
+        }
+        const created = await this.channelsPropertiesService.create(channel.id, {
+            type: channel.type,
+            identifier: definition.identifier,
+            name: definition.name,
+            category: definition.category,
+            permissions: [devices_constants_1.PermissionType.READ_ONLY],
+            data_type: devices_constants_1.DataTypeType.STRING,
+            value: definition.value,
+            value_origin: devices_virtual_entity_1.VirtualValueOrigin.LOCAL,
+        });
+        const stillOwned = await this.channelsService.findOne(channel.id);
+        if (stillOwned) {
+            return;
+        }
+        this.logger.warn(`Channel id=${channel.id} was deleted while property id=${created.id} was being synthesized for it; removing the property rather than leaving it with no channel`);
+        await this.channelsPropertiesService.remove(created.id).catch((error) => {
+            this.logger.error(`Failed to remove property id=${created.id} left behind by a deleted channel`, error instanceof Error ? error : undefined);
+        });
+    }
+};
+exports.VirtualDeviceInformationListener = VirtualDeviceInformationListener;
+VirtualDeviceInformationListener.MAX_CONNECTION_STATE_ATTEMPTS = 3;
+VirtualDeviceInformationListener.MAX_DEVICE_INFORMATION_CHANNEL_ATTEMPTS = 3;
+__decorate([
+    (0, event_emitter_1.OnEvent)(devices_constants_1.EventType.DEVICE_CREATED),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [devices_entity_1.DeviceEntity]),
+    __metadata("design:returntype", Promise)
+], VirtualDeviceInformationListener.prototype, "handleDeviceCreated", null);
+exports.VirtualDeviceInformationListener = VirtualDeviceInformationListener = VirtualDeviceInformationListener_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [channels_service_1.ChannelsService,
+        channels_properties_service_1.ChannelsPropertiesService,
+        virtual_status_listener_1.VirtualStatusListener])
+], VirtualDeviceInformationListener);
+//# sourceMappingURL=virtual-device-information.listener.js.map

package/dist/plugins/devices-virtual/listeners/virtual-device-information.listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-device-information.listener.js","sourceRoot":"","sources":["../../../../src/plugins/devices-virtual/listeners/virtual-device-information.listener.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,yDAAgD;AAEhD,8FAAwF;AACxF,kFAOoD;AACpD,qFAAsH;AACtH,+GAA0G;AAC1G,yFAAqF;AACrF,4EAAiG;AACjG,+EAI4C;AAE5C,uEAAkE;AAkF3D,IAAM,gCAAgC,wCAAtC,MAAM,gCAAgC;IAmB5C,YACkB,eAAgC,EAChC,yBAAoD,EACpD,cAAqC;QAFrC,oBAAe,GAAf,eAAe,CAAiB;QAChC,8BAAyB,GAAzB,yBAAyB,CAA2B;QACpD,mBAAc,GAAd,cAAc,CAAuB;QArBtC,WAAM,GAAG,IAAA,gDAAqB,EAAC,uDAA2B,EAAE,kCAAkC,CAAC,CAAC;IAsB9G,CAAC;IAGE,AAAN,KAAK,CAAC,mBAAmB,CAAC,MAAoB;QAC7C,IAAI,MAAM,CAAC,IAAI,KAAK,gDAAoB,EAAE,CAAC;YAC1C,OAAO;QACR,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;YAElE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,4DAA4D,MAAM,CAAC,EAAE,oCAAoC,CACzG,CAAC;gBAEF,OAAO;YACR,CAAC;YAID,MAAM,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;YAMlD,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,wBAAwB,CAAC,CAAC;YAEzE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChE,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACrD,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mEAAmE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QACnG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAKhB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iEAAiE,MAAM,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC;QAC1G,CAAC;IACF,CAAC;IAkCD,KAAK,CAAC,8BAA8B,CAAC,QAA+B;QACnE,IAAI,CAAC,CAAC,QAAQ,YAAY,qDAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACjF,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEjC,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAK7C,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,gDAAgD,QAAQ,CAAC,EAAE,kDAAkD,CAC7G,CAAC;YAEF,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,KAAK,mCAAe,CAAC,kBAAkB,EAAE,CAAC;YAC7D,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAEnC,OAAO,QAAQ,CAAC;IACjB,CAAC;IAqCO,KAAK,CAAC,8BAA8B,CAAC,MAAoB;QAChE,KACC,IAAI,OAAO,GAAG,CAAC,EACf,OAAO,IAAI,kCAAgC,CAAC,uCAAuC,EACnF,OAAO,EAAE,EACR,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,UAAU,EAAE,mCAAe,CAAC,kBAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;YAEjH,IAAI,QAAQ,EAAE,CAAC;gBACd,OAAO,QAAQ,CAAC;YACjB,CAAC;YAED,IAAI,CAAC;gBACJ,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;oBACxC,MAAM,EAAE,MAAM,CAAC,EAAE;oBACjB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,UAAU,EAAE,oBAAoB;oBAChC,QAAQ,EAAE,mCAAe,CAAC,kBAAkB;oBAC5C,IAAI,EAAE,oBAAoB;iBAC1B,CAAC,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,WAAW,OAAO,2DAA2D,MAAM,CAAC,EAAE,wBAAwB,KAAK,EAAE,CACrH,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IA2CO,KAAK,CAAC,6BAA6B,CAAC,OAAsB;QACjE,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAC9D,UAAU,EACV,oCAAgB,CAAC,MAAM,EACvB,OAAO,CAAC,EAAE,CACV,CAAC;YAEF,IAAI,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAEnC,OAAO;YACR,CAAC;YAED,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE;oBACvD,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,UAAU,EAAE,kBAAkB;oBAC9B,IAAI,EAAE,kBAAkB;oBACxB,QAAQ,EAAE,oCAAgB,CAAC,MAAM;oBACjC,WAAW,EAAE,CAAC,kCAAc,CAAC,SAAS,CAAC;oBACvC,SAAS,EAAE,gCAAY,CAAC,IAAI;oBAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,mCAAe,CAAC;oBACtC,YAAY,EAAE,2CAAkB,CAAC,KAAK;iBACtC,CAAC,CAAC;gBAEH,OAAO;YACR,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,OAAO,IAAI,kCAAgC,CAAC,6BAA6B,EAAE,CAAC;oBAC/E,MAAM,KAAK,CAAC;gBACb,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,uEAAuE,OAAO,CAAC,EAAE,2CAA2C,KAAK,EAAE,CACnI,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAgCO,KAAK,CAAC,aAAa,CAAC,QAAsC;QACjE,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;YAC5B,OAAO;QACR,CAAC;QAED,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE;YACxD,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,YAAY,EAAE,2CAAkB,CAAC,KAAK;YACtC,eAAe,EAAE,IAAI;YAIrB,WAAW,EAAE,IAAA,0DAAiC,EAAC,2CAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC;gBAC7F,CAAC,CAAC,CAAC,kCAAc,CAAC,SAAS,CAAC;gBAC5B,CAAC,CAAC,SAAS;SACZ,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,QAAQ,CAAC,EAAE,iCAAiC,CAAC,CAAC;IACvF,CAAC;IAEO,wBAAwB,CAAC,MAAoB;QACpD,OAAO;YACN;gBACC,UAAU,EAAE,cAAc;gBAC1B,IAAI,EAAE,cAAc;gBACpB,QAAQ,EAAE,oCAAgB,CAAC,YAAY;gBACvC,KAAK,EAAE,WAAW;aAClB;YACD,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,oCAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE;YACjG;gBACC,UAAU,EAAE,eAAe;gBAC3B,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,oCAAgB,CAAC,aAAa;gBACxC,KAAK,EAAE,MAAM,CAAC,EAAE;aAChB;SACD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,OAAsB,EAAE,UAAmC;QAM5F,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,2BAA2B,UAAU,CAAC,UAAU,8EAA8E,CAC9H,CAAC;YAEF,OAAO;QACR,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7G,IAAI,QAAQ,EAAE,CAAC;YACd,OAAO;QACR,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE;YACvE,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,WAAW,EAAE,CAAC,kCAAc,CAAC,SAAS,CAAC;YACvC,SAAS,EAAE,gCAAY,CAAC,MAAM;YAC9B,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,YAAY,EAAE,2CAAkB,CAAC,KAAK;SACtC,CAAC,CAAC;QAYH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,UAAU,EAAE,CAAC;YAChB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,cAAc,OAAO,CAAC,EAAE,kCAAkC,OAAO,CAAC,EAAE,6FAA6F,CACjK,CAAC;QAEF,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAQ,EAAE;YACtF,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,gCAAgC,OAAO,CAAC,EAAE,mCAAmC,EAC7E,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAC1C,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;;AA5YW,4EAAgC;AAUpB,8DAA6B,GAAG,CAAC,AAAJ,CAAK;AAOlC,wEAAuC,GAAG,CAAC,AAAJ,CAAK;AAS9D;IADL,IAAA,uBAAO,EAAC,6BAAS,CAAC,cAAc,CAAC;;qCACA,6BAAY;;2EAsC7C;2CAhEW,gCAAgC;IAD5C,IAAA,mBAAU,GAAE;qCAqBuB,kCAAe;QACL,uDAAyB;QACpC,+CAAqB;GAtB3C,gCAAgC,CA6Y5C"}

package/dist/plugins/devices-virtual/listeners/virtual-index-maintenance.listener.d.ts

@@ -0,0 +1,55 @@
+import { DataSource, Repository } from 'typeorm';
+import { OnApplicationBootstrap } from '@nestjs/common';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { ChannelEntity, ChannelPropertyEntity, DeviceEntity } from '../../../modules/devices/entities/devices.entity';
+import { ChannelsPropertiesService } from '../../../modules/devices/services/channels.properties.service';
+import { DeviceStructureLockService } from '../../../modules/devices/services/device-structure-lock.service';
+import { DevicesService } from '../../../modules/devices/services/devices.service';
+import { VirtualDevicesService } from '../services/virtual-devices.service';
+import { VirtualPropertyIndexService } from '../services/virtual-property-index.service';
+import { VirtualStatusListener } from './virtual-status.listener';
+export declare class VirtualIndexMaintenanceListener implements OnApplicationBootstrap {
+    private readonly index;
+    private readonly status;
+    private readonly devicesService;
+    private readonly virtualDevicesService;
+    private readonly channelsPropertiesService;
+    private readonly structureLock;
+    private readonly eventEmitter;
+    private readonly dataSource;
+    private readonly devicesRepository;
+    private readonly logger;
+    private static readonly TRANSACTION_SETTLE_IMMEDIATE_POLLS;
+    private static readonly TRANSACTION_SETTLE_TIMER_POLLS;
+    private static readonly TRANSACTION_SETTLE_TIMER_INTERVAL_MS;
+    private static readonly MAX_REPAIR_PASSES;
+    private static readonly REPAIR_PASS_DELAY_MS;
+    private static readonly MAX_REBUILD_ATTEMPTS;
+    private running;
+    private pending;
+    private repairTimer;
+    private repairPasses;
+    private readonly pendingUnhideSourceDeviceIds;
+    private readonly pendingAnnounceVirtualDeviceIds;
+    private readonly pendingRecheckChannelIds;
+    private connectionStoppedSettling;
+    constructor(index: VirtualPropertyIndexService, status: VirtualStatusListener, devicesService: DevicesService, virtualDevicesService: VirtualDevicesService, channelsPropertiesService: ChannelsPropertiesService, structureLock: DeviceStructureLockService, eventEmitter: EventEmitter2, dataSource: DataSource, devicesRepository: Repository<DeviceEntity>);
+    onApplicationBootstrap(): Promise<void>;
+    handleStructuralChange(): void;
+    private runRebuildLoop;
+    private scheduleRepairPass;
+    private announceOrphanedProjections;
+    private recomputeStatuses;
+    private reconcileSystemHiddenSources;
+    private rebuildWithRetry;
+    private unhideAbandonedSources;
+    private isSystemHidden;
+    handleSourceChannelChange(payload: ChannelEntity): Promise<void>;
+    private promoteEnergyClaim;
+    private reconcileEnergyClaims;
+    private recheckPendingChannels;
+    handleSourceMetadataChange(payload: ChannelPropertyEntity): Promise<void>;
+    private unhideSource;
+    private looksTransientSqliteError;
+    private deferPastOpenTransaction;
+}