edilkamin 1.1.0 → 1.2.0

package/README.md

@@ -1,6 +1,7 @@
 # Edilkamin.js
 
 [![Tests](https://github.com/AndreMiras/edilkamin.js/workflows/Tests/badge.svg)](https://github.com/AndreMiras/edilkamin.js/actions/workflows/tests.yml)
+[![CLI Tests](https://github.com/AndreMiras/edilkamin.js/actions/workflows/cli-tests.yml/badge.svg)](https://github.com/AndreMiras/edilkamin.js/actions/workflows/cli-tests.yml)
 [![Documentation](https://github.com/AndreMiras/edilkamin.js/workflows/Documentation/badge.svg)](https://github.com/AndreMiras/edilkamin.js/actions/workflows/documentation.yml)
 [![npm version](https://badge.fury.io/js/edilkamin.svg)](https://badge.fury.io/js/edilkamin)
 
@@ -39,12 +40,26 @@ It's also possible to change the default backend URL:
 ```js
 import { signIn, configure } from "edilkamin";
 
-const baseUrl = "https://my-proxy.com/"
+const baseUrl = "https://my-proxy.com/";
 const { deviceInfo, setPower } = configure(baseUrl);
 deviceInfo(token, macAddress).then(console.log);
 setPower(token, macAddress, 0).then(console.log);
 ```
 
+## CLI
+
+The library includes a CLI tool that is useful for debugging.
+
+```sh
+yarn cli deviceInfo --mac $MAC --username $USERNAME --password $PASSWORD
+```
+
+Or with `npx` once the library is installed:
+
+```sh
+npx edilkamin deviceInfo --mac $MAC --username $USERNAME --password $PASSWORD
+```
+
 ## Motivations
 
 - providing an open source web alternative

package/dist/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "edilkamin",
+    "version": "1.2.0",
+    "description": "",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "cli": "ts-node src/cli.ts",
+        "test": "mocha --require ts-node/register src/*.test.ts",
+        "lint": "prettier --check src docs .github *.md",
+        "format": "prettier --write src docs .github *.md",
+        "build": "tsc"
+    },
+    "files": [
+        "/dist"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/AndreMiras/edilkamin.js.git"
+    },
+    "author": "Andre Miras",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/AndreMiras/edilkamin.js/issues"
+    },
+    "homepage": "https://github.com/AndreMiras/edilkamin.js#readme",
+    "bin": {
+        "edilkamin": "dist/cli.js"
+    },
+    "dependencies": {
+        "@aws-amplify/core": "^4.3.14",
+        "aws-amplify": "^4.3.14",
+        "aws-crt": "^1.14.5"
+    },
+    "devDependencies": {
+        "@aws-amplify/cli": "^7.6.21",
+        "@types/mocha": "^10.0.10",
+        "@types/sinon": "^17.0.3",
+        "mocha": "^10.8.2",
+        "prettier": "^2.5.1",
+        "sinon": "^19.0.2",
+        "ts-node": "^10.9.1",
+        "typedoc": "^0.22.12"
+    },
+    "optionalDependencies": {
+        "commander": "^12.1.0"
+    }
+}

package/dist/src/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+declare const main: () => void;
+export { main };

package/dist/src/cli.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const library_1 = require("./library");
+const commander_1 = require("commander");
+const readline_1 = __importDefault(require("readline"));
+const package_json_1 = require("../package.json");
+const promptPassword = () => {
+    const rl = readline_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+        terminal: true,
+    });
+    return new Promise((resolve) => {
+        rl.question("Enter password: ", (password) => {
+            // Hide the password input
+            readline_1.default.moveCursor(process.stdout, 0, -1);
+            readline_1.default.clearLine(process.stdout, 0);
+            rl.close();
+            resolve(password);
+        });
+        // Disable input echoing for password
+        process.stdin.on("data", (char) => {
+            if (char.toString("hex") === "0d0a")
+                return; // Enter key
+            process.stdout.write("*");
+        });
+    });
+};
+/**
+ * Adds common options (username and password) to a command.
+ * @param command The command to which options should be added.
+ * @returns The command with options added.
+ */
+const addCommonOptions = (command) => command
+    .requiredOption("-u, --username <username>", "Username")
+    .option("-p, --password <password>", "Password");
+const createProgram = () => {
+    const program = new commander_1.Command();
+    program
+        .name("edilkamin-cli")
+        .description("CLI tool for interacting with the Edilkamin API")
+        .version(package_json_1.version);
+    // Command: signIn
+    addCommonOptions(program.command("signIn").description("Sign in and retrieve a JWT token")).action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        const { username, password } = options;
+        const pwd = password || (yield promptPassword());
+        const jwtToken = yield library_1.signIn(username, pwd);
+        console.log("JWT Token:", jwtToken);
+    }));
+    // Command: deviceInfo
+    addCommonOptions(program
+        .command("deviceInfo")
+        .description("Retrieve device info for a specific MAC address")
+        .requiredOption("-m, --mac <macAddress>", "MAC address of the device")).action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        const { username, password, mac } = options;
+        const pwd = password || (yield promptPassword());
+        const jwtToken = yield library_1.signIn(username, pwd);
+        const api = library_1.configure(); // Use the default API configuration
+        const deviceInfo = yield api.deviceInfo(jwtToken, mac);
+        console.log("Device Info:", deviceInfo.data);
+    }));
+    return program;
+};
+const main = () => {
+    const program = createProgram();
+    program.parse(process.argv);
+};
+exports.main = main;
+if (require.main === module) {
+    main();
+}

package/dist/src/index.d.ts

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

package/dist/{library.d.ts → src/library.d.ts}

@@ -4,9 +4,9 @@ import { DeviceInfoType } from "./types";
  */
 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>>;
+    deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<DeviceInfoType, any>>;
+    setPower: (jwtToken: string, macAddress: string, value: number) => Promise<import("axios").AxiosResponse<any, any>>;
+    setPowerOff: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    setPowerOn: (jwtToken: string, macAddress: string) => Promise<import("axios").AxiosResponse<any, any>>;
 };
 export { signIn, configure };

package/dist/{library.js → src/library.js}

@@ -8,11 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configure = exports.signIn = void 0;
-const assert_1 = require("assert");
 const aws_amplify_1 = require("aws-amplify");
-const axios_1 = require("axios");
+const axios_1 = __importDefault(require("axios"));
 const constants_1 = require("./constants");
 const amplifyconfiguration = {
     Auth: {
@@ -34,7 +36,7 @@ exports.signIn = signIn;
 const deviceInfo = (axiosInstance) => (jwtToken, macAddress) => axiosInstance.get(`device/${macAddress}/info`, {
     headers: headers(jwtToken),
 });
-const mqttCommand = (axiosInstance) => (jwtToken, macAddress, payload) => axiosInstance.put(`mqtt/command`, Object.assign({ mac_address: macAddress }, payload), { headers: headers(jwtToken) });
+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);
@@ -53,12 +55,3 @@ const configure = (baseURL = constants_1.API_URL) => {
 };
 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);
-    assert_1.ok(MAC_ADDRESS);
-    const jwtToken = yield signIn(USERNAME, PASSWORD);
-    const info = yield defaultApi.deviceInfo(jwtToken, MAC_ADDRESS);
-    console.log({ info });
-});

package/dist/src/library.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/library.test.js

@@ -0,0 +1,97 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = require("assert");
+const sinon_1 = __importDefault(require("sinon"));
+const aws_amplify_1 = require("aws-amplify");
+const axios_1 = __importDefault(require("axios"));
+const library_1 = require("../src/library");
+describe("library", () => {
+    let axiosStub;
+    beforeEach(() => {
+        axiosStub = sinon_1.default.stub(axios_1.default, "create").returns({
+            get: sinon_1.default.stub(),
+            put: sinon_1.default.stub(),
+        });
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+    });
+    describe("signIn", () => {
+        it("should return a JWT token on successful login", () => __awaiter(void 0, void 0, void 0, function* () {
+            const expectedJwtToken = "mockToken123";
+            const mockUserSession = {
+                getAccessToken: () => ({ jwtToken: expectedJwtToken }),
+            };
+            const mockUser = {
+                getSignInUserSession: () => mockUserSession,
+            };
+            const signInStub = sinon_1.default.stub(aws_amplify_1.Auth, "signIn").resolves(mockUser);
+            const jwtToken = yield library_1.signIn("mockUser", "mockPassword");
+            assert_1.strict.ok(signInStub.calledOnce);
+            assert_1.strict.equal(jwtToken, expectedJwtToken);
+        }));
+    });
+    describe("configure", () => {
+        it("should create API methods with the correct baseURL", () => {
+            const baseURL = "https://example.com/api";
+            const api = library_1.configure(baseURL);
+            assert_1.strict.ok(axiosStub.calledOnce);
+            assert_1.strict.deepEqual(axiosStub.firstCall.args[0], { baseURL });
+            assert_1.strict.deepEqual(Object.keys(api), [
+                "deviceInfo",
+                "setPower",
+                "setPowerOff",
+                "setPowerOn",
+            ]);
+        });
+    });
+    describe("API Methods", () => {
+        it("should call axios for deviceInfo", () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockAxios = {
+                get: sinon_1.default
+                    .stub()
+                    .resolves({ data: { id: "123", name: "Mock Device" } }),
+            };
+            axiosStub.returns(mockAxios);
+            const api = library_1.configure("https://example.com/api");
+            const result = yield api.deviceInfo("mockToken", "mockMacAddress");
+            assert_1.strict.ok(mockAxios.get.calledOnce);
+            assert_1.strict.equal(mockAxios.get.firstCall.args[0], "device/mockMacAddress/info");
+            assert_1.strict.deepEqual(mockAxios.get.firstCall.args[1], {
+                headers: { Authorization: "Bearer mockToken" },
+            });
+            assert_1.strict.deepEqual(result.data, { id: "123", name: "Mock Device" });
+        }));
+        it("should call axios for setPowerOn", () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockAxios = {
+                put: sinon_1.default.stub().resolves({ status: 200 }),
+            };
+            axiosStub.returns(mockAxios);
+            const api = library_1.configure("https://example.com/api");
+            const result = yield api.setPowerOn("mockToken", "mockMacAddress");
+            assert_1.strict.ok(mockAxios.put.calledOnce);
+            assert_1.strict.equal(mockAxios.put.firstCall.args[0], "mqtt/command");
+            assert_1.strict.deepEqual(mockAxios.put.firstCall.args[1], {
+                mac_address: "mockMacAddress",
+                name: "power",
+                value: 1,
+            });
+            assert_1.strict.deepEqual(mockAxios.put.firstCall.args[2], {
+                headers: { Authorization: "Bearer mockToken" },
+            });
+            assert_1.strict.equal(result.status, 200);
+        }));
+    });
+});

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "edilkamin",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "cli": "ts-node src/cli.ts",
+    "test": "mocha --require ts-node/register src/*.test.ts",
     "lint": "prettier --check src docs .github *.md",
     "format": "prettier --write src docs .github *.md",
     "build": "tsc"
@@ -23,14 +24,25 @@
     "url": "https://github.com/AndreMiras/edilkamin.js/issues"
   },
   "homepage": "https://github.com/AndreMiras/edilkamin.js#readme",
+  "bin": {
+    "edilkamin": "dist/cli.js"
+  },
   "dependencies": {
     "@aws-amplify/core": "^4.3.14",
-    "aws-amplify": "^4.3.14"
+    "aws-amplify": "^4.3.14",
+    "aws-crt": "^1.14.5"
   },
   "devDependencies": {
     "@aws-amplify/cli": "^7.6.21",
+    "@types/mocha": "^10.0.10",
+    "@types/sinon": "^17.0.3",
+    "mocha": "^10.8.2",
     "prettier": "^2.5.1",
+    "sinon": "^19.0.2",
     "ts-node": "^10.9.1",
     "typedoc": "^0.22.12"
+  },
+  "optionalDependencies": {
+    "commander": "^12.1.0"
   }
 }

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export { API_URL } from "./constants";
-export { CommandsType, DeviceInfoType, StatusType, TemperaturesType, UserParametersType, } from "./types";
-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>>;