edilkamin 1.6.2 → 1.7.3

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

@@ -10,7 +10,7 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6

package/.github/workflows/documentation.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6
         with:
-          node-version: "22.x"
+          node-version: "24.x"
       - name: git config
         run: |
           git config user.name documentation-deploy-action

package/.github/workflows/publish.yml

@@ -4,6 +4,10 @@ on:
   push:
   pull_request:
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -12,12 +16,10 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6
         with:
-          node-version: "22.x"
+          node-version: "24.x"
           registry-url: "https://registry.npmjs.org"
       - run: yarn install
       - run: yarn build
-      - run: npm publish --dry-run
+      - run: npm pack --dry-run
       - run: npm publish
         if: startsWith(github.ref, 'refs/tags/')
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

package/.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6

package/README.md

@@ -1,9 +1,9 @@
 # Edilkamin.js
 
-[![Tests](https://github.com/AndreMiras/edilkamin.js/workflows/Tests/badge.svg)](https://github.com/AndreMiras/edilkamin.js/actions/workflows/tests.yml)
+[![Tests](https://github.com/AndreMiras/edilkamin.js/actions/workflows/tests.yml/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)
 [![codecov](https://codecov.io/gh/AndreMiras/edilkamin.js/graph/badge.svg?token=YG3LKXNZWU)](https://app.codecov.io/gh/AndreMiras/edilkamin.js/tree/main)
-[![Documentation](https://github.com/AndreMiras/edilkamin.js/workflows/Documentation/badge.svg)](https://github.com/AndreMiras/edilkamin.js/actions/workflows/documentation.yml)
+[![Documentation](https://github.com/AndreMiras/edilkamin.js/actions/workflows/documentation.yml/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)
 
 This is a library for the [Reverse Engineered](docs/ReverseEngineering.md) "The Mind" Edilkamin API.
@@ -31,11 +31,26 @@ Basic usage:
 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);
+const token = await signIn(username, password);
+console.log(await deviceInfo(token, macAddress));
+console.log(await setPowerOff(token, macAddress));
 ```
 
+For long-running applications, use `getSession()` to automatically refresh tokens:
+
+```js
+import { signIn, getSession, deviceInfo } from "edilkamin";
+
+// Authenticate once
+await signIn(username, password);
+
+// Get current session (auto-refreshes if expired)
+const token = await getSession();
+console.log(await deviceInfo(token, macAddress));
+```
+
+Sessions persist for ~30 days without re-authentication. Call `getSession()` to retrieve fresh tokens as needed.
+
 It's also possible to change the default backend URL:
 
 ```js
@@ -43,8 +58,8 @@ 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);
+console.log(await deviceInfo(token, macAddress));
+console.log(await setPower(token, macAddress, 0));
 ```
 
 ## CLI
@@ -52,7 +67,14 @@ setPower(token, macAddress, 0).then(console.log);
 The library includes a CLI tool that is useful for debugging.
 
 ```sh
+# First time: provide credentials to authenticate
 yarn cli deviceInfo --mac $MAC --username $USERNAME --password $PASSWORD
+
+# Subsequent calls: session persists, credentials optional
+yarn cli deviceInfo --mac $MAC
+
+# Clear stored session
+yarn cli logout
 ```
 
 Or with `npx` once the library is installed:
@@ -61,6 +83,8 @@ Or with `npx` once the library is installed:
 npx edilkamin deviceInfo --mac $MAC --username $USERNAME --password $PASSWORD
 ```
 
+The CLI stores session data in `~/.edilkamin/session.json` and automatically refreshes tokens when needed. Sessions remain valid for ~30 days.
+
 ## API Versions
 
 This library supports both the new and legacy Edilkamin API endpoints.

package/dist/esm/browser-bundle.test.d.ts

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

package/dist/esm/browser-bundle.test.js

@@ -0,0 +1,29 @@
+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());
+    });
+};
+import { strict as assert } from "assert";
+import * as esbuild from "esbuild";
+describe("browser-bundle", () => {
+    it("should bundle for browser without Node.js built-ins", () => __awaiter(void 0, void 0, void 0, function* () {
+        // This test verifies that the library can be bundled for browser environments
+        // without requiring Node.js built-in modules (fs, os, path).
+        // If this test fails, it means Node.js-only code has leaked into the main exports.
+        const result = yield esbuild.build({
+            entryPoints: ["dist/esm/index.js"],
+            platform: "browser",
+            bundle: true,
+            write: false,
+            // External dependencies that are expected (real deps + assert which is used for validation)
+            external: ["aws-amplify", "aws-amplify/*", "pako", "assert"],
+            logLevel: "silent",
+        });
+        // If we get here without error, the bundle succeeded
+        assert.ok(result.outputFiles.length > 0, "Bundle should produce output");
+    }));
+});

package/dist/esm/cli.js

@@ -12,7 +12,8 @@ import { Command } from "commander";
 import readline from "readline";
 import { version } from "../package.json";
 import { NEW_API_URL, OLD_API_URL } from "./constants";
-import { configure, signIn } from "./library";
+import { configure, configureAmplify, getSession, signIn } from "./library";
+import { clearSession, createFileStorage } from "./token-storage";
 const promptPassword = () => {
     const rl = readline.createInterface({
         input: process.stdin,
@@ -37,11 +38,12 @@ const promptPassword = () => {
 };
 /**
  * Adds common options (username and password) to a command.
+ * Username is optional if a session already exists.
  * @param command The command to which options should be added.
  * @returns The command with options added.
  */
 const addAuthOptions = (command) => command
-    .requiredOption("-u, --username <username>", "Username")
+    .option("-u, --username <username>", "Username (optional if session exists)")
     .option("-p, --password <password>", "Password");
 /**
  * Adds MAC address option to a command.
@@ -57,14 +59,29 @@ const addMacOption = (command) => command.requiredOption("-m, --mac <macAddress>
 const addLegacyOption = (command) => command.option("--legacy", "Use legacy API endpoint (old AWS Gateway)");
 /**
  * Handles common authentication and API initialization logic.
+ * Tries to use existing session first, falls back to sign-in if needed.
  * @param options The options passed from the CLI command.
  * @returns An object containing the normalized MAC, JWT token, and configured API instance.
  */
 const initializeCommand = (options) => __awaiter(void 0, void 0, void 0, function* () {
     const { username, password, mac, legacy = false } = options;
     const normalizedMac = mac.replace(/:/g, "");
-    const pwd = password || (yield promptPassword());
-    const jwtToken = yield signIn(username, pwd, legacy);
+    // Initialize file storage for session persistence
+    const storage = createFileStorage();
+    configureAmplify(storage);
+    let jwtToken;
+    try {
+        // Try to get existing session first
+        jwtToken = yield getSession(false, legacy);
+    }
+    catch (_a) {
+        // No session, need to sign in
+        if (!username) {
+            throw new Error("No session found. Please provide --username to sign in.");
+        }
+        const pwd = password || (yield promptPassword());
+        jwtToken = yield signIn(username, pwd, legacy);
+    }
     const apiUrl = legacy ? OLD_API_URL : NEW_API_URL;
     const api = configure(apiUrl);
     return { normalizedMac, jwtToken, api };
@@ -96,12 +113,28 @@ const createProgram = () => {
         .description("CLI tool for interacting with the Edilkamin API")
         .version(version);
     // Command: signIn
-    addAuthOptions(program.command("signIn").description("Sign in and retrieve a JWT token")).action((options) => __awaiter(void 0, void 0, void 0, function* () {
+    program
+        .command("signIn")
+        .description("Sign in and retrieve a JWT token")
+        .requiredOption("-u, --username <username>", "Username")
+        .option("-p, --password <password>", "Password")
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         const { username, password } = options;
+        // Initialize file storage for session persistence
+        const storage = createFileStorage();
+        configureAmplify(storage);
         const pwd = password || (yield promptPassword());
         const jwtToken = yield signIn(username, pwd);
         console.log("JWT Token:", jwtToken);
     }));
+    // Command: logout
+    program
+        .command("logout")
+        .description("Clear stored session")
+        .action(() => __awaiter(void 0, void 0, void 0, function* () {
+        yield clearSession();
+        console.log("Session cleared successfully");
+    }));
     // Generic getter commands
     [
         {
@@ -153,8 +186,20 @@ const createProgram = () => {
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         const { username, password, mac, serial, name, room, legacy = false, } = options;
         const normalizedMac = mac.replace(/:/g, "");
-        const pwd = password || (yield promptPassword());
-        const jwtToken = yield signIn(username, pwd, legacy);
+        // Initialize file storage for session persistence
+        const storage = createFileStorage();
+        configureAmplify(storage);
+        let jwtToken;
+        try {
+            jwtToken = yield getSession(false, legacy);
+        }
+        catch (_a) {
+            if (!username) {
+                throw new Error("No session found. Please provide --username to sign in.");
+            }
+            const pwd = password || (yield promptPassword());
+            jwtToken = yield signIn(username, pwd, legacy);
+        }
         const apiUrl = legacy ? OLD_API_URL : NEW_API_URL;
         const api = configure(apiUrl);
         const result = yield api.registerDevice(jwtToken, normalizedMac, serial, name, room);
@@ -162,14 +207,28 @@ const createProgram = () => {
         console.log(JSON.stringify(result, null, 2));
     }));
     // Command: editDevice
-    addLegacyOption(addMacOption(addAuthOptions(program.command("editDevice").description("Update device name and room"))))
+    addLegacyOption(addMacOption(addAuthOptions(program
+        .command("editDevice")
+        .description("Update device name and room"))))
         .requiredOption("-n, --name <deviceName>", "Device name")
         .requiredOption("-r, --room <deviceRoom>", "Room name")
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         const { username, password, mac, name, room, legacy = false } = options;
         const normalizedMac = mac.replace(/:/g, "");
-        const pwd = password || (yield promptPassword());
-        const jwtToken = yield signIn(username, pwd, legacy);
+        // Initialize file storage for session persistence
+        const storage = createFileStorage();
+        configureAmplify(storage);
+        let jwtToken;
+        try {
+            jwtToken = yield getSession(false, legacy);
+        }
+        catch (_a) {
+            if (!username) {
+                throw new Error("No session found. Please provide --username to sign in.");
+            }
+            const pwd = password || (yield promptPassword());
+            jwtToken = yield signIn(username, pwd, legacy);
+        }
         const apiUrl = legacy ? OLD_API_URL : NEW_API_URL;
         const api = configure(apiUrl);
         const result = yield api.editDevice(jwtToken, normalizedMac, name, room);

package/dist/esm/configureAmplify.test.d.ts

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

package/dist/esm/configureAmplify.test.js

@@ -0,0 +1,37 @@
+import { strict as assert } from "assert";
+import sinon from "sinon";
+import { configureAmplify } from "../src/library";
+/**
+ * This test file specifically tests the configureAmplify function with custom storage.
+ * It tests line 61 in library.ts:
+ * cognitoUserPoolsTokenProvider.setKeyValueStorage(storage)
+ *
+ * IMPORTANT: This file is named to run BEFORE library.test.ts (alphabetically)
+ * to ensure amplifyConfigured is still false when these tests run.
+ */
+describe("configureAmplify", () => {
+    it("should configure Amplify with custom storage", () => {
+        const mockStorage = {
+            setItem: sinon.stub().resolves(),
+            getItem: sinon.stub().resolves(null),
+            removeItem: sinon.stub().resolves(),
+            clear: sinon.stub().resolves(),
+        };
+        // Call configureAmplify with custom storage
+        // This is the first call in the test suite, so amplifyConfigured is false
+        // This should trigger line 61 in library.ts
+        configureAmplify(mockStorage);
+        // The test passes if no error is thrown
+        // Coverage confirms line 61 is executed
+        assert.ok(true, "configureAmplify with storage completed without error");
+    });
+    it("should only configure Amplify once (idempotent)", () => {
+        // Call configureAmplify multiple times without storage
+        configureAmplify();
+        configureAmplify();
+        configureAmplify();
+        // Should not throw or have any side effects
+        // The function returns early if already configured (line 58)
+        assert.ok(true, "Multiple calls to configureAmplify completed without error");
+    });
+});

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
 export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
 export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
-export { configure, signIn } from "./library";
+export { configure, getSession, signIn } from "./library";
 export { serialNumberDisplay, serialNumberFromHex, serialNumberToHex, } from "./serial-utils";
 export { BufferEncodedType, CommandsType, DeviceAssociationBody, DeviceAssociationResponse, DeviceInfoRawType, DeviceInfoType, EditDeviceAssociationBody, StatusType, TemperaturesType, UserParametersType, } from "./types";
-export declare const deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("./types").DeviceInfoType>, registerDevice: (jwtToken: string, macAddress: string, serialNumber: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, editDevice: (jwtToken: string, macAddress: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, 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, {}>>, getPower: (jwtToken: string, macAddress: string) => Promise<boolean>, getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>, getTargetTemperature: (jwtToken: string, macAddress: string) => Promise<number>, setTargetTemperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare const deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("./types").DeviceInfoType>, registerDevice: (jwtToken: string, macAddress: string, serialNumber: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, editDevice: (jwtToken: string, macAddress: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, setPower: (jwtToken: string, macAddress: string, value: number) => Promise<unknown>, setPowerOff: (jwtToken: string, macAddress: string) => Promise<unknown>, setPowerOn: (jwtToken: string, macAddress: string) => Promise<unknown>, getPower: (jwtToken: string, macAddress: string) => Promise<boolean>, getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>, getTargetTemperature: (jwtToken: string, macAddress: string) => Promise<number>, setTargetTemperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<unknown>;

package/dist/esm/index.js

@@ -1,6 +1,6 @@
 import { configure } from "./library";
 export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
 export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
-export { configure, signIn } from "./library";
+export { configure, getSession, signIn } from "./library";
 export { serialNumberDisplay, serialNumberFromHex, serialNumberToHex, } from "./serial-utils";
 export const { deviceInfo, registerDevice, editDevice, setPower, setPowerOff, setPowerOn, getPower, getEnvironmentTemperature, getTargetTemperature, setTargetTemperature, } = configure();

package/dist/esm/library.d.ts

@@ -8,6 +8,17 @@ import { DeviceAssociationResponse, DeviceInfoType } from "./types";
 declare const headers: (jwtToken: string) => {
     Authorization: string;
 };
+/**
+ * Configures Amplify if not already configured.
+ * Uses a local flag to avoid calling getConfig() which prints a warning.
+ * @param {object} [storage] - Optional custom storage adapter for token persistence
+ */
+declare const configureAmplify: (storage?: {
+    setItem: (key: string, value: string) => Promise<void>;
+    getItem: (key: string) => Promise<string | null>;
+    removeItem: (key: string) => Promise<void>;
+    clear: () => Promise<void>;
+}) => void;
 /**
  * Creates an authentication service with sign-in functionality.
  * @param {typeof amplifyAuth} auth - The authentication module to use.
@@ -15,8 +26,9 @@ declare const headers: (jwtToken: string) => {
  */
 declare const createAuthService: (auth: typeof amplifyAuth) => {
     signIn: (username: string, password: string, legacy?: boolean) => Promise<string>;
+    getSession: (forceRefresh?: boolean, legacy?: boolean) => Promise<string>;
 };
-declare const signIn: (username: string, password: string, legacy?: boolean) => Promise<string>;
+declare const signIn: (username: string, password: string, legacy?: boolean) => Promise<string>, getSession: (forceRefresh?: boolean, legacy?: boolean) => Promise<string>;
 /**
  * Configures the library for API interactions.
  * Initializes API methods with a specified base URL.
@@ -32,12 +44,12 @@ declare const configure: (baseURL?: string) => {
     deviceInfo: (jwtToken: string, macAddress: string) => Promise<DeviceInfoType>;
     registerDevice: (jwtToken: string, macAddress: string, serialNumber: string, deviceName?: string, deviceRoom?: string) => Promise<DeviceAssociationResponse>;
     editDevice: (jwtToken: string, macAddress: string, deviceName?: string, deviceRoom?: string) => Promise<DeviceAssociationResponse>;
-    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, {}>>;
+    setPower: (jwtToken: string, macAddress: string, value: number) => Promise<unknown>;
+    setPowerOff: (jwtToken: string, macAddress: string) => Promise<unknown>;
+    setPowerOn: (jwtToken: string, macAddress: string) => Promise<unknown>;
     getPower: (jwtToken: string, macAddress: string) => Promise<boolean>;
     getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>;
     getTargetTemperature: (jwtToken: string, macAddress: string) => Promise<number>;
-    setTargetTemperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    setTargetTemperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<unknown>;
 };
-export { configure, createAuthService, headers, signIn };
+export { configure, configureAmplify, createAuthService, getSession, headers, signIn, };