feat!: improve types check and clean up repeated patterns (#48)

* feat: improve types check and clean up repeated patterns

* fix: remove unused import

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: enhance type checking for receiverOrOptions in BACnetClient

* fix: update sendBvlc method to require a non-null receiver parameter

* fix: update receiver parameter type in _segmentAckResponse method to AddressParameter

* fix: remove unused DecodedAddress import from client.ts

* fix: update AddressParameter type to use a consistent structure and modify related interfaces

* fix: update encode function to accept both AddressParameter and BACNetAddress types for destinationAddr

* fix: handle undefined destinationAddr in encode function for better type safety

* fix: simplify sender address handling in _segmentAckResponse method

* fix: update address parameter handling in various integration tests to use object structure

* fix: enhance NPDU handling by updating sender address structure and improving DecodedNpdu interface documentation

* style: fix lint

* fix: streamline sender address handling in transport send method

* fix: update address handling to use AddressParameter type in readProperty methods

* fix: replace AddressParameter with BACNetAddress type across multiple files for consistency

* fix: enhance BACNetAddress type documentation for clarity and consistency

* fix: allow null receiver in sendBvlc method for improved robustness

* fix: refactor buffer handling to use _send method for improved clarity and consistency

* fix: simplify BACNetAddress interface by merging optional properties and improving documentation

* fix: update discoveredAddress type to BACNetAddress for consistency across compliance tests

* fix: update asyncWritePropertyMultiple to use BACNetAddress for receiver parameter

* fix: update readProperty call to remove unnecessary cast to string for address

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: robertsLando

emulator/bacnet-device-emulator.ts

@@ -138,7 +138,7 @@ client.on('readProperty', (data) => {
 		if (!object) {
 			debug(`Object not found: ${objectKey}, sending error response`)
 			return client.errorResponse(
-				address,
+				{ address },
 				ConfirmedServiceChoice.READ_PROPERTY,
 				invokeId,
 				ErrorClass.OBJECT,
@@ -154,7 +154,7 @@ client.on('readProperty', (data) => {
 				`Property not found: ${request.property?.id}, sending error response`,
 			)
 			return client.errorResponse(
-				address,
+				{ address },
 				ConfirmedServiceChoice.READ_PROPERTY,
 				invokeId,
 				ErrorClass.PROPERTY,
@@ -167,7 +167,7 @@ client.on('readProperty', (data) => {
 				`Sending readPropertyResponse to ${address} for ${objectKey}:${request.property?.id} with invokeId ${invokeId}`,
 			)
 			client.readPropertyResponse(
-				address,
+				{ address },
 				invokeId,
 				request.objectId,
 				request.property,
@@ -180,7 +180,7 @@ client.on('readProperty', (data) => {
 					`Property index not found: ${request.property?.index}, sending error response`,
 				)
 				return client.errorResponse(
-					address,
+					{ address },
 					ConfirmedServiceChoice.READ_PROPERTY,
 					invokeId,
 					ErrorClass.PROPERTY,
@@ -192,7 +192,7 @@ client.on('readProperty', (data) => {
 				`Sending readPropertyResponse (with index) to ${address} for ${objectKey}:${request.property?.id}[${request.property?.index}] with invokeId ${invokeId}`,
 			)
 			client.readPropertyResponse(
-				address,
+				{ address },
 				invokeId,
 				request.objectId,
 				request.property,

examples/discover-devices.ts

@@ -52,7 +52,7 @@ bacnetClient.on('iAm', (device: any) => {
 	const deviceObjectId: BACNetObjectID = { type: 8, instance: deviceId }
 
 	bacnetClient.readProperty(
-		address as string,
+		address,
 		deviceObjectId,
 		PropertyIdentifier.OBJECT_NAME,
 		(err, value: DecodeAcknowledgeSingleResult | undefined) => {
@@ -63,7 +63,7 @@ bacnetClient.on('iAm', (device: any) => {
 				console.log(err)
 			} else {
 				bacnetClient.readProperty(
-					address as string, // Cast to string here as well
+					address,
 					deviceObjectId,
 					PropertyIdentifier.VENDOR_NAME,
 					(err2, valueVendor) => {

examples/read-device.ts

@@ -41,6 +41,7 @@ import Bacnet, {
 	DeviceObjectResult,
 	PropertyResult,
 	getEnumValues,
+	BACNetAddress,
 } from '../src'
 import * as process from 'process'
 
@@ -209,7 +210,7 @@ const debug = process.argv.includes('--debug')
  * Retrieve all properties manually because ReadPropertyMultiple is not available
  */
 function getAllPropertiesManually(
-	address: string | { address: string; forwardedFrom?: string },
+	address: BACNetAddress,
 	objectId: BACNetObjectID,
 	callback: (result: DeviceObjectResult) => void,
 	propList?: number[],
@@ -245,7 +246,7 @@ function getAllPropertiesManually(
 
 	// Read only object-list property
 	bacnetClient.readProperty(
-		address as string,
+		address,
 		objectId,
 		prop,
 		{}, // Options object
@@ -334,7 +335,7 @@ function handleBitString(
  * Parses a property value
  */
 function parseValue(
-	address: string | { address: string; forwardedFrom?: string },
+	address: BACNetAddress,
 	objId: number,
 	parentType: number,
 	value: any,
@@ -445,7 +446,7 @@ function parseValue(
 						},
 					]
 					bacnetClient.readPropertyMultiple(
-						address as string,
+						address,
 						requestArray,
 						(err, resValue) => {
 							//console.log(JSON.stringify(value.value) + ': ' + JSON.stringify(resValue));
@@ -517,7 +518,7 @@ function parseValue(
  * Parse an object structure
  */
 function parseDeviceObject(
-	address: string | { address: string; forwardedFrom?: string },
+	address: BACNetAddress,
 	obj: DeviceObjectResult | any,
 	parent: BACNetObjectID,
 	supportsMultiple: boolean,
@@ -778,39 +779,35 @@ bacnetClient.on('iAm', (device) => {
 		},
 	]
 
-	bacnetClient.readPropertyMultiple(
-		address.address,
-		requestArray,
-		(err, value) => {
-			if (err) {
-				console.log(
-					deviceId,
-					'No ReadPropertyMultiple supported:',
-					err.message,
-				)
-				getAllPropertiesManually(
-					address,
-					{ type: 8, instance: deviceId },
-					(result) => {
-						parseDeviceObject(
-							address,
-							result,
-							{ type: 8, instance: deviceId },
-							false,
-							(res) => printResultObject(deviceId, res),
-						)
-					},
-				)
-			} else {
-				console.log(deviceId, 'ReadPropertyMultiple supported ...')
-				parseDeviceObject(
-					address,
-					value,
-					{ type: 8, instance: deviceId },
-					true,
-					(res) => printResultObject(deviceId, res),
-				)
-			}
-		},
-	)
+	bacnetClient.readPropertyMultiple(address, requestArray, (err, value) => {
+		if (err) {
+			console.log(
+				deviceId,
+				'No ReadPropertyMultiple supported:',
+				err.message,
+			)
+			getAllPropertiesManually(
+				address,
+				{ type: 8, instance: deviceId },
+				(result) => {
+					parseDeviceObject(
+						address,
+						result,
+						{ type: 8, instance: deviceId },
+						false,
+						(res) => printResultObject(deviceId, res),
+					)
+				},
+			)
+		} else {
+			console.log(deviceId, 'ReadPropertyMultiple supported ...')
+			parseDeviceObject(
+				address,
+				value,
+				{ type: 8, instance: deviceId },
+				true,
+				(res) => printResultObject(deviceId, res),
+			)
+		}
+	})
 })