@devicechain/widgets 0.23.0 → 0.24.0

package/dist/widgets/alarm-widgets.d.ts

@@ -1,2 +1,4 @@
 export { AlarmTable } from './alarm-table';
 export { AlarmCount } from './alarm-count';
+export { AlarmSeverity } from './alarm-severity';
+export { GroupedAlarm } from './alarm-grouped';

package/dist/widgets/command-stepper.d.ts

@@ -0,0 +1,22 @@
+import type { ReactNode } from 'react';
+import { type WidgetScale } from '@devicechain/widget-sdk';
+import { type Binding } from '../command-control-core';
+import { type CommandSender } from '../command-control';
+type Bound = Extract<Binding, {
+    ok: true;
+}>;
+export declare function StepperBody({ binding, label, draft, lastValue, sender, captionId, hintId, caption, onStage, onCommit, onDiscard, scale: ws, }: {
+    binding: Bound;
+    label: string;
+    draft: number | null;
+    lastValue: number | undefined;
+    sender: CommandSender;
+    captionId: string;
+    hintId: string;
+    caption: ReactNode;
+    onStage: (v: number) => void;
+    onCommit: () => void;
+    onDiscard: () => void;
+    scale: WidgetScale;
+}): import("react").JSX.Element;
+export {};

package/dist/widgets/control-lazy.d.ts

@@ -1,9 +1,8 @@
 export declare const loadControlWidgets: () => Promise<typeof import("./control-widgets")>;
-export declare const commandSliderWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", {
+export declare const commandSliderWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
     };
     readonly commandName: {
         readonly kind: 'string';
@@ -11,14 +10,12 @@ export declare const commandSliderWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: 'Command key issued to the target device. Without it the control cannot send.';
     };
     readonly commandLabel: {
         readonly kind: 'string';
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: 'Name of the control for assistive technology. Defaults to the command key.';
     };
     readonly parameterSchema: {
         readonly kind: 'string';
@@ -26,39 +23,43 @@ export declare const commandSliderWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: "The command's parameter descriptors, baked in as JSON at author time. Gives the control its range and its refusals.";
     };
     readonly parameter: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelParameter';
         readonly helpId: 'widgetHintControlParameter';
-        readonly doc: 'Which parameter of the command this control sets. May be left blank when the command has exactly one parameter of the right type.';
     };
     readonly min: {
         readonly kind: "number";
         readonly labelId: "widgetLabelMin";
         readonly helpId: "widgetHintSliderRange";
-        readonly doc: "Lowest value, used only when the command's parameter declares no minimum.";
     };
     readonly max: {
         readonly kind: "number";
         readonly labelId: "widgetLabelMax";
         readonly helpId: "widgetHintSliderRange";
-        readonly doc: "Highest value, used only when the command's parameter declares no maximum.";
     };
     readonly step: {
         readonly kind: "number";
         readonly min: 0;
         readonly labelId: "widgetLabelStep";
         readonly helpId: "widgetHintSliderStep";
-        readonly doc: "Distance between values. Defaults to 1 for a whole-number parameter, else a hundredth of the range.";
     };
-}>;
-export declare const commandToggleWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", {
+    readonly mode: {
+        readonly kind: "enum";
+        readonly values: readonly ["slider", "stepper"];
+        readonly labelId: "widgetLabelControlMode";
+        readonly valueLabelIds: {
+            readonly slider: "widgetControlModeSlider";
+            readonly stepper: "widgetControlModeStepper";
+        };
+        readonly placeholderId: "widgetPlaceholderDefault";
+    };
+}>>;
+export declare const commandToggleWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
     };
     readonly commandName: {
         readonly kind: 'string';
@@ -66,14 +67,12 @@ export declare const commandToggleWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: 'Command key issued to the target device. Without it the control cannot send.';
     };
     readonly commandLabel: {
         readonly kind: 'string';
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: 'Name of the control for assistive technology. Defaults to the command key.';
     };
     readonly parameterSchema: {
         readonly kind: 'string';
@@ -81,20 +80,17 @@ export declare const commandToggleWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: 'widgetCommandHeading';
         readonly helpId: 'widgetCommandFieldHint';
         readonly control: 'command-vocabulary';
-        readonly doc: "The command's parameter descriptors, baked in as JSON at author time. Gives the control its range and its refusals.";
     };
     readonly parameter: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelParameter';
         readonly helpId: 'widgetHintControlParameter';
-        readonly doc: 'Which parameter of the command this control sets. May be left blank when the command has exactly one parameter of the right type.';
     };
-}>;
-export declare const commandButtonWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", {
+}>>;
+export declare const commandButtonWidget: import("@devicechain/widget-sdk").WidgetDefinition<"control", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
     };
     readonly commandName: {
         readonly kind: "string";
@@ -102,14 +98,12 @@ export declare const commandButtonWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: "widgetCommandHeading";
         readonly helpId: "widgetCommandFieldHint";
         readonly control: "command-vocabulary";
-        readonly doc: "Command key issued to the target device. Without it the widget cannot send.";
     };
     readonly commandLabel: {
         readonly kind: "string";
         readonly labelId: "widgetCommandHeading";
         readonly helpId: "widgetCommandFieldHint";
         readonly control: "command-vocabulary";
-        readonly doc: "Text on the send button. Defaults to the command key.";
     };
     readonly parameterSchema: {
         readonly kind: "string";
@@ -117,7 +111,6 @@ export declare const commandButtonWidget: import("@devicechain/widget-sdk").Widg
         readonly labelId: "widgetCommandHeading";
         readonly helpId: "widgetCommandFieldHint";
         readonly control: "command-vocabulary";
-        readonly doc: "The command's parameter descriptors, baked in as JSON at author time. Drives the typed form.";
     };
     readonly maxRows: {
         readonly kind: "number";
@@ -125,6 +118,5 @@ export declare const commandButtonWidget: import("@devicechain/widget-sdk").Widg
         readonly min: 1;
         readonly labelId: "widgetLabelMaxRows";
         readonly helpId: "widgetMaxRowsCommandHint";
-        readonly doc: "Recent commands shown in the history. Default 20.";
     };
-}>;
+}>>;

package/dist/widgets/device-status.d.ts

@@ -0,0 +1,4 @@
+import { type WidgetProps } from '@devicechain/widget-sdk';
+export declare const OFFLINE_LEVEL: 'major';
+export declare function formatLastSeen(at: number, locale?: string | undefined): string;
+export declare function DeviceStatus({ widget, data }: WidgetProps): import("react").JSX.Element;

package/dist/widgets/fleet-count.d.ts

@@ -0,0 +1,2 @@
+import { type WidgetProps } from '@devicechain/widget-sdk';
+export declare function FleetCount({ widget, data }: WidgetProps): import("react").JSX.Element;

package/dist/widgets/gauge.d.ts

@@ -4,32 +4,27 @@ export declare function Gauge({ widget, data }: WidgetProps): import("react").JS
 export declare namespace Gauge {
     export { loadChartEngine as preload };
 }
-export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
+export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
     };
     readonly measurement: {
         readonly kind: "string";
         readonly labelId: "widgetLabelMeasurement";
         readonly helpId: "widgetHintMeasurement";
-        readonly doc: "Which measurement to display. Defaults to the first the datasource selects.";
     };
     readonly min: {
         readonly kind: "number";
         readonly labelId: "widgetLabelMin";
-        readonly doc: "Low end of the gauge scale. Default 0.";
     };
     readonly max: {
         readonly kind: "number";
         readonly labelId: "widgetLabelMax";
-        readonly doc: "High end of the gauge scale. Default 100.";
     };
     readonly unit: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelUnit';
-        readonly doc: 'Unit suffix shown beside the value.';
     };
     readonly precision: {
         readonly kind: 'number';
@@ -38,20 +33,17 @@ export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefini
         readonly max: 100;
         readonly labelId: 'widgetLabelPrecision';
         readonly helpId: 'widgetHintPrecision';
-        readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
     };
     readonly thresholds: {
         readonly kind: 'list';
         readonly maxItems: 12;
         readonly labelId: 'widgetLabelThresholds';
         readonly helpId: 'widgetHintThresholds';
-        readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
         readonly item: {
             readonly value: {
                 readonly kind: 'number';
                 readonly required: true;
                 readonly labelId: 'widgetLabelThresholdValue';
-                readonly doc: 'The value at which this band starts.';
             };
             readonly level: {
                 readonly kind: 'enum';
@@ -66,12 +58,10 @@ export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefini
                     readonly critical: 'widgetSeverityCritical';
                 };
                 readonly placeholderId: 'widgetPlaceholderThresholdLevel';
-                readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
             };
             readonly label: {
                 readonly kind: 'string';
                 readonly labelId: 'widgetLabelThresholdLabel';
-                readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
             };
         };
     };
@@ -79,7 +69,6 @@ export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefini
         readonly kind: 'boolean';
         readonly labelId: 'widgetFlashOnChange';
         readonly helpId: 'widgetFlashOnChangeHint';
-        readonly doc: 'Briefly tint a value green on a rise and red on a fall when it changes.';
     };
     readonly staleAfterSeconds: {
         readonly kind: 'number';
@@ -87,7 +76,6 @@ export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefini
         readonly min: 1;
         readonly labelId: 'widgetLabelStaleAfter';
         readonly helpId: 'widgetHintStaleAfter';
-        readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
     };
     readonly window: {
         readonly kind: 'number';
@@ -95,6 +83,5 @@ export declare const gaugeWidget: import("@devicechain/widget-sdk").WidgetDefini
         readonly min: 1;
         readonly labelId: 'widgetLabelWindow';
         readonly helpId: 'widgetHintWindow';
-        readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
     };
-}>;
+}>>;

package/dist/widgets/image.d.ts

@@ -1,21 +1,18 @@
 import { type WidgetProps } from '@devicechain/widget-sdk';
 export declare function Image({ widget }: WidgetProps<null>): import("react").JSX.Element;
-export declare const imageWidget: import("@devicechain/widget-sdk").WidgetDefinition<"none", {
+export declare const imageWidget: import("@devicechain/widget-sdk").WidgetDefinition<"none", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
     };
     readonly url: {
         readonly kind: "string";
         readonly required: true;
         readonly labelId: "widgetLabelImageUrl";
-        readonly doc: "Source URL of the image.";
     };
     readonly alt: {
         readonly kind: "string";
         readonly labelId: "widgetLabelAltText";
-        readonly doc: "Alternative text describing the image for assistive technology.";
     };
     readonly fit: {
         readonly kind: "enum";
@@ -27,6 +24,5 @@ export declare const imageWidget: import("@devicechain/widget-sdk").WidgetDefini
             readonly fill: "widgetFitFill";
         };
         readonly placeholderId: "widgetPlaceholderDefault";
-        readonly doc: "How the image fills its box. Default contain.";
     };
-}>;
+}>>;

package/dist/widgets/label.d.ts

@@ -1,16 +1,14 @@
 import { type WidgetProps } from '@devicechain/widget-sdk';
 export declare function Label({ widget }: WidgetProps<null>): import("react").JSX.Element;
-export declare const labelWidget: import("@devicechain/widget-sdk").WidgetDefinition<"none", {
+export declare const labelWidget: import("@devicechain/widget-sdk").WidgetDefinition<"none", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
     };
     readonly text: {
         readonly kind: "string";
         readonly required: true;
         readonly labelId: "widgetLabelText";
-        readonly doc: "The text to show. Rendered as plain text — markup is never interpreted.";
     };
     readonly align: {
         readonly kind: "enum";
@@ -22,13 +20,11 @@ export declare const labelWidget: import("@devicechain/widget-sdk").WidgetDefini
             readonly right: "widgetAlignRight";
         };
         readonly placeholderId: "widgetPlaceholderDefault";
-        readonly doc: "Horizontal alignment of the text. Default center.";
     };
     readonly fontSize: {
         readonly kind: "number";
         readonly min: 1;
         readonly labelId: "widgetLabelFontSize";
         readonly helpId: "widgetHintFontSize";
-        readonly doc: "Text size in pixels at the comfortable density; it scales with the board density. Default 16.";
     };
-}>;
+}>>;

package/dist/widgets/latest-card.d.ts

@@ -1,21 +1,18 @@
 import { type WidgetProps } from '@devicechain/widget-sdk';
 export declare function LatestCard({ widget, data }: WidgetProps): import("react").JSX.Element;
-export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
+export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", import("../builtin-descriptors").DocumentedSpecs<{
     readonly title: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelTitle';
-        readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
     };
     readonly measurement: {
         readonly kind: "string";
         readonly labelId: "widgetLabelMeasurement";
         readonly helpId: "widgetHintMeasurement";
-        readonly doc: "Which measurement to display. Defaults to the first the datasource selects.";
     };
     readonly unit: {
         readonly kind: 'string';
         readonly labelId: 'widgetLabelUnit';
-        readonly doc: 'Unit suffix shown beside the value.';
     };
     readonly precision: {
         readonly kind: 'number';
@@ -24,20 +21,17 @@ export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetD
         readonly max: 100;
         readonly labelId: 'widgetLabelPrecision';
         readonly helpId: 'widgetHintPrecision';
-        readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
     };
     readonly thresholds: {
         readonly kind: 'list';
         readonly maxItems: 12;
         readonly labelId: 'widgetLabelThresholds';
         readonly helpId: 'widgetHintThresholds';
-        readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
         readonly item: {
             readonly value: {
                 readonly kind: 'number';
                 readonly required: true;
                 readonly labelId: 'widgetLabelThresholdValue';
-                readonly doc: 'The value at which this band starts.';
             };
             readonly level: {
                 readonly kind: 'enum';
@@ -52,12 +46,10 @@ export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetD
                     readonly critical: 'widgetSeverityCritical';
                 };
                 readonly placeholderId: 'widgetPlaceholderThresholdLevel';
-                readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
             };
             readonly label: {
                 readonly kind: 'string';
                 readonly labelId: 'widgetLabelThresholdLabel';
-                readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
             };
         };
     };
@@ -65,7 +57,6 @@ export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetD
         readonly kind: 'boolean';
         readonly labelId: 'widgetFlashOnChange';
         readonly helpId: 'widgetFlashOnChangeHint';
-        readonly doc: 'Briefly tint a value green on a rise and red on a fall when it changes.';
     };
     readonly staleAfterSeconds: {
         readonly kind: 'number';
@@ -73,7 +64,6 @@ export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetD
         readonly min: 1;
         readonly labelId: 'widgetLabelStaleAfter';
         readonly helpId: 'widgetHintStaleAfter';
-        readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
     };
     readonly window: {
         readonly kind: 'number';
@@ -81,6 +71,5 @@ export declare const latestCardWidget: import("@devicechain/widget-sdk").WidgetD
         readonly min: 1;
         readonly labelId: 'widgetLabelWindow';
         readonly helpId: 'widgetHintWindow';
-        readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
     };
-}>;
+}>>;

package/dist/widgets/lazy-chunk.d.ts

@@ -1,7 +1,12 @@
-import type { MeasurementStreamState, WidgetProps } from '@devicechain/widget-sdk';
+import { type ComponentType } from 'react';
+import { type MeasurementStreamState, type WidgetProps } from '@devicechain/widget-sdk';
+import type { WidgetInstance } from '@devicechain/dashboards';
+export declare function ChunkLoadingFrame({ widget }: {
+    widget: WidgetInstance;
+}): import("react").JSX.Element;
 export declare function lazyChunk<M extends Record<string, unknown>, D = MeasurementStreamState>(importer: () => Promise<M>): {
     load: () => Promise<M>;
-    component: <P = D, Props extends object = WidgetProps<P>>(name: keyof M & string, alsoPreload?: () => Promise<unknown>) => {
+    component: <P = D, Props extends object = WidgetProps<P>>(name: keyof M & string, alsoPreload?: () => Promise<unknown>, Fallback?: ComponentType<Props>) => {
         (props: Props): import("react").JSX.Element | null;
         displayName: string;
         preload: () => Promise<M>;