edilkamin 0.0.5 → 1.1.0

package/README.md

@@ -7,16 +7,61 @@
 This is a library for the [Reverse Engineered](docs/ReverseEngineering.md) "The Mind" Edilkamin API.
 The Mind offers an app/API to remote control the Edilkamin pellet stoves.
 
+## Install
+
+Using npm:
+
+```sh
+npm install edilkamin
+```
+
+Using yarn:
+
+```sh
+yarn add edilkamin
+```
+
+## Usage
+
+Basic usage:
+
+```js
+import { signIn, deviceInfo, setPowerOff } from "edilkamin";
+
+const macAddress = "aabbccddeeff";
+const token = signIn(username, password);
+deviceInfo(token, macAddress).then(console.log);
+setPowerOff(token, macAddress).then(console.log);
+```
+
+It's also possible to change the default backend URL:
+
+```js
+import { signIn, configure } from "edilkamin";
+
+const baseUrl = "https://my-proxy.com/"
+const { deviceInfo, setPower } = configure(baseUrl);
+deviceInfo(token, macAddress).then(console.log);
+setPower(token, macAddress, 0).then(console.log);
+```
 
 ## Motivations
+
 - providing an open source web alternative
   to the [proprietary mobile app](https://play.google.com/store/apps/details?id=com.edilkamin.stufe)
 - improving the interoperability (Nest, HomeAssistant...)
 
 ## Roadmap
+
 - [x] AWS Amplify/ Cognito authentication
 - [x] unauthenticated endpoint call
-- [ ] authenticated endpoint call
-- [ ] list stoves
+- [x] authenticated endpoint call
+- [ ] ~list stoves~
 - [x] turn stove on/off
 - [ ] set temperature
+
+## Limitations
+
+It seems like there's no endpoint to list stoves associated to a user.
+The way the official app seem to work is by probing the stove via bluetooth.
+Then cache the stove MAC address to a local database for later use.

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+export { API_URL } from "./constants";
 export { CommandsType, DeviceInfoType, StatusType, TemperaturesType, UserParametersType, } from "./types";
-export { main, deviceInfo, setPower, setPowerOff, setPowerOn } from "./library";
+export { signIn, configure } from "./library";
+export declare const deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<import("./types").DeviceInfoType>>, setPower: (jwtToken: string, macAddress: string, value: number) => Promise<import("axios").AxiosResponse<any>>, setPowerOff: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any>>, setPowerOn: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any>>;

package/dist/index.js

@@ -1,8 +1,11 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-var library_1 = require("./library");
-Object.defineProperty(exports, "main", { enumerable: true, get: function () { return library_1.main; } });
-Object.defineProperty(exports, "deviceInfo", { enumerable: true, get: function () { return library_1.deviceInfo; } });
-Object.defineProperty(exports, "setPower", { enumerable: true, get: function () { return library_1.setPower; } });
-Object.defineProperty(exports, "setPowerOff", { enumerable: true, get: function () { return library_1.setPowerOff; } });
-Object.defineProperty(exports, "setPowerOn", { enumerable: true, get: function () { return library_1.setPowerOn; } });
+exports.setPowerOn = exports.setPowerOff = exports.setPower = exports.deviceInfo = void 0;
+const library_1 = require("./library");
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "API_URL", { enumerable: true, get: function () { return constants_1.API_URL; } });
+var library_2 = require("./library");
+Object.defineProperty(exports, "signIn", { enumerable: true, get: function () { return library_2.signIn; } });
+Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return library_2.configure; } });
+_a = library_1.configure(), exports.deviceInfo = _a.deviceInfo, exports.setPower = _a.setPower, exports.setPowerOff = _a.setPowerOff, exports.setPowerOn = _a.setPowerOn;

package/dist/library.d.ts

@@ -1,7 +1,12 @@
 import { DeviceInfoType } from "./types";
-declare const deviceInfo: (macAddress: string) => Promise<import("axios").AxiosResponse<DeviceInfoType>>;
-declare const setPower: (macAddress: string, value: number) => Promise<import("axios").AxiosResponse<any>>;
-declare const setPowerOn: (macAddress: string) => Promise<import("axios").AxiosResponse<any>>;
-declare const setPowerOff: (macAddress: string) => Promise<import("axios").AxiosResponse<any>>;
-declare const main: () => void;
-export { main, deviceInfo, setPower, setPowerOff, setPowerOn };
+/**
+ * Sign in to return the JWT token.
+ */
+declare const signIn: (username: string, password: string) => Promise<string>;
+declare const configure: (baseURL?: string) => {
+    deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<DeviceInfoType>>;
+    setPower: (jwtToken: string, macAddress: string, value: number) => Promise<import("axios").AxiosResponse<any>>;
+    setPowerOff: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any>>;
+    setPowerOn: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any>>;
+};
+export { signIn, configure };

package/dist/library.js

@@ -9,10 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setPowerOn = exports.setPowerOff = exports.setPower = exports.deviceInfo = exports.main = void 0;
+exports.configure = exports.signIn = void 0;
 const assert_1 = require("assert");
-const axios_1 = require("axios");
 const aws_amplify_1 = require("aws-amplify");
+const axios_1 = require("axios");
 const constants_1 = require("./constants");
 const amplifyconfiguration = {
     Auth: {
@@ -22,28 +22,43 @@ const amplifyconfiguration = {
     },
 };
 aws_amplify_1.Amplify.configure(amplifyconfiguration);
+const headers = (jwtToken) => ({ Authorization: `Bearer ${jwtToken}` });
+/**
+ * Sign in to return the JWT token.
+ */
 const signIn = (username, password) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        const user = yield aws_amplify_1.Auth.signIn(username, password);
-        console.log("user:", user);
-    }
-    catch (error) {
-        console.log("error signing in", error);
-    }
+    const user = yield aws_amplify_1.Auth.signIn(username, password);
+    return user.getSignInUserSession().getAccessToken().jwtToken;
+});
+exports.signIn = signIn;
+const deviceInfo = (axiosInstance) => (jwtToken, macAddress) => axiosInstance.get(`device/${macAddress}/info`, {
+    headers: headers(jwtToken),
 });
-const deviceInfo = (macAddress) => axios_1.default.get(`${constants_1.API_URL}device/${macAddress}/info`);
-exports.deviceInfo = deviceInfo;
-const mqttCommand = (macAddress, payload) => axios_1.default.put(`${constants_1.API_URL}/mqtt/command`, Object.assign({ mac_address: macAddress }, payload));
-const setPower = (macAddress, value) => mqttCommand(macAddress, { name: "power", value });
-exports.setPower = setPower;
-const setPowerOn = (macAddress) => setPower(macAddress, 1);
-exports.setPowerOn = setPowerOn;
-const setPowerOff = (macAddress) => setPower(macAddress, 0);
-exports.setPowerOff = setPowerOff;
-const main = () => {
-    const { USERNAME, PASSWORD } = process.env;
+const mqttCommand = (axiosInstance) => (jwtToken, macAddress, payload) => axiosInstance.put(`mqtt/command`, Object.assign({ mac_address: macAddress }, payload), { headers: headers(jwtToken) });
+const setPower = (axiosInstance) => (jwtToken, macAddress, value) => mqttCommand(axiosInstance)(jwtToken, macAddress, { name: "power", value });
+const setPowerOn = (axiosInstance) => (jwtToken, macAddress) => setPower(axiosInstance)(jwtToken, macAddress, 1);
+const setPowerOff = (axiosInstance) => (jwtToken, macAddress) => setPower(axiosInstance)(jwtToken, macAddress, 0);
+const configure = (baseURL = constants_1.API_URL) => {
+    const axiosInstance = axios_1.default.create({ baseURL });
+    const deviceInfoInstance = deviceInfo(axiosInstance);
+    const setPowerInstance = setPower(axiosInstance);
+    const setPowerOffInstance = setPowerOff(axiosInstance);
+    const setPowerOnInstance = setPowerOn(axiosInstance);
+    return {
+        deviceInfo: deviceInfoInstance,
+        setPower: setPowerInstance,
+        setPowerOff: setPowerOffInstance,
+        setPowerOn: setPowerOnInstance,
+    };
+};
+exports.configure = configure;
+const defaultApi = configure();
+const main = () => __awaiter(void 0, void 0, void 0, function* () {
+    const { USERNAME, PASSWORD, MAC_ADDRESS } = process.env;
     assert_1.ok(USERNAME);
     assert_1.ok(PASSWORD);
-    signIn(USERNAME, PASSWORD);
-};
-exports.main = main;
+    assert_1.ok(MAC_ADDRESS);
+    const jwtToken = yield signIn(USERNAME, PASSWORD);
+    const info = yield defaultApi.deviceInfo(jwtToken, MAC_ADDRESS);
+    console.log({ info });
+});

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "edilkamin",
-  "version": "0.0.5",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "prettier --check src",
-    "format": "prettier --write src",
+    "lint": "prettier --check src docs .github *.md",
+    "format": "prettier --write src docs .github *.md",
     "build": "tsc"
   },
   "files": [
@@ -30,6 +30,7 @@
   "devDependencies": {
     "@aws-amplify/cli": "^7.6.21",
     "prettier": "^2.5.1",
+    "ts-node": "^10.9.1",
     "typedoc": "^0.22.12"
   }
 }