@iobroker/dm-utils 0.1.2 → 0.1.4

package/README.md

@@ -294,7 +294,10 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
-### 0.1.2 (2023-12-10)
+### 0.1.4 (2023-12-13)
+* (bluefox) added error codes
+
+### 0.1.3 (2023-12-10)
 * (bluefox) added some fields to DeviceInfo interface
 * (bluefox) added control possibilities
 

package/build/DeviceManagement.d.ts

@@ -15,10 +15,10 @@ export declare abstract class DeviceManagement<T extends AdapterInstance = Adapt
     protected getDeviceDetails(id: string): RetVal<DeviceDetails | null | {
         error: string;
     }>;
-    protected handleInstanceAction(actionId: string, context: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
-    protected handleDeviceAction(deviceId: string, actionId: string, context: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
-    protected handleDeviceControl(deviceId: string, controlId: string, newState: ControlState, context: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
-    protected handleDeviceControlState(deviceId: string, controlId: string, context: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
+    protected handleInstanceAction(actionId: string, context?: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
+    protected handleDeviceAction(deviceId: string, actionId: string, context?: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
+    protected handleDeviceControl(deviceId: string, controlId: string, newState: ControlState, context?: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
+    protected handleDeviceControlState(deviceId: string, controlId: string, context?: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
     private onMessage;
     private handleMessage;
     private convertActions;

package/build/DeviceManagement.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageContext = exports.DeviceManagement = void 0;
+const types_1 = require("./types");
 class DeviceManagement {
     constructor(adapter) {
         this.adapter = adapter;
@@ -20,17 +21,17 @@ class DeviceManagement {
         var _a;
         if (!this.instanceInfo) {
             this.log.warn(`Instance action ${actionId} was called before getInstanceInfo()`);
-            return { error: { code: 101, message: `Instance action ${actionId} was called before getInstanceInfo()` } };
+            return { error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_NOT_INITIALIZED, message: `Instance action ${actionId} was called before getInstanceInfo()` } };
         }
         const action = (_a = this.instanceInfo.actions) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === actionId);
         if (!action) {
             this.log.warn(`Instance action ${actionId} is unknown`);
-            return { error: { code: 102, message: `Instance action ${actionId} is unknown` } };
+            return { error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_UNKNOWN, message: `Instance action ${actionId} is unknown` } };
         }
         if (!action.handler) {
             this.log.warn(`Instance action ${actionId} is disabled because it has no handler`);
             return {
-                error: { code: 103, message: `Instance action ${actionId} is disabled because it has no handler` },
+                error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_NO_HANDLER, message: `Instance action ${actionId} is disabled because it has no handler` },
             };
         }
         return action.handler(context);
@@ -39,25 +40,25 @@ class DeviceManagement {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device action ${actionId} was called before listDevices()`);
-            return { error: { code: 201, message: `Device action ${actionId} was called before listDevices()` } };
+            return { error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_NOT_INITIALIZED, message: `Device action ${actionId} was called before listDevices()` } };
         }
         const device = this.devices.get(deviceId);
         if (!device) {
             this.log.warn(`Device action ${actionId} was called on unknown device: ${deviceId}`);
             return {
-                error: { code: 202, message: `Device action ${actionId} was called on unknown device: ${deviceId}` },
+                error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_DEVICE_UNKNOWN, message: `Device action ${actionId} was called on unknown device: ${deviceId}` },
             };
         }
         const action = (_a = device.actions) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === actionId);
         if (!action) {
             this.log.warn(`Device action ${actionId} doesn't exist on device ${deviceId}`);
-            return { error: { code: 203, message: `Device action ${actionId} doesn't exist on device ${deviceId}` } };
+            return { error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_UNKNOWN, message: `Device action ${actionId} doesn't exist on device ${deviceId}` } };
         }
         if (!action.handler) {
             this.log.warn(`Device action ${actionId} on ${deviceId} is disabled because it has no handler`);
             return {
                 error: {
-                    code: 204,
+                    code: types_1.ErrorCodes.E_DEVICE_ACTION_NO_HANDLER,
                     message: `Device action ${actionId} on ${deviceId} is disabled because it has no handler`,
                 },
             };
@@ -68,25 +69,25 @@ class DeviceManagement {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device control ${controlId} was called before listDevices()`);
-            return { error: { code: 201, message: `Device control ${controlId} was called before listDevices()` } };
+            return { error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_NOT_INITIALIZED, message: `Device control ${controlId} was called before listDevices()` } };
         }
         const device = this.devices.get(deviceId);
         if (!device) {
             this.log.warn(`Device control ${controlId} was called on unknown device: ${deviceId}`);
             return {
-                error: { code: 202, message: `Device control ${controlId} was called on unknown device: ${deviceId}` },
+                error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_DEVICE_UNKNOWN, message: `Device control ${controlId} was called on unknown device: ${deviceId}` },
             };
         }
         const control = (_a = device.controls) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === controlId);
         if (!control) {
             this.log.warn(`Device control ${controlId} doesn't exist on device ${deviceId}`);
-            return { error: { code: 203, message: `Device control ${controlId} doesn't exist on device ${deviceId}` } };
+            return { error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_UNKNOWN, message: `Device control ${controlId} doesn't exist on device ${deviceId}` } };
         }
         if (!control.handler) {
             this.log.warn(`Device control ${controlId} on ${deviceId} is disabled because it has no handler`);
             return {
                 error: {
-                    code: 204,
+                    code: types_1.ErrorCodes.E_DEVICE_CONTROL_NO_HANDLER,
                     message: `Device control ${controlId} on ${deviceId} is disabled because it has no handler`,
                 },
             };

package/build/types/base.d.ts

@@ -36,7 +36,7 @@ export interface ControlBase {
         color?: Color;
     }[];
 }
-export interface DeviceControl<T extends ActionType = "api"> extends ActionBase<T> {
+export interface DeviceControl<T extends ActionType = "api"> extends ControlBase {
     handler?: T extends "api" ? never : (deviceId: string, actionId: string, state: ControlState, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
     getStateHandler?: T extends "api" ? never : (deviceId: string, actionId: string, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
 }

package/build/types/common.d.ts

@@ -5,7 +5,7 @@ export type DeviceStatus = "connected" | "disconnected" | {
      */
     icon?: string;
     battery?: number | boolean | "charging" | string;
-    connection: "connected" | "disconnected";
+    connection?: "connected" | "disconnected";
     rssi?: number;
     warning?: ioBroker.StringOrTranslated | boolean;
 };

package/build/types/errorCodes.d.ts

@@ -0,0 +1,14 @@
+export declare enum ErrorCodes {
+    E_INSTANCE_ACTION_NOT_INITIALIZED = 101,
+    E_INSTANCE_ACTION_UNKNOWN = 102,
+    E_INSTANCE_ACTION_NO_HANDLER = 103,
+    E_DEVICE_ACTION_NOT_INITIALIZED = 201,
+    E_DEVICE_ACTION_DEVICE_UNKNOWN = 202,
+    E_DEVICE_ACTION_UNKNOWN = 203,
+    E_DEVICE_ACTION_NO_HANDLER = 204,
+    E_DEVICE_CONTROL_NOT_INITIALIZED = 301,
+    E_DEVICE_CONTROL_DEVICE_UNKNOWN = 302,
+    E_DEVICE_CONTROL_UNKNOWN = 303,
+    E_DEVICE_CONTROL_NO_HANDLER = 304,
+    E_DEVICE_CONTROL_NO_STATE = 305
+}

package/build/types/errorCodes.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCodes = void 0;
+var ErrorCodes;
+(function (ErrorCodes) {
+    ErrorCodes[ErrorCodes["E_INSTANCE_ACTION_NOT_INITIALIZED"] = 101] = "E_INSTANCE_ACTION_NOT_INITIALIZED";
+    ErrorCodes[ErrorCodes["E_INSTANCE_ACTION_UNKNOWN"] = 102] = "E_INSTANCE_ACTION_UNKNOWN";
+    ErrorCodes[ErrorCodes["E_INSTANCE_ACTION_NO_HANDLER"] = 103] = "E_INSTANCE_ACTION_NO_HANDLER";
+    ErrorCodes[ErrorCodes["E_DEVICE_ACTION_NOT_INITIALIZED"] = 201] = "E_DEVICE_ACTION_NOT_INITIALIZED";
+    ErrorCodes[ErrorCodes["E_DEVICE_ACTION_DEVICE_UNKNOWN"] = 202] = "E_DEVICE_ACTION_DEVICE_UNKNOWN";
+    ErrorCodes[ErrorCodes["E_DEVICE_ACTION_UNKNOWN"] = 203] = "E_DEVICE_ACTION_UNKNOWN";
+    ErrorCodes[ErrorCodes["E_DEVICE_ACTION_NO_HANDLER"] = 204] = "E_DEVICE_ACTION_NO_HANDLER";
+    ErrorCodes[ErrorCodes["E_DEVICE_CONTROL_NOT_INITIALIZED"] = 301] = "E_DEVICE_CONTROL_NOT_INITIALIZED";
+    ErrorCodes[ErrorCodes["E_DEVICE_CONTROL_DEVICE_UNKNOWN"] = 302] = "E_DEVICE_CONTROL_DEVICE_UNKNOWN";
+    ErrorCodes[ErrorCodes["E_DEVICE_CONTROL_UNKNOWN"] = 303] = "E_DEVICE_CONTROL_UNKNOWN";
+    ErrorCodes[ErrorCodes["E_DEVICE_CONTROL_NO_HANDLER"] = 304] = "E_DEVICE_CONTROL_NO_HANDLER";
+    ErrorCodes[ErrorCodes["E_DEVICE_CONTROL_NO_STATE"] = 305] = "E_DEVICE_CONTROL_NO_STATE";
+})(ErrorCodes || (exports.ErrorCodes = ErrorCodes = {}));

package/build/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./adapter";
 export * from "./common";
+export * from "./errorCodes";

package/build/types/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./adapter"), exports);
 __exportStar(require("./common"), exports);
+__exportStar(require("./errorCodes"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {