@pepperdash/mobile-control-react-app-core 1.15.0 → 1.17.0

package/dist/shared/hooks/interfaces/useMobileControlTouchpanelController.d.ts

@@ -1,4 +1,9 @@
 import { MobileControlTouchpanelState } from "src/lib/types/state/state/MobileControlTouchpanelState";
+/**
+ * hook that controls a device that implements the MobileControlTouchpanelController interface
+ * @param key key of the device
+ * @returns
+ */
 export declare function useMobileControlTouchpanelController(key: string): MobileControlTouchpanelControllerReturn | undefined;
 interface MobileControlTouchpanelControllerReturn {
     touchpanelState: MobileControlTouchpanelState;

package/dist/shared/hooks/interfaces/useMobileControlTouchpanelController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useMobileControlTouchpanelController.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useMobileControlTouchpanelController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,wDAAwD,CAAC;AAGtG,wBAAgB,oCAAoC,CAClD,GAAG,EAAE,MAAM,GACV,uCAAuC,GAAG,SAAS,CA6BrD;AAED,UAAU,uCAAuC;IAC/C,eAAe,EAAE,4BAA4B,CAAC;IAC9C,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,QAAQ,EAAE,MAAM,IAAI,CAAC;KACtB,CAAC;IACF,WAAW,EAAE;QACX,OAAO,EAAE,MAAM,IAAI,CAAC;KACrB,CAAC;CACH"}
+{"version":3,"file":"useMobileControlTouchpanelController.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useMobileControlTouchpanelController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,wDAAwD,CAAC;AAGtG;;;;GAIG;AACH,wBAAgB,oCAAoC,CAClD,GAAG,EAAE,MAAM,GACV,uCAAuC,GAAG,SAAS,CA6BrD;AAED,UAAU,uCAAuC;IAC/C,eAAe,EAAE,4BAA4B,CAAC;IAC9C,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,OAAO,EAAE,MAAM,IAAI,CAAC;QACpB,QAAQ,EAAE,MAAM,IAAI,CAAC;KACtB,CAAC;IACF,WAAW,EAAE;QACX,OAAO,EAAE,MAAM,IAAI,CAAC;KACrB,CAAC;CACH"}

package/dist/shared/hooks/interfaces/useTwoWayDisplayBase.d.ts

@@ -2,6 +2,11 @@ import { DisplayState } from "src/lib/types";
 import { IHasInputsState } from 'src/lib/types/state/state/IHasInputsState';
 import { IHasPowerWithFeedbackProps } from "./useIHasPowerControl";
 import { IHasSelectableItemsReturn } from './useIHasSelectableItems';
+/**
+ * Provides a set of hooks to control a device that extends the TwoWayDisplayBase class
+ * @param key key of the device
+ * @returns
+ */
 export declare function useTwoWayDisplayBase(key: string): TwoWayDisplayBaseReturn | undefined;
 interface TwoWayDisplayBaseReturn {
     displayState: DisplayState;

package/dist/shared/hooks/interfaces/useTwoWayDisplayBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTwoWayDisplayBase.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useTwoWayDisplayBase.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EACL,0BAA0B,EAE3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,yBAAyB,EAA0B,MAAM,0BAA0B,CAAC;AAG7F,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,GACV,uBAAuB,GAAG,SAAS,CAqBrC;AAED,UAAU,uBAAuB;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,0BAA0B,CAAC;IACzC,YAAY,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IACzD,OAAO,EAAE;QAAE,SAAS,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;CACtD"}
+{"version":3,"file":"useTwoWayDisplayBase.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useTwoWayDisplayBase.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EACL,0BAA0B,EAE3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,yBAAyB,EAA0B,MAAM,0BAA0B,CAAC;AAE7F;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,GACV,uBAAuB,GAAG,SAAS,CAqBrC;AAED,UAAU,uBAAuB;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,0BAA0B,CAAC;IACzC,YAAY,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IACzD,OAAO,EAAE;QAAE,SAAS,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;CACtD"}

package/dist/shared/hooks/usePressHoldRelease.d.ts

@@ -1,3 +1,21 @@
+/**
+ * This hook is used to link up the functions to trigger for a button that can be pressed and held
+ * @param onPress function to call when the pointer is pressed
+ * @param onRelease function to call when the pointer is released
+ * @param onHold function to call when the pointer is held
+ * @param holdTimeMs time in milliseconds to hold before onHold is called
+ * @returns an object that can be easily applied to a button or other element using a spread operator to attach to the element events
+ * @example
+ * const button1 = usePressHoldRelease({
+ *  onPress: () => console.log('pressed'),
+ *  onRelease: () => console.log('released'),
+ *  onHold: () => console.log('held'),
+ *  holdTimeMs: 2000
+ * });
+ *
+ * // use the spread operator to attach the events to the button
+ * <button {...button1}>Press and Hold</button>
+ */
 export declare function usePressHoldRelease({ onPress, onRelease, onHold, holdTimeMs, }: PressHoldReleaseParams): {
     onPointerDown: () => void;
     onPointerUp: () => void;

package/dist/shared/hooks/usePressHoldRelease.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usePressHoldRelease.d.ts","sourceRoot":"","sources":["../../../src/lib/shared/hooks/usePressHoldRelease.ts"],"names":[],"mappings":"AAEA,wBAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,SAAS,EACT,MAAM,EACN,UAAgB,GACjB,EAAE,sBAAsB;;;;EAmCxB;AAED,UAAU,sBAAsB;IAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,sBAAsB,GAAI,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"usePressHoldRelease.d.ts","sourceRoot":"","sources":["../../../src/lib/shared/hooks/usePressHoldRelease.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,SAAS,EACT,MAAM,EACN,UAAgB,GACjB,EAAE,sBAAsB;;;;EAmCxB;AAED,UAAU,sBAAsB;IAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,sBAAsB,GAAI,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/types/state/state/DevicePresetsState.d.ts

@@ -0,0 +1,10 @@
+import { DeviceState } from './DeviceState';
+export interface DevicePresetsState extends DeviceState {
+    favorites: PresetChannel[];
+}
+export interface PresetChannel {
+    name: string;
+    channel: string;
+    iconUrl: string;
+}
+//# sourceMappingURL=DevicePresetsState.d.ts.map

package/dist/types/state/state/DevicePresetsState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevicePresetsState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/DevicePresetsState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/state/state/index.d.ts

@@ -2,6 +2,7 @@ export * from './CameraState';
 export * from './CamerasState';
 export * from './CommunicationMonitorState';
 export * from './DeviceInfoState';
+export * from './DevicePresetsState';
 export * from './DeviceState';
 export * from './DisplayState';
 export * from './EnvironmentState';
@@ -18,7 +19,6 @@ export * from './LightingState';
 export * from './MatrixRoutingState';
 export * from './MeetingInfo';
 export * from './PowerState';
-export * from './PresetChannel';
 export * from './RoomState';
 export * from './RoutingState';
 export * from './ScheduleEvent';
@@ -27,6 +27,5 @@ export * from './ShadeState';
 export * from './ShareState';
 export * from './SurroundSoundModeState';
 export * from './SwitchedOutputState';
-export * from './TunerState';
 export * from './endpointState';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/state/state/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC"}

package/dist/utils/WebsocketProvider.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from "react";
 /**
- * The context component that contains the websocket connection and provides the sendMessage function
+ * The context component that contains the websocket connection and provides the functions to send messages
  * Must wrap all other components
  * @param children the child components.  First child should be a room buseness logic component
  */

package/dist/utils/useWebsocketContext.d.ts

@@ -1,2 +1,6 @@
+/**
+ * A hook that provides access to the websocket for the purposes of sending messages as well as adding and removing event handlers
+ * @returns The websocket context
+ */
 export declare function useWebsocketContext(): import("./WebsocketContext").WebsocketContextType;
 //# sourceMappingURL=useWebsocketContext.d.ts.map

package/dist/utils/useWebsocketContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWebsocketContext.d.ts","sourceRoot":"","sources":["../../src/lib/utils/useWebsocketContext.ts"],"names":[],"mappings":"AAGA,wBAAgB,mBAAmB,sDAElC"}
+{"version":3,"file":"useWebsocketContext.d.ts","sourceRoot":"","sources":["../../src/lib/utils/useWebsocketContext.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAgB,mBAAmB,sDAElC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pepperdash/mobile-control-react-app-core",
   "private": false,
-  "version": "1.15.0",
+  "version": "1.17.0",
   "type": "module",
   "scripts": {
     "dev": "vite",

package/dist/shared/hooks/interfaces/useIChannelMessenger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useIChannelMessenger.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useIChannelMessenger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAiBpF;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,sBAAsB,CAAC;IACpC,WAAW,EAAE,sBAAsB,CAAC;IACpC,KAAK,EAAE,sBAAsB,CAAC;IAC9B,IAAI,EAAE,sBAAsB,CAAC;IAC7B,IAAI,EAAE,sBAAsB,CAAC;CAC9B"}

package/dist/shared/hooks/interfaces/useISurroundSoundModes.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=useISurroundSoundModes.d.ts.map

package/dist/shared/hooks/interfaces/useISurroundSoundModes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useISurroundSoundModes.d.ts","sourceRoot":"","sources":["../../../../src/lib/shared/hooks/interfaces/useISurroundSoundModes.ts"],"names":[],"mappings":""}

package/dist/types/state/state/PresetChannel.d.ts

@@ -1,6 +0,0 @@
-export declare class PresetChannel {
-    name: string;
-    iconUrl: string;
-    channel: string;
-}
-//# sourceMappingURL=PresetChannel.d.ts.map

package/dist/types/state/state/PresetChannel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PresetChannel.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/PresetChannel.ts"],"names":[],"mappings":"AAIA,qBAAa,aAAa;IACxB,IAAI,EAAE,MAAM,CAAM;IAElB,OAAO,EAAE,MAAM,CAAM;IAErB,OAAO,EAAE,MAAM,CAAM;CACtB"}

package/dist/types/state/state/TunerState.d.ts

@@ -1,6 +0,0 @@
-import { DeviceState } from './DeviceState';
-import { PresetChannel } from './PresetChannel';
-export interface TunerState extends DeviceState {
-    favorites: PresetChannel[];
-}
-//# sourceMappingURL=TunerState.d.ts.map

package/dist/types/state/state/TunerState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TunerState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/TunerState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B"}