feat: Add proposed API changes within types declarations (#37)

awslabs · Jan 20, 2022 · d165299 · d165299
1 parent 82479eb
commit d165299
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 1 deletion.
diff --git a/packages/components/src/components/iot-bar-chart/iot-bar-chart.tsx b/packages/components/src/components/iot-bar-chart/iot-bar-chart.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -21,6 +22,8 @@ export class IotBarChart {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-kpi/iot-kpi.tsx b/packages/components/src/components/iot-kpi/iot-kpi.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 };
 
@@ -21,6 +22,8 @@ export class IotKpi {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-line-chart/iot-line-chart.tsx b/packages/components/src/components/iot-line-chart/iot-line-chart.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -21,6 +22,8 @@ export class IotLineChart {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.tsx b/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -21,6 +22,8 @@ export class IotScatterChart {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-status-grid/iot-status-grid.tsx b/packages/components/src/components/iot-status-grid/iot-status-grid.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -21,6 +22,8 @@ export class IotStatusGrid {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-status-timeline/iot-status-timeline.tsx b/packages/components/src/components/iot-status-timeline/iot-status-timeline.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -21,6 +22,8 @@ export class IotStatusTimeline {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/iot-table/iot-table.tsx b/packages/components/src/components/iot-table/iot-table.tsx
@@ -1,6 +1,7 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
 import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
+import { StyleSettingsMap } from '../types';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -19,6 +20,8 @@ export class IotTable {
 
   @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
+  @Prop() styles: StyleSettingsMap | undefined;
+
   getSettings(): TimeSeriesDataRequestSettings {
     return {
       ...this.settings,

diff --git a/packages/components/src/components/types.d.ts b/packages/components/src/components/types.d.ts
@@ -0,0 +1,8 @@
+export type StyleSettings = {
+  name?: string;
+  detailedName?: string;
+  color?: string; // CSS color string, i.e. 'red' or '#ffffff'
+  unit?: string;
+};
+
+export type StyleSettingsMap = { [refId: string]: StyleSettings };
diff --git a/packages/core/src/data-sources/site-wise/types.d.ts b/packages/core/src/data-sources/site-wise/types.d.ts
@@ -10,8 +10,12 @@ export type AssetId = string;
 
 export type PropertyAlias = string;
 
+// Reference which can be used to associate styles to the associated results from a query
+export type RefId = string;
+
 export type PropertyQuery = {
   propertyId: string;
+  refId?: RefId;
   resolution?: string;
 };
 
@@ -26,7 +30,10 @@ type SiteWiseAssetDataStreamQuery = DataStreamQuery & {
 
 // TODO: Make the data stream query support property aliases for unmodeled data support
 type SiteWisePropertyAliasDataStreamQuery = DataStreamQuery & {
-  propertyAliases: PropertyAlias[];
+  propertyAliases: {
+    propertyAlias: PropertyAlias;
+    refId: RefId;
+  };
 };
 
 // Unused currently, this is what we want to work towards.