@pepperdash/mobile-control-react-app-core 1.21.0-type-updates.1 → 1.21.0-type-updates.3

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

@@ -1,16 +1,109 @@
-/**
- * Used for an individual display state
- */
 import { Volume } from '../volume/volume';
 import { DeviceState } from './DeviceState';
-import { IHasCurrentSourceInfoChangeState } from './IHasCurrentSourceInfoChangeState';
-export interface DisplayState extends DeviceState, IHasCurrentSourceInfoChangeState {
+import { ICurrentSourcesState } from './ICurrentSourcesState';
+/**
+ * Represents the state of an individual display device in the AV system.
+ * This interface extends DeviceState and ICurrentSourcesState to provide
+ * comprehensive display-specific functionality including power management,
+ * input selection, volume control, and thermal state monitoring.
+ *
+ * @interface DisplayState
+ * @extends {DeviceState}
+ * @extends {ICurrentSourcesState}
+ * @since 1.0.0
+ *
+ * @example
+ * ```typescript
+ * const displayState: DisplayState = {
+ *   // DeviceState properties
+ *   key: 'main-display',
+ *   name: 'Conference Room Display',
+ *   isOnline: true,
+ *
+ *   // DisplayState-specific properties
+ *   hasFeedback: true,
+ *   powerState: true,
+ *   isWarming: false,
+ *   isCooling: false,
+ *   currentInput: 'hdmi-1',
+ *   volume: {
+ *     level: 75,
+ *     isMuted: false
+ *   },
+ *   inputKeys: ['hdmi-1', 'hdmi-2', 'vga', 'usb-c']
+ * };
+ * ```
+ */
+export interface DisplayState extends DeviceState, ICurrentSourcesState {
+    /**
+     * Indicates whether the display provides feedback about its current state.
+     * When true, the system can receive status updates from the display device.
+     * When false, the system operates in "blind" mode without confirmation.
+     *
+     * @type {boolean}
+     * @example true // Display sends status updates
+     * @example false // Display operates without feedback
+     */
     hasFeedback: boolean;
+    /**
+     * The current power state of the display.
+     * True indicates the display is powered on and operational.
+     * False indicates the display is powered off or in standby mode.
+     *
+     * @type {boolean}
+     * @example true // Display is on
+     * @example false // Display is off or in standby
+     */
     powerState: boolean;
+    /**
+     * Indicates whether the display is currently in a warming-up phase.
+     * Many displays require a warm-up period after power-on before they
+     * can display content or accept input changes.
+     *
+     * @type {boolean}
+     * @example true // Display is warming up after power-on
+     * @example false // Display is ready for normal operation
+     */
     isWarming: boolean;
+    /**
+     * Indicates whether the display is currently in a cooling-down phase.
+     * Some displays enter a cooling period after power-off to protect
+     * internal components before fully shutting down.
+     *
+     * @type {boolean}
+     * @example true // Display is cooling down after power-off
+     * @example false // Display is not in cooling phase
+     */
     isCooling: boolean;
+    /**
+     * The identifier of the currently selected input on the display.
+     * This should match one of the keys in the inputKeys array.
+     *
+     * @type {string}
+     * @example 'hdmi-1', 'hdmi-2', 'vga', 'usb-c', 'displayport'
+     */
     currentInput: string;
+    /**
+     * The current volume state of the display's built-in audio system.
+     * Optional as not all displays have audio capabilities.
+     *
+     * @type {Volume | undefined}
+     * @optional
+     * @example { level: 75, isMuted: false }
+     * @example undefined // Display has no audio capabilities
+     */
     volume?: Volume;
+    /**
+     * Array of available input identifiers that can be selected on this display.
+     * Each key represents a physical input port or connection type.
+     * Optional as some displays may not expose their input list.
+     *
+     * @type {string[] | undefined}
+     * @optional
+     * @example ['hdmi-1', 'hdmi-2', 'vga', 'usb-c']
+     * @example ['displayport-1', 'displayport-2', 'dvi']
+     * @example undefined // Input list not available
+     */
     inputKeys?: string[];
 }
 //# sourceMappingURL=DisplayState.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DisplayState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/DisplayState.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,gCAAgC;IACjF,WAAW,EAAE,OAAO,CAAC;IAErB,UAAU,EAAE,OAAO,CAAC;IAEpB,SAAS,EAAE,OAAO,CAAC;IAEnB,SAAS,EAAE,OAAO,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB"}
+{"version":3,"file":"DisplayState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/DisplayState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,oBAAoB;IACrE;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;;;;;OAQG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;;;;;OAQG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;;;OAQG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB"}

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

@@ -9,11 +9,11 @@ export interface ICurrentSourcesState extends IHasCurrentSourceInfoChangeState {
      * A record of all current sources keyed by their unique source key.
      * This allows quick access to the source information.
      */
-    currentSources: Record<string, SourceListItem>;
+    currentSources?: Record<string, SourceListItem>;
     /**
      * A record of current source keys, mapping device keys to their corresponding source keys.
      * This is useful for tracking which sources are currently active on each device.
      */
-    currentSourceKeys: Record<string, string>;
+    currentSourceKeys?: Record<string, string>;
 }
 //# sourceMappingURL=ICurrentSourcesState.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ICurrentSourcesState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/ICurrentSourcesState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gCAAgC;IAC5E;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE/C;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C"}
+{"version":3,"file":"ICurrentSourcesState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/ICurrentSourcesState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gCAAgC;IAC5E;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAEhD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C"}

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

@@ -9,11 +9,11 @@ export interface IHasCurrentSourceInfoChangeState extends DeviceState {
      * The key of the current source.
      * This is used to identify which source is currently active.
      */
-    currentSourceKey: string;
+    currentSourceKey?: string;
     /**
      * The current source item.
      * This provides detailed information about the currently active source.
      */
-    currentSource: SourceListItem;
+    currentSource?: SourceListItem;
 }
 //# sourceMappingURL=IHasCurrentSourceInfoChangeState.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"IHasCurrentSourceInfoChangeState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/IHasCurrentSourceInfoChangeState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,WAAW;IACnE;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,aAAa,EAAE,cAAc,CAAC;CAC/B"}
+{"version":3,"file":"IHasCurrentSourceInfoChangeState.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/state/state/IHasCurrentSourceInfoChangeState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,WAAW;IACnE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC;CAChC"}

package/package.json

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