feat: add null/NaN support

.github/workflows/validate.yml

@@ -62,7 +62,6 @@ jobs:
             data-mocked,
             dev-env,
             doc-site,
-            helpers,
             react-components,
             scene-composer,
             source-iotsitewise,

apps/dev-env/package.json

@@ -22,7 +22,6 @@
     "@iot-app-kit/core-util": "*",
     "@iot-app-kit/dashboard": "*",
     "@iot-app-kit/data-mocked": "*",
-    "@iot-app-kit/helpers": "*",
     "@iot-app-kit/ts-config": "*",
     "@playwright/test": "^1.48.2",
     "@storybook/addon-essentials": "^8.4.5",

apps/dev-env/playwright.config.ts

@@ -1,9 +1,8 @@
-import {
-  MINUTE_IN_MS,
-  SECOND_IN_MS,
-} from '@iot-app-kit/helpers/constants/time';
 import { defineConfig, devices } from '@playwright/test';
 
+const SECOND_IN_MS = 1000;
+const MINUTE_IN_MS = 60_000;
+
 /**
  * See https://playwright.dev/docs/test-configuration.
  */

configuration/eslint-config/index.js

@@ -20,7 +20,7 @@ module.exports = {
     'plugin:import/recommended',
     'plugin:import/typescript',
   ],
-  plugins: ['prettier', 'react', 'jest', 'import', 'unused-imports'],
+  plugins: ['prettier', 'react', "react-hooks", 'jest', 'import', 'unused-imports'],
   globals: {
     module: true,
     process: true,

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

@@ -27,7 +27,7 @@ export interface DataPoint<T extends Primitive = Primitive>
 
 export type Resolution = number;
 
-export type Primitive = string | number | boolean;
+export type Primitive = string | number | boolean | null;
 
 export type DataStreamId = string;
 

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

@@ -4,7 +4,7 @@ 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/multiYAxis/yAxisMenu.tsx

@@ -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/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 './toValue';
 
 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/requests/use-latest-values/toValue.ts

@@ -0,0 +1,45 @@
+import type { Primitive } from '@iot-app-kit/core';
+import type { Variant } from '@aws-sdk/client-iotsitewise';
+
+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/resource-explorers/types/resources.ts

@@ -59,6 +59,6 @@ export type TimeSeriesResourceWithLatestValue =
 
 export type DataStreamResourceWithLatestValue<DataStreamResource> =
   DataStreamResource & {
-    latestValue?: number | string | boolean;
+    latestValue?: number | string | boolean | null;
     latestValueTimestamp?: number;
   };

packages/react-components/src/components/table/createTableItems.ts

@@ -40,7 +40,7 @@ export const createTableItems: (
   const alarmItemsWithData = alarms.map((alarm) => {
     const isLoading = alarm.isLoading;
     return {
-      id: alarm.id as Primitive,
+      id: alarm.id as string,
       assetId: createCellItem(
         {
           value: alarm.assetId,
@@ -189,7 +189,7 @@ export const createTableItems: (
 
     const [first] = keyDataPairs;
     return {
-      id: first.data.value as Primitive,
+      id: first.data.value as string | number | boolean,
       ...keyDataPairs.reduce(
         (previous, { key, data }) => ({
           ...previous,

packages/react-components/src/queries/useAssetPropertyValues/types.ts

@@ -8,6 +8,7 @@ import {
   type GetAssetPropertyValueHistoryRequest,
   type GetAssetPropertyValueHistoryResponse,
 } from '@aws-sdk/client-iotsitewise';
+import { type Primitive } from '@iot-app-kit/charts-core';
 import {
   type RequestFunction,
   type RequestParameters,
@@ -84,7 +85,7 @@ export type AssetPropertyValuesRequest =
   | AssetPropertyValueHistoryRequest
   | AssetPropertyAggregatesRequest;
 
-export type AssetPropertyValuesData = DataPoint[];
+export type AssetPropertyValuesData = DataPoint<Primitive>[];
 
 export type AssetPropertyValuesRequestFunctions = {
   getAssetPropertyValueHistory?: GetAssetPropertyValueHistoryRequestFunction;

packages/react-components/src/queries/useAssetPropertyValues/utils/toDataPoint.spec.ts

@@ -70,13 +70,13 @@ describe('toDataPoint', () => {
     });
   });
 
-  it('throws error when no property values passed in', () => {
+  it('does not throw error when no property values passed in', () => {
     expect(() =>
       toDataPoint({
         timestamp: { timeInSeconds: SECONDS },
         value: {},
       })
-    ).toThrowError();
+    ).not.toThrowError();
   });
 
   it('converts correctly for a string value', () => {

packages/react-components/src/queries/useAssetPropertyValues/utils/toDataPoint.ts

@@ -1,12 +1,13 @@
 import { NANO_SECOND_IN_MS, SECOND_IN_MS } from './timeConstants';
-import type { DataPoint, Primitive } from '@iot-app-kit/core';
+import type { DataPoint } from '@iot-app-kit/core';
 import type {
   AssetPropertyValue,
   TimeInNanos,
   Variant,
   Aggregates,
   AggregatedValue,
 } from '@aws-sdk/client-iotsitewise';
+import { type Primitive } from '@iot-app-kit/charts-core';
 
 /** converts the TimeInNanos to milliseconds */
 export const toTimestamp = (time: TimeInNanos | undefined): number =>
@@ -24,7 +25,7 @@ export const toTimestamp = (time: TimeInNanos | undefined): number =>
  *
  * NOTE: Currently we treat booleans as strings.
  */
-export const toValue = (variant: Variant | undefined): Primitive => {
+export const toValue = (variant: Variant | undefined): Primitive | null => {
   if (variant == null) {
     throw new Error('variant is undefined');
   }
@@ -47,17 +48,15 @@ export const toValue = (variant: Variant | undefined): Primitive => {
     return booleanValue.toString();
   }
 
-  throw new Error(
-    'Expected value to have at least one property value, but instead it has none!'
-  );
+  return null;
 };
 
 /**
  * Converts a SiteWise response for data into a data point understood by IoT App Kit.
  */
 export const toDataPoint = (
   assetPropertyValue: AssetPropertyValue | undefined
-): DataPoint | undefined => {
+): DataPoint<Primitive> | undefined => {
   if (assetPropertyValue == null) {
     return undefined;
   }

packages/react-components/src/utils/getPreciseValue.ts

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

packages/react-components/src/utils/thresholdUtils.ts

@@ -226,7 +226,11 @@ export const getBreachedThreshold = (
     return undefined;
   }
 
-  if (typeof value === 'string' || typeof value === 'boolean') {
+  if (
+    typeof value === 'string' ||
+    typeof value === 'boolean' ||
+    value === null
+  ) {
     return (
       thresholds.find((threshold) => isThresholdBreached(value, threshold)) ||
       undefined

packages/source-iotsitewise/src/alarms/iotevents/siteWiseAlarmModule.ts

@@ -110,7 +110,8 @@ export class SiteWiseAlarmModule {
         inputPropertyId,
         thresholdPropertyId,
         comparisonOperator,
-        threshold,
+        // old synchro charts type does not support null
+        threshold: threshold === null ? '' : threshold,
         severity,
         rule,
         state,

packages/source-iotsitewise/src/alarms/iotevents/util/completeAlarmStream.ts

@@ -35,7 +35,7 @@ export const completeAlarmStream = ({
   if (!assetModel) {
     if (
       isIoTEventsAlarmStateProperty(
-        dataStream.data[dataStream.data?.length - 1]?.y
+        dataStream.data[dataStream.data?.length - 1]?.y ?? undefined
       )
     ) {
       return {

packages/source-iotsitewise/src/time-series-data/util/toDataPoint.spec.ts

@@ -70,13 +70,16 @@ describe('toDataPoint', () => {
     });
   });
 
-  it('throws error when no property values passed in', () => {
+  it('does not throw error when no property values passed in', () => {
+    /**
+     * changing this functionality to patch support null / nan data
+     */
     expect(() =>
       toDataPoint({
         timestamp: { timeInSeconds: SECONDS },
         value: {},
       })
-    ).toThrowError();
+    ).not.toThrowError();
   });
 
   it('converts correctly for a string value', () => {

packages/source-iotsitewise/src/time-series-data/util/toDataPoint.ts

@@ -47,9 +47,24 @@ export const toValue = (variant: Variant | undefined): Primitive => {
     return booleanValue.toString();
   }
 
-  throw new Error(
-    'Expected value to have at least one property value, but instead it has none!'
-  );
+  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!'
+  // );
 };
 
 /**