Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add messageOverrrides for table. #211

Merged
merged 1 commit into from
Aug 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/components/src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
import { Provider, StyleSettingsMap, TimeQuery, TimeSeriesData, TimeSeriesDataRequest, TimeSeriesDataRequestSettings, TreeQuery, Viewport } from "@iot-app-kit/core";
import { AlarmsConfig, Annotations, Axis, LabelsConfig, LayoutConfig, LegendConfig, MessageOverrides, MinimalSizeConfig, MovementConfig, ScaleConfig, TableColumn, Trend } from "@synchro-charts/core";
import { Item, TableItem, TableProps } from "@iot-app-kit/table";
import { Item, RecursivePartial, TableItem, TableMessages, TableProps } from "@iot-app-kit/table";
import { BranchReference, SiteWiseAssetTreeNode } from "@iot-app-kit/source-iotsitewise";
import { ColumnDefinition, FilterTexts } from "./components/iot-resource-explorer/types";
import { TableProps as TableProps1 } from "@awsui/components-react/table";
Expand Down Expand Up @@ -64,6 +64,7 @@ export namespace Components {
interface IotReactTable {
"columnDefinitions": TableProps['columnDefinitions'];
"items": TableItem[];
"messageOverrides": TableMessages;
"propertyFiltering": TableProps['propertyFiltering'];
"sorting": TableProps['sorting'];
}
Expand Down Expand Up @@ -134,7 +135,7 @@ export namespace Components {
"annotations": Annotations;
"columnDefinitions": TableProps['columnDefinitions'];
"items": Item[];
"messageOverrides"?: MessageOverrides;
"messageOverrides"?: RecursivePartial<TableMessages>;
"propertyFiltering": TableProps['propertyFiltering'];
"queries": TimeQuery<TimeSeriesData[], TimeSeriesDataRequest>[];
"settings": TimeSeriesDataRequestSettings;
Expand Down Expand Up @@ -347,6 +348,7 @@ declare namespace LocalJSX {
interface IotReactTable {
"columnDefinitions": TableProps['columnDefinitions'];
"items": TableItem[];
"messageOverrides"?: TableMessages;
"propertyFiltering"?: TableProps['propertyFiltering'];
"sorting"?: TableProps['sorting'];
}
Expand Down Expand Up @@ -417,7 +419,7 @@ declare namespace LocalJSX {
"annotations"?: Annotations;
"columnDefinitions": TableProps['columnDefinitions'];
"items": Item[];
"messageOverrides"?: MessageOverrides;
"messageOverrides"?: RecursivePartial<TableMessages>;
"propertyFiltering"?: TableProps['propertyFiltering'];
"queries": TimeQuery<TimeSeriesData[], TimeSeriesDataRequest>[];
"settings"?: TimeSeriesDataRequestSettings;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Component, Element, Host, Prop, h } from '@stencil/core';
import React, { FunctionComponent } from 'react';
import { Table, TableItem, TableProps } from '@iot-app-kit/table';
import { Table, TableItem, TableProps, TableMessages } from '@iot-app-kit/table';
import ReactDOM from 'react-dom';

@Component({
Expand All @@ -15,6 +15,8 @@ export class IotReactTable {

@Prop() propertyFiltering: TableProps['propertyFiltering'];

@Prop() messageOverrides: TableMessages;

@Element() host: HTMLElement;

componentWillLoad() {}
Expand All @@ -29,6 +31,7 @@ export class IotReactTable {
columnDefinitions: this.columnDefinitions,
sorting: this.sorting,
propertyFiltering: this.propertyFiltering,
messageOverrides: this.messageOverrides,
};
ReactDOM.render(React.createElement<TableProps>(Table as FunctionComponent<TableProps>, props), this.host);
}
Expand Down
33 changes: 24 additions & 9 deletions packages/components/src/components/iot-table/iot-table.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Component, Prop, h, State, Listen, Watch } from '@stencil/core';
import { Annotations, MessageOverrides, TableColumn, Trend, getThresholds } from '@synchro-charts/core';
import { Annotations, TableColumn, Trend, getThresholds } from '@synchro-charts/core';
import {
StyleSettingsMap,
TimeSeriesDataRequestSettings,
Expand All @@ -11,7 +11,15 @@ import {
ProviderWithViewport,
} from '@iot-app-kit/core';
import { v4 as uuidv4 } from 'uuid';
import { createTableItems, Item, TableProps } from '@iot-app-kit/table';
import {
createTableItems,
Item,
TableProps,
DefaultTableMessages,
TableMessages,
RecursivePartial,
} from '@iot-app-kit/table';
import merge from 'lodash/merge';

@Component({
tag: 'iot-table',
Expand All @@ -20,7 +28,7 @@ import { createTableItems, Item, TableProps } from '@iot-app-kit/table';
export class IotTable {
@Prop() annotations: Annotations;

@Prop() messageOverrides?: MessageOverrides;
@Prop() messageOverrides?: RecursivePartial<TableMessages>;

@Prop() trends: Trend[];

Expand All @@ -46,6 +54,8 @@ export class IotTable {

@State() provider: ProviderWithViewport<TimeSeriesData[]>;

private messages: TableMessages;

private defaultSettings: TimeSeriesDataRequestSettings = {
resolution: '0',
fetchMostRecentBeforeEnd: true,
Expand All @@ -66,6 +76,7 @@ export class IotTable {
}

componentWillLoad() {
this.messages = merge(DefaultTableMessages, this.messageOverrides);
this.buildProvider();
}

Expand All @@ -91,14 +102,18 @@ export class IotTable {
return (
<iot-react-table
columnDefinitions={this.columnDefinitions}
items={createTableItems({
dataStreams,
items: this.items,
viewport: this.viewport,
thresholds: getThresholds(this.annotations),
})}
items={createTableItems(
{
dataStreams,
items: this.items,
viewport: this.viewport,
thresholds: getThresholds(this.annotations),
},
this.messages
)}
sorting={this.sorting}
propertyFiltering={this.propertyFiltering}
messageOverrides={this.messages}
/>
);
}}
Expand Down
12 changes: 9 additions & 3 deletions packages/table/src/table/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@ import React, { FunctionComponent } from 'react';
import { PropertyFilter, Table as AWSUITable } from '@awsui/components-react';
import { useCollection } from '@awsui/collection-hooks';
import { TableProps } from '../utils';
import { defaultI18nStrings, getDefaultColumnDefinitions } from '../utils/tableHelpers';
import { getDefaultColumnDefinitions } from '../utils/tableHelpers';

export const Table: FunctionComponent<TableProps> = (props) => {
const { items: userItems, sorting = {}, propertyFiltering, columnDefinitions: userColumnDefinitions } = props;
const {
items: userItems,
sorting = {},
propertyFiltering,
columnDefinitions: userColumnDefinitions,
messageOverrides: { propertyFilter },
} = props;
const { items, collectionProps, propertyFilterProps } = useCollection(userItems, { sorting, propertyFiltering });
const columnDefinitions = getDefaultColumnDefinitions(userColumnDefinitions);
return (
Expand All @@ -14,7 +20,7 @@ export const Table: FunctionComponent<TableProps> = (props) => {
items={items}
{...collectionProps}
columnDefinitions={columnDefinitions}
filter={propertyFiltering && <PropertyFilter {...propertyFilterProps} i18nStrings={defaultI18nStrings} />}
filter={propertyFiltering && <PropertyFilter {...propertyFilterProps} i18nStrings={propertyFilter} />}
/>
);
};
42 changes: 25 additions & 17 deletions packages/table/src/utils/createCellItem.spec.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
import { createCellItem } from './createCellItem';
import { CellItem } from './types';
import { DefaultTableMessages, TableMessages } from './messages';

describe('createCellItem', () => {
it('creates CellItem', () => {
const props = { value: 10, error: undefined, isLoading: false, threshold: undefined };
const item: CellItem = createCellItem(props);
expect(item).toMatchObject({ value: 10 });
expect(item.valueOf()).toEqual(10);
});
const messageOverride = { tableCell: { loading: 'Override loading text' } } as TableMessages;

it('creates CellItem that returns error message on error', () => {
const props = { value: 10, error: { msg: 'Some error' }, isLoading: false, threshold: undefined };
const item: CellItem = createCellItem(props);
it('creates CellItem', () => {
const props = { value: 10, error: undefined, isLoading: false, threshold: undefined };
const item: CellItem = createCellItem(props, DefaultTableMessages);
expect(item).toMatchObject({ value: 10 });
expect(item.valueOf()).toEqual(10);
});

it('creates CellItem that returns error message on error', () => {
const props = { value: 10, error: { msg: 'Some error' }, isLoading: false, threshold: undefined };
const item: CellItem = createCellItem(props, DefaultTableMessages);

expect(`${item}`).toBe('Some error');
});

it('creates CellItem that returns loading message on loading', () => {
const props = { value: 10, isLoading: true, threshold: undefined };
const item: CellItem = createCellItem(props, DefaultTableMessages);

expect(`${item}`).toBe('Some error');
});
expect(`${item}`).toBe('Loading');
});

it('creates CellItem that returns loading message on loading', () => {
const props = { value: 10, isLoading: true, threshold: undefined };
const item: CellItem = createCellItem(props);
it('accepts messageOverrides for loading message', () => {
const props = { value: 10, isLoading: true, threshold: undefined };
const item: CellItem = createCellItem(props, messageOverride);

expect(`${item}`).toBe('Loading');
});
expect(`${item}`).toBe(messageOverride!.tableCell!.loading);
});
18 changes: 7 additions & 11 deletions packages/table/src/utils/createCellItem.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
import { Primitive, Threshold } from '@synchro-charts/core';
import { ErrorDetails } from '@iot-app-kit/core';
import { CellItem } from './types';
import { CellItem, CellProps } from './types';
import { TableMessages } from './messages';

type CellProps = {
value?: Primitive;
error?: ErrorDetails;
isLoading?: boolean;
threshold?: Threshold;
};
export const createCellItem: (props?: CellProps) => CellItem = ({ value, error, isLoading, threshold } = {}) => {
export const createCellItem: (props: Partial<CellProps>, messageOverrides: TableMessages) => CellItem = (
{ value, error, isLoading, threshold } = {},
messageOverrides
) => {
const valueOf = () => {
if (error) {
return error.msg;
}
if (isLoading) {
return 'Loading';
return messageOverrides.tableCell.loading;
}
return value;
};
Expand Down
26 changes: 15 additions & 11 deletions packages/table/src/utils/createTableItems.spec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { DataStream, Viewport } from '@iot-app-kit/core';
import { Annotations, COMPARISON_OPERATOR, getThresholds } from '@synchro-charts/core';
import { createTableItems } from './createTableItems';
import { DefaultTableMessages } from './messages';

const dataStreams: DataStream[] = [
{
Expand Down Expand Up @@ -82,7 +83,7 @@ const itemWithRef = [
];

it('creates table items', () => {
const items = createTableItems({ dataStreams, viewport, items: itemWithRef });
const items = createTableItems({ dataStreams, viewport, items: itemWithRef }, DefaultTableMessages);
expect(items).toMatchObject([
{
value1: { value: 4 },
Expand All @@ -104,7 +105,7 @@ it('creates table items', () => {
});

it('returns value as it is a primitive value', () => {
const items = createTableItems({ dataStreams, viewport, items: itemWithRef });
const items = createTableItems({ dataStreams, viewport, items: itemWithRef }, DefaultTableMessages);
const data = items[0].value1;
expect((data as number) + 1).toBe(5);
});
Expand All @@ -130,8 +131,8 @@ it('gets different data points on different viewports on the same data stream',
},
},
];
const items1 = createTableItems({ dataStreams, viewport: viewport1, items: itemDef });
const items2 = createTableItems({ dataStreams, viewport: viewport2, items: itemDef });
const items1 = createTableItems({ dataStreams, viewport: viewport1, items: itemDef }, DefaultTableMessages);
const items2 = createTableItems({ dataStreams, viewport: viewport2, items: itemDef }, DefaultTableMessages);

expect(items1).not.toEqual(items2);
});
Expand All @@ -152,7 +153,7 @@ it('returns undefined value when no data points in data stream', () => {
},
},
];
const items1 = createTableItems({ dataStreams, viewport: viewport1, items: itemDef });
const items1 = createTableItems({ dataStreams, viewport: viewport1, items: itemDef }, DefaultTableMessages);
expect(items1).toMatchObject([{ noDataPoints: { value: undefined } }]);
});

Expand Down Expand Up @@ -198,12 +199,15 @@ it('contains breached threshold', () => {
},
];

const tableItems = createTableItems({
dataStreams,
viewport,
items,
thresholds: getThresholds(annotations),
});
const tableItems = createTableItems(
{
dataStreams,
viewport,
items,
thresholds: getThresholds(annotations),
},
DefaultTableMessages
);

const { itemOne, itemTwo, noRef } = tableItems[0];

Expand Down
24 changes: 14 additions & 10 deletions packages/table/src/utils/createTableItems.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ import { getDataBeforeDate } from './dataFilters';
import { getDataPoints } from './getDataPoints';
import { CellItem, Item, ItemRef, TableItem } from './types';
import { createCellItem } from './createCellItem';
import { TableMessages } from './messages';

export const createTableItems: (config: {
dataStreams: DataStream[];
items: Item[];
viewport: Viewport;
thresholds?: Threshold[];
}) => TableItem[] = ({ dataStreams, viewport, items, thresholds = [] }) => {
export const createTableItems: (
config: {
dataStreams: DataStream[];
items: Item[];
viewport: Viewport;
thresholds?: Threshold[];
},
messageOverrides: TableMessages
) => TableItem[] = ({ dataStreams, viewport, items, thresholds = [] }, messageOverrides) => {
return items.map((item) => {
const keys = Object.keys(item);
const keyDataPairs = keys.map<{ key: string; data: CellItem }>((key) => {
Expand All @@ -32,7 +36,7 @@ export const createTableItems: (config: {
thresholds,
date: viewport.end,
});
return { key, data: createCellItem({ value, error, isLoading, threshold }) };
return { key, data: createCellItem({ value, error, isLoading, threshold }, messageOverrides) };
}

const value = dataPoints.slice(-1)[0]?.y;
Expand All @@ -44,11 +48,11 @@ export const createTableItems: (config: {
date: new Date(Date.now()),
});

return { key, data: createCellItem({ value, error, isLoading, threshold }) };
return { key, data: createCellItem({ value, error, isLoading, threshold }, messageOverrides) };
}
return { key, data: createCellItem() };
return { key, data: createCellItem({}, messageOverrides) };
}
return { key, data: createCellItem({ value: item[key] as Primitive }) };
return { key, data: createCellItem({ value: item[key] as Primitive }, messageOverrides) };
});

return keyDataPairs.reduce(
Expand Down
12 changes: 11 additions & 1 deletion packages/table/src/utils/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
export { createTableItems } from './createTableItems';
export { CellItem, Item, ItemRef, TableItem, TableProps, ColumnDefinition, CellItemProps } from './types';
export {
CellItem,
Item,
ItemRef,
TableItem,
TableProps,
ColumnDefinition,
CellItemProps,
RecursivePartial,
} from './types';
export { TableMessages, DefaultTableMessages } from './messages';
Loading