5/scadable stream

[danielrafailov1]

#5

[Copilot]

Pull Request Overview

This PR implements the Scadable Stream library for real-time telemetry data consumption in React applications. The library provides a useLiveTelemetry hook for connecting to WebSocket streams and managing telemetry data state.

• Adds core classes (Facility, Device) for managing API authentication and WebSocket connections
• Implements useLiveTelemetry React hook for real-time telemetry data consumption
• Sets up comprehensive testing infrastructure with mocked WebSocket implementation

Reviewed Changes

Copilot reviewed 24 out of 25 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
vitest.config.ts	Test configuration for Vitest with jsdom environment
src/core/	Core library classes for Facility and Device management
src/hooks/	React hooks including the main useLiveTelemetry hook
src/types.ts, src/core/types.ts	Type definitions with duplicate interfaces
src/utils/parseMessage.ts	Message parsing utility for WebSocket data
tests/	Comprehensive test suite with WebSocket mocks
README.md	Complete documentation with examples and API reference

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

This entire file duplicates type definitions that exist in src/core/types.ts. Having duplicate type definitions creates maintenance overhead and potential inconsistencies. Remove this file and use the centralized types from src/core/types.ts.

Suggested change

	/**
	* Telemetry data types for the Scadable Stream library
	*/
	/**
	* Base telemetry data structure
	* Can contain any key-value pairs representing sensor data
	*/
	export interface TelemetryData {
	[key: string]: any;
	}
	/**
	* WebSocket message structure
	*/
	export interface WebSocketMessage {
	data: string;
	type?: string;
	target?: WebSocket;
	}
	/**
	* Configuration for WebSocket connection
	*/
	export interface WebSocketConfig {
	url: string;
	token: string;
	deviceId: string;
	}
	/**
	* Hook return type for useLiveTelemetry
	*/
	export interface TelemetryHookResult {
	telemetry: TelemetryData | string | null;
	isConnected: boolean;
	error: string | null;
	}
	/**
	* Device connection status
	*/
	export enum ConnectionStatus {
	DISCONNECTED = 'disconnected',
	CONNECTING = 'connecting',
	CONNECTED = 'connected',
	ERROR = 'error'
	}

[Copilot]

This implements ConnectionStatus as a const object while src/types.ts uses an enum. This inconsistency between the two type definition files creates confusion. Since this appears to be the canonical location, ensure all imports use this implementation.

[Copilot]

This file duplicates the Facility class that exists in src/core/Facility.ts. Having duplicate implementations creates maintenance issues and confusion about which version is canonical. Remove this duplicate file.

Suggested change

	/**
	* Facility class manages the API key for WebSocket connections
	*/
	export class Facility {
	private readonly apiKey: string;
	constructor(apiKey: string) {
	if (!apiKey || typeof apiKey !== 'string') {
	throw new Error('API key must be a non-empty string');
	}
	this.apiKey = apiKey;
	}
	/**
	* Get the API key for WebSocket authentication
	* @returns The API key
	*/
	getApiKey(): string {
	return this.apiKey;
	}
	/**
	* Validate that the facility has a valid API key
	* @returns True if the API key is valid
	*/
	isValid(): boolean {
	return this.apiKey.length > 0;
	}
	}
	// Re-export canonical Facility class
	export { Facility } from './core/Facility';

[Copilot]

The type annotation for statusHandlers is incorrect. It references ConnectionStatus which is an enum-like object, but the actual parameter type should be ConnectionStatusValue to match the implementation in the updateConnectionStatus method.

Suggested change

	private statusHandlers: Set<(_connectionStatus: ConnectionStatus) => void> = new Set();
	private statusHandlers: Set<(_connectionStatus: ConnectionStatusValue) => void> = new Set();

[Copilot]

The parameter type ConnectionStatusValue is correct here but inconsistent with the statusHandlers Set type definition on line 15. The Set should be typed as Set<(_connectionStatus: ConnectionStatusValue) => void> for consistency.

[Copilot]

Pull Request Overview

Copilot reviewed 21 out of 22 changed files in this pull request and generated 10 comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}