awslabs
diff --git a/‎.github/workflows/release-please.yml
+50 b/‎.github/workflows/release-please.yml
+50
diff --git a/‎.release-please-manifest.json
+11 b/‎.release-please-manifest.json
+11
diff --git a/‎CHANGELOG.md
+55-3 b/‎CHANGELOG.md
+55-3
diff --git a/‎docs/AWSIoTSiteWiseSource.md
+27 b/‎docs/AWSIoTSiteWiseSource.md
+27
diff --git a/‎docs/GettingStarted.md
+140-53 b/‎docs/GettingStarted.md
+140-53
diff --git a/‎docs/imgs/lineChartWithAlarms.png
55.5 KB b/‎docs/imgs/lineChartWithAlarms.png
55.5 KB
diff --git a/‎docs/imgs/statusGridWithAlarms.png
68.2 KB b/‎docs/imgs/statusGridWithAlarms.png
68.2 KB
diff --git a/‎docs/imgs/statusTimelineWithAlarms.png
68.9 KB b/‎docs/imgs/statusTimelineWithAlarms.png
68.9 KB
@@ -0,0 +1,50 @@
+on:
+  push:
+    branches:
+      - main
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          command: manifest
+          token: ${{secrets.GITHUB_TOKEN}}
+          default-branch: main
+
+  update-pull-request:
+    name: Update pull request
+    runs-on: ubuntu-latest
+    needs: release-please
+    if: ${{ !needs.release-please.outputs.releases_created }}
+    steps:
+      - name: Fetching the repository
+        uses: actions/checkout@v2
+        with:
+          ref: release-please--branches--main
+          fetch-depth: 2
+
+      - name: Setting up Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Updating package-lock.json file
+        run: npm install --no-audit --no-fund --ignore-scripts --package-lock-only
+
+      - name: Merging changes with last commit
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add .
+          git commit --amend --no-edit
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        continue-on-error: true
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: release-please--branches--main
+          force: true
@@ -0,0 +1,11 @@
+{
+  "packages/components": "2.2.0",
+  "packages/core": "2.2.0",
+  "packages/react-components": "2.2.0",
+  "packages/related-table": "2.2.0",
+  "packages/scene-composer": "2.2.0",
+  "packages/source-iotsitewise": "2.2.0",
+  "packages/source-iottwinmaker": "2.2.0",
+  "packages/table": "2.2.0",
+  ".": "2.2.0"
+}
@@ -3,7 +3,59 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# 2.1.0 (2022-09-30)
+## 2.2.0 (2022-10-21)
+
+### Features
+
+* source-iotsitewise, core, components:
+  * Introduce alarms support ([9bc221e](https://github.com/awslabs/iot-app-kit/commit/9bc221ef19fc5a9db4360c1d124f41e7b0d896be))
+
+* react-components, scene-composer:
+  * EnvironmentModelComponent for Adding support for environment overlay ([eb91179](https://github.com/awslabs/iot-app-kit/commit/eb911799e555c07c535853661e93237969159ff0))
+
+* core, components:
+  * Support viewport grouping in iot-table ([be5b588](https://github.com/awslabs/iot-app-kit/commit/be5b588a90ec267a2c8cdce24bdea86b45c97136))
+
+* scene-composer:
+  * Removes the dependency on the feature flag for the top bar camera drowpdown ([fb8e333](https://github.com/awslabs/iot-app-kit/commit/fb8e3330cc4f4933ccd6f9cde32b1d4694897358))
+  * Add flag to resizable tags ([560e1b1](https://github.com/awslabs/iot-app-kit/commit/560e1b1a2db0f60700b7246626c71f1bc05f49e1))
+
+### Bug Fixes
+
+* scene-composer:
+  * Camera Component Editor for Lens and Clipping planes updates when changing between cameras ([94c5978](https://github.com/awslabs/iot-app-kit/commit/94c59786aae02a4c9fd088cfc6c9cea516880f3c))
+  * improve ViewCursorWidget performance ([58b70bd](https://github.com/awslabs/iot-app-kit/commit/58b70bdc82cd1e4bbcc0c0e7f66bfef3f064e86b))
+  * Allows user to hit Esc key to cancel Enhanced Editing ([9c1b9e6](https://github.com/awslabs/iot-app-kit/commit/9c1b9e64c725671adb0766d1c080297389385fd8))
+  * selectedDataBinding not able to update selected node ([b23bce2](https://github.com/awslabs/iot-app-kit/commit/b23bce279b81496583c052a0dc69ac9be5994643))
+  * use arrow data as texture to avoid public path issue ([0d2e427](https://github.com/awslabs/iot-app-kit/commit/0d2e427354cbd3c0678d579ceaffab84e5e88e5c))
+  * fix show svg ([cb6094e](https://github.com/awslabs/iot-app-kit/commit/cb6094e724465ccc11d9f7ae7f7fe3179d4d2596))
+  * fix adding tag always attached to root ([775446a](https://github.com/awslabs/iot-app-kit/commit/775446a210877780c2a220092e6b0210edc7ea2c))
+  * Fix the tag scaling with parent scale regression ([4483140](https://github.com/awslabs/iot-app-kit/commit/448314018882912a49c8522786bc8ae3c964b7aa))
+  * SceneHierarchy Tree Performance ([c74d1dc](https://github.com/awslabs/iot-app-kit/commit/c74d1dc8be97135529d55e994834e7dd3f352ee8))
+  * Minimum FOV check introduced ([720b8e8](https://github.com/awslabs/iot-app-kit/commit/720b8e85d3b8329c898638030e32ad1e910c4e62))
+  * Fix the camera zoom field locked to 1 or greater ([cada75e](https://github.com/awslabs/iot-app-kit/commit/cada75ec32c81312bf5ee403f10bbf4567c30c05))
+  * Add success popup message when updating camera location ([4af9c07](https://github.com/awslabs/iot-app-kit/commit/4af9c0758c8adc04f35c80fae2f39b60460e903a))
+  * Update the text from Cameras in the drop down to Camera View ([5687f5e](https://github.com/awslabs/iot-app-kit/commit/5687f5efc38dabbd0ec06ccc5e395576fa3d57e4))
+  * fix model shader material color restore ([0786c4a](https://github.com/awslabs/iot-app-kit/commit/0786c4a038cbe93be8a4d7a4b2f7a57bfacd76c2))
+  * CSS updates to Scene Hierarchy ([ab3c749](https://github.com/awslabs/iot-app-kit/commit/ab3c7490add7338611533e6b68cecefe0f9cb3a1))
+
+* core:
+  * add currentTime param to viewportStartDate and `viewportEndDate` ([eb02085](https://github.com/awslabs/iot-app-kit/commit/eb02085fd3b0aa987c38278cedc8eba0e56d9fa9))
+
+* react-components:
+  * fix propertiesNotChanged for videoPlayer ([9a360b1](https://github.com/awslabs/iot-app-kit/commit/9a360b10fc87b2e31b4c6a00d9e49a5224e207d0))
+
+### Documentation
+
+* Updating scene-composer documentation for Storybook ([901ff53](https://github.com/awslabs/iot-app-kit/commit/901ff53efc86d0c68f0cbc15dc7be9dfc00b0243))
+* add TwinMaker components to GettingStarted doc ([84e9fdf](https://github.com/awslabs/iot-app-kit/commit/84e9fdfb3b1af3c47343a91ca1259e5e45f1eaac))
+
+### Miscellaneous
+
+* reduce concurrent workers in testing ([e8d6dbc](https://github.com/awslabs/iot-app-kit/commit/e8d6dbcac3f3e2e503e02db0087d5db324e9b521))
+* easier linking for iot-app-kit packages ([44d454d](https://github.com/awslabs/iot-app-kit/commit/44d454d955e22581228d3d77829b8ad27a24fd52))
+
+## 2.1.0 (2022-09-30)
 
 ### Features
 
@@ -30,7 +82,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * update jest versions from 28 to 27 to be consistent with other modules ([f08c541](https://github.com/awslabs/iot-app-kit/commit/f08c541f017f4bbefae085e45c2ef2e686eb5919))
 
 
-# 2.0.0 (2022-09-14)
+## 2.0.0 (2022-09-14)
 
 ### BREAKING CHANGES
 * core:
@@ -59,7 +111,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * Migrate to NPM workspaces ([8e200be](https://github.com/awslabs/iot-app-kit/commit/8e200be0401fe6fa989cbf9a1ad96aafd8305a96))
 
 
-# 1.4.0 (2022-06-09)
+## 1.4.0 (2022-06-09)
 
 
 ### Features
 
@@ -112,6 +112,33 @@ Each asset contains the following fields:
 
       Type: String
 
+#### Alarms
+
+AWS IoT SiteWise has a concept of [alarms](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/industrial-alarms.html).
+
+The source of alarms in IoT Application Kit is AWS IoT Events.
+
+AWS IoT Events alarms are able to process and alarm on AWS IoT SiteWise data.
+
+To query for an alarm you have to know the **AlarmState Property ID**. The **AlarmState Property ID** can be found in the AWS IoT SiteWise console on the **Models** page. Find the model which the alarm was created on. Then under the **Alarm definitions** tab you should see your alarm. Use the **AlarmState Property ID** as the `propertyId` in the asset property query.
+
+```
+query.timeSeriesData({ 
+  assets: [{
+    assetId: 'id', 
+    properties: [{ propertyId: 'alarmStatePropertyId' }]
+  }]
+})
+```
+
+This query will request an AWS IoT Events alarm stream, which can be in one of [these states](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html). The alarms input property stream will be associated with the alarm stream if queried. IoT Application Kit will autogenerate thresholds that represent the alarm. This is how alarms are visualized in @iot-app-kit/components.
+
+![status grid with alarms](./imgs/statusGridWithAlarms.png)
+
+![status timeline with alarms](./imgs/statusTimelineWithAlarms.png)
+
+![line chart with alarms](./imgs/lineChartWithAlarms.png)
+
 ### TimeSeriesDataSettings parameter
 
 (Optional) Specifies how IoT Application Kit requests time series data. Learn more about how to configure TimeSeriesDataSettings, see TimeSeriesDataSettings under [Core](https://github.com/awslabs/iot-app-kit/tree/main/docs/Core.md).  
 
@@ -5,79 +5,166 @@ Use the step-by-step tutorial in this section to learn how to set up IoT Applica
 1. Install the required dependencies
     To install by using npm, run the following command.
     1. `npm install --save @iot-app-kit/source-iotsitewise`
+    1. `npm install --save @iot-app-kit/source-iottwinmaker`
     1. `npm install --save @iot-app-kit/components`
     1.  If you want to use React: `npm install --save @iot-app-kit/react-components`
+    1. `npm install --save @iot-app-kit/scene-composer`
 2. To initialize the AWS IoT SiteWise source, choose one of the following. 
     1. To initialize an instance of [@aws-sdk/client-iotsitewise](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-iotsitewise/index.html), use the following sample code.
 
-            import { initialize } from '@iot-app-kit/source-iotsitewise';
+    ```ts
+    import { initialize } from '@iot-app-kit/source-iotsitewise';
 
-            const { IoTSiteWiseClient } = require("@aws-sdk/client-iotsitewise");
+    const { IoTSiteWiseClient } = require("@aws-sdk/client-iotsitewise");
 
-            const iotsitewiseClient = new IoTSiteWiseClient({ region: "REGION" });
+    const iotsitewiseClient = new IoTSiteWiseClient({ region: "REGION" });
 
-            const { query } = initialize({ iotsitewiseClient });
+    const { query } = initialize({ iotsitewiseClient });
+    ```
 
     2. To initialize an instance of [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers), use the following sample code, but replace the credential provider with the one you wish to utilize: 
 
-            import { initialize } from '@iot-app-kit/source-iotsitewise';
-            import { fromCognitoIdentity } from "@aws-sdk/credential-providers";
-
-            const { query } = initialize({ awsCredentials: fromCognitoIdentity(...) });
+    ```ts
+    import { initialize } from '@iot-app-kit/source-iotsitewise';
+    import { fromCognitoIdentity } from "@aws-sdk/credential-providers";
 
+    const { query } = initialize({ awsCredentials: fromCognitoIdentity(...) });
+    ```
 
 3. Include the style sheets somewhere in your application
 
-```
+```ts
 import "@iot-app-kit/components/styles.css";
 ```
 
 4. To mount the component, use the following sample code. 
 
-        import { initialize } from '@iot-app-kit/source-iotsitewise';
-        import { LineChart, WebglContext } from '@iot-app-kit/react-components';
-        const { IoTSiteWiseClient } = require("@aws-sdk/client-iotsitewise");
-
-        const iotsitewiseClient = new IoTSiteWiseClient({ region: "REGION" });
-        const { query } = initialize({ iotsitewiseClient });
-
-        // React component example
-        <LineChart
-          queries={[
-            query.timeSeriesData(
-              {
-                assets: [{
-                  // Replace sitewse-asset-id with the ID of your AWS IoT SiteWise asset. 
-                  assetId: 'sitewise-asset-id',
-                  // Replace property-id with the ID of your AWS IoT SiteWise asset property. 
-                  properties: [{ propertyId: 'property-id' }],
-                }]
-              }
-            )
-          ]}
-        />
-        <WebglContext />
-
-        // Web component example
-        const { defineCustomElements } = require('@iot-app-kit/components/loader');
-        defineCustomElements();
-
-        <iot-line-chart
-          queries={[
-            query.timeSeriesData(
-              {
-                assets: [{
-                  // Replace sitewse-asset-id with the ID of your AWS IoT SiteWise asset. 
-                  assetId: 'sitewise-asset-id',
-                  // Replace property-id with the ID of your AWS IoT SiteWise asset property. 
-                  properties: [{ propertyId: 'property-id' }],
-                }]
-              }
-            )
-          ]}
-        />
-        <iot-webgl-context />
-
+```tsx
+import { initialize } from '@iot-app-kit/source-iotsitewise';
+import { LineChart, WebglContext } from '@iot-app-kit/react-components';
+const { IoTSiteWiseClient } = require("@aws-sdk/client-iotsitewise");
+
+const iotsitewiseClient = new IoTSiteWiseClient({ region: "REGION" });
+const { query } = initialize({ iotsitewiseClient });
+
+// React component example
+<LineChart
+  queries={[
+    query.timeSeriesData(
+      {
+        assets: [{
+          // Replace sitewse-asset-id with the ID of your AWS IoT SiteWise asset. 
+          assetId: 'sitewise-asset-id',
+          // Replace property-id with the ID of your AWS IoT SiteWise asset property. 
+          properties: [{ propertyId: 'property-id' }],
+        }]
+      }
+    )
+  ]}
+/>
+<WebglContext />
+
+// Web component example
+const { defineCustomElements } = require('@iot-app-kit/components/loader');
+defineCustomElements();
+
+<iot-line-chart
+  queries={[
+    query.timeSeriesData(
+      {
+        assets: [{
+          // Replace sitewse-asset-id with the ID of your AWS IoT SiteWise asset. 
+          assetId: 'sitewise-asset-id',
+          // Replace property-id with the ID of your AWS IoT SiteWise asset property. 
+          properties: [{ propertyId: 'property-id' }],
+        }]
+      }
+    )
+  ]}
+/>
+<iot-webgl-context />
+```
 The IoT App Kit components are all supported broadly across all modern browsers, including IE11. Due to usage of WebGL, users with misconfigured or missing graphics drivers may face problems when utilizing IoT App Kit components which utilize WebGL. Components which require WebGL will specify in their components documentation.
 
 
+5. To initialize the AWS IoT TwinMaker source with [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers), use the following sample code, but replace the credential provider with the one you wish to utilize: 
+
+```ts
+import { initialize } from '@iot-app-kit/source-iottwinmaker';
+import { fromCognitoIdentity } from "@aws-sdk/credential-providers";
+
+// Replace twin-maker-workspace-id with the ID of your AWS IoT TwinMaker workspace, and replace
+// REGION with the region of your workspace.
+const { query } = initialize('twin-maker-workspace-id', { awsCredentials: fromCognitoIdentity(...), awsRegion: 'REGION' });
+```
+
+6. To mount the SceneViewer component, use the following sample code. 
+
+```tsx
+import { initialize, TwinMakerQuery } from '@iot-app-kit/source-iottwinmaker';
+import { SceneViewer } from '@iot-app-kit/scene-composer';
+
+const { query, s3SceneLoader } = initialize( ... );
+// Replace scene-id with the ID of your AWS IoT TwinMaker scene in the workspace.
+const sceneLoader = s3SceneLoader('scene-id');
+const queries: TwinMakerQuery[] = [
+  {
+    // Replace entity-id with the ID of your AWS IoT TwinMaker entity in the workspace.
+    entityId: 'entity-id',
+    // Replace component-name with the name of the component for your entity.
+    componentName: 'component-name',
+    // Replace property-name with the name of the property for your component.
+    properties: [{ propertyName: 'property-name' }],
+  },
+  {
+    // Replace component-type-id with the ID of your concrete AWS IoT TwinMaker component type in the workspace.
+    componentTypeId: 'component-type-id',
+    // Replace property-name with the name of the property for your component type.
+    properties: [{ propertyName: 'property-name' }],
+  },
+];
+const viewport = {
+  // Replace start-time with the start time to query data from your workspace.
+  start: new Date('start-time'),
+  // Replace end-time with the end time to query data from your workspace.
+  end: new Date('end-time'),
+};
+
+// React component example
+<SceneViewer 
+  sceneLoader={sceneLoader}
+  queries={queries}
+  viewport={viewport}
+/>
+```
+
+7. To mount the VideoPlayer component, use the following sample code. 
+```tsx
+import { initialize } from '@iot-app-kit/source-iottwinmaker';
+import { VideoPlayer } from '@iot-app-kit/react-components';
+
+const videoData = initialize( ... ).videoData({
+  // Replace entity-id with your AWS IoT TwinMaker entity that has KinesisVideoStream component
+  entityId: 'entity-id',
+  // Replace component-name with the name of the component for your entity that has KinesisVideoStreamName property
+  componentName: 'component-name',
+});
+// or
+const videoData = initialize( ... ).videoData({
+  // Replace kvs-stream-name with your KinesisVideo stream name
+  kvsStreamName: 'kvs-stream-name',
+});
+
+// Video player for On-Demand playback mode with specified start and end time
+<VideoPlayer
+  videoData={videoData}
+  // Replace start-time and end-time with the correct time to play the video.
+  viewport={{ start: new Date('start-time'), end: new Date('end-time') }}
+/>
+
+// Video player for Live playback mode
+<VideoPlayer
+  videoData={videoData}
+  viewport={{ duration: '0' }}
+/>
+```