freeathome-local-api-client 0.2.0-pre

package/dist/src/model/scenes-triggered.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Describes the ScenesTriggered object that is included in the @see WebSocketMessage.
+ *
+ * @interface
+ */
+export interface ScenesTriggered {
+    [key: string]: {
+        channels: {
+            [key: string]: {
+                outputs: {
+                    [key: string]: {
+                        value: string;
+                        pairingID: number;
+                    };
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=scenes-triggered.d.ts.map

package/dist/src/model/scenes-triggered.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenes-triggered.d.ts","sourceRoot":"","sources":["../../../src/model/scenes-triggered.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,QAAQ,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG;gBACb,OAAO,EAAE;oBACP,CAAC,GAAG,EAAE,MAAM,GAAG;wBACb,KAAK,EAAE,MAAM,CAAC;wBACd,SAAS,EAAE,MAAM,CAAC;qBACnB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;CACH"}

package/dist/src/model/set-data-point-response.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Describes a response to a request setting a new value for a data point.
+ *
+ * @interface
+ */
+export interface SetDataPointResponse {
+    [key: string]: {
+        [key: string]: string;
+    };
+}
+//# sourceMappingURL=set-data-point-response.d.ts.map

package/dist/src/model/set-data-point-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-data-point-response.d.ts","sourceRoot":"","sources":["../../../src/model/set-data-point-response.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH"}

package/dist/src/model/sys-ap.d.ts

@@ -0,0 +1,18 @@
+import { Devices } from "./devices";
+import { Floors } from "./floors";
+import { Users } from "./users";
+/**
+ * Describes a system access point
+ *
+ * @interface
+ */
+export interface SysAP {
+    devices: Devices;
+    floorplan: {
+        floors: Floors;
+    };
+    sysapName: string;
+    users: Users;
+    error?: Error;
+}
+//# sourceMappingURL=sys-ap.d.ts.map

package/dist/src/model/sys-ap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sys-ap.d.ts","sourceRoot":"","sources":["../../../src/model/sys-ap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,KAAK,CAAC;CACf"}

package/dist/src/model/users.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Describes the user collection
+ *
+ * @interface
+ */
+export interface Users {
+    [key: string]: {
+        enabled: boolean;
+        flags: Array<string>;
+        grantedPermissions: Array<string>;
+        jid: string;
+        name: string;
+        requestedPermissions: Array<string>;
+        role: string;
+    };
+}
+//# sourceMappingURL=users.d.ts.map

package/dist/src/model/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/model/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACrB,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH"}

package/dist/src/model/validation/channel-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const ChannelTypeSuite: ITypeSuite;
+//# sourceMappingURL=channel-ti.d.ts.map

package/dist/src/model/validation/channel-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/channel-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAwB,MAAM,sBAAsB,CAAC;AAoBxE,eAAO,MAAM,gBAAgB,EAAE,UAE9B,CAAC"}

package/dist/src/model/validation/configuration-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const ConfigurationTypeSuite: ITypeSuite;
+//# sourceMappingURL=configuration-ti.d.ts.map

package/dist/src/model/validation/configuration-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/configuration-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAMnE,eAAO,MAAM,sBAAsB,EAAE,UAEpC,CAAC"}

package/dist/src/model/validation/device-list-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const DeviceListTypeSuite: ITypeSuite;
+//# sourceMappingURL=device-list-ti.d.ts.map

package/dist/src/model/validation/device-list-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-list-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/device-list-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAM1E,eAAO,MAAM,mBAAmB,EAAE,UAEjC,CAAC"}

package/dist/src/model/validation/device-response-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const DeviceResponseTypeSuite: ITypeSuite;
+//# sourceMappingURL=device-response-ti.d.ts.map

package/dist/src/model/validation/device-response-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-response-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/device-response-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQnE,eAAO,MAAM,uBAAuB,EAAE,UAErC,CAAC"}

package/dist/src/model/validation/device-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const DeviceTypeSuite: ITypeSuite;
+//# sourceMappingURL=device-ti.d.ts.map

package/dist/src/model/validation/device-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/device-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAexE,eAAO,MAAM,eAAe,EAAE,UAE7B,CAAC"}

package/dist/src/model/validation/devices-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const DevicesTypeSuite: ITypeSuite;
+//# sourceMappingURL=devices-ti.d.ts.map

package/dist/src/model/validation/devices-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/devices-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAMnE,eAAO,MAAM,gBAAgB,EAAE,UAE9B,CAAC"}

package/dist/src/model/validation/error-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const ErrorTypeSuite: ITypeSuite;
+//# sourceMappingURL=error-ti.d.ts.map

package/dist/src/model/validation/error-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/error-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQzD,eAAO,MAAM,cAAc,EAAE,UAE5B,CAAC"}

package/dist/src/model/validation/floors-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const FloorsTypeSuite: ITypeSuite;
+//# sourceMappingURL=floors-ti.d.ts.map

package/dist/src/model/validation/floors-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"floors-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/floors-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AASnE,eAAO,MAAM,eAAe,EAAE,UAE7B,CAAC"}

package/dist/src/model/validation/get-data-point-response-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const GetDataPointResponseTypeSuite: ITypeSuite;
+//# sourceMappingURL=get-data-point-response-ti.d.ts.map

package/dist/src/model/validation/get-data-point-response-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-data-point-response-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/get-data-point-response-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQ1E,eAAO,MAAM,6BAA6B,EAAE,UAE3C,CAAC"}

package/dist/src/model/validation/in-out-put-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const InOutPutTypeSuite: ITypeSuite;
+//# sourceMappingURL=in-out-put-ti.d.ts.map

package/dist/src/model/validation/in-out-put-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-out-put-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/in-out-put-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAO9D,eAAO,MAAM,iBAAiB,EAAE,UAE/B,CAAC"}

package/dist/src/model/validation/index.d.ts

@@ -0,0 +1,18 @@
+export { ChannelTypeSuite } from "./channel-ti";
+export { ConfigurationTypeSuite } from "./configuration-ti";
+export { DeviceTypeSuite } from "./device-ti";
+export { DeviceListTypeSuite } from "./device-list-ti";
+export { DeviceResponseTypeSuite } from "./device-response-ti";
+export { DevicesTypeSuite } from "./devices-ti";
+export { ErrorTypeSuite } from "./error-ti";
+export { FloorsTypeSuite } from "./floors-ti";
+export { GetDataPointResponseTypeSuite } from "./get-data-point-response-ti";
+export { InOutPutTypeSuite } from "./in-out-put-ti";
+export { RoomsTypeSuite } from "./rooms-ti";
+export { ScenesTriggeredTypeSuite } from "./scenes-triggered-ti";
+export { SetDataPointResponseTypeSuite } from "./set-data-point-response-ti";
+export { SysApTypeSuite } from "./sys-ap-ti";
+export { UsersTypeSuite } from "./users-ti";
+export { VirtualDeviceResponseTypeSuite } from "./virtual-device-response-ti";
+export { WebSocketMessageTypeSuite } from "./websocket-message-ti";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/model/validation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,8BAA8B,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/src/model/validation/rooms-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const RoomsTypeSuite: ITypeSuite;
+//# sourceMappingURL=rooms-ti.d.ts.map

package/dist/src/model/validation/rooms-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rooms-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/rooms-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQnE,eAAO,MAAM,cAAc,EAAE,UAE5B,CAAC"}

package/dist/src/model/validation/scenes-triggered-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const ScenesTriggeredTypeSuite: ITypeSuite;
+//# sourceMappingURL=scenes-triggered-ti.d.ts.map

package/dist/src/model/validation/scenes-triggered-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenes-triggered-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/scenes-triggered-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAiBnE,eAAO,MAAM,wBAAwB,EAAE,UAEtC,CAAC"}

package/dist/src/model/validation/set-data-point-response-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const SetDataPointResponseTypeSuite: ITypeSuite;
+//# sourceMappingURL=set-data-point-response-ti.d.ts.map

package/dist/src/model/validation/set-data-point-response-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-data-point-response-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/set-data-point-response-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQnE,eAAO,MAAM,6BAA6B,EAAE,UAE3C,CAAC"}

package/dist/src/model/validation/sys-ap-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const SysApTypeSuite: ITypeSuite;
+//# sourceMappingURL=sys-ap-ti.d.ts.map

package/dist/src/model/validation/sys-ap-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sys-ap-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/sys-ap-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAY9D,eAAO,MAAM,cAAc,EAAE,UAE5B,CAAC"}

package/dist/src/model/validation/users-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const UsersTypeSuite: ITypeSuite;
+//# sourceMappingURL=users-ti.d.ts.map

package/dist/src/model/validation/users-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/users-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAc1E,eAAO,MAAM,cAAc,EAAE,UAE5B,CAAC"}

package/dist/src/model/validation/virtual-device-response-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const VirtualDeviceResponseTypeSuite: ITypeSuite;
+//# sourceMappingURL=virtual-device-response-ti.d.ts.map

package/dist/src/model/validation/virtual-device-response-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-device-response-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/virtual-device-response-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAYnE,eAAO,MAAM,8BAA8B,EAAE,UAE5C,CAAC"}

package/dist/src/model/validation/websocket-message-ti.d.ts

@@ -0,0 +1,3 @@
+import { ITypeSuite } from "ts-interface-checker";
+export declare const WebSocketMessageTypeSuite: ITypeSuite;
+//# sourceMappingURL=websocket-message-ti.d.ts.map

package/dist/src/model/validation/websocket-message-ti.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-message-ti.d.ts","sourceRoot":"","sources":["../../../../src/model/validation/websocket-message-ti.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAgB1E,eAAO,MAAM,yBAAyB,EAAE,UAEvC,CAAC"}

package/dist/src/model/validator.d.ts

@@ -0,0 +1,57 @@
+import { WebSocketMessage as Message } from "./websocket-message";
+import { Configuration as Config } from "./configuration";
+import { DeviceList as DevList } from "./device-list";
+import { DeviceResponse as DevResponse } from "./device-response";
+import { GetDataPointResponse as GetResponse } from "./get-data-point-response";
+import { SetDataPointResponse as SetResponse } from "./set-data-point-response";
+import { VirtualDeviceResponse as VDeviceResponse } from "./virtual-device-response";
+/**
+ * Determines whether the specified object is a web socket message.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see Message.
+ */
+export declare function isWebSocketMessage(obj: unknown, verbose?: boolean): obj is Message;
+/**
+ * Determines whether the specified object is a configuration.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see Config.
+ */
+export declare function isConfiguration(obj: unknown, verbose?: boolean): obj is Config;
+/**
+ * Determines whether the specified object is a device list.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see DevList.
+ */
+export declare function isDeviceList(obj: unknown, verbose?: boolean): obj is DevList;
+/**
+ * Determines whether the specified object is a device response.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see DevResponse.
+ */
+export declare function isDeviceResponse(obj: unknown, verbose?: boolean): obj is DevResponse;
+/**
+ * Determines whether the specified object is a valid response to a get data point request.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see GetResponse.
+ */
+export declare function isGetDataPointResponse(obj: unknown, verbose?: boolean): obj is GetResponse;
+/**
+ * Determines whether the specified object is a valid response to a set data point request.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see SetResponse.
+ */
+export declare function isSetDataPointResponse(obj: unknown, verbose?: boolean): obj is SetResponse;
+/**
+ * Determines whether the specified object is a virtual device response.
+ * @param obj The object to be tested
+ * @param verbose Determines whether validation errors shall be logged. Default value is false.
+ * @returns A boolean value indicating whether the specified object is a @see VDeviceResponse.
+ */
+export declare function isVirtualDeviceResponse(obj: unknown, verbose?: boolean): obj is VDeviceResponse;
+//# sourceMappingURL=validator.d.ts.map

package/dist/src/model/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../../src/model/validator.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,cAAc,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,oBAAoB,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,oBAAoB,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,qBAAqB,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAwDrF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,OAAO,EACZ,OAAO,UAAQ,GACd,GAAG,IAAI,OAAO,CAEhB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,UAAQ,GAAG,GAAG,IAAI,MAAM,CAE5E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,UAAQ,GAAG,GAAG,IAAI,OAAO,CAE1E;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,OAAO,EACZ,OAAO,UAAQ,GACd,GAAG,IAAI,WAAW,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,OAAO,UAAQ,GACd,GAAG,IAAI,WAAW,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,OAAO,UAAQ,GACd,GAAG,IAAI,WAAW,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,OAAO,UAAQ,GACd,GAAG,IAAI,eAAe,CAExB"}

package/dist/src/model/virtual-device-response.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Describes a response to a request creating a new virtual device.
+ *
+ * @interface
+ */
+export interface VirtualDeviceResponse {
+    [key: string]: {
+        devices: {
+            [key: string]: {
+                serial: string;
+            };
+        };
+    };
+}
+//# sourceMappingURL=virtual-device-response.d.ts.map

package/dist/src/model/virtual-device-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-device-response.d.ts","sourceRoot":"","sources":["../../../src/model/virtual-device-response.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,OAAO,EAAE;YACP,CAAC,GAAG,EAAE,MAAM,GAAG;gBACb,MAAM,EAAE,MAAM,CAAC;aAChB,CAAC;SACH,CAAC;KACH,CAAC;CACH"}

package/dist/src/model/virtual-device.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Defines a virtual device
+ *
+ * @interface
+ */
+export interface VirtualDevice {
+    type: VirtualDeviceType;
+    properties?: {
+        ttl?: string;
+        displayname?: string;
+    };
+}
+/**
+ * Defines the possible types of virtual devices
+ *
+ * @enum
+ */
+export declare enum VirtualDeviceType {
+    BinarySensor = "BinarySensor",
+    BlindActuator = "BlindActuator",
+    SwitchingActuator = "SwitchingActuator",
+    CeilingFanActuator = "CeilingFanActuator",
+    RTC = "RTC",
+    DimActuator = "DimActuator",
+    EVCharging = "evcharging",
+    WindowSensor = "WindowSensor",
+    SimpleDoorlock = "simple_doorlock",
+    ShutterActuator = "ShutterActuator",
+    WeatherStation = "WeatherStation",
+    WeatherTemperatureSensor = "Weather-TemperatureSensor",
+    WeatherWindSensor = "Weather-WindSensor",
+    WeatherBrightnessSensor = "Weather-BrightnessSensor",
+    WeatherRainSensor = "Weather-RainSensor",
+    WindowActuator = "WindowActuator",
+    CODetector = "CODetector",
+    FireDetector = "FireDetector",
+    KNXSwitchSensor = "KNX-SwitchSensor",
+    MediaPlayer = "MediaPlayer",
+    EnergyBattery = "EnergyBattery",
+    EnergyInverter = "EnergyInverter",
+    EnergyMeter = "EnergyMeter",
+    EnergyInverterBattery = "EnergyInverterBattery",
+    EnergyInverterMeter = "EnergyInverterMeter",
+    EnergyInverterMeterBattery = "EnergyInverterMeterBattery",
+    EnergyMeterBattery = "EnergyMeterBattery",
+    AirQualityCO2 = "AirQualityCO2",
+    AirQualityCO = "AirQualityCO",
+    AirQualityFull = "AirQualityFull",
+    AirQualityHumidity = "AirQualityHumidity",
+    AirQualityNO2 = "AirQualityNO2",
+    AirQualityO3 = "AirQualityO3",
+    AirQualityPM10 = "AirQualityPM10",
+    AirQualityPM25 = "AirQualityPM25",
+    AirQualityPressure = "AirQualityPressure",
+    AirQualityTemperature = "AirQualityTemperature",
+    AirQualityVOC = "AirQualityVOC"
+}
+//# sourceMappingURL=virtual-device.d.ts.map

package/dist/src/model/virtual-device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-device.d.ts","sourceRoot":"","sources":["../../../src/model/virtual-device.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,iBAAiB,CAAC;IACxB,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,iBAAiB,sBAAsB;IACvC,kBAAkB,uBAAuB;IACzC,GAAG,QAAQ;IACX,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,cAAc,oBAAoB;IAClC,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,wBAAwB,8BAA8B;IACtD,iBAAiB,uBAAuB;IACxC,uBAAuB,6BAA6B;IACpD,iBAAiB,uBAAuB;IACxC,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,eAAe,qBAAqB;IACpC,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;IAC3B,qBAAqB,0BAA0B;IAC/C,mBAAmB,wBAAwB;IAC3C,0BAA0B,+BAA+B;IACzD,kBAAkB,uBAAuB;IACzC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,kBAAkB,uBAAuB;IACzC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,cAAc,mBAAmB;IACjC,kBAAkB,uBAAuB;IACzC,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;CAChC"}

package/dist/src/model/websocket-message.d.ts

@@ -0,0 +1,21 @@
+import { Devices } from "./devices";
+import { ScenesTriggered } from "./scenes-triggered";
+/**
+ * Represents a message that was received from the System Access Point web socket.
+ *
+ * @interface
+ */
+export interface WebSocketMessage {
+    [key: string]: {
+        datapoints: {
+            [key: string]: string;
+        };
+        devices: {
+            [key: string]: Devices;
+        };
+        devicesAdded: Array<string>;
+        devicesRemoved: Array<string>;
+        scenesTriggered: ScenesTriggered;
+    };
+}
+//# sourceMappingURL=websocket-message.d.ts.map

package/dist/src/model/websocket-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-message.d.ts","sourceRoot":"","sources":["../../../src/model/websocket-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,UAAU,EAAE;YACV,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;SACvB,CAAC;QACF,OAAO,EAAE;YACP,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9B,eAAe,EAAE,eAAe,CAAC;KAClC,CAAC;CACH"}

package/dist/src/system-access-point.d.ts

@@ -0,0 +1,96 @@
+import { Observable } from "rxjs";
+import { Configuration, DeviceList, DeviceResponse, GetDataPointResponse, SetDataPointResponse, WebSocketMessage, VirtualDevice, VirtualDeviceResponse } from "./model";
+/**
+ * The class representing a System Access Point.
+ *
+ * @class
+ */
+export declare class SystemAccessPoint {
+    /** The basic authentication key used for requests. */
+    readonly basicAuthKey: string;
+    /** The host name of the system access point. */
+    readonly hostName: string;
+    /** Determines whether requests to the system access point will use TLS. */
+    readonly tlsEnabled: boolean;
+    private verboseErrors;
+    private webSocket?;
+    private readonly webSocketMessageSubject;
+    /**
+     * Constructs a new SystemAccessPoint instance
+     *
+     * @constructor
+     * @param hostName The system access point host name.
+     * @param userName The user name that shall be used to authenticate with the system access point.
+     * @param password The password that shall be used to authenticate with the system access point.
+     * @param tlsEnabled Determines whether the communication with the system access point shall be protected by TLS. Defaults to true
+     * @param verboseErrors Determines whether verbose error messages shall be used, for example for message validation. Defaults to false.
+     */
+    constructor(hostName: string, userName: string, password: string, tlsEnabled?: boolean, verboseErrors?: boolean);
+    /**
+     * Connects to the System Access Point web socket.
+     *
+     * @function
+     * @param certificateVerification Determines whether the TLS certificate presented by the server will be verified.
+     */
+    connectWebSocket(certificateVerification?: boolean): void;
+    /**
+     * Creates a new virtual device.
+     * @param sysApUuid The UUID identifying the system access point
+     * @param deviceSerial The serial number to be assigned to the device.
+     * @param virtualDevice The virtual device to be created.
+     */
+    createVirtualDevice(sysApUuid: string, deviceSerial: string, virtualDevice: VirtualDevice): Promise<VirtualDeviceResponse>;
+    private createWebSocket;
+    /**
+     * Disconnects from the System Access Point web socket.
+     *
+     * @function
+     * @param force Determines whether or not the connection will be closed forcibly
+     */
+    disconnectWebSocket(force?: boolean): void;
+    /**
+     * Gets the configuration from the system access point
+     * @returns The @see Configuration
+     */
+    getConfiguration(): Promise<Configuration>;
+    /**
+     * Gets the device list from the system access point.
+     * @returns The @see DeviceList
+     */
+    getDeviceList(): Promise<DeviceList>;
+    /**
+     * Gets the specified device from the system access point
+     * @param sysApUuid The UUID identifying the system access point
+     * @param deviceSerial The device serial number
+     */
+    getDevice(sysApUuid: string, deviceSerial: string): Promise<DeviceResponse>;
+    /**
+     * Gets the specified data point from the system access point.
+     * @param sysApUuid The UUID idenfifying the system access point
+     * @param deviceSerial The device serial number
+     * @param channel The channel identifier
+     * @param dataPoint The datapoint identifier
+     * @returns The requested @see GetDataPointResponse
+     */
+    getDatapoint(sysApUuid: string, deviceSerial: string, channel: string, dataPoint: string): Promise<GetDataPointResponse>;
+    /**
+     * Gets the web socket messages.
+     *
+     * @returns An observable that is updated with the messages received from the web socket.
+     */
+    getWebSocketMessages(): Observable<WebSocketMessage>;
+    /**
+     * Sets a new value for the specificed data point.
+     * @param sysApUuid The UUID idenfifying the system access point
+     * @param deviceSerial The device serial number
+     * @param channel The channel identifier
+     * @param dataPoint The datapoint identifier
+     * @param value The new value to be set
+     * @returns A @see SetDataPointResponse describing the result of the operation
+     */
+    setDatapoint(sysApUuid: string, deviceSerial: string, channel: string, dataPoint: string, value: string): Promise<SetDataPointResponse>;
+    private fetchDataViaRest;
+    private processRestResponse;
+    private processWebSocketMessage;
+}
+//# sourceMappingURL=system-access-point.d.ts.map

package/dist/src/system-access-point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-access-point.d.ts","sourceRoot":"","sources":["../../src/system-access-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAW,MAAM,MAAM,CAAC;AAE3C,OAAO,EACL,aAAa,EACb,UAAU,EACV,cAAc,EACd,oBAAoB,EAOpB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAKjB;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,sDAAsD;IACtD,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,gDAAgD;IAChD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,2EAA2E;IAC3E,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAmC;IAE3E;;;;;;;;;OASG;gBAED,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,UAAO,EACjB,aAAa,UAAQ;IAWvB;;;;;OAKG;IACI,gBAAgB,CAAC,uBAAuB,UAAO,GAAG,IAAI;IAQ7D;;;;;OAKG;IACU,mBAAmB,CAC9B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAYjC,OAAO,CAAC,eAAe;IAuCvB;;;;;OAKG;IACI,mBAAmB,CAAC,KAAK,UAAQ,GAAG,IAAI;IAY/C;;;OAGG;IACU,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAWvD;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IAQjD;;;;OAIG;IACU,SAAS,CACpB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,cAAc,CAAC;IAW1B;;;;;;;OAOG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,oBAAoB,CAAC;IAWhC;;;;OAIG;IACI,oBAAoB,IAAI,UAAU,CAAC,gBAAgB,CAAC;IAG3D;;;;;;;;OAQG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,CAAC;YAYlB,gBAAgB;YAuBhB,mBAAmB;IAmCjC,OAAO,CAAC,uBAAuB;CAyBhC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "freeathome-local-api-client",
+  "version": "0.2.0-pre",
+  "description": "A client library for the BUSCH-JAEGER free@home local API implemented in TypeScript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pgerke/freeathome-local-api-client.git"
+  },
+  "keywords": [
+    "freeathome",
+    "api-client",
+    "typescript"
+  ],
+  "author": {
+    "email": "info@philipgerke.com",
+    "name": "Philip Gerke",
+    "url": "https://www.philipgerke.com"
+  },
+  "homepage": "https://github.com/pgerke/freeathome-local-api-client#readme",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pgerke/freeathome-local-api-client/issues"
+  },
+  "type": "module",
+  "main": "dist/bundle.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && webpack --node-env=production --config webpack.config.js",
+    "test": "ts-node --project ./tsconfig.spec.json node_modules/jasmine/bin/jasmine --config=jasmine.json",
+    "test:coverage": "nyc npm run test",
+    "lint": "eslint . --fix"
+  },
+  "dependencies": {
+    "rxjs": "^7.5.5",
+    "ts-interface-checker": "^1.0.2",
+    "ws": "^8.5.0"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/jasmine": "^4.0.3",
+    "@types/webpack": "^5.28.0",
+    "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "jasmine": "^4.1.0",
+    "jasmine-spec-reporter": "^7.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.2",
+    "rimraf": "^3.0.2",
+    "ts-interface-builder": "^0.3.3",
+    "ts-loader": "^9.3.0",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.4",
+    "webpack": "^5.72.0",
+    "webpack-cli": "^4.9.2"
+  }
+}