myio-js-library 0.1.164 → 0.1.166

package/dist/index.d.cts

@@ -2434,7 +2434,7 @@ type ChartDomain = 'energy' | 'water' | 'gas' | 'temperature' | string;
 /**
  * Theme modes
  */
-type ThemeMode = 'light' | 'dark';
+type ThemeMode$1 = 'light' | 'dark';
 /**
  * Chart visualization types
  */
@@ -2595,7 +2595,7 @@ interface Consumption7DaysConfig {
     /** Fill area under line chart (default: true) */
     fill?: boolean;
     /** Theme mode: 'light' or 'dark' (default: 'light') */
-    theme?: ThemeMode;
+    theme?: ThemeMode$1;
     /** Default period in days (default: 7) */
     defaultPeriod?: number;
     /** Default chart type (default: 'line') */
@@ -2750,7 +2750,7 @@ interface Consumption7DaysInstance {
         period: number;
         chartType: ChartType;
         vizMode: VizMode;
-        theme: ThemeMode;
+        theme: ThemeMode$1;
         isRendered: boolean;
     };
     /**
@@ -2762,7 +2762,7 @@ interface Consumption7DaysInstance {
      * Set theme mode
      * @param theme - 'light' or 'dark'
      */
-    setTheme: (theme: ThemeMode) => void;
+    setTheme: (theme: ThemeMode$1) => void;
     /**
      * Set or update the ideal range
      * Pass null to remove the ideal range
@@ -2800,7 +2800,7 @@ interface ThemeColors {
 /**
  * Default theme colors for light and dark modes
  */
-declare const THEME_COLORS: Record<ThemeMode, ThemeColors>;
+declare const THEME_COLORS: Record<ThemeMode$1, ThemeColors>;
 /**
  * Default configuration values
  */
@@ -2808,7 +2808,7 @@ declare const DEFAULT_CONFIG: {
     defaultPeriod: number;
     defaultChartType: ChartType;
     defaultVizMode: VizMode;
-    defaultTheme: ThemeMode;
+    defaultTheme: ThemeMode$1;
     cacheTTL: number;
     decimalPlaces: number;
     lineTension: number;
@@ -2874,7 +2874,7 @@ interface ConsumptionModalConfig extends Omit<Consumption7DaysConfig, 'container
     /** Modal title */
     title?: string;
     /** Initial theme */
-    theme?: ThemeMode;
+    theme?: ThemeMode$1;
     /** Callback when modal closes */
     onClose?: () => void;
     /** Container to append modal (default: document.body) */
@@ -2883,6 +2883,10 @@ interface ConsumptionModalConfig extends Omit<Consumption7DaysConfig, 'container
     exportFormats?: ExportFormat$1[];
     /** Custom export handler (receives format, default uses built-in CSV export) */
     onExport?: (format: ExportFormat$1) => void;
+    /** Show settings button (default: true) */
+    showSettingsButton?: boolean;
+    /** Callback when settings button is clicked */
+    onSettingsClick?: () => void;
 }
 interface ConsumptionModalInstance {
     /** Opens the modal */
@@ -2954,7 +2958,7 @@ interface ConsumptionWidgetInstance {
     /** Sets the visualization mode */
     setVizMode: (mode: VizMode) => void;
     /** Sets the theme */
-    setTheme: (theme: ThemeMode) => void;
+    setTheme: (theme: ThemeMode$1) => void;
     /** Sets the period in days */
     setPeriod: (days: number) => Promise<void>;
     /** Sets the ideal range */
@@ -3245,4 +3249,220 @@ declare const EXPORT_DOMAIN_LABELS: Record<ExportDomain, string>;
 /** Domain units */
 declare const EXPORT_DOMAIN_UNITS: Record<ExportDomain, string>;
 
-export { type BuildTemplateExportParams, CHART_COLORS, DEFAULT_COLORS as CONSUMPTION_CHART_COLORS, DEFAULT_CONFIG as CONSUMPTION_CHART_DEFAULTS, THEME_COLORS as CONSUMPTION_THEME_COLORS, type ChartDomain, type ClampRange, ConnectionStatusType, type Consumption7DaysColors, type Consumption7DaysConfig, type Consumption7DaysData, type Consumption7DaysInstance, type ChartType as ConsumptionChartType, type ConsumptionDataPoint, type IdealRangeConfig as ConsumptionIdealRangeConfig, type ConsumptionModalConfig, type ConsumptionModalInstance, type TemperatureConfig as ConsumptionTemperatureConfig, type TemperatureReferenceLine as ConsumptionTemperatureReferenceLine, type ThemeColors as ConsumptionThemeColors, type ThemeMode as ConsumptionThemeMode, type VizMode as ConsumptionVizMode, type ConsumptionWidgetConfig, type ConsumptionWidgetInstance, type CreateDateRangePickerOptions, type CreateInputDateRangePickerInsideDIVParams, DEFAULT_CLAMP_RANGE, type DateRangeControl, type DateRangeInputController, type DateRangeResult, type DemandModalInstance, type DemandModalParams, type DemandModalPdfConfig, type DemandModalStyles, DeviceStatusType, EXPORT_DEFAULT_COLORS, EXPORT_DOMAIN_ICONS, EXPORT_DOMAIN_LABELS, EXPORT_DOMAIN_UNITS, type EnergyModalContext, type EnergyModalError, type EnergyModalI18n, type EnergyModalStyleOverrides, type ExportColorsPallet, type ExportComparisonData, type ExportConfigTemplate, type ExportCustomerData, type ExportCustomerInfo, type ExportData, type ExportDataInput, type ExportDataInstance, type ExportDataPoint, type ExportDeviceInfo, type ExportDomain, type ExportFormat, type ExportGroupData, type ExportOptions, type ExportProgressCallback, type ExportResult, type ExportStats, type ExportType, type ExportFormat$1 as ModalExportFormat, type ModalHeaderConfig, type ModalHeaderInstance, type ModalTheme, type MyIOAuthConfig, type MyIOAuthInstance, MyIOChartModal, MyIODraggableCard, MyIOSelectionStore, MyIOSelectionStoreClass, MyIOToast, type OpenDashboardPopupEnergyOptions, type OpenDashboardPopupSettingsParams, type OpenDashboardPopupWaterTankOptions, type PersistResult, type RealTimeTelemetryInstance, type RealTimeTelemetryParams, type SettingsError, type SettingsEvent, type ShoppingDataPoint, type StoreRow, type TbScope, type TelemetryFetcher, type TemperatureComparisonModalInstance, type TemperatureComparisonModalParams, type TemperatureDevice, type TemperatureGranularity, type TemperatureModalInstance, type TemperatureModalParams, type TemperatureSettingsInstance, type TemperatureSettingsParams, type TemperatureStats, type TemperatureTelemetry, type ThingsboardCustomerAttrsConfig, type TimedValue, type WaterRow, type WaterTankDataPoint, type WaterTankModalContext, type WaterTankModalError, type WaterTankModalI18n, type WaterTankModalStyleOverrides, type WaterTankTelemetryData, addDetectionContext, addNamespace, aggregateByDay, averageByDay, buildListItemsThingsboardByUniqueDatasource, buildMyioIngestionAuth, buildTemplateExport, buildWaterReportCSV, buildWaterStoresCSV, calcDeltaPercent, calculateDeviceStatus, calculateDeviceStatusWithRanges, calculateStats as calculateExportStats, calculateStats$1 as calculateStats, clampTemperature, classify, classifyWaterLabel, classifyWaterLabels, clearAllAuthCaches, connectionStatusIcons, createConsumption7DaysChart, createConsumptionChartWidget, createConsumptionModal, createDateRangePicker, createInputDateRangePickerInsideDIV, createModalHeader, decodePayload, decodePayloadBase64Xor, detectDeviceType, determineInterval, deviceStatusIcons, exportTemperatureCSV, exportToCSV, exportToCSVAll, extractMyIOCredentials, fetchTemperatureData, fetchThingsboardCustomerAttrsFromStorage, fetchThingsboardCustomerServerScopeAttrs, findValue, findValueWithDefault, fmtPerc$1 as fmtPerc, fmtPerc as fmtPercLegacy, formatAllInSameUnit, formatAllInSameWaterUnit, formatDateForInput, formatDateToYMD, formatDateWithTimezoneOffset, formatDuration, formatEnergy, formatNumberReadable, formatRelativeTime, formatTankHeadFromCm, formatTemperature, formatWater, formatWaterByGroup, formatWaterVolumeM3, formatarDuracao, generateFilename as generateExportFilename, getAuthCacheStats, getAvailableContexts, getConnectionStatusIcon, getDateRangeArray, getDeviceStatusIcon, getDeviceStatusInfo, getModalHeaderStyles, getSaoPauloISOString, getSaoPauloISOStringFixed, getValueByDatakey, getValueByDatakeyLegacy, getWaterCategories, groupByDay, interpolateTemperature, isDeviceOffline, isValidConnectionStatus, isValidDeviceStatus, isWaterCategory, mapConnectionStatus, mapDeviceStatusToCardStatus, mapDeviceToConnectionStatus, myioExportData, normalizeRecipients, numbers, openDashboardPopup, openDashboardPopupAllReport, openDashboardPopupEnergy, openDashboardPopupReport, openDashboardPopupSettings, openDashboardPopupWaterTank, openDemandModal, openGoalsPanel, openRealTimeTelemetryModal, openTemperatureComparisonModal, openTemperatureModal, openTemperatureSettingsModal, parseInputDateToDate, renderCardComponent$2 as renderCardComponent, renderCardComponent$1 as renderCardComponentEnhanced, renderCardComponentHeadOffice, renderCardComponentLegacy, renderCardComponentV2, renderCardComponent as renderCardComponentV5, renderCardComponentV5 as renderCardV5, shouldFlashIcon, strings, timeWindowFromInputYMD, toCSV, toFixedSafe, waterDeviceStatusIcons };
+/**
+ * RFC-0102: Distribution Chart Widget Types
+ * TypeScript interfaces for the distribution chart component
+ */
+type DistributionDomain = 'energy' | 'water' | 'gas' | string;
+type ThemeMode = 'light' | 'dark';
+/**
+ * Visualization mode configuration
+ */
+interface DistributionMode {
+    value: string;
+    label: string;
+}
+/**
+ * Distribution data - key-value pairs of category/shopping to consumption value
+ */
+interface DistributionData {
+    [key: string]: number;
+}
+/**
+ * Color mapping for equipment groups
+ */
+interface GroupColors {
+    [groupName: string]: string;
+}
+/**
+ * Color mapping for shoppings (from orchestrator)
+ */
+interface ShoppingColors {
+    [shoppingId: string]: string;
+}
+/**
+ * Theme colors for chart rendering
+ */
+interface DistributionThemeColors {
+    text: string;
+    secondaryText: string;
+    background: string;
+    cardBackground: string;
+    border: string;
+    grid: string;
+}
+/**
+ * Main configuration for createDistributionChartWidget
+ */
+interface DistributionChartConfig {
+    /** Domain identifier (energy, water, etc.) */
+    domain: DistributionDomain;
+    /** Container element ID where widget will be injected */
+    containerId: string;
+    /** Unit of measurement (kWh, m³, etc.) */
+    unit: string;
+    /** Function to fetch distribution data for a given mode */
+    fetchDistribution: (mode: string) => Promise<DistributionData | null>;
+    /** Large unit for values above threshold (MWh, etc.) */
+    unitLarge?: string | null;
+    /** Threshold to switch to large unit */
+    thresholdForLargeUnit?: number | null;
+    /** Decimal places for formatting (default: 2) */
+    decimalPlaces?: number;
+    /** Available visualization modes */
+    modes?: DistributionMode[];
+    /** Default mode to display (default: 'groups') */
+    defaultMode?: string;
+    /** Widget title */
+    title?: string;
+    /** Theme mode (default: 'light') */
+    theme?: ThemeMode;
+    /** Chart height in pixels (default: 300) */
+    chartHeight?: number;
+    /** Show header with title (default: true) */
+    showHeader?: boolean;
+    /** Show mode selector dropdown (default: true) */
+    showModeSelector?: boolean;
+    /** Show settings button (default: false) */
+    showSettingsButton?: boolean;
+    /** Show maximize button (default: false) */
+    showMaximizeButton?: boolean;
+    /** Custom colors for equipment groups */
+    groupColors?: GroupColors;
+    /** Function to get shopping colors from orchestrator */
+    getShoppingColors?: () => ShoppingColors | null;
+    /** Function to get shopping names from orchestrator */
+    getShoppingNames?: () => Record<string, string> | null;
+    /** Called when mode changes */
+    onModeChange?: (mode: string) => void;
+    /** Called when data is loaded */
+    onDataLoaded?: (data: DistributionData) => void;
+    /** Called on error */
+    onError?: (error: Error) => void;
+    /** Called when settings button is clicked */
+    onSettingsClick?: () => void;
+    /** Called when maximize button is clicked */
+    onMaximizeClick?: () => void;
+    /** jQuery container for ThingsBoard widget context */
+    $container?: {
+        [0]: HTMLElement;
+    } | HTMLElement[];
+}
+/**
+ * Instance returned by createDistributionChartWidget
+ */
+interface DistributionChartInstance {
+    /** Render the widget into the container */
+    render: () => Promise<void>;
+    /** Change visualization mode */
+    setMode: (mode: string) => Promise<void>;
+    /** Refresh data from source */
+    refresh: () => Promise<void>;
+    /** Change theme */
+    setTheme: (theme: ThemeMode) => void;
+    /** Destroy the widget and clean up */
+    destroy: () => void;
+    /** Get the Chart.js instance */
+    getChartInstance: () => Chart | null;
+    /** Get current mode */
+    getCurrentMode: () => string;
+    /** Get current data */
+    getCurrentData: () => DistributionData | null;
+}
+declare global {
+    interface Window {
+        Chart: typeof Chart;
+    }
+}
+declare class Chart {
+    constructor(ctx: CanvasRenderingContext2D, config: any);
+    data: any;
+    options: any;
+    update(mode?: string): void;
+    destroy(): void;
+}
+
+/**
+ * RFC-0102: Distribution Chart Widget
+ * Self-contained horizontal bar chart for consumption distribution
+ * Supports ENERGY, WATER, and other domains with consistent shopping colors
+ */
+
+/**
+ * Create a distribution chart widget
+ * Injects all HTML into the container element
+ */
+declare function createDistributionChartWidget(config: DistributionChartConfig): DistributionChartInstance;
+
+/**
+ * RFC-0102: Centralized Color Management
+ * Ensures consistent shopping colors across all widgets and domains
+ */
+
+/**
+ * Default color palette for shoppings
+ * Used when orchestrator colors are not available
+ * These colors cycle for more than 10 shoppings
+ */
+declare const DEFAULT_SHOPPING_COLORS: string[];
+/**
+ * Default colors for ENERGY equipment groups
+ */
+declare const DEFAULT_ENERGY_GROUP_COLORS: GroupColors;
+/**
+ * Default colors for WATER groups
+ */
+declare const DEFAULT_WATER_GROUP_COLORS: GroupColors;
+/**
+ * Default colors for GAS groups
+ */
+declare const DEFAULT_GAS_GROUP_COLORS: GroupColors;
+/**
+ * Get default group colors based on domain
+ */
+declare function getDefaultGroupColors(domain: string): GroupColors;
+/**
+ * Creates a color assignment map for shoppings
+ * Should be called once by the orchestrator during initialization
+ *
+ * @param shoppingIds - Array of shopping IDs
+ * @returns Map of shopping ID to color
+ */
+declare function assignShoppingColors(shoppingIds: string[]): ShoppingColors;
+/**
+ * Gets the color for a specific shopping
+ * Falls back to cycling through default colors if not found
+ *
+ * @param shoppingId - The shopping ID or name
+ * @param shoppingColors - Color map from orchestrator (optional)
+ * @param fallbackIndex - Index to use for fallback color cycling
+ * @returns Color hex string
+ */
+declare function getShoppingColor(shoppingId: string, shoppingColors: ShoppingColors | null, fallbackIndex?: number): string;
+/**
+ * Gets the color for a group (equipment type, area type, etc.)
+ *
+ * @param groupName - The group name
+ * @param groupColors - Custom group colors (optional)
+ * @param domain - Domain for default colors
+ * @param fallbackIndex - Index for fallback color
+ * @returns Color hex string
+ */
+declare function getGroupColor(groupName: string, groupColors: GroupColors | null, domain?: string, fallbackIndex?: number): string;
+/**
+ * Get theme colors for chart rendering
+ *
+ * @param theme - Light or dark theme
+ * @returns Theme color configuration
+ */
+declare function getThemeColors(theme: ThemeMode): DistributionThemeColors;
+/**
+ * Generate a deterministic color for a string (useful for unknown categories)
+ * Uses a simple hash to ensure same string always gets same color
+ *
+ * @param str - String to hash
+ * @returns Color hex string
+ */
+declare function getHashColor(str: string): string;
+
+export { type BuildTemplateExportParams, CHART_COLORS, DEFAULT_COLORS as CONSUMPTION_CHART_COLORS, DEFAULT_CONFIG as CONSUMPTION_CHART_DEFAULTS, THEME_COLORS as CONSUMPTION_THEME_COLORS, type ChartDomain, type ClampRange, ConnectionStatusType, type Consumption7DaysColors, type Consumption7DaysConfig, type Consumption7DaysData, type Consumption7DaysInstance, type ChartType as ConsumptionChartType, type ConsumptionDataPoint, type IdealRangeConfig as ConsumptionIdealRangeConfig, type ConsumptionModalConfig, type ConsumptionModalInstance, type TemperatureConfig as ConsumptionTemperatureConfig, type TemperatureReferenceLine as ConsumptionTemperatureReferenceLine, type ThemeColors as ConsumptionThemeColors, type ThemeMode$1 as ConsumptionThemeMode, type VizMode as ConsumptionVizMode, type ConsumptionWidgetConfig, type ConsumptionWidgetInstance, type CreateDateRangePickerOptions, type CreateInputDateRangePickerInsideDIVParams, DEFAULT_CLAMP_RANGE, DEFAULT_ENERGY_GROUP_COLORS, DEFAULT_GAS_GROUP_COLORS, DEFAULT_SHOPPING_COLORS, DEFAULT_WATER_GROUP_COLORS, type DateRangeControl, type DateRangeInputController, type DateRangeResult, type DemandModalInstance, type DemandModalParams, type DemandModalPdfConfig, type DemandModalStyles, DeviceStatusType, type DistributionChartConfig, type DistributionChartInstance, type DistributionData, type DistributionDomain, type DistributionMode, type DistributionThemeColors, EXPORT_DEFAULT_COLORS, EXPORT_DOMAIN_ICONS, EXPORT_DOMAIN_LABELS, EXPORT_DOMAIN_UNITS, type EnergyModalContext, type EnergyModalError, type EnergyModalI18n, type EnergyModalStyleOverrides, type ExportColorsPallet, type ExportComparisonData, type ExportConfigTemplate, type ExportCustomerData, type ExportCustomerInfo, type ExportData, type ExportDataInput, type ExportDataInstance, type ExportDataPoint, type ExportDeviceInfo, type ExportDomain, type ExportFormat, type ExportGroupData, type ExportOptions, type ExportProgressCallback, type ExportResult, type ExportStats, type ExportType, type GroupColors, type ExportFormat$1 as ModalExportFormat, type ModalHeaderConfig, type ModalHeaderInstance, type ModalTheme, type MyIOAuthConfig, type MyIOAuthInstance, MyIOChartModal, MyIODraggableCard, MyIOSelectionStore, MyIOSelectionStoreClass, MyIOToast, type OpenDashboardPopupEnergyOptions, type OpenDashboardPopupSettingsParams, type OpenDashboardPopupWaterTankOptions, type PersistResult, type RealTimeTelemetryInstance, type RealTimeTelemetryParams, type SettingsError, type SettingsEvent, type ShoppingColors, type ShoppingDataPoint, type StoreRow, type TbScope, type TelemetryFetcher, type TemperatureComparisonModalInstance, type TemperatureComparisonModalParams, type TemperatureDevice, type TemperatureGranularity, type TemperatureModalInstance, type TemperatureModalParams, type TemperatureSettingsInstance, type TemperatureSettingsParams, type TemperatureStats, type TemperatureTelemetry, type ThingsboardCustomerAttrsConfig, type TimedValue, type WaterRow, type WaterTankDataPoint, type WaterTankModalContext, type WaterTankModalError, type WaterTankModalI18n, type WaterTankModalStyleOverrides, type WaterTankTelemetryData, addDetectionContext, addNamespace, aggregateByDay, assignShoppingColors, averageByDay, buildListItemsThingsboardByUniqueDatasource, buildMyioIngestionAuth, buildTemplateExport, buildWaterReportCSV, buildWaterStoresCSV, calcDeltaPercent, calculateDeviceStatus, calculateDeviceStatusWithRanges, calculateStats as calculateExportStats, calculateStats$1 as calculateStats, clampTemperature, classify, classifyWaterLabel, classifyWaterLabels, clearAllAuthCaches, connectionStatusIcons, createConsumption7DaysChart, createConsumptionChartWidget, createConsumptionModal, createDateRangePicker, createDistributionChartWidget, createInputDateRangePickerInsideDIV, createModalHeader, decodePayload, decodePayloadBase64Xor, detectDeviceType, determineInterval, deviceStatusIcons, exportTemperatureCSV, exportToCSV, exportToCSVAll, extractMyIOCredentials, fetchTemperatureData, fetchThingsboardCustomerAttrsFromStorage, fetchThingsboardCustomerServerScopeAttrs, findValue, findValueWithDefault, fmtPerc$1 as fmtPerc, fmtPerc as fmtPercLegacy, formatAllInSameUnit, formatAllInSameWaterUnit, formatDateForInput, formatDateToYMD, formatDateWithTimezoneOffset, formatDuration, formatEnergy, formatNumberReadable, formatRelativeTime, formatTankHeadFromCm, formatTemperature, formatWater, formatWaterByGroup, formatWaterVolumeM3, formatarDuracao, generateFilename as generateExportFilename, getAuthCacheStats, getAvailableContexts, getConnectionStatusIcon, getDateRangeArray, getDefaultGroupColors, getDeviceStatusIcon, getDeviceStatusInfo, getThemeColors as getDistributionThemeColors, getGroupColor, getHashColor, getModalHeaderStyles, getSaoPauloISOString, getSaoPauloISOStringFixed, getShoppingColor, getValueByDatakey, getValueByDatakeyLegacy, getWaterCategories, groupByDay, interpolateTemperature, isDeviceOffline, isValidConnectionStatus, isValidDeviceStatus, isWaterCategory, mapConnectionStatus, mapDeviceStatusToCardStatus, mapDeviceToConnectionStatus, myioExportData, normalizeRecipients, numbers, openDashboardPopup, openDashboardPopupAllReport, openDashboardPopupEnergy, openDashboardPopupReport, openDashboardPopupSettings, openDashboardPopupWaterTank, openDemandModal, openGoalsPanel, openRealTimeTelemetryModal, openTemperatureComparisonModal, openTemperatureModal, openTemperatureSettingsModal, parseInputDateToDate, renderCardComponent$2 as renderCardComponent, renderCardComponent$1 as renderCardComponentEnhanced, renderCardComponentHeadOffice, renderCardComponentLegacy, renderCardComponentV2, renderCardComponent as renderCardComponentV5, renderCardComponentV5 as renderCardV5, shouldFlashIcon, strings, timeWindowFromInputYMD, toCSV, toFixedSafe, waterDeviceStatusIcons };