mclimate-payload-helper 1.2.6 → 1.2.8

package/.eslintrc.cjs

@@ -0,0 +1,18 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+	root: true,
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: './tsconfig.json',
+		tsconfigRootDir: __dirname,
+	},
+	env: {
+		node: true,
+		es2021: true,
+		jest: true,
+	},
+	plugins: ['@typescript-eslint', 'jest'],
+	extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:jest/recommended', 'prettier'],
+	ignorePatterns: ['dist', 'node_modules', 'jest.config.ts'],
+	rules: {},
+}

package/.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+set -e
+npm run format:check
+npm run type-check
+npm run lint
+npm run test

package/CLAUDE.md

@@ -5,17 +5,20 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Common Development Commands
 
 ### Building the Package
+
 ```bash
 npm run build  # Compiles TypeScript and resolves path aliases
 ```
 
 ### Running Tests
+
 ```bash
 npm test       # Runs all tests
 npm test -- [pattern]  # Run specific test files
 ```
 
 ### Publishing
+
 ```bash
 npm publish    # Publishes to npm (runs build automatically via prepublishOnly)
 ```
@@ -25,12 +28,14 @@ npm publish    # Publishes to npm (runs build automatically via prepublishOnly)
 This is a TypeScript library for encoding and decoding payloads for MClimate IoT devices. The codebase is organized into three main areas:
 
 ### 1. Decoders (`src/decoders/`)
+
 - **Purpose**: Parse incoming device payloads (hex strings) into structured data
 - **Entry Point**: `uplinkPayloadParser` in `src/decoders/payloadParsers/uplinkPayloadParser.ts`
 - **Device Parsers**: Individual parser classes in `src/decoders/payloadParsers/` (e.g., `VickiPayloadParser`, `HTSensorPayloadParser`)
 - **Command Reading**: `commandsReadingHelper.ts` handles parsing of command responses
 
 ### 2. Encoders (`src/encoders/`)
+
 - **Purpose**: Build commands to send to devices
 - **Entry Point**: `CommandBuilder` class that routes to device-specific command classes
 - **Command Classes**: Each device has its own command class (e.g., `VickiCommands`, `HTSensorCommands`)
@@ -38,6 +43,7 @@ This is a TypeScript library for encoding and decoding payloads for MClimate IoT
 - **Schemas**: Command validation schemas in `src/encoders/types/schemas.ts`
 
 ### 3. Type System
+
 - **Device Types**: Enumerated in `src/decoders/payloadParsers/types/allDevices.ts`
 - **Path Aliases**: Uses `@/` prefix for absolute imports from `src/`
 - **Zod Schemas**: Used for command parameter validation
@@ -45,6 +51,7 @@ This is a TypeScript library for encoding and decoding payloads for MClimate IoT
 ## Key Implementation Patterns
 
 ### Adding New Devices
+
 1. Add device type to `DeviceType` enum
 2. Create payload parser class and export it
 3. Add parser case to `uplinkPayloadParser` switch
@@ -55,12 +62,14 @@ This is a TypeScript library for encoding and decoding payloads for MClimate IoT
 6. Define Zod schema for command validation
 
 ### Command Structure
+
 - Commands use hexadecimal encoding
 - Each command extends `BaseCommand`
 - Commands can be combined using `CommandBuilder.combine()`
 - Mixins used for shared command sets (e.g., `TemperatureCommonCommands`)
 
 ### Testing
+
 - Tests located in `src/test/`
 - Separate test files for decoders and encoders
-- Uses Jest with TypeScript support
+- Uses Jest with TypeScript support

package/add-encoder-command-existing.md

@@ -184,27 +184,27 @@ export namespace [YourDeviceCommandTypes] {
 ```typescript
 /* --------------------------------------- CO2 PIR LITE COMMANDS --------------------------------------- */
 const Co2PirLiteCommandSchemas = {
- ...GeneralCommandSchemas,
- ...PIRCommandSchemas,
- setUplinkSendingOnButtonPress: z.object({
-  value: z.number(),
- }),
- getUplinkSendingOnButtonPress: z.object({}),
- restartDevice: z.object({}),
- setCo2BoundaryLevels: z.object({
-  good_medium: z.number(),
-  medium_bad: z.number(),
- }),
- getCo2BoundaryLevels: z.object({}),
- // ... more commands
+	...GeneralCommandSchemas,
+	...PIRCommandSchemas,
+	setUplinkSendingOnButtonPress: z.object({
+		value: z.number(),
+	}),
+	getUplinkSendingOnButtonPress: z.object({}),
+	restartDevice: z.object({}),
+	setCo2BoundaryLevels: z.object({
+		good_medium: z.number(),
+		medium_bad: z.number(),
+	}),
+	getCo2BoundaryLevels: z.object({}),
+	// ... more commands
 }
 
 export namespace Co2PirLiteCommandTypes {
- export type SetUplinkSendingOnButtonPressParams = z.infer<
-  typeof Co2PirLiteCommandSchemas.setUplinkSendingOnButtonPress
- >
- export type RestartDeviceParams = z.infer<typeof Co2PirLiteCommandSchemas.restartDevice>
- export type SetCo2BoundaryLevelsParams = z.infer<typeof Co2PirLiteCommandSchemas.setCo2BoundaryLevels>
+	export type SetUplinkSendingOnButtonPressParams = z.infer<
+		typeof Co2PirLiteCommandSchemas.setUplinkSendingOnButtonPress
+	>
+	export type RestartDeviceParams = z.infer<typeof Co2PirLiteCommandSchemas.restartDevice>
+	export type SetCo2BoundaryLevelsParams = z.infer<typeof Co2PirLiteCommandSchemas.setCo2BoundaryLevels>
 }
 ```
 
@@ -243,31 +243,31 @@ import { CustomError } from '@/utils'
 import { MyDeviceCommandTypes, DeviceCommandSchemas } from '@/encoders/types'
 
 export class MyDeviceCommands {
- static setTemperature(params: MyDeviceCommandTypes.SetTemperatureParams) {
-  try {
-   DeviceCommandSchemas.MyDeviceCommandSchemas.setTemperature.parse(params)
-   const { value } = params
-   return new BaseCommand('SetTemperature', 0x15, value)
-  } catch (e) {
-   if (e instanceof ZodError) {
-    throw new CustomError({
-     message: 'Zod validation error during SetTemperature execution',
-     command: 'SetTemperature',
-     originalError: e,
-    })
-   } else {
-    throw new CustomError({
-     message: 'Error during SetTemperature execution',
-     command: 'SetTemperature',
-     originalError: e as Error,
-    })
-   }
-  }
- }
-
- static getTemperature() {
-  return new BaseCommand('GetTemperature', 0x16)
- }
+	static setTemperature(params: MyDeviceCommandTypes.SetTemperatureParams) {
+		try {
+			DeviceCommandSchemas.MyDeviceCommandSchemas.setTemperature.parse(params)
+			const { value } = params
+			return new BaseCommand('SetTemperature', 0x15, value)
+		} catch (e) {
+			if (e instanceof ZodError) {
+				throw new CustomError({
+					message: 'Zod validation error during SetTemperature execution',
+					command: 'SetTemperature',
+					originalError: e,
+				})
+			} else {
+				throw new CustomError({
+					message: 'Error during SetTemperature execution',
+					command: 'SetTemperature',
+					originalError: e as Error,
+				})
+			}
+		}
+	}
+
+	static getTemperature() {
+		return new BaseCommand('GetTemperature', 0x16)
+	}
 }
 ```
 
@@ -276,21 +276,21 @@ export class MyDeviceCommands {
 ```typescript
 /* --------------------------------------- MY DEVICE COMMANDS --------------------------------------- */
 const MyDeviceCommandSchemas = {
- ...GeneralCommandSchemas,
- setTemperature: z.object({
-  value: z.number().min(-40).max(85),
- }),
- getTemperature: z.object({}),
+	...GeneralCommandSchemas,
+	setTemperature: z.object({
+		value: z.number().min(-40).max(85),
+	}),
+	getTemperature: z.object({}),
 }
 
 export namespace MyDeviceCommandTypes {
- export type SetTemperatureParams = z.infer<typeof MyDeviceCommandSchemas.setTemperature>
+	export type SetTemperatureParams = z.infer<typeof MyDeviceCommandSchemas.setTemperature>
 }
 
 // Then add to the export at bottom:
 export const DeviceCommandSchemas = {
- // ... existing schemas
- MyDeviceCommandSchemas,
+	// ... existing schemas
+	MyDeviceCommandSchemas,
 }
 ```
 

package/add-encoder-command-new.md

@@ -230,27 +230,27 @@ export namespace [YourDeviceCommandTypes] {
 ```typescript
 /* --------------------------------------- CO2 PIR LITE COMMANDS --------------------------------------- */
 const Co2PirLiteCommandSchemas = {
- ...GeneralCommandSchemas,
- ...PIRCommandSchemas,
- setUplinkSendingOnButtonPress: z.object({
-  value: z.number(),
- }),
- getUplinkSendingOnButtonPress: z.object({}),
- restartDevice: z.object({}),
- setCo2BoundaryLevels: z.object({
-  good_medium: z.number(),
-  medium_bad: z.number(),
- }),
- getCo2BoundaryLevels: z.object({}),
- // ... more commands
+	...GeneralCommandSchemas,
+	...PIRCommandSchemas,
+	setUplinkSendingOnButtonPress: z.object({
+		value: z.number(),
+	}),
+	getUplinkSendingOnButtonPress: z.object({}),
+	restartDevice: z.object({}),
+	setCo2BoundaryLevels: z.object({
+		good_medium: z.number(),
+		medium_bad: z.number(),
+	}),
+	getCo2BoundaryLevels: z.object({}),
+	// ... more commands
 }
 
 export namespace Co2PirLiteCommandTypes {
- export type SetUplinkSendingOnButtonPressParams = z.infer<
-  typeof Co2PirLiteCommandSchemas.setUplinkSendingOnButtonPress
- >
- export type RestartDeviceParams = z.infer<typeof Co2PirLiteCommandSchemas.restartDevice>
- export type SetCo2BoundaryLevelsParams = z.infer<typeof Co2PirLiteCommandSchemas.setCo2BoundaryLevels>
+	export type SetUplinkSendingOnButtonPressParams = z.infer<
+		typeof Co2PirLiteCommandSchemas.setUplinkSendingOnButtonPress
+	>
+	export type RestartDeviceParams = z.infer<typeof Co2PirLiteCommandSchemas.restartDevice>
+	export type SetCo2BoundaryLevelsParams = z.infer<typeof Co2PirLiteCommandSchemas.setCo2BoundaryLevels>
 }
 ```
 
@@ -293,31 +293,31 @@ import { CustomError } from '@/utils'
 import { MyDeviceCommandTypes, DeviceCommandSchemas } from '@/encoders/types'
 
 export class MyDeviceCommands {
- static setTemperature(params: MyDeviceCommandTypes.SetTemperatureParams) {
-  try {
-   DeviceCommandSchemas.MyDeviceCommandSchemas.setTemperature.parse(params)
-   const { value } = params
-   return new BaseCommand('SetTemperature', 0x15, value)
-  } catch (e) {
-   if (e instanceof ZodError) {
-    throw new CustomError({
-     message: 'Zod validation error during SetTemperature execution',
-     command: 'SetTemperature',
-     originalError: e,
-    })
-   } else {
-    throw new CustomError({
-     message: 'Error during SetTemperature execution',
-     command: 'SetTemperature',
-     originalError: e as Error,
-    })
-   }
-  }
- }
-
- static getTemperature() {
-  return new BaseCommand('GetTemperature', 0x16)
- }
+	static setTemperature(params: MyDeviceCommandTypes.SetTemperatureParams) {
+		try {
+			DeviceCommandSchemas.MyDeviceCommandSchemas.setTemperature.parse(params)
+			const { value } = params
+			return new BaseCommand('SetTemperature', 0x15, value)
+		} catch (e) {
+			if (e instanceof ZodError) {
+				throw new CustomError({
+					message: 'Zod validation error during SetTemperature execution',
+					command: 'SetTemperature',
+					originalError: e,
+				})
+			} else {
+				throw new CustomError({
+					message: 'Error during SetTemperature execution',
+					command: 'SetTemperature',
+					originalError: e as Error,
+				})
+			}
+		}
+	}
+
+	static getTemperature() {
+		return new BaseCommand('GetTemperature', 0x16)
+	}
 }
 ```
 
@@ -326,21 +326,21 @@ export class MyDeviceCommands {
 ```typescript
 /* --------------------------------------- MY DEVICE COMMANDS --------------------------------------- */
 const MyDeviceCommandSchemas = {
- ...GeneralCommandSchemas,
- setTemperature: z.object({
-  value: z.number().min(-40).max(85),
- }),
- getTemperature: z.object({}),
+	...GeneralCommandSchemas,
+	setTemperature: z.object({
+		value: z.number().min(-40).max(85),
+	}),
+	getTemperature: z.object({}),
 }
 
 export namespace MyDeviceCommandTypes {
- export type SetTemperatureParams = z.infer<typeof MyDeviceCommandSchemas.setTemperature>
+	export type SetTemperatureParams = z.infer<typeof MyDeviceCommandSchemas.setTemperature>
 }
 
 // Then add to the export at bottom:
 export const DeviceCommandSchemas = {
- // ... existing schemas
- MyDeviceCommandSchemas,
+	// ... existing schemas
+	MyDeviceCommandSchemas,
 }
 ```
 

package/dist/decoders/commandsReadingHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commandsReadingHelper.d.ts","sourceRoot":"","sources":["../../src/decoders/commandsReadingHelper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAG5D,eAAO,MAAM,qBAAqB,YAAa,MAAM,iBAAiB,MAAM,cAAc,UAAU,mBA6tFnG,CAAA"}
+{"version":3,"file":"commandsReadingHelper.d.ts","sourceRoot":"","sources":["../../src/decoders/commandsReadingHelper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAG5D,eAAO,MAAM,qBAAqB,YAAa,MAAM,iBAAiB,MAAM,cAAc,UAAU,mBAiwFnG,CAAA"}