edilkamin 1.3.1 → 1.4.0

package/.github/workflows/cli-tests.yml

@@ -8,10 +8,13 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: ${{ matrix.node-version }}
       - run: yarn install --no-ignore-optional
       - run: yarn cli --help

package/.github/workflows/documentation.yml

@@ -2,17 +2,17 @@ name: Documentation
 
 on:
   push:
-    branches:
-      - main
+  pull_request:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: "22.x"
       - name: git config
         run: |
           git config user.name documentation-deploy-action
@@ -20,7 +20,7 @@ jobs:
           git remote set-url origin https://${{github.actor}}:${{github.token}}@github.com/${{github.repository}}.git
       - run: yarn install
       - run: yarn typedoc src/index.ts --out /tmp/docs
-      - name: deploy documentation
+      - name: commit documentation
         run: |
           git ls-remote --exit-code . origin/gh-pages \
             && git checkout -b gh-pages \
@@ -30,5 +30,8 @@ jobs:
           cp --recursive /tmp/docs/. .
           echo /node_modules > .gitignore
           git add --all
-          git commit --all --message ":memo: docs: Update generated documentation"
+          git commit --all --message ":memo: docs: Update generated documentation" || echo "No changes to commit"
+      - name: push documentation
+        if: github.ref_name == 'main'
+        run: |
           git push origin gh-pages

package/.github/workflows/publish.yml

@@ -8,11 +8,12 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: "22.x"
           registry-url: "https://registry.npmjs.org"
       - run: yarn install
       - run: yarn build

package/.github/workflows/tests.yml

@@ -5,13 +5,17 @@ on:
   pull_request:
 
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: ${{ matrix.node-version }}
       - run: yarn install
       - run: yarn lint
       - run: yarn build

package/dist/{cli.js → esm/cli.js}

@@ -1,5 +1,4 @@
 #!/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) {
@@ -9,17 +8,12 @@ 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.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");
+import { signIn, configure } from "./library";
+import { Command } from "commander";
+import readline from "readline";
+import { version } from "../package.json";
 const promptPassword = () => {
-    const rl = readline_1.default.createInterface({
+    const rl = readline.createInterface({
         input: process.stdin,
         output: process.stdout,
         terminal: true,
@@ -27,8 +21,8 @@ const promptPassword = () => {
     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);
+            readline.moveCursor(process.stdout, 0, -1);
+            readline.clearLine(process.stdout, 0);
             rl.close();
             resolve(password);
         });
@@ -49,16 +43,16 @@ const addCommonOptions = (command) => command
     .requiredOption("-u, --username <username>", "Username")
     .option("-p, --password <password>", "Password");
 const createProgram = () => {
-    const program = new commander_1.Command();
+    const program = new Command();
     program
         .name("edilkamin-cli")
         .description("CLI tool for interacting with the Edilkamin API")
-        .version(package_json_1.version);
+        .version(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 (0, library_1.signIn)(username, pwd);
+        const jwtToken = yield signIn(username, pwd);
         console.log("JWT Token:", jwtToken);
     }));
     // Command: deviceInfo
@@ -68,8 +62,8 @@ const createProgram = () => {
         .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 (0, library_1.signIn)(username, pwd);
-        const api = (0, library_1.configure)(); // Use the default API configuration
+        const jwtToken = yield signIn(username, pwd);
+        const api = configure(); // Use the default API configuration
         const deviceInfo = yield api.deviceInfo(jwtToken, mac);
         console.log("Device Info:", deviceInfo.data);
     }));
@@ -79,7 +73,7 @@ const main = () => {
     const program = createProgram();
     program.parse(process.argv);
 };
-exports.main = main;
 if (require.main === module) {
     main();
 }
+export { main };

package/dist/esm/constants.js

@@ -0,0 +1,2 @@
+const API_URL = "https://fxtj7xkgc6.execute-api.eu-central-1.amazonaws.com/prod/";
+export { API_URL };

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+import { configure } from "./library";
+export { API_URL } from "./constants";
+export { signIn, configure } from "./library";
+export const { deviceInfo, setPower, setPowerOff, setPowerOn } = configure();

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

@@ -1,37 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 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) {
@@ -41,37 +7,34 @@ 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 amplifyAuth = __importStar(require("aws-amplify/auth"));
-const axios_1 = __importDefault(require("axios"));
-const constants_1 = require("./constants");
+import { strict as assert } from "assert";
+import { Amplify } from "aws-amplify";
+import * as amplifyAuth from "aws-amplify/auth";
+import axios from "axios";
+import { API_URL } from "./constants";
 const amplifyconfiguration = {
     aws_project_region: "eu-central-1",
     aws_user_pools_id: "eu-central-1_BYmQ2VBlo",
     aws_user_pools_web_client_id: "7sc1qltkqobo3ddqsk4542dg2h",
 };
-aws_amplify_1.Amplify.configure(amplifyconfiguration);
+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* () {
-    const { isSignedIn, nextStep } = yield amplifyAuth.signIn({
+    // in case the user is already signed in, refs:
+    // https://github.com/aws-amplify/amplify-js/issues/13813
+    yield amplifyAuth.signOut();
+    const { isSignedIn } = yield amplifyAuth.signIn({
         username,
         password,
     });
-    assert_1.strict.ok(isSignedIn);
+    assert.ok(isSignedIn);
     const { tokens } = yield amplifyAuth.fetchAuthSession();
-    assert_1.strict.ok(tokens);
+    assert.ok(tokens);
     return tokens.accessToken.toString();
 });
-exports.signIn = signIn;
 const deviceInfo = (axiosInstance) => (jwtToken, macAddress) => axiosInstance.get(`device/${macAddress}/info`, {
     headers: headers(jwtToken),
 });
@@ -79,8 +42,8 @@ const mqttCommand = (axiosInstance) => (jwtToken, macAddress, payload) => axiosI
 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 configure = (baseURL = API_URL) => {
+    const axiosInstance = axios.create({ baseURL });
     const deviceInfoInstance = deviceInfo(axiosInstance);
     const setPowerInstance = setPower(axiosInstance);
     const setPowerOffInstance = setPowerOff(axiosInstance);
@@ -92,5 +55,4 @@ const configure = (baseURL = constants_1.API_URL) => {
         setPowerOn: setPowerOnInstance,
     };
 };
-exports.configure = configure;
-const defaultApi = configure();
+export { signIn, configure };

package/dist/{library.test.js → esm/library.test.js}

@@ -1,4 +1,3 @@
-"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) {
@@ -8,32 +7,28 @@ 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 });
-const assert_1 = require("assert");
-const sinon_1 = __importDefault(require("sinon"));
-const axios_1 = __importDefault(require("axios"));
-const library_1 = require("../src/library");
+import { strict as assert } from "assert";
+import sinon from "sinon";
+import axios from "axios";
+import { configure } from "../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(),
+        axiosStub = sinon.stub(axios, "create").returns({
+            get: sinon.stub(),
+            put: sinon.stub(),
         });
     });
     afterEach(() => {
-        sinon_1.default.restore();
+        sinon.restore();
     });
     describe("configure", () => {
         it("should create API methods with the correct baseURL", () => {
             const baseURL = "https://example.com/api";
-            const api = (0, 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), [
+            const api = configure(baseURL);
+            assert.ok(axiosStub.calledOnce);
+            assert.deepEqual(axiosStub.firstCall.args[0], { baseURL });
+            assert.deepEqual(Object.keys(api), [
                 "deviceInfo",
                 "setPower",
                 "setPowerOff",
@@ -44,38 +39,38 @@ describe("library", () => {
     describe("API Methods", () => {
         it("should call axios for deviceInfo", () => __awaiter(void 0, void 0, void 0, function* () {
             const mockAxios = {
-                get: sinon_1.default
+                get: sinon
                     .stub()
                     .resolves({ data: { id: "123", name: "Mock Device" } }),
             };
             axiosStub.returns(mockAxios);
-            const api = (0, library_1.configure)("https://example.com/api");
+            const api = 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], {
+            assert.ok(mockAxios.get.calledOnce);
+            assert.equal(mockAxios.get.firstCall.args[0], "device/mockMacAddress/info");
+            assert.deepEqual(mockAxios.get.firstCall.args[1], {
                 headers: { Authorization: "Bearer mockToken" },
             });
-            assert_1.strict.deepEqual(result.data, { id: "123", name: "Mock Device" });
+            assert.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 }),
+                put: sinon.stub().resolves({ status: 200 }),
             };
             axiosStub.returns(mockAxios);
-            const api = (0, library_1.configure)("https://example.com/api");
+            const api = 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], {
+            assert.ok(mockAxios.put.calledOnce);
+            assert.equal(mockAxios.put.firstCall.args[0], "mqtt/command");
+            assert.deepEqual(mockAxios.put.firstCall.args[1], {
                 mac_address: "mockMacAddress",
                 name: "power",
                 value: 1,
             });
-            assert_1.strict.deepEqual(mockAxios.put.firstCall.args[2], {
+            assert.deepEqual(mockAxios.put.firstCall.args[2], {
                 headers: { Authorization: "Bearer mockToken" },
             });
-            assert_1.strict.equal(result.status, 200);
+            assert.equal(result.status, 200);
         }));
     });
 });

package/dist/esm/types.js

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

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "edilkamin",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "scripts": {
     "cli": "ts-node src/cli.ts",
     "cli:debug": "node --inspect --require ts-node/register/transpile-only src/cli.ts",
     "test": "mocha --require ts-node/register src/*.test.ts",
     "test:debug": "mocha --require ts-node/register/transpile-only --inspect src/*.test.ts",
-    "lint": "prettier --check src docs .github *.md",
-    "format": "prettier --write src docs .github *.md",
-    "build": "tsc"
+    "lint": "prettier --check src docs .github *.md *.json",
+    "format": "prettier --write src docs .github *.md *.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm"
   },
   "repository": {
     "type": "git",
@@ -24,7 +27,7 @@
   },
   "homepage": "https://github.com/AndreMiras/edilkamin.js#readme",
   "bin": {
-    "edilkamin": "dist/cli.js"
+    "edilkamin": "dist/cjs/cli.js"
   },
   "dependencies": {
     "aws-amplify": "^6.10.0",

package/src/library.test.ts

@@ -1,8 +1,7 @@
 import { strict as assert } from "assert";
 import sinon from "sinon";
-import { Amplify } from "aws-amplify";
 import axios from "axios";
-import { signIn, configure } from "../src/library";
+import { configure } from "../src/library";
 
 describe("library", () => {
   let axiosStub: sinon.SinonStub;

package/src/library.ts

@@ -18,7 +18,10 @@ const headers = (jwtToken: string) => ({ Authorization: `Bearer ${jwtToken}` });
  * Sign in to return the JWT token.
  */
 const signIn = async (username: string, password: string): Promise<string> => {
-  const { isSignedIn, nextStep } = await amplifyAuth.signIn({
+  // in case the user is already signed in, refs:
+  // https://github.com/aws-amplify/amplify-js/issues/13813
+  await amplifyAuth.signOut();
+  const { isSignedIn } = await amplifyAuth.signIn({
     username,
     password,
   });
@@ -69,6 +72,4 @@ const configure = (baseURL: string = API_URL) => {
   };
 };
 
-const defaultApi = configure();
-
 export { signIn, configure };

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "module": "es6"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "module": "es6"
+  }
+}

package/tsconfig.json

@@ -1,16 +1,17 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
-    "target": "es2015",
-    "declaration": true,
-    "outDir": "./dist",
+    "target": "es6",
+    "target": "es6",
+    "moduleResolution": "node",
+    "outDir": "dist",
     "rootDir": "src",
     "strict": true,
+    "declaration": true,
     "esModuleInterop": true,
     "resolveJsonModule": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "preserveConstEnums": true
   },
-  "include": [
-    "src/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"]
 }

package/dist/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_URL = void 0;
-const API_URL = "https://fxtj7xkgc6.execute-api.eu-central-1.amazonaws.com/prod/";
-exports.API_URL = API_URL;

package/dist/index.js

@@ -1,11 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setPowerOn = exports.setPowerOff = exports.setPower = exports.deviceInfo = exports.configure = exports.signIn = exports.API_URL = 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 = (0, library_1.configure)(), exports.deviceInfo = _a.deviceInfo, exports.setPower = _a.setPower, exports.setPowerOff = _a.setPowerOff, exports.setPowerOn = _a.setPowerOn;

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });