@devicechain/dashboards 0.23.0 → 0.24.0-rc.1

package/dist/channel-snapshots.d.ts

@@ -1,4 +1,4 @@
-import type { AlarmRow, CommandRow, LocationSample, MeasurementSample } from './types';
+import type { AlarmRow, AlarmSeverityCount, AlarmTypeCount, CommandRow, LocationSample, MeasurementSample } from './types';
 export interface MeasurementStreamState {
     latest: Record<string, MeasurementSample>;
     samples: MeasurementSample[];
@@ -7,6 +7,18 @@ export interface MeasurementStreamState {
     gaps?: string[];
     members?: FleetState;
 }
+export type MemberPresence = {
+    status: 'pending';
+} | {
+    status: 'failed';
+} | {
+    status: 'unknown';
+} | {
+    status: 'ready';
+    active: boolean;
+    lastActivityTime: string | null;
+    inactivityTimeout: number;
+};
 export interface FleetMember {
     token: string;
     name: string | null;
@@ -14,6 +26,8 @@ export interface FleetMember {
     seed: 'pending' | 'ready' | 'failed';
     observed: string[];
     unread?: string[];
+    declared?: string[];
+    presence?: MemberPresence;
 }
 export interface FleetState {
     status: 'loading' | 'ready' | 'unbound' | 'forbidden' | 'unsupported';
@@ -26,6 +40,21 @@ export interface AlarmStreamState {
     total: number;
     loading: boolean;
     error: unknown | null;
+    typeTabs?: AlarmTypeTabs;
+    typeCounts?: AlarmTypeCount[];
+    severityCounts?: AlarmSeverityCount[];
+}
+export interface AlarmTypeTab {
+    token: string;
+    name: string | null;
+    active: number;
+    worstSeverity: string | null;
+}
+export interface AlarmTypeTabs {
+    tabs: AlarmTypeTab[];
+    selected: string | null;
+    select: (token: string | null) => void;
+    loading: boolean;
 }
 export interface CommandStreamState {
     deviceToken: string | null;
@@ -53,11 +82,15 @@ export interface AggregateSpan {
     endTime: string;
     spanSeconds: number;
 }
+export interface AggregateTrendPoint extends MeasurementAggregate {
+    bucketStart: string;
+}
 export type AggregateResult = {
     status: 'loading';
 } | ({
     status: 'ready';
     byName: Record<string, MeasurementAggregate>;
+    series?: Record<string, AggregateTrendPoint[]>;
 } & AggregateSpan) | {
     status: 'unavailable';
     reason: 'unsupported' | 'failed';

package/dist/deep-link.d.ts

@@ -0,0 +1,45 @@
+import type { DeviceResolver } from './hub';
+import type { DashboardDefinition, SlotBinding } from './types';
+export declare const BIND_PARAM_PREFIX = "bind.";
+export type BindParamIssue = {
+    kind: 'unknown-slot';
+    slot: string;
+    token: string;
+} | {
+    kind: 'not-a-device-slot';
+    slot: string;
+    token: string;
+} | {
+    kind: 'invalid-token';
+    slot: string;
+    token: string;
+} | {
+    kind: 'duplicate-slot';
+    slot: string;
+    token: string;
+} | {
+    kind: 'derived-slot';
+    slot: string;
+    token: string;
+};
+export interface ParsedBinds {
+    binds: Record<string, string>;
+    issues: BindParamIssue[];
+}
+export declare function parseBindParams(search: string, definition: DashboardDefinition): ParsedBinds;
+export interface BindCheck {
+    ok: Record<string, string>;
+    missing: Array<{
+        slot: string;
+        token: string;
+    }>;
+    failed: Array<{
+        slot: string;
+        token: string;
+    }>;
+}
+export declare function validateBinds(binds: Record<string, string>, resolver: Pick<DeviceResolver, 'deviceExists'>): Promise<BindCheck>;
+export declare function bindsToSelection(binds: Record<string, string>): Record<string, SlotBinding>;
+export declare function selectionToBinds(selection: Record<string, SlotBinding>, definition: DashboardDefinition): Record<string, string>;
+export declare function withBindParams(search: string, binds: Record<string, string>): string;
+export declare function bindParamsOf(search: string): string;

package/dist/event-window.d.ts

@@ -0,0 +1,15 @@
+import type { AlarmRow, CommandRow } from './types';
+export interface EventWindow {
+    spanSeconds: number;
+    endAt?: number;
+}
+export declare function eventWindowBounds(window: EventWindow, now: number): {
+    from: number;
+    to: number | undefined;
+};
+export declare function windowCriteria(window: EventWindow | undefined, now: number): {
+    startTime: string | null;
+    endTime: string | null;
+};
+export declare function alarmOverlaps(row: Pick<AlarmRow, 'raisedTime' | 'clearedTime'>, window: EventWindow, now: number): boolean;
+export declare function commandInRange(row: Pick<CommandRow, 'sentTime' | 'queuedTime'>, window: EventWindow, now: number): boolean;

package/dist/hub.d.ts

@@ -1,8 +1,9 @@
+import { type EventWindow } from './event-window';
 import { type HubConnectionState } from './connection';
 import type { HistoryWindow } from './history';
-import type { MemberRef, MemberSeed, MemberSeedPlan, MemberSink, SeedFailure } from './members';
+import type { MemberRef, MemberSeed, MemberSeedPlan, MemberSink, PresenceSink, SeedFailure } from './members';
 import { type MeasurementBucket } from './queries';
-import type { AlarmRow, AnchorTarget, CommandRow, DatasourceSelector, LocationSample, MeasurementSample } from './types';
+import type { AlarmRow, AlarmSeverityCount, AlarmTypeCount, AnchorTarget, CommandRow, DatasourceSelector, LocationSample, MeasurementSample } from './types';
 export interface DeviceResolver {
     devicesForAnchor(anchor: AnchorTarget): Promise<string[]>;
     deviceExists(deviceToken: string): Promise<boolean>;
@@ -10,6 +11,7 @@ export interface DeviceResolver {
         members: MemberRef[];
         total: number;
     }>;
+    declaredMetrics?(deviceType: string): Promise<string[] | null>;
 }
 export interface WidgetStreamSink {
     next: (sample: MeasurementSample) => void;
@@ -22,10 +24,17 @@ export interface AlarmSubscription {
     severity?: string;
     acknowledged?: boolean;
     pageSize: number;
+    enrichDeviceType?: boolean;
+    deviceType?: string;
+    countByDeviceType?: boolean;
+    countBySeverity?: boolean;
+    window?: EventWindow;
 }
 export interface AlarmSnapshot {
     alarms: AlarmRow[];
     total: number;
+    typeCounts?: AlarmTypeCount[];
+    severityCounts?: AlarmSeverityCount[];
 }
 export interface AlarmStreamSink {
     next: (snapshot: AlarmSnapshot) => void;
@@ -34,6 +43,7 @@ export interface AlarmStreamSink {
 export interface CommandSubscription {
     datasource?: DatasourceSelector;
     pageSize: number;
+    window?: EventWindow;
 }
 export interface CommandSnapshot {
     deviceToken: string | null;
@@ -87,6 +97,8 @@ export interface WidgetDataSource {
     bucketMeasurements?(datasource: DatasourceSelector, window: HistoryWindow): Promise<MeasurementBucket[]>;
     subscribeMembers?(datasource: DatasourceSelector, sink: MemberSink): () => void;
     readMemberSeeds?(deviceTokens: readonly string[], plan: MemberSeedPlan, onSeed: (deviceToken: string, seed: MemberSeed | null, failure?: SeedFailure) => void, cancelled?: () => boolean): Promise<void>;
+    declaredMetrics?(deviceType: string): Promise<readonly string[] | null>;
+    subscribePresence?(datasource: DatasourceSelector, sink: PresenceSink): () => void;
 }
 export declare class DashboardHub implements WidgetDataSource, WidgetActions {
     private readonly resolver;
@@ -97,6 +109,7 @@ export declare class DashboardHub implements WidgetDataSource, WidgetActions {
     private readonly alarmDisposers;
     private readonly commandDisposers;
     private readonly locationDisposers;
+    private readonly presenceDisposers;
     private readonly connection;
     private readonly deadStreams;
     constructor(config: DashboardHubConfig);
@@ -105,6 +118,8 @@ export declare class DashboardHub implements WidgetDataSource, WidgetActions {
     subscribeWidget(datasource: DatasourceSelector, sink: WidgetStreamSink): () => void;
     subscribeMembers(datasource: DatasourceSelector, sink: MemberSink): () => void;
     private resolveRoster;
+    private readonly declared;
+    declaredMetrics(deviceType: string): Promise<readonly string[] | null>;
     private readonly seedLimiter;
     private readonly seedReads;
     readMemberSeeds(deviceTokens: readonly string[], plan: MemberSeedPlan, onSeed: (deviceToken: string, seed: MemberSeed | null, failure?: SeedFailure) => void, cancelled?: () => boolean): Promise<void>;
@@ -115,12 +130,16 @@ export declare class DashboardHub implements WidgetDataSource, WidgetActions {
     subscribeAlarms(subscription: AlarmSubscription, sink: AlarmStreamSink): () => void;
     private resolveAlarmScope;
     private queryAlarms;
+    private readonly alarmDeviceTypes;
+    private withDeviceTypes;
     subscribeCommands(subscription: CommandSubscription, sink: CommandStreamSink): () => void;
     private resolveCommandScope;
     private queryCommands;
     subscribeLocations(subscription: LocationSubscription, sink: LocationStreamSink): () => void;
     private resolveLocationScope;
     private queryLocations;
+    subscribePresence(datasource: DatasourceSelector, sink: PresenceSink): () => void;
+    private queryPresence;
     can(authority: string): boolean;
     acknowledgeAlarm(alarmToken: string): Promise<void>;
     clearAlarm(alarmToken: string): Promise<void>;

package/dist/index.d.ts

@@ -1,7 +1,8 @@
-export type { DashboardDefinition, BoardTimeRange, Canvas, CanvasBackground, CanvasGrid, CanvasSizing, Breakpoints, BreakpointSpec, GridLength, GridPlacement, RelativePlacement, RelativeSize, Placement, PlacementAnchor, PlacementMode, FrameBorder, FrameBorderWidth, FrameHeader, FrameRadius, FrameVariant, ResolvedFrame, SpaceTokenName, ThemeColorToken, WidgetFrameSpec, WidgetInstance, KnownWidgetInstance, ExtensionWidgetInstance, ExtensionWidgetType, ResolvedWidgetInstance, UnknownWidgetInstance, UnknownWidgetType, UnresolvedWidgetCode, UnresolvedWidgetReason, WidgetImplementationRef, WidgetType, WidgetLayout, DatasourceSelector, DeviceSelector, AnchorSelector, AnchorTarget, AnchorAggregation, DevicesSelector, RelatedTraversalSelector, SlotSelector, UnboundSelector, SlotDefinition, SlotScope, SlotBinding, SelectionTarget, SelectionCandidate, EntityCandidateLister, EntityListKind, MeasurementSample, LocationSample, LocationSeries, LocationSelection, AlarmRow, CommandRow, CommandParameter, CommandParamDataType, } from './types';
+export type { DashboardDefinition, BoardTimeRange, Canvas, CanvasBackground, CanvasGrid, CanvasSizing, Breakpoints, BreakpointSpec, GridLength, GridPlacement, RelativePlacement, RelativeSize, Placement, PlacementAnchor, PlacementMode, FrameBorder, FrameBorderWidth, FrameHeader, FrameRadius, FrameVariant, ResolvedFrame, SpaceTokenName, ThemeColorToken, WidgetFrameSpec, WidgetInstance, KnownWidgetInstance, ExtensionWidgetInstance, ExtensionWidgetType, ResolvedWidgetInstance, UnknownWidgetInstance, UnknownWidgetType, UnresolvedWidgetCode, UnresolvedWidgetReason, WidgetImplementationRef, WidgetType, WidgetLayout, DatasourceSelector, DeviceSelector, AnchorSelector, AnchorTarget, AnchorAggregation, DevicesSelector, RelatedTraversalSelector, SlotSelector, UnboundSelector, SlotDefinition, SlotScope, SlotBinding, SelectionTarget, SelectionCandidate, EntityCandidateLister, EntityListKind, MeasurementSample, LocationSample, DevicePresence, LocationSeries, LocationSelection, AlarmRow, AlarmDeviceType, AlarmTypeCount, AlarmSeverityCount, CommandRow, CommandParameter, CommandParamDataType, } from './types';
 export { COMMAND_STATUSES, isTerminalCommandStatus, isCancellableCommandStatus, type CommandStatus, } from './command-status';
 export { effectiveBindings, parseBindingManifest, resolveWidgetDatasource, stripDefaultBindings, type ParsedBindingManifest, } from './bindings';
 export { resolveContextBindings, hasScopedSlots, applySelection, bindingsWithoutScopedSlots, type MemberResolver, } from './context';
+export { BIND_PARAM_PREFIX, parseBindParams, validateBinds, bindsToSelection, selectionToBinds, withBindParams, bindParamsOf, type BindCheck, type BindParamIssue, type ParsedBinds, } from './deep-link';
 export { migrateToSlots, bindWidgetSlot, clearWidgetDatasource, pruneSlots, widgetBinding, widgetSlotName, sameBinding, resolveConcrete, setSlotScope, anchorSlotNames, type ConcreteSelector, } from './slots';
 export { resolveSlotCandidates } from './candidates';
 export { createEntityLister } from './entity-lister';
@@ -20,10 +21,10 @@ export { WIDGET_CLIPBOARD_FORMAT, WIDGET_CLIPBOARD_VERSION, copyWidget, duplicat
 export { createDeviceResolver } from './resolver';
 export type { MeasurementBucket } from './queries';
 export { ANCHOR_PAGE_SIZE } from './resolver';
-export type { MemberBucketCriteria, MemberBucketRead, MemberRef, MemberRoster, MemberSeed, MemberSeedPlan, MemberSink, SeedFailure, } from './members';
+export type { MemberBucketCriteria, MemberBucketRead, MemberRef, MemberRoster, MemberSeed, MemberSeedPlan, MemberSink, PresenceSink, SeedFailure, } from './members';
 export { defaultHistoryWindow, fetchWidgetHistory, historyWindowFor, type HistoryWindow } from './history';
 export { DEFAULT_TIME_RANGE_SECONDS, MAX_SEED_BUCKETS, MAX_TIME_RANGE_SECONDS, MIN_TIME_RANGE_SECONDS, TIME_RANGE_PRESETS, bucketSecondsFor, initialTimeRange, isValidSpanSeconds, parsePausedParam, parseRangeParam, pauseRange, presetIdOf, rangeEnd, rangeWindow, resumeRange, seedBucketCount, setBoardTimeRange, spanLabel, timeRangeFromSearch, withSpan, type RangeWindow, type TimeRangePresetId, type TimeRangeState, } from './time-range';
-export type { AggregateResult, AggregateSpan, AggregateStreamState, AlarmStreamState, CommandStreamState, FleetMember, FleetState, LocationStreamState, MeasurementAggregate, MeasurementStreamState, } from './channel-snapshots';
+export type { AggregateResult, AggregateSpan, AggregateTrendPoint, AggregateStreamState, AlarmStreamState, AlarmTypeTab, AlarmTypeTabs, CommandStreamState, FleetMember, FleetState, MemberPresence, LocationStreamState, MeasurementAggregate, MeasurementStreamState, } from './channel-snapshots';
 export { applyOptionPatch, clampNumberOption, enumValues, numberSpec, validateOptions, HOST_OPTION_CONTROLS, type HostOptionControl, type BooleanOptionSpec, type DefaultsOf, type EnumOptionSpec, type ListItemFieldSpec, type ListOptionSpec, type GreaterThanConstraint, type NumberOptionSpec, type OptionConstraint, type OptionIssue, type OptionIssueCode, type OptionKeysOfKind, type OptionSpec, type OptionsOf, type RequiredOptionKeys, type SpecValue, type StringOptionSpec, type ValidateOptionsContext, type WidgetOptionSpecs, } from './option-schema';
 export { SDK_API_VERSION, defineWidgetDescriptor, isBuiltinWidgetId, isNamespacedWidgetId, type AckOptionRef, type BuiltinWidgetId, type ChannelBindingPolicy, type ChannelSnapshot, type ConstBinding, type DatasourcePolicy, type DatasourcePolicyFor, type DatasourceSelectorKind, type InteractionsFor, type NamespacedWidgetId, type NumberOptionRef, type StringOptionRef, type WidgetChannel, type WidgetDescriptor, type WidgetDisplay, type WidgetId, type WidgetInteractionDeclaration, FALLBACK_DEFAULT_SPAN, pinnedAxes, type WidgetLayoutSpec, type WidgetResizeMode, type WidgetSpan, } from './widget-descriptor';
 export { WidgetCatalogError, collectCatalogIssues, createWidgetCatalog, describeIssues, validateWidgetDescriptor, type DescriptorIssue, type WidgetCatalog, } from './widget-catalog';
@@ -32,3 +33,4 @@ export { DEFAULT_GRID, PHONE_MIN_COLUMNS, activeBreakpoint, anchorFraction, brea
 export { effectiveLayout, layoutShape, liveColumns, reflowGrid, STACK_BELOW_WIDTH, type EffectiveLayout, type LayoutShape, type ReflowItem, } from './reflow';
 export { LEGACY_REFERENCE_WIDTH } from './legacy-grid';
 export { blockingLayoutFindings, lintLayout, PUBLISH_BLOCKING_LAYOUT_CODES, spanLimitsOfLayout, type LayoutFinding, type LayoutLintCode, type LayoutLintOptions, type LayoutLintSeverity, type SpanLimits, } from './layout-lint';
+export { type EventWindow, eventWindowBounds } from './event-window';