edilkamin 1.7.3 → 1.8.0

package/dist/cjs/src/library.js

@@ -0,0 +1,324 @@
+"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.signIn = exports.headers = exports.getSession = exports.createAuthService = exports.configureAmplify = exports.configure = void 0;
+const assert_1 = require("assert");
+const aws_amplify_1 = require("aws-amplify");
+const amplifyAuth = __importStar(require("aws-amplify/auth"));
+const cognito_1 = require("aws-amplify/auth/cognito");
+const buffer_utils_1 = require("./buffer-utils");
+const constants_1 = require("./constants");
+/**
+ * Makes a fetch request and returns parsed JSON response.
+ * Throws an error for non-2xx status codes.
+ */
+const fetchJson = (baseURL_1, path_1, ...args_1) => __awaiter(void 0, [baseURL_1, path_1, ...args_1], void 0, function* (baseURL, path, options = {}) {
+    const response = yield fetch(`${baseURL}${path}`, options);
+    if (!response.ok) {
+        throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+    }
+    return response.json();
+});
+const amplifyconfiguration = {
+    aws_project_region: "eu-central-1",
+    aws_user_pools_id: "eu-central-1_BYmQ2VBlo",
+    aws_user_pools_web_client_id: "7sc1qltkqobo3ddqsk4542dg2h",
+};
+/**
+ * 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}` });
+exports.headers = headers;
+let amplifyConfigured = false;
+/**
+ * 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
+ */
+const configureAmplify = (storage) => {
+    if (amplifyConfigured)
+        return;
+    aws_amplify_1.Amplify.configure(amplifyconfiguration);
+    if (storage) {
+        cognito_1.cognitoUserPoolsTokenProvider.setKeyValueStorage(storage);
+    }
+    amplifyConfigured = true;
+};
+exports.configureAmplify = configureAmplify;
+/**
+ * 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.
+     * @param {boolean} [legacy=false] - If true, returns accessToken for legacy API.
+     * @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_1, password_1, ...args_1) => __awaiter(void 0, [username_1, password_1, ...args_1], void 0, function* (username, password, legacy = false) {
+        configureAmplify();
+        yield auth.signOut(); // Ensure the user is signed out first
+        const { isSignedIn } = yield auth.signIn({ username, password });
+        assert_1.strict.ok(isSignedIn, "Sign-in failed");
+        const { tokens } = yield auth.fetchAuthSession();
+        assert_1.strict.ok(tokens, "No tokens found");
+        if (legacy) {
+            assert_1.strict.ok(tokens.accessToken, "No access token found");
+            return tokens.accessToken.toString();
+        }
+        assert_1.strict.ok(tokens.idToken, "No ID token found");
+        return tokens.idToken.toString();
+    });
+    /**
+     * Retrieves the current session, refreshing tokens if necessary.
+     * Requires a prior successful signIn() call.
+     * @param {boolean} [forceRefresh=false] - Force token refresh even if valid
+     * @param {boolean} [legacy=false] - If true, returns accessToken for legacy API
+     * @returns {Promise<string>} - The JWT token (idToken or accessToken)
+     * @throws {Error} - If no session exists (user needs to sign in)
+     */
+    const getSession = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (forceRefresh = false, legacy = false) {
+        configureAmplify();
+        const { tokens } = yield auth.fetchAuthSession({ forceRefresh });
+        assert_1.strict.ok(tokens, "No session found - please sign in first");
+        if (legacy) {
+            assert_1.strict.ok(tokens.accessToken, "No access token found");
+            return tokens.accessToken.toString();
+        }
+        assert_1.strict.ok(tokens.idToken, "No ID token found");
+        return tokens.idToken.toString();
+    });
+    return { signIn, getSession };
+};
+exports.createAuthService = createAuthService;
+// Create the default auth service using amplifyAuth
+const { signIn, getSession } = createAuthService(amplifyAuth);
+exports.signIn = signIn;
+exports.getSession = getSession;
+const deviceInfo = (baseURL) => 
+/**
+ * Retrieves information about a device by its MAC address.
+ * Automatically decompresses any gzip-compressed Buffer fields in the response.
+ *
+ * @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.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const data = yield fetchJson(baseURL, `device/${macAddress}/info`, {
+        method: "GET",
+        headers: headers(jwtToken),
+    });
+    // Process response to decompress any gzipped Buffer fields
+    return (0, buffer_utils_1.processResponse)(data);
+});
+const mqttCommand = (baseURL) => 
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+(jwtToken, macAddress, payload) => fetchJson(baseURL, "mqtt/command", {
+    method: "PUT",
+    headers: Object.assign({ "Content-Type": "application/json" }, headers(jwtToken)),
+    body: JSON.stringify(Object.assign({ mac_address: macAddress }, payload)),
+});
+const setPower = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress, { name: "power", value });
+const setPowerOn = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress, 1);
+const setPowerOff = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress, 0);
+const getPower = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress);
+    return info.status.commands.power;
+});
+const getEnvironmentTemperature = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress);
+    return info.status.temperatures.enviroment;
+});
+const getTargetTemperature = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.enviroment_1_temperature;
+});
+const setTargetTemperature = (baseURL) => 
+/**
+ * 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(baseURL)(jwtToken, macAddress, {
+    name: "enviroment_1_temperature",
+    value: temperature,
+});
+const registerDevice = (baseURL) => 
+/**
+ * Registers a device with the user's account.
+ * This must be called before other device operations will work on the new API.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device (colons optional).
+ * @param {string} serialNumber - The device serial number.
+ * @param {string} deviceName - User-friendly name for the device (default: empty string).
+ * @param {string} deviceRoom - Room name for the device (default: empty string).
+ * @returns {Promise<DeviceAssociationResponse>} - A promise that resolves to the registration response.
+ */
+(jwtToken_1, macAddress_1, serialNumber_1, ...args_1) => __awaiter(void 0, [jwtToken_1, macAddress_1, serialNumber_1, ...args_1], void 0, function* (jwtToken, macAddress, serialNumber, deviceName = "", deviceRoom = "") {
+    const body = {
+        macAddress: macAddress.replace(/:/g, ""),
+        deviceName,
+        deviceRoom,
+        serialNumber,
+    };
+    return fetchJson(baseURL, "device", {
+        method: "POST",
+        headers: Object.assign({ "Content-Type": "application/json" }, headers(jwtToken)),
+        body: JSON.stringify(body),
+    });
+});
+const editDevice = (baseURL) => 
+/**
+ * Updates a device's name and room.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device (colons optional).
+ * @param {string} deviceName - New name for the device (default: empty string).
+ * @param {string} deviceRoom - New room for the device (default: empty string).
+ * @returns {Promise<DeviceAssociationResponse>} - A promise that resolves to the update response.
+ */
+(jwtToken_1, macAddress_1, ...args_1) => __awaiter(void 0, [jwtToken_1, macAddress_1, ...args_1], void 0, function* (jwtToken, macAddress, deviceName = "", deviceRoom = "") {
+    const normalizedMac = macAddress.replace(/:/g, "");
+    const body = {
+        deviceName,
+        deviceRoom,
+    };
+    return fetchJson(baseURL, `device/${normalizedMac}`, {
+        method: "PUT",
+        headers: Object.assign({ "Content-Type": "application/json" }, headers(jwtToken)),
+        body: JSON.stringify(body),
+    });
+});
+/**
+ * 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 = constants_1.API_URL) => ({
+    deviceInfo: deviceInfo(baseURL),
+    registerDevice: registerDevice(baseURL),
+    editDevice: editDevice(baseURL),
+    setPower: setPower(baseURL),
+    setPowerOff: setPowerOff(baseURL),
+    setPowerOn: setPowerOn(baseURL),
+    getPower: getPower(baseURL),
+    getEnvironmentTemperature: getEnvironmentTemperature(baseURL),
+    getTargetTemperature: getTargetTemperature(baseURL),
+    setTargetTemperature: setTargetTemperature(baseURL),
+});
+exports.configure = configure;