edilkamin 1.7.3 → 1.7.4

package/dist/cjs/src/token-storage.js

@@ -0,0 +1,119 @@
+"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) {
+        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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearSession = exports.createFileStorage = void 0;
+const fs_1 = require("fs");
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+const TOKEN_DIR = path.join(os.homedir(), ".edilkamin");
+const TOKEN_FILE = path.join(TOKEN_DIR, "session.json");
+/**
+ * Custom storage adapter for AWS Amplify that persists to file system.
+ * Used for CLI to maintain sessions between invocations.
+ */
+const createFileStorage = () => {
+    let cache = {};
+    let loaded = false;
+    const ensureDir = () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield fs_1.promises.mkdir(TOKEN_DIR, { recursive: true, mode: 0o700 });
+        }
+        catch (_a) {
+            // Directory may already exist
+        }
+    });
+    const load = () => __awaiter(void 0, void 0, void 0, function* () {
+        if (loaded)
+            return;
+        try {
+            const data = yield fs_1.promises.readFile(TOKEN_FILE, "utf-8");
+            cache = JSON.parse(data);
+        }
+        catch (_a) {
+            cache = {};
+        }
+        loaded = true;
+    });
+    const save = () => __awaiter(void 0, void 0, void 0, function* () {
+        yield ensureDir();
+        yield fs_1.promises.writeFile(TOKEN_FILE, JSON.stringify(cache), {
+            encoding: "utf-8",
+            mode: 0o600,
+        });
+    });
+    return {
+        setItem: (key, value) => __awaiter(void 0, void 0, void 0, function* () {
+            yield load();
+            cache[key] = value;
+            yield save();
+        }),
+        getItem: (key) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            yield load();
+            return (_a = cache[key]) !== null && _a !== void 0 ? _a : null;
+        }),
+        removeItem: (key) => __awaiter(void 0, void 0, void 0, function* () {
+            yield load();
+            delete cache[key];
+            yield save();
+        }),
+        clear: () => __awaiter(void 0, void 0, void 0, function* () {
+            cache = {};
+            yield save();
+        }),
+    };
+};
+exports.createFileStorage = createFileStorage;
+/**
+ * Clears all stored session data.
+ */
+const clearSession = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield fs_1.promises.unlink(TOKEN_FILE);
+    }
+    catch (_a) {
+        // File may not exist
+    }
+});
+exports.clearSession = clearSession;

package/dist/cjs/src/types.js

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

package/dist/esm/package.json

@@ -0,0 +1,84 @@
+{
+    "name": "edilkamin",
+    "version": "1.7.4",
+    "description": "",
+    "main": "dist/cjs/src/index.js",
+    "module": "dist/esm/src/index.js",
+    "types": "dist/esm/src/index.d.ts",
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/esm/src/index.d.ts",
+                "default": "./dist/esm/src/index.js"
+            },
+            "require": {
+                "types": "./dist/cjs/src/index.d.ts",
+                "default": "./dist/cjs/src/index.js"
+            }
+        }
+    },
+    "scripts": {
+        "cli": "ts-node src/cli.ts",
+        "cli:debug": "node --inspect --require ts-node/register/transpile-only src/cli.ts",
+        "test": "nyc mocha --require ts-node/register src/*.test.ts",
+        "test:debug": "nyc mocha --require ts-node/register/transpile-only --inspect src/*.test.ts",
+        "lint:prettier": "prettier --check src docs .github *.json *.md *.mjs",
+        "format:prettier": "prettier --write src docs .github *.json *.md *.mjs",
+        "lint:eslint": "eslint src",
+        "format:eslint": "eslint --fix src",
+        "lint": "yarn lint:prettier && yarn lint:eslint",
+        "format": "yarn format:prettier && yarn format:eslint",
+        "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",
+        "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/cjs/src/cli.js"
+    },
+    "nyc": {
+        "reporter": [
+            "html",
+            "lcov",
+            "text"
+        ]
+    },
+    "dependencies": {
+        "aws-amplify": "^6.10.0",
+        "pako": "^2.1.0"
+    },
+    "devDependencies": {
+        "@eslint/eslintrc": "^3.2.0",
+        "@eslint/js": "^9.16.0",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^25.0.2",
+        "@types/pako": "^2.0.4",
+        "@types/sinon": "^17.0.3",
+        "@typescript-eslint/eslint-plugin": "^8.17.0",
+        "@typescript-eslint/parser": "^8.17.0",
+        "esbuild": "^0.27.1",
+        "eslint": "^9.16.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-prettier": "^5.2.1",
+        "eslint-plugin-simple-import-sort": "^12.1.1",
+        "mocha": "^11.7.5",
+        "nyc": "^17.1.0",
+        "prettier": "^3.7.4",
+        "sinon": "^19.0.2",
+        "ts-node": "^10.9.1",
+        "typedoc": "^0.28.15",
+        "typescript": "^5.7.2"
+    },
+    "optionalDependencies": {
+        "commander": "^12.1.0"
+    }
+}

package/dist/esm/{browser-bundle.test.js → src/browser-bundle.test.js}

@@ -15,7 +15,7 @@ describe("browser-bundle", () => {
         // 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"],
+            entryPoints: ["dist/esm/src/index.js"],
             platform: "browser",
             bundle: true,
             write: false,

package/dist/esm/src/buffer-utils.d.ts

@@ -0,0 +1,25 @@
+import { BufferEncodedType } from "./types";
+/**
+ * Type guard to check if a value is a serialized Node.js Buffer.
+ * Node.js Buffers serialize to JSON as: {type: "Buffer", data: [...]}
+ *
+ * @param value - The value to check
+ * @returns True if the value is a Buffer-encoded object
+ */
+declare const isBuffer: (value: unknown) => value is BufferEncodedType;
+/**
+ * Decompresses a Buffer-encoded gzip object and parses the resulting JSON.
+ *
+ * @param bufferObj - A serialized Buffer object containing gzip data
+ * @returns The decompressed and parsed JSON data, or the original object on failure
+ */
+declare const decompressBuffer: (bufferObj: BufferEncodedType) => unknown;
+/**
+ * Recursively processes an API response to decompress any Buffer-encoded fields.
+ * Handles nested objects and arrays, preserving structure while decompressing.
+ *
+ * @param data - The API response data to process
+ * @returns The processed data with all Buffer fields decompressed
+ */
+declare const processResponse: <T>(data: T) => T;
+export { decompressBuffer, isBuffer, processResponse };

package/dist/esm/src/buffer-utils.test.d.ts

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

package/dist/esm/src/cli.d.ts

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

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

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

package/dist/esm/src/constants.d.ts

@@ -0,0 +1,4 @@
+declare const OLD_API_URL = "https://fxtj7xkgc6.execute-api.eu-central-1.amazonaws.com/prod/";
+declare const NEW_API_URL = "https://the-mind-api.edilkamin.com/";
+declare const API_URL = "https://the-mind-api.edilkamin.com/";
+export { API_URL, NEW_API_URL, OLD_API_URL };

package/dist/esm/src/index.d.ts

@@ -0,0 +1,6 @@
+export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
+export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
+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<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/src/library.d.ts

@@ -0,0 +1,55 @@
+import * as amplifyAuth from "aws-amplify/auth";
+import { DeviceAssociationResponse, DeviceInfoType } from "./types";
+/**
+ * Generates headers with a JWT token for authenticated requests.
+ * @param {string} jwtToken - The JWT token for authorization.
+ * @returns {object} - The headers object with the Authorization field.
+ */
+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.
+ * @returns {object} - An object containing authentication-related methods.
+ */
+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>, getSession: (forceRefresh?: boolean, legacy?: boolean) => Promise<string>;
+/**
+ * Configures the library for API interactions.
+ * Initializes API methods with a specified base URL.
+ *
+ * @param {string} [baseURL=API_URL] - The base URL for the API.
+ * @returns {object} - An object containing methods for interacting with the API.
+ *
+ * @example
+ * const api = configure();
+ * const power = await api.getPower(jwtToken, macAddress);
+ */
+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<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>;
+};
+export { configure, configureAmplify, createAuthService, getSession, headers, signIn, };

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

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

package/dist/esm/src/serial-utils.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Converts a raw serial number string to hex-encoded format.
+ * This is useful when serial numbers contain non-printable characters.
+ *
+ * @param serial - The raw serial number string
+ * @returns Hex-encoded string representation
+ *
+ * @example
+ * serialNumberToHex("EDK123") // returns "45444b313233"
+ */
+declare const serialNumberToHex: (serial: string) => string;
+/**
+ * Converts a hex-encoded serial number back to raw string format.
+ *
+ * @param hex - The hex-encoded serial number
+ * @returns Raw serial number string
+ *
+ * @example
+ * serialNumberFromHex("45444b313233") // returns "EDK123"
+ */
+declare const serialNumberFromHex: (hex: string) => string;
+/**
+ * Produces a display-friendly version of a serial number by removing
+ * non-printable characters and collapsing whitespace.
+ *
+ * @param serial - The raw serial number string
+ * @returns Display-friendly serial number
+ *
+ * @example
+ * serialNumberDisplay("EDK\x00123\x1F") // returns "EDK123"
+ */
+declare const serialNumberDisplay: (serial: string) => string;
+export { serialNumberDisplay, serialNumberFromHex, serialNumberToHex };

package/dist/esm/src/serial-utils.test.d.ts

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

package/dist/esm/src/token-storage.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Custom storage adapter for AWS Amplify that persists to file system.
+ * Used for CLI to maintain sessions between invocations.
+ */
+export declare const createFileStorage: () => {
+    setItem: (key: string, value: string) => Promise<void>;
+    getItem: (key: string) => Promise<string | null>;
+    removeItem: (key: string) => Promise<void>;
+    clear: () => Promise<void>;
+};
+/**
+ * Clears all stored session data.
+ */
+export declare const clearSession: () => Promise<void>;

package/dist/esm/src/types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Represents a Node.js Buffer object serialized to JSON.
+ * This format is used by the Edilkamin API for gzip-compressed fields.
+ */
+interface BufferEncodedType {
+    type: "Buffer";
+    data: number[];
+}
+interface CommandsType {
+    power: boolean;
+}
+interface TemperaturesType {
+    board: number;
+    enviroment: number;
+}
+interface StatusType {
+    commands: CommandsType;
+    temperatures: TemperaturesType;
+}
+interface UserParametersType {
+    enviroment_1_temperature: number;
+    enviroment_2_temperature: number;
+    enviroment_3_temperature: number;
+    is_auto: boolean;
+    is_sound_active: boolean;
+}
+interface DeviceInfoType {
+    status: StatusType;
+    nvm: {
+        user_parameters: UserParametersType;
+    };
+}
+/**
+ * Raw device info response that may contain Buffer-encoded compressed fields.
+ * Used internally before processing; external callers receive DeviceInfoType.
+ */
+interface DeviceInfoRawType {
+    status: StatusType | BufferEncodedType;
+    nvm: {
+        user_parameters: UserParametersType;
+    } | BufferEncodedType;
+    component_info?: BufferEncodedType | Record<string, unknown>;
+}
+/**
+ * Request body for registering a device with a user account.
+ * All fields are required by the API.
+ */
+interface DeviceAssociationBody {
+    macAddress: string;
+    deviceName: string;
+    deviceRoom: string;
+    serialNumber: string;
+}
+/**
+ * Request body for editing a device's name and room.
+ * MAC address is specified in the URL path, not the body.
+ * Serial number cannot be changed after registration.
+ */
+interface EditDeviceAssociationBody {
+    deviceName: string;
+    deviceRoom: string;
+}
+/**
+ * Response from device registration endpoint.
+ * Structure based on Android app behavior - may need adjustment after testing.
+ */
+interface DeviceAssociationResponse {
+    macAddress: string;
+    deviceName: string;
+    deviceRoom: string;
+    serialNumber: string;
+}
+export type { BufferEncodedType, CommandsType, DeviceAssociationBody, DeviceAssociationResponse, DeviceInfoRawType, DeviceInfoType, EditDeviceAssociationBody, StatusType, TemperaturesType, UserParametersType, };

package/dist/esm/src/types.js

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

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "edilkamin",
-  "version": "1.7.3",
+  "version": "1.7.4",
   "description": "",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/esm/index.d.ts",
+  "main": "dist/cjs/src/index.js",
+  "module": "dist/esm/src/index.js",
+  "types": "dist/esm/src/index.d.ts",
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
+        "types": "./dist/esm/src/index.d.ts",
+        "default": "./dist/esm/src/index.js"
       },
       "require": {
-        "types": "./dist/cjs/index.d.ts",
-        "default": "./dist/cjs/index.js"
+        "types": "./dist/cjs/src/index.d.ts",
+        "default": "./dist/cjs/src/index.js"
       }
     }
   },
@@ -43,7 +43,7 @@
   },
   "homepage": "https://github.com/AndreMiras/edilkamin.js#readme",
   "bin": {
-    "edilkamin": "dist/cjs/cli.js"
+    "edilkamin": "dist/cjs/src/cli.js"
   },
   "nyc": {
     "reporter": [
@@ -57,10 +57,10 @@
     "pako": "^2.1.0"
   },
   "devDependencies": {
-    "@aws-amplify/cli": "^7.6.21",
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.16.0",
     "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.2",
     "@types/pako": "^2.0.4",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^8.17.0",

package/src/browser-bundle.test.ts

@@ -7,7 +7,7 @@ describe("browser-bundle", () => {
     // 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 = await esbuild.build({
-      entryPoints: ["dist/esm/index.js"],
+      entryPoints: ["dist/esm/src/index.js"],
       platform: "browser",
       bundle: true,
       write: false,

package/tsconfig.cjs.json

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

package/tsconfig.json

@@ -1,10 +1,9 @@
 {
   "compilerOptions": {
-    "target": "es6",
     "target": "es6",
     "moduleResolution": "node",
     "outDir": "dist",
-    "rootDir": "src",
+    "rootDir": ".",
     "strict": true,
     "declaration": true,
     "esModuleInterop": true,
@@ -13,5 +12,5 @@
     "noUnusedParameters": true,
     "preserveConstEnums": true
   },
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts", "package.json"]
 }