edilkamin 1.4.0 → 1.5.0

package/.github/workflows/publish.yml

@@ -2,8 +2,7 @@ name: Publish
 
 on:
   push:
-    tags:
-      - "*"
+  pull_request:
 
 jobs:
   build:
@@ -17,6 +16,8 @@ jobs:
           registry-url: "https://registry.npmjs.org"
       - run: yarn install
       - run: yarn build
+      - run: npm publish --dry-run
       - run: npm publish
+        if: startsWith(github.ref, 'refs/tags/')
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

package/.github/workflows/tests.yml

@@ -19,4 +19,11 @@ jobs:
       - run: yarn install
       - run: yarn lint
       - run: yarn build
-      - run: npm publish --dry-run
+      - run: yarn test
+      - uses: codecov/codecov-action@v5
+        with:
+          files: ./coverage/lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

package/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![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)
 [![npm version](https://badge.fury.io/js/edilkamin.svg)](https://badge.fury.io/js/edilkamin)
 

package/dist/esm/cli.js

@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { signIn, configure } from "./library";
 import { Command } from "commander";
 import readline from "readline";
 import { version } from "../package.json";
+import { configure, signIn } from "./library";
 const promptPassword = () => {
     const rl = readline.createInterface({
         input: process.stdin,
@@ -39,9 +39,48 @@ const promptPassword = () => {
  * @param command The command to which options should be added.
  * @returns The command with options added.
  */
-const addCommonOptions = (command) => command
+const addAuthOptions = (command) => command
     .requiredOption("-u, --username <username>", "Username")
     .option("-p, --password <password>", "Password");
+/**
+ * Adds MAC address option to a command.
+ * @param command The command to which the MAC address option should be added.
+ * @returns The command with the MAC address option added.
+ */
+const addMacOption = (command) => command.requiredOption("-m, --mac <macAddress>", "MAC address of the device");
+/**
+ * Handles common authentication and API initialization logic.
+ * @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 } = options;
+    const normalizedMac = mac.replace(/:/g, "");
+    const pwd = password || (yield promptPassword());
+    const jwtToken = yield signIn(username, pwd);
+    const api = configure();
+    return { normalizedMac, jwtToken, api };
+});
+/**
+ * Executes a getter command by handling common steps (authentication, API initialization).
+ * @param options The options passed from the CLI command.
+ * @param getter A function to call on the configured API object.
+ */
+const executeGetter = (options, getter) => __awaiter(void 0, void 0, void 0, function* () {
+    const { normalizedMac, jwtToken, api } = yield initializeCommand(options);
+    const result = yield getter(api, jwtToken, normalizedMac);
+    console.log(result);
+});
+/**
+ * Executes a setter command by handling common steps (authentication, API initialization).
+ * @param options The options passed from the CLI command.
+ * @param setter A function to call on the configured API object.
+ */
+const executeSetter = (options, setter) => __awaiter(void 0, void 0, void 0, function* () {
+    const { normalizedMac, jwtToken, api } = yield initializeCommand(options);
+    const result = yield setter(api, jwtToken, normalizedMac, options.value);
+    console.log(result);
+});
 const createProgram = () => {
     const program = new Command();
     program
@@ -49,24 +88,52 @@ const createProgram = () => {
         .description("CLI tool for interacting with the Edilkamin API")
         .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* () {
+    addAuthOptions(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 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 signIn(username, pwd);
-        const api = configure(); // Use the default API configuration
-        const deviceInfo = yield api.deviceInfo(jwtToken, mac);
-        console.log("Device Info:", deviceInfo.data);
-    }));
+    // Generic getter commands
+    [
+        {
+            commandName: "deviceInfo",
+            description: "Retrieve device info for a specific MAC address",
+            getter: (api, jwtToken, mac) => api.deviceInfo(jwtToken, mac),
+        },
+        {
+            commandName: "getPower",
+            description: "Retrieve device power status",
+            getter: (api, jwtToken, mac) => api.getPower(jwtToken, mac),
+        },
+        {
+            commandName: "getEnvironmentTemperature",
+            description: "Retrieve environment temperature",
+            getter: (api, jwtToken, mac) => api.getEnvironmentTemperature(jwtToken, mac),
+        },
+        {
+            commandName: "getTargetTemperature",
+            description: "Retrieve target temperature",
+            getter: (api, jwtToken, mac) => api.getTargetTemperature(jwtToken, mac),
+        },
+    ].forEach(({ commandName, description, getter }) => {
+        addMacOption(addAuthOptions(program.command(commandName).description(description))).action((options) => executeGetter(options, getter));
+    });
+    // Generic setter commands
+    [
+        {
+            commandName: "setPower",
+            description: "Set the power state of the device (1 for ON, 0 for OFF)",
+            setter: (api, jwtToken, mac, value) => api.setPower(jwtToken, mac, value),
+        },
+        {
+            commandName: "setTargetTemperature",
+            description: "Set the target temperature (degree celsius) for a device",
+            setter: (api, jwtToken, mac, value) => api.setTargetTemperature(jwtToken, mac, value),
+        },
+    ].forEach(({ commandName, description, setter }) => {
+        addMacOption(addAuthOptions(program.command(commandName).description(description)).requiredOption("-v, --value <number>", "Value to set", parseFloat)).action((options) => executeSetter(options, setter));
+    });
     return program;
 };
 const main = () => {

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
 export { API_URL } from "./constants";
+export { configure, signIn } from "./library";
 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>>;
+export declare const deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("./types").DeviceInfoType>, 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>>;

package/dist/esm/index.js

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

package/dist/esm/library.d.ts

@@ -1,12 +1,41 @@
+import * as amplifyAuth from "aws-amplify/auth";
 import { DeviceInfoType } from "./types";
 /**
- * Sign in to return the JWT token.
+ * 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;
+};
+/**
+ * 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) => Promise<string>;
+};
 declare const signIn: (username: string, password: string) => 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<import("axios").AxiosResponse<DeviceInfoType, any>>;
+    deviceInfo: (jwtToken: string, macAddress: string) => Promise<DeviceInfoType>;
     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 { signIn, configure };
+export { configure, createAuthService, headers, signIn };

package/dist/esm/library.js

@@ -17,42 +17,180 @@ const amplifyconfiguration = {
     aws_user_pools_id: "eu-central-1_BYmQ2VBlo",
     aws_user_pools_web_client_id: "7sc1qltkqobo3ddqsk4542dg2h",
 };
-Amplify.configure(amplifyconfiguration);
+/**
+ * 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.
+ */
 const headers = (jwtToken) => ({ Authorization: `Bearer ${jwtToken}` });
 /**
- * Sign in to return the JWT token.
+ * Configures Amplify if not already configured.
+ * Ensures the configuration is only applied once.
+ */
+const configureAmplify = () => {
+    const currentConfig = Amplify.getConfig();
+    if (Object.keys(currentConfig).length !== 0)
+        return;
+    Amplify.configure(amplifyconfiguration);
+};
+/**
+ * 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.
+ */
+const createAuthService = (auth) => {
+    /**
+     * Signs in a user with the provided credentials.
+     * @param {string} username - The username of the user.
+     * @param {string} password - The password of the user.
+     * @returns {Promise<string>} - The JWT token of the signed-in user.
+     * @throws {Error} - If sign-in fails or no tokens are retrieved.
+     */
+    const signIn = (username, password) => __awaiter(void 0, void 0, void 0, function* () {
+        configureAmplify();
+        yield auth.signOut(); // Ensure the user is signed out first
+        const { isSignedIn } = yield auth.signIn({ username, password });
+        assert.ok(isSignedIn, "Sign-in failed");
+        const { tokens } = yield auth.fetchAuthSession();
+        assert.ok(tokens, "No tokens found");
+        return tokens.accessToken.toString();
+    });
+    return { signIn };
+};
+// Create the default auth service using amplifyAuth
+const { signIn } = createAuthService(amplifyAuth);
+const deviceInfo = (axiosInstance) => 
+/**
+ * Retrieves information about a device by its MAC address.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<DeviceInfoType>} - A promise that resolves to the device info.
  */
-const signIn = (username, password) => __awaiter(void 0, void 0, void 0, function* () {
-    // 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,
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield axiosInstance.get(`device/${macAddress}/info`, {
+        headers: headers(jwtToken),
     });
-    assert.ok(isSignedIn);
-    const { tokens } = yield amplifyAuth.fetchAuthSession();
-    assert.ok(tokens);
-    return tokens.accessToken.toString();
+    return response.data;
+});
+const mqttCommand = (axiosInstance) => 
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+(jwtToken, macAddress, payload) => axiosInstance.put("mqtt/command", Object.assign({ mac_address: macAddress }, payload), { headers: headers(jwtToken) });
+const setPower = (axiosInstance) => 
+/**
+ * Sends a command to set the power state of a device.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @param {number} value - The desired power state (1 for ON, 0 for OFF).
+ * @returns {Promise<string>} - A promise that resolves to the command response.
+ */
+(jwtToken, macAddress, value) => mqttCommand(axiosInstance)(jwtToken, macAddress, { name: "power", value });
+const setPowerOn = (axiosInstance) => 
+/**
+ * Turns a device ON by setting its power state.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<string>} - A promise that resolves to the command response.
+ *
+ * @example
+ * const response = await api.setPowerOn(jwtToken, macAddress);
+ * console.log(response);
+ */
+(jwtToken, macAddress) => setPower(axiosInstance)(jwtToken, macAddress, 1);
+const setPowerOff = (axiosInstance) => 
+/**
+ * Turns a device OFF by setting its power state.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<string>} - A promise that resolves to the command response.
+ *
+ * @example
+ * const response = await api.setPowerOff(jwtToken, macAddress);
+ * console.log(response);
+ */
+(jwtToken, macAddress) => setPower(axiosInstance)(jwtToken, macAddress, 0);
+const getPower = (axiosInstance) => 
+/**
+ * Retrieves the power status of the device.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<boolean>} - A promise that resolves to the power status.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(axiosInstance)(jwtToken, macAddress);
+    return info.status.commands.power;
+});
+const getEnvironmentTemperature = (axiosInstance) => 
+/**
+ * Retrieves the environment temperature from the device's sensors.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<number>} - A promise that resolves to the temperature value.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(axiosInstance)(jwtToken, macAddress);
+    return info.status.temperatures.enviroment;
 });
-const deviceInfo = (axiosInstance) => (jwtToken, macAddress) => axiosInstance.get(`device/${macAddress}/info`, {
-    headers: headers(jwtToken),
+const getTargetTemperature = (axiosInstance) => 
+/**
+ * Retrieves the target temperature value set on the device.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<number>} - A promise that resolves to the target temperature (degree celsius).
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(axiosInstance)(jwtToken, macAddress);
+    return info.nvm.user_parameters.enviroment_1_temperature;
 });
-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 setTargetTemperature = (axiosInstance) => 
+/**
+ * Sends a command to set the target temperature (degree celsius) of a device.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @param {number} temperature - The desired target temperature (degree celsius).
+ * @returns {Promise<string>} - A promise that resolves to the command response.
+ */
+(jwtToken, macAddress, temperature) => mqttCommand(axiosInstance)(jwtToken, macAddress, {
+    name: "enviroment_1_temperature",
+    value: temperature,
+});
+/**
+ * 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);
+ */
 const configure = (baseURL = API_URL) => {
     const axiosInstance = axios.create({ baseURL });
     const deviceInfoInstance = deviceInfo(axiosInstance);
     const setPowerInstance = setPower(axiosInstance);
     const setPowerOffInstance = setPowerOff(axiosInstance);
     const setPowerOnInstance = setPowerOn(axiosInstance);
+    const getPowerInstance = getPower(axiosInstance);
+    const getEnvironmentTemperatureInstance = getEnvironmentTemperature(axiosInstance);
+    const getTargetTemperatureInstance = getTargetTemperature(axiosInstance);
+    const setTargetTemperatureInstance = setTargetTemperature(axiosInstance);
     return {
         deviceInfo: deviceInfoInstance,
         setPower: setPowerInstance,
         setPowerOff: setPowerOffInstance,
         setPowerOn: setPowerOnInstance,
+        getPower: getPowerInstance,
+        getEnvironmentTemperature: getEnvironmentTemperatureInstance,
+        getTargetTemperature: getTargetTemperatureInstance,
+        setTargetTemperature: setTargetTemperatureInstance,
     };
 };
-export { signIn, configure };
+export { configure, createAuthService, headers, signIn };