feat: add support for null / nan

packages/core-util/package.json

@@ -51,6 +51,7 @@
   "devDependencies": {
     "@aws-sdk/types": "^3.696.0",
     "@iot-app-kit/eslint-config": "*",
+    "@iot-app-kit/helpers": "*",
     "@iot-app-kit/ts-config": "*",
     "@iot-app-kit/vite-config": "*",
     "@types/lodash-es": "^4.17.12",

packages/core-util/src/sdks/number.ts

@@ -1,4 +1,4 @@
-import type { Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 
 /**
  * Rounds a number to a given precision

packages/core/src/common/dataFilters.ts

@@ -1,9 +1,11 @@
 import { bisector } from 'd3-array';
 
+import type { Primitive } from '@iot-app-kit/helpers';
+
 import { isHistoricalViewport } from './predicates';
 import { parseDuration } from './time';
 import type { Viewport } from '../data-module/data-cache/requestTypes';
-import type { DataPoint, Primitive } from '../data-module/types';
+import type { DataPoint } from '../data-module/types';
 
 // By doing the mapping to a date within the bisector
 // we eliminate the need to iterate over the entire data.

packages/core/src/common/number.ts

@@ -1,4 +1,4 @@
-import type { Primitive } from '../data-module/types';
+import type { Primitive } from '@iot-app-kit/helpers';
 
 const MAX_PRECISION = 4;
 

packages/core/src/data-module/data-cache/caching/caching.ts

@@ -1,3 +1,4 @@
+import type { Primitive } from '@iot-app-kit/helpers';
 import {
   MINUTE_IN_MS,
   SECOND_IN_MS,
@@ -14,7 +15,6 @@ import { getExpiredCacheIntervals } from './expiredCacheIntervals';
 import { pointBisector } from '../../../common/dataFilters';
 import type {
   DataPoint,
-  Primitive,
   RequestInformation,
   RequestInformationAndRange,
 } from '../../types';

packages/core/src/data-module/types.ts

@@ -1,3 +1,7 @@
+import type { Primitive } from '@iot-app-kit/helpers';
+
+export type { Primitive } from '@iot-app-kit/helpers';
+
 import { type AggregateType, type Quality } from '@aws-sdk/client-iotsitewise';
 import type {
   TimeSeriesDataRequest,
@@ -27,8 +31,6 @@ export interface DataPoint<T extends Primitive = Primitive>
 
 export type Resolution = number;
 
-export type Primitive = string | number | boolean;
-
 export type DataStreamId = string;
 
 export type DataBase = {

packages/dashboard/package.json

@@ -94,6 +94,7 @@
     "@iot-app-kit/atoms": "*",
     "@iot-app-kit/core": "*",
     "@iot-app-kit/core-util": "*",
+    "@iot-app-kit/helpers": "*",
     "@iot-app-kit/react-components": "*",
     "@iot-app-kit/source-iotsitewise": "*",
     "@popperjs/core": "^2.11.8",

packages/dashboard/src/components/csvDownloadButton/types.ts

@@ -1,4 +1,4 @@
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 import { type Quality } from '@aws-sdk/client-iotsitewise';
 
 export type CSVDownloadObject = {

packages/dashboard/src/components/dashboard/queryContext.ts

@@ -3,11 +3,9 @@ import { useRefreshRate } from '../../customization/hooks/useRefreshRate';
 import { alarmModelQueryToSiteWiseAssetQuery } from '../../customization/widgets/utils/alarmModelQueryToAlarmQuery';
 import { assetModelQueryToSiteWiseAssetQuery } from '../../customization/widgets/utils/assetModelQueryToAssetQuery';
 
-import type {
-  DataStream,
-  Primitive,
-  TimeSeriesDataQuery,
-} from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
+
+import type { DataStream, TimeSeriesDataQuery } from '@iot-app-kit/core';
 import type {
   AlarmDataQuery,
   SiteWiseAlarmDataStreamQuery,

packages/data-mocked/src/iot-sitewise/handlers/batchGetAssetPropertyValue/batchGetAssetPropertyValueHandler.ts

@@ -67,8 +67,9 @@ export class AssetPropertyValueFactory {
       ...this.#createDefaults(),
       ...partialAssetPropertyValue,
       value: {
+        // nullValue: { valueType: 'I' },
         integerValue: faker.number.int({ min: 0, max: 100 }),
-      },
+      } as any,
     };
 
     return assetPropertyValue;
@@ -81,8 +82,9 @@ export class AssetPropertyValueFactory {
       ...this.#createDefaults(),
       ...partialAssetPropertyValue,
       value: {
+        // nullValue: { valueType: 'D' },
         doubleValue: faker.number.float({ min: 0, max: 100, precision: 0.001 }),
-      },
+      } as any,
     };
 
     return assetPropertyValue;
@@ -95,8 +97,9 @@ export class AssetPropertyValueFactory {
       ...this.#createDefaults(),
       ...partialAssetPropertyValue,
       value: {
+        // nullValue: { valueType: 'B' },
         booleanValue: faker.datatype.boolean(),
-      },
+      } as any,
     };
 
     return assetPropertyValue;
@@ -109,8 +112,9 @@ export class AssetPropertyValueFactory {
       ...this.#createDefaults(),
       ...partialAssetPropertyValue,
       value: {
+        // nullValue: { valueType: 'S' },
         stringValue: faker.helpers.arrayElement(['ON', 'OFF']),
-      },
+      } as any,
     };
 
     return assetPropertyValue;
@@ -206,6 +210,7 @@ export function batchGetAssetPropertyValueHistoryHandler() {
     };
 
     await delay();
+
     return HttpResponse.json(response, { status: 200 });
   });
 }

packages/helpers/package.json

@@ -36,6 +36,9 @@
     "typescript": "^5.5.4",
     "vite": "^5.4.11"
   },
+  "peerDependencies": {
+    "@aws-sdk/client-iotsitewise": "^3.696.0"
+  },
   "iotAppKit": {
     "scope": "protected"
   }

packages/helpers/src/index.ts

@@ -5,3 +5,7 @@ export {
   NANO_SECOND_IN_MS,
   SECOND_IN_MS,
 } from './constants/time';
+
+export { toValue } from './utils/toValue';
+
+export type { Primitive } from './types';

packages/helpers/src/types.ts

@@ -0,0 +1 @@
+export type Primitive = string | number | boolean | null;

packages/helpers/src/utils/toValue.ts

@@ -0,0 +1,52 @@
+import type { Primitive } from '../types';
+import type { Variant } from '@aws-sdk/client-iotsitewise';
+
+/**
+ * Extracts the value out of a SiteWise Model Variant
+ *
+ * SiteWise Model values can either be a string, number or boolean.
+ *
+ * NOTE: Currently we treat booleans as strings.
+ */
+export const toValue = (variant: Variant | undefined): Primitive => {
+  if (variant == null) {
+    throw new Error('variant is undefined');
+  }
+
+  const { doubleValue, integerValue, stringValue, booleanValue } = variant;
+
+  if (doubleValue != null) {
+    return doubleValue;
+  }
+
+  if (integerValue != null) {
+    return integerValue;
+  }
+
+  if (stringValue != null) {
+    return stringValue;
+  }
+
+  if (booleanValue != null) {
+    return booleanValue.toString();
+  }
+
+  if ('nullValue' in variant && variant.nullValue != null) {
+    /**
+     * nullValue is not a nullish value
+     * it's an object with the string type of
+     * what the value should be.
+     */
+    return null;
+  }
+
+  /**
+   * A variant with no properties is treated
+   * as null data so that datastreams do not
+   * break when the sdk updates
+   */
+  return null;
+  // throw new Error(
+  //   'Expected value to have at least one property value, but instead it has none!'
+  // );
+};

packages/react-components/src/components/bar-chart/hooks/useBarChartAlarms.ts

@@ -1,6 +1,6 @@
+import type { Primitive } from '@iot-app-kit/helpers';
 import {
   type DataStream,
-  type Primitive,
   type ResolutionConfig,
   type Threshold,
   type ThresholdValue,

packages/react-components/src/components/chart/chartOptions/tooltip/value.tsx

@@ -1,10 +1,10 @@
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 import { isNumeric, round } from '@iot-app-kit/core-util';
 
 export const formatValue =
   (significantDigits = 4) =>
   (value: Primitive) =>
-    isNumeric(value) ? `${round(value, significantDigits)}` : value.toString();
+    isNumeric(value) ? `${round(value, significantDigits)}` : value?.toString();
 
 export type XYPlotTooltipValueOptions = {
   value?: Primitive;

packages/react-components/src/components/chart/hooks/useChartAlarms.ts

@@ -1,6 +1,6 @@
+import type { Primitive } from '@iot-app-kit/helpers';
 import {
   type DataStream,
-  type Primitive,
   type Threshold,
   type ThresholdValue,
 } from '@iot-app-kit/core';

packages/react-components/src/components/chart/legend/table/legendTableAdapter.tsx

@@ -1,4 +1,5 @@
-import { type DataStream, type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
+import { type DataStream } from '@iot-app-kit/core';
 import { type ChartLegend, type ChartOptions } from '../../types';
 import { ChartLegendTable } from './table';
 import { type DataStreamInformation, type TrendCursor } from './types';

packages/react-components/src/components/chart/legend/table/types.ts

@@ -1,4 +1,5 @@
-import { type DataStream, type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
+import { type DataStream } from '@iot-app-kit/core';
 import type { AlarmAssistantContext } from '../../../../common/assistantProps';
 
 export type TrendCursorValues = { [id in string]?: number };

packages/react-components/src/components/chart/multiYAxis/yAxisMenu.tsx

@@ -1,7 +1,7 @@
 import { useState } from 'react';
 import { useMeasure } from 'react-use';
 import { isNumeric, round } from '@iot-app-kit/core-util';
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 
 import Icon from '@cloudscape-design/components/icon';
 import {
@@ -24,7 +24,7 @@ import { useHighlightedDataStreams } from '../hooks/useHighlightedDataStreams';
 import './yAxisMenu.css';
 
 const getValue = (value: Primitive, significantDigits = 4) =>
-  isNumeric(value) ? `${round(value, significantDigits)}` : value.toString();
+  isNumeric(value) ? `${round(value, significantDigits)}` : value?.toString();
 
 const MENU_OFFSET = 5;
 const MENU_FONT_SIZE = 14;

packages/react-components/src/components/chart/types.ts

@@ -1,6 +1,6 @@
+import type { Primitive } from '@iot-app-kit/helpers';
 import {
   type DataStream,
-  type Primitive,
   type StyledThreshold,
   type ThresholdSettings,
   type Viewport,

packages/react-components/src/components/gauge/converters/convertDataset.ts

@@ -1,4 +1,4 @@
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 
 export const convertDataset = (gaugeValue?: Primitive) => {
   return {

packages/react-components/src/components/gauge/gaugeText.tsx

@@ -9,7 +9,7 @@ import {
 import { AlarmStateTextWithAssistant } from '../alarm-components/alarm-state/alarmStateTextWithAssistant';
 import { AlarmStateText } from '../alarm-components/alarm-state/alarmStateText';
 import { getPreciseValue } from '../../utils/getPreciseValue';
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 import { GaugeErrorText } from './gaugeErrorText';
 import { type AlarmContent } from '../alarm-components/alarm-content/types';
 import { type AssistantProperty } from '../../common/assistantProps';

packages/react-components/src/components/gauge/hooks/useGaugeConfiguration.ts

@@ -1,4 +1,4 @@
-import { type Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 import isEqual from 'lodash-es/isEqual';
 import merge from 'lodash-es/merge';
 import { useEffect, useReducer } from 'react';

packages/react-components/src/components/gauge/types.ts

@@ -1,8 +1,8 @@
+import type { Primitive } from '@iot-app-kit/helpers';
 import {
   type StyleSettingsMap,
   type Threshold,
   type Viewport,
-  type Primitive,
 } from '@iot-app-kit/core';
 import type { WidgetSettings } from '../../common/dataTypes';
 import { type AssistantProperty } from '../../common/assistantProps';

packages/react-components/src/components/gauge/utils/thresholdsToColor.ts

@@ -1,4 +1,5 @@
-import { type Primitive, type Threshold } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
+import { type Threshold } from '@iot-app-kit/core';
 
 export const thresholdsToColor = ({
   gaugeValue,

packages/react-components/src/components/resource-explorers/requests/use-latest-values/create-data-streams-with-latest-value.ts

@@ -1,6 +1,7 @@
 import type { BatchGetAssetPropertyValueSuccessEntry } from '@aws-sdk/client-iotsitewise';
 import type { DataStreamRequestEntry, DataStreamResource } from './types';
 import type { DataStreamResourceWithLatestValue } from '../../types/resources';
+import { toValue } from '@iot-app-kit/helpers';
 
 type SuccessEntry = BatchGetAssetPropertyValueSuccessEntry;
 
@@ -41,11 +42,10 @@ function createDataStreamWithLatestValue<DataStream extends DataStreamResource>(
   requestEntry: DataStreamRequestEntry<DataStream>,
   successEntry?: SuccessEntry
 ): DataStreamResourceWithLatestValue<DataStream> {
+  const variant = successEntry?.assetPropertyValue?.value;
   const dataStreamWithLatestValue = {
     ...requestEntry.dataStream,
-    latestValue: Object.values(
-      successEntry?.assetPropertyValue?.value ?? {}
-    ).at(0),
+    latestValue: variant && toValue(variant),
     latestValueTimestamp:
       successEntry?.assetPropertyValue?.timestamp?.timeInSeconds,
   };

packages/react-components/src/components/resource-explorers/types/resources.ts

@@ -1,4 +1,5 @@
 import type { AssetSummary } from '@aws-sdk/client-iotsitewise';
+import { type Primitive } from '@iot-app-kit/helpers';
 
 export interface AssetModelResource {
   assetModelId: string;
@@ -59,6 +60,6 @@ export type TimeSeriesResourceWithLatestValue =
 
 export type DataStreamResourceWithLatestValue<DataStreamResource> =
   DataStreamResource & {
-    latestValue?: number | string | boolean;
+    latestValue?: Primitive;
     latestValueTimestamp?: number;
   };

packages/react-components/src/components/shared-components/Value/Value.tsx

@@ -1,4 +1,4 @@
-import type { Primitive } from '@iot-app-kit/core';
+import type { Primitive } from '@iot-app-kit/helpers';
 import { round } from '@iot-app-kit/core-util';
 
 export const Value: React.FC<{