@norgate-av/react-crestron-ch5-hooks 1.0.0 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Norgate AV Solutions Ltd
+Copyright (c) 2010-2026 Norgate AV
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,12 +7,12 @@
 
 ---
 
-[![CI](https://github.com/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks/actions/workflows/main.yml/badge.svg?branch=develop)](https://github.com/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks/actions/workflows/main.yml)
-[![codecov](https://codecov.io/gh/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks/branch/develop/graph/badge.svg?token=ZA36O8UTSI)](https://codecov.io/gh/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks)
-[![Coverage Status](https://coveralls.io/repos/github/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks/badge.svg?branch=develop)](https://coveralls.io/github/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks?branch=develop)
+[![CI](https://github.com/Norgate-AV/react-crestron-ch5-hooks/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Norgate-AV/react-crestron-ch5-hooks/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Norgate-AV/react-crestron-ch5-hooks/branch/develop/graph/badge.svg?token=ZA36O8UTSI)](https://codecov.io/gh/Norgate-AV/react-crestron-ch5-hooks)
+[![Coverage Status](https://coveralls.io/repos/github/Norgate-AV/react-crestron-ch5-hooks/badge.svg?branch=master)](https://coveralls.io/github/Norgate-AV/react-crestron-ch5-hooks?branch=master)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-[![GitHub contributors](https://img.shields.io/github/contributors/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks)](#contributors)
+[![GitHub contributors](https://img.shields.io/github/contributors/Norgate-AV/react-crestron-ch5-hooks)](#contributors)
 [![NPM](https://img.shields.io/npm/v/@norgate-av/react-crestron-ch5-hooks.svg)](https://www.npmjs.com/package/@norgate-av/react-crestron-ch5-hooks)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
@@ -25,59 +25,59 @@ A collection of React custom hooks ⚓ for Crestron CH5 project development.
 
 ## Contents 📖
 
--   [Features :package:](#features-package)
--   [Installation :zap:](#installation-zap)
--   [Usage :rocket:](#usage-rocket)
-    -   [Publish :arrow_right:](#publish-arrow_right)
-        -   [useCrestronPublishAnalog](#usecrestronpublishanalog)
-        -   [useCrestronPublishDigital](#usecrestronpublishdigital)
-        -   [useCrestronPublishSerial](#usecrestronpublishserial)
-        -   [useCrestronPublishAnalogCollection](#usecrestronpublishanalogcollection)
-        -   [useCrestronPublishDigitalCollection](#usecrestronpublishdigitalcollection)
-        -   [useCrestronPublishSerialCollection](#usecrestronpublishserialcollection)
-    -   [Subscribe :arrow_left:](#subscribe-arrow_left)
-        -   [useCrestronSubscribeAnalog](#usecrestronsubscribeanalog)
-        -   [useCrestronSubscribeDigital](#usecrestronsubscribedigital)
-        -   [useCrestronSubscribeSerial](#usecrestronsubscribeserial)
-        -   [useCrestronSubscribeAnalogCollection](#usecrestronsubscribeanalogcollection)
-        -   [useCrestronSubscribeDigitalCollection](#usecrestronsubscribedigitalcollection)
-        -   [useCrestronSubscribeSerialCollection](#usecrestronsubscribeserialcollection)
-    -   [Publish & Subscribe :left_right_arrow:](#publish--subscribe-left_right_arrow)
-        -   [useCrestronAnalog](#usecrestronanalog)
-        -   [useCrestronDigital](#usecrestrondigital)
-        -   [useCrestronSerial](#usecrestronserial)
-        -   [useCrestronAnalogCollection](#usecrestronanalogcollection)
-        -   [useCrestronDigitalCollection](#usecrestrondigitalcollection)
-        -   [useCrestronSerialCollection](#usecrestronserialcollection)
-    -   [Optional Subscribe Callback :phone:](#optional-subscribe-callback-phone)
--   [Types :keyboard:](#types-keyboard)
-    -   [Aliases](#aliases)
-        -   [Analog](#analog)
-        -   [Digital](#digital)
-        -   [Serial](#serial)
-    -   [Event Actions](#event-actions)
-        -   [IBaseEventAction](#ibaseeventaction)
-        -   [IAnalogEventAction](#ianalogeventaction)
-        -   [IDigitalEventAction](#idigitaleventaction)
-        -   [ISerialEventAction](#iserialeventaction)
-    -   [State](#state)
-        -   [IBaseState](#ibasestate)
-        -   [IAnalogState](#ianalogstate)
-        -   [IDigitalState](#idigitalstate)
-        -   [ISerialState](#iserialstate)
-        -   [IStateSubscription](#istatesubscription)
-        -   [StateCallback](#statecallback)
-        -   [AnalogStateCallback](#analogstatecallback)
-        -   [DigitalStateCallback](#digitalstatecallback)
-        -   [SerialStateCallback](#serialstatecallback)
-    -   [Signals](#signals)
-        -   [IBaseSignal](#ibasesignal)
-        -   [IAnalogSignal](#ianalogsignal)
-        -   [IDigitalSignal](#idigitalsignal)
-        -   [ISerialSignal](#iserialsignal)
--   [Team :soccer:](#team-soccer)
--   [Contributors :sparkles:](#contributors-sparkles)
--   [LICENSE :balance_scale:](#license-balance_scale)
+- [Features :package:](#features-package)
+- [Installation :zap:](#installation-zap)
+- [Usage :rocket:](#usage-rocket)
+    - [Publish :arrow_right:](#publish-arrow_right)
+        - [useCrestronPublishAnalog](#usecrestronpublishanalog)
+        - [useCrestronPublishDigital](#usecrestronpublishdigital)
+        - [useCrestronPublishSerial](#usecrestronpublishserial)
+        - [useCrestronPublishAnalogCollection](#usecrestronpublishanalogcollection)
+        - [useCrestronPublishDigitalCollection](#usecrestronpublishdigitalcollection)
+        - [useCrestronPublishSerialCollection](#usecrestronpublishserialcollection)
+    - [Subscribe :arrow_left:](#subscribe-arrow_left)
+        - [useCrestronSubscribeAnalog](#usecrestronsubscribeanalog)
+        - [useCrestronSubscribeDigital](#usecrestronsubscribedigital)
+        - [useCrestronSubscribeSerial](#usecrestronsubscribeserial)
+        - [useCrestronSubscribeAnalogCollection](#usecrestronsubscribeanalogcollection)
+        - [useCrestronSubscribeDigitalCollection](#usecrestronsubscribedigitalcollection)
+        - [useCrestronSubscribeSerialCollection](#usecrestronsubscribeserialcollection)
+    - [Publish & Subscribe :left_right_arrow:](#publish--subscribe-left_right_arrow)
+        - [useCrestronAnalog](#usecrestronanalog)
+        - [useCrestronDigital](#usecrestrondigital)
+        - [useCrestronSerial](#usecrestronserial)
+        - [useCrestronAnalogCollection](#usecrestronanalogcollection)
+        - [useCrestronDigitalCollection](#usecrestrondigitalcollection)
+        - [useCrestronSerialCollection](#usecrestronserialcollection)
+    - [Optional Subscribe Callback :phone:](#optional-subscribe-callback-phone)
+- [Types :keyboard:](#types-keyboard)
+    - [Aliases](#aliases)
+        - [Analog](#analog)
+        - [Digital](#digital)
+        - [Serial](#serial)
+    - [Event Actions](#event-actions)
+        - [IBaseEventAction](#ibaseeventaction)
+        - [IAnalogEventAction](#ianalogeventaction)
+        - [IDigitalEventAction](#idigitaleventaction)
+        - [ISerialEventAction](#iserialeventaction)
+    - [State](#state)
+        - [IBaseState](#ibasestate)
+        - [IAnalogState](#ianalogstate)
+        - [IDigitalState](#idigitalstate)
+        - [ISerialState](#iserialstate)
+        - [IStateSubscription](#istatesubscription)
+        - [StateCallback](#statecallback)
+        - [AnalogStateCallback](#analogstatecallback)
+        - [DigitalStateCallback](#digitalstatecallback)
+        - [SerialStateCallback](#serialstatecallback)
+    - [Signals](#signals)
+        - [IBaseSignal](#ibasesignal)
+        - [IAnalogSignal](#ianalogsignal)
+        - [IDigitalSignal](#idigitalsignal)
+        - [ISerialSignal](#iserialsignal)
+- [Team :soccer:](#team-soccer)
+- [Contributors :sparkles:](#contributors-sparkles)
+- [LICENSE :balance_scale:](#license-balance_scale)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -97,6 +97,10 @@ npm install @norgate-av/react-crestron-ch5-hooks
 # or
 
 yarn add @norgate-av/react-crestron-ch5-hooks
+
+# or
+
+pnpm add @norgate-av/react-crestron-ch5-hooks
 ```
 
 ## Usage :rocket:
@@ -148,6 +152,8 @@ export const SomeAwesomeComponent = () => {
             </button>
 
             <button onClick={() => action.click()}>Click</button>
+
+            <button onTouchStart={() => action.hold(2000)}>Hold</button>
         </div>
     );
 };
@@ -232,6 +238,8 @@ export const SomeAwesomeComponent = () => {
 
             <button onClick={() => action1.click()}>Click 1</button>
 
+            <button onTouchStart={() => action1.hold(2000)}>Hold 1</button>
+
             <button
                 onTouchStart={() => action2.setValue(true)}
                 onTouchEnd={() => action2.setValue(false)}
@@ -248,6 +256,8 @@ export const SomeAwesomeComponent = () => {
 
             <button onClick={() => action2.click()}>Click 2</button>
 
+            <button onTouchStart={() => action2.hold(2000)}>Hold 2</button>
+
             <button
                 onTouchStart={() => action3.setValue(true)}
                 onTouchEnd={() => action3.setValue(false)}
@@ -262,6 +272,8 @@ export const SomeAwesomeComponent = () => {
                 Push/Release 3
             </button>
             <button onClick={() => action3.click()}>Click 3</button>
+
+            <button onTouchStart={() => action3.hold(2000)}>Hold 3</button>
         </div>
     );
 };
@@ -493,6 +505,8 @@ export const SomeAwesomeComponent = () => {
             </button>
 
             <button onClick={() => signal.action.click()}>Click</button>
+
+            <button onTouchStart={() => signal.action.hold(2000)}>Hold</button>
         </div>
     );
 };
@@ -595,6 +609,10 @@ export const SomeAwesomeComponent = () => {
 
             <button onClick={() => signal1.action.click()}>Click 1</button>
 
+            <button onTouchStart={() => signal1.action.hold(2000)}>
+                Hold 1
+            </button>
+
             <button
                 onTouchStart={() => signal2.action.setValue(true)}
                 onTouchEnd={() => signal2.action.setValue(false)}
@@ -611,6 +629,10 @@ export const SomeAwesomeComponent = () => {
 
             <button onClick={() => signal2.action.click()}>Click 2</button>
 
+            <button onTouchStart={() => signal2.action.hold(2000)}>
+                Hold 2
+            </button>
+
             <button
                 onTouchStart={() => signal3.action.setValue(true)}
                 onTouchEnd={() => signal3.action.setValue(false)}
@@ -625,6 +647,10 @@ export const SomeAwesomeComponent = () => {
                 Push/Release 3
             </button>
             <button onClick={() => signal3.action.click()}>Click 3</button>
+
+            <button onTouchStart={() => signal3.action.hold(2000)}>
+                Hold 3
+            </button>
         </div>
     );
 };
@@ -770,6 +796,7 @@ export declare interface IDigitalEventAction extends IBaseEventAction<Digital> {
     push: () => void;
     release: () => void;
     click: () => void;
+    hold: (duration: number) => void;
 }
 ```
 
@@ -854,22 +881,28 @@ export declare interface IBaseSignal<TState, TAction> {
 #### IAnalogSignal
 
 ```ts
-export declare interface IAnalogSignal
-    extends IBaseSignal<IAnalogState, IAnalogEventAction> {}
+export declare interface IAnalogSignal extends IBaseSignal<
+    IAnalogState,
+    IAnalogEventAction
+> {}
 ```
 
 #### IDigitalSignal
 
 ```ts
-export declare interface IDigitalSignal
-    extends IBaseSignal<IDigitalState, IDigitalEventAction> {}
+export declare interface IDigitalSignal extends IBaseSignal<
+    IDigitalState,
+    IDigitalEventAction
+> {}
 ```
 
 #### ISerialSignal
 
 ```ts
-export declare interface ISerialSignal
-    extends IBaseSignal<ISerialState, ISerialEventAction> {}
+export declare interface ISerialSignal extends IBaseSignal<
+    ISerialState,
+    ISerialEventAction
+> {}
 ```
 
 ## Team :soccer:

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("react"),t=require("@crestron/ch5-crcomlib");function r(e){return e&&e.__esModule?e:{default:e}}var u=r(require("@norgate-av/crestron-ch5-helper"));function s(r){let s=e.useCallback(e=>t.publishEvent(u.default.SignalType.Number,r,e),[r]);return e.useMemo(()=>[{setValue:s}],[s])}var n=s;function l(r,s){let[n,l]=e.useState(0),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.Number,s=t.subscribeState(e,r,e=>{l(e),o.current&&o.current(e,r)});return()=>{t.unsubscribeState(e,r,s)}},[r]),[{value:n}]}var o=l;function a(e,t){let[r]=l(e,t),[u]=s(e);return[{state:r,action:u}]}var i=a;function c(r){let s=e.useCallback(e=>t.publishEvent(u.default.SignalType.Boolean,r,e),[r]),n=e.useCallback(()=>s(!0),[s]),l=e.useCallback(()=>s(!1),[s]),o=e.useCallback(e=>{n(),setTimeout(l,e)},[n,l]),a=e.useCallback(()=>o(0),[o]);return e.useMemo(()=>[{setValue:s,push:n,release:l,hold:o,click:a}],[s,n,l,o,a])}var b=c;function f(r,s){let[n,l]=e.useState(!1),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.Boolean,s=t.subscribeState(e,r,e=>{l(e),o.current&&o.current(e,r)});return()=>{t.unsubscribeState(e,r,s)}},[r]),[{value:n}]}var p=f;function C(e,t){let[r]=f(e,t),[u]=c(e);return[{state:r,action:u}]}var S=C;function g(r){let s=e.useCallback(e=>t.publishEvent(u.default.SignalType.String,r,e),[r]);return e.useMemo(()=>[{setValue:s}],[s])}var h=g;function v(r,s){let[n,l]=e.useState(""),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.String,s=t.subscribeState(e,r,e=>{l(e),o.current&&o.current(e,r)});return()=>{t.unsubscribeState(e,r,s)}},[r]),[{value:n}]}var x=v;function m(e,t){let[r]=v(e,t),[u]=g(e);return[{state:r,action:u}]}var d=m;function E(e,t,r){let u=[];for(let s=0;s<e;s++)u.push({state:t[s],action:r[s]});return u}function N(r){return e.useMemo(()=>r.map(e=>({setValue:r=>t.publishEvent(u.default.SignalType.Number,e,r)})),[r])}var y=N;function T(r,s){let[n,l]=e.useState(Array.from({length:r.length},()=>({value:0}))),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.Number,s=[];r.forEach((r,u)=>{let n=t.subscribeState(e,r,e=>{l(t=>{let r=[...t];return r[u]={...r[u],value:e},r}),o.current&&o.current(e,r)});s.push({id:n,signalName:r})});return()=>{s.forEach(({id:r,signalName:u})=>{t.unsubscribeState(e,u,r)})}},[]),n}var P=T;function B(e,t){let r=T(e,t),u=N(e);return E(e.length,r,u)}var k=B;function A(r){return e.useMemo(()=>r.map(e=>{let r=r=>{t.publishEvent(u.default.SignalType.Boolean,e,r)},s=()=>r(!0),n=()=>r(!1),l=e=>{s(),setTimeout(n,e)};return{setValue:r,push:s,release:n,hold:l,click:()=>l(0)}}),[r])}var M=A;function D(r,s){let[n,l]=e.useState(Array.from({length:r.length},()=>({value:!1}))),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.Boolean,s=[];r.forEach((r,u)=>{let n=t.subscribeState(e,r,e=>{l(t=>{let r=[...t];return r[u]={...r[u],value:e},r}),o.current&&o.current(e,r)});s.push({id:n,signalName:r})});return()=>{s.forEach(({id:r,signalName:u})=>{t.unsubscribeState(e,u,r)})}},[]),n}var R=D;function V(e,t){let r=D(e,t),u=A(e);return E(e.length,r,u)}var q=V;function _(r){return e.useMemo(()=>r.map(e=>({setValue:r=>t.publishEvent(u.default.SignalType.String,e,r)})),[r])}var j=_;function w(r,s){let[n,l]=e.useState(Array.from({length:r.length},()=>({value:""}))),o=e.useRef(void 0);return e.useEffect(()=>{o.current=s},[s]),e.useEffect(()=>{let e=u.default.SignalType.String,s=[];r.forEach((r,u)=>{let n=t.subscribeState(e,r,e=>{l(t=>{let r=[...t];return r[u]={...r[u],value:e},r}),o.current&&o.current(e,r)});s.push({id:n,signalName:r})});return()=>{s.forEach(({id:r,signalName:u})=>{t.unsubscribeState(e,u,r)})}},[]),n}var z=w;function F(e,t){let r=w(e,t),u=_(e);return E(e.length,r,u)}var G=F;exports.useCrestronAnalog=a,exports.useCrestronAnalogCollection=B,exports.useCrestronBoolean=S,exports.useCrestronBooleanCollection=q,exports.useCrestronDigital=C,exports.useCrestronDigitalCollection=V,exports.useCrestronNumber=i,exports.useCrestronNumberCollection=k,exports.useCrestronPublishAnalog=s,exports.useCrestronPublishAnalogCollection=N,exports.useCrestronPublishBoolean=b,exports.useCrestronPublishBooleanCollection=M,exports.useCrestronPublishDigital=c,exports.useCrestronPublishDigitalCollection=A,exports.useCrestronPublishNumber=n,exports.useCrestronPublishNumberCollection=y,exports.useCrestronPublishSerial=g,exports.useCrestronPublishSerialCollection=_,exports.useCrestronPublishString=h,exports.useCrestronPublishStringCollection=j,exports.useCrestronSerial=m,exports.useCrestronSerialCollection=F,exports.useCrestronString=d,exports.useCrestronStringCollection=G,exports.useCrestronSubscribeAnalog=l,exports.useCrestronSubscribeAnalogCollection=T,exports.useCrestronSubscribeBoolean=p,exports.useCrestronSubscribeBooleanCollection=R,exports.useCrestronSubscribeDigital=f,exports.useCrestronSubscribeDigitalCollection=D,exports.useCrestronSubscribeNumber=o,exports.useCrestronSubscribeNumberCollection=P,exports.useCrestronSubscribeSerial=v,exports.useCrestronSubscribeSerialCollection=w,exports.useCrestronSubscribeString=x,exports.useCrestronSubscribeStringCollection=z;

package/dist/index.d.cts

@@ -0,0 +1,259 @@
+type Analog = number;
+
+interface IAnalogEventAction extends IBaseEventAction<Analog> {
+}
+
+interface IAnalogState extends IBaseState<Analog> {
+}
+
+interface IAnalogSignal extends IBaseSignal<IAnalogState, IAnalogEventAction> {
+}
+
+type AnalogStateCallback = StateCallback<Analog>;
+
+type Digital = boolean;
+
+interface IDigitalEventAction extends IBaseEventAction<Digital> {
+    push: () => void;
+    release: () => void;
+    click: () => void;
+    hold: (duration: number) => void;
+}
+
+interface IDigitalState extends IBaseState<Digital> {
+}
+
+interface IDigitalSignal extends IBaseSignal<IDigitalState, IDigitalEventAction> {
+}
+
+type DigitalStateCallback = StateCallback<Digital>;
+
+type Serial = string;
+
+interface ISerialEventAction extends IBaseEventAction<Serial> {
+}
+
+interface ISerialState extends IBaseState<Serial> {
+}
+
+interface ISerialSignal extends IBaseSignal<ISerialState, ISerialEventAction> {
+}
+
+type SerialStateCallback = StateCallback<Serial>;
+
+type StateCallback<T> = (value: T, signalName?: string) => void;
+
+interface IStateSubscription {
+    id: string;
+    signalName: string;
+}
+
+interface IBaseEventAction<T> {
+    setValue: (value: T) => void;
+}
+
+interface IBaseState<T> {
+    value: T;
+}
+
+interface IBaseSignal<TState, TAction> {
+    state: TState;
+    action: TAction;
+}
+
+/**
+ * `useCrestronAnalog` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single IAnalogSignal object.
+ */
+declare function useCrestronAnalog(signalName: string, callback?: AnalogStateCallback): [IAnalogSignal];
+
+declare const useCrestronNumber: typeof useCrestronAnalog;
+
+/**
+ * `useCrestronDigital` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single IDigitalSignal object
+ */
+declare function useCrestronDigital(signalName: string, callback?: DigitalStateCallback): [IDigitalSignal];
+
+declare const useCrestronBoolean: typeof useCrestronDigital;
+
+/**
+ * `useCrestronSerial` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single ISerialSignal object.
+ */
+declare function useCrestronSerial(signalName: string, callback?: SerialStateCallback): [ISerialSignal];
+
+declare const useCrestronString: typeof useCrestronSerial;
+
+/**
+ * `useCrestronAnalogCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {AnalogStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of IAnalogSignal objects.
+ */
+declare function useCrestronAnalogCollection(signalNames: string[], callback?: AnalogStateCallback): IAnalogSignal[];
+
+declare const useCrestronNumberCollection: typeof useCrestronAnalogCollection;
+
+/**
+ * `useCrestronDigitalCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {DigitalStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of IDigitalSignal objects.
+ */
+declare function useCrestronDigitalCollection(signalNames: string[], callback?: DigitalStateCallback): IDigitalSignal[];
+
+declare const useCrestronBooleanCollection: typeof useCrestronDigitalCollection;
+
+/**
+ * `useCrestronSerialCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {SerialStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of ISerialSignal objects.
+ */
+declare function useCrestronSerialCollection(signalNames: string[], callback?: SerialStateCallback): ISerialSignal[];
+
+declare const useCrestronStringCollection: typeof useCrestronSerialCollection;
+
+/**
+ * `useCrestronPublishAnalog` is a hook that returns an object with a setValue function.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single IAnalogEventAction object.
+ */
+declare function useCrestronPublishAnalog(signalName: string): [IAnalogEventAction];
+
+declare const useCrestronPublishNumber: typeof useCrestronPublishAnalog;
+
+/**
+ * `useCrestronPublishDigital` is a hook that returns an object with setValue, push, release and click functions.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single IDigitalEventAction object.
+ */
+declare function useCrestronPublishDigital(signalName: string): [IDigitalEventAction];
+
+declare const useCrestronPublishBoolean: typeof useCrestronPublishDigital;
+
+/**
+ * `useCrestronPublishSerial` is a hook that returns an object with a setValue function.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single ISerialEventAction object.
+ */
+declare function useCrestronPublishSerial(signalName: string): [ISerialEventAction];
+
+declare const useCrestronPublishString: typeof useCrestronPublishSerial;
+
+/**
+ * `useCrestronPublishAnalogCollection` is a hook that returns an array of objects each with a setValue function.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of IAnalogEventAction objects.
+ */
+declare function useCrestronPublishAnalogCollection(signalNames: string[]): IAnalogEventAction[];
+
+declare const useCrestronPublishNumberCollection: typeof useCrestronPublishAnalogCollection;
+
+/**
+ * `useCrestronPublishDigitalCollection` is a hook that returns an array of objects each with setValue, push, release and click functions.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of IDigitalEventAction objects.
+ */
+declare function useCrestronPublishDigitalCollection(signalNames: string[]): IDigitalEventAction[];
+
+declare const useCrestronPublishBooleanCollection: typeof useCrestronPublishDigitalCollection;
+
+/**
+ * `useCrestronPublishSerialCollection` is a hook that returns an array of objects each with a setValue function.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of ISerialEventAction objects.
+ */
+declare function useCrestronPublishSerialCollection(signalNames: string[]): ISerialEventAction[];
+
+declare const useCrestronPublishStringCollection: typeof useCrestronPublishSerialCollection;
+
+/**
+ * `useCrestronSubscribeAnalog` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single IAnalogState object.
+ */
+declare function useCrestronSubscribeAnalog(signalName: string, callback?: AnalogStateCallback): [IAnalogState];
+
+declare const useCrestronSubscribeNumber: typeof useCrestronSubscribeAnalog;
+
+/**
+ * `useCrestronSubscribeDigital` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single IDigitalState object.
+ */
+declare function useCrestronSubscribeDigital(signalName: string, callback?: DigitalStateCallback): [IDigitalState];
+
+declare const useCrestronSubscribeBoolean: typeof useCrestronSubscribeDigital;
+
+/**
+ * `useCrestronSubscribeSerial` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single ISerialState object.
+ */
+declare function useCrestronSubscribeSerial(signalName: string, callback?: SerialStateCallback): [ISerialState];
+
+declare const useCrestronSubscribeString: typeof useCrestronSubscribeSerial;
+
+/**
+ * `useCrestronSubscribeAnalogCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of IAnalogState objects.
+ */
+declare function useCrestronSubscribeAnalogCollection(signalNames: string[], callback?: AnalogStateCallback): IAnalogState[];
+
+declare const useCrestronSubscribeNumberCollection: typeof useCrestronSubscribeAnalogCollection;
+
+/**
+ * `useCrestronSubscribeDigitalCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of IDigitalState objects.
+ */
+declare function useCrestronSubscribeDigitalCollection(signalNames: string[], callback?: DigitalStateCallback): IDigitalState[];
+
+declare const useCrestronSubscribeBooleanCollection: typeof useCrestronSubscribeDigitalCollection;
+
+/**
+ * `useCrestronSubscribeSerialCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of ISerialState objects.
+ */
+declare function useCrestronSubscribeSerialCollection(signalNames: string[], callback?: SerialStateCallback): ISerialState[];
+
+declare const useCrestronSubscribeStringCollection: typeof useCrestronSubscribeSerialCollection;
+
+export { type Analog, type AnalogStateCallback, type Digital, type DigitalStateCallback, type IAnalogEventAction, type IAnalogSignal, type IAnalogState, type IBaseEventAction, type IBaseSignal, type IBaseState, type IDigitalEventAction, type IDigitalSignal, type IDigitalState, type ISerialEventAction, type ISerialSignal, type ISerialState, type IStateSubscription, type Serial, type SerialStateCallback, type StateCallback, useCrestronAnalog, useCrestronAnalogCollection, useCrestronBoolean, useCrestronBooleanCollection, useCrestronDigital, useCrestronDigitalCollection, useCrestronNumber, useCrestronNumberCollection, useCrestronPublishAnalog, useCrestronPublishAnalogCollection, useCrestronPublishBoolean, useCrestronPublishBooleanCollection, useCrestronPublishDigital, useCrestronPublishDigitalCollection, useCrestronPublishNumber, useCrestronPublishNumberCollection, useCrestronPublishSerial, useCrestronPublishSerialCollection, useCrestronPublishString, useCrestronPublishStringCollection, useCrestronSerial, useCrestronSerialCollection, useCrestronString, useCrestronStringCollection, useCrestronSubscribeAnalog, useCrestronSubscribeAnalogCollection, useCrestronSubscribeBoolean, useCrestronSubscribeBooleanCollection, useCrestronSubscribeDigital, useCrestronSubscribeDigitalCollection, useCrestronSubscribeNumber, useCrestronSubscribeNumberCollection, useCrestronSubscribeSerial, useCrestronSubscribeSerialCollection, useCrestronSubscribeString, useCrestronSubscribeStringCollection };