Greengrass IPC post-release followup (#367)

* Shuffle greengrass IPC user guide location, update echo client and service model, add greengrass ipc component sample

Author: bretambrose

.gitignore

@@ -206,5 +206,4 @@ config.ts
 docs/
 
 # don't track sample package locks
-samples/node/*/package-lock.json
-samples/browser/*/package-lock.json
+samples/**/package-lock.json

README.md

@@ -22,6 +22,9 @@ to JS by the [awscrt](https://github.com/awslabs/aws-crt-nodejs) package.
 
 ## What's New
 
+The SDK now supports Greengrass IPC.  See the [Greengrass IPC User Guide](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/documents/GreengrassIPC.md)
+or the [API Documentation](https://aws.github.io/aws-iot-device-sdk-js-v2/node/modules/greengrasscoreipc.html) for more information.
+
 The SDK now supports MQTT5.  See the [MQTT5 User Guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md)
 or the API Documentation for [NodeJS](https://awslabs.github.io/aws-crt-nodejs/node/modules/mqtt5.html) or
 the [browser](https://awslabs.github.io/aws-crt-nodejs/browser/modules/mqtt5.html) for more information. There is also a [MQTT5 sample for NodeJS](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/samples/node/pub_sub_mqtt5) and a [MQTT5 sample for the browser](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/samples/browser/pub_sub_mqtt5).

docsrc/typedoc-node.json

@@ -1,6 +1,9 @@
 {
     "entryPoints": [
+        "../lib/eventstream_rpc.ts",
         "../lib/greengrass/discoveryclient.ts",
+        "../lib/greengrasscoreipc.ts",
+        "../lib/greengrasscoreipc/client.ts",
         "../lib/iotidentity/iotidentityclient.ts",
         "../lib/iotjobs/iotjobsclient.ts",
         "../lib/iotshadow/iotshadowclient.ts",

GreengrassIPC.md renamed to documents/GreengrassIPC.md

@@ -36,8 +36,8 @@ The Javascript Greengrass IPC implementation has several differences relative to
 * Single client - Other v2 IoT SDKs have both a v1 and v2 client, where the v1 client is low-level and more verbose (and complex) in usage, while the v2 client is streamlined and less prone to accidental misuse.  Javascript Greengrass IPC skips the v1 client and starts directly with the v2 client approach.
 
 ## Greengrass IPC Example
-For those who prefer to dive right in, you can start with our [Greengrass IPC example](./samples/node/gg_pic/index.ts).  
-The associated [README](./samples/node/gg_ipc/README.md) contains instructions for how to perform a local greengrass deployment of the sample
+For those who prefer to dive right in, you can start with our [Greengrass IPC example](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/samples/node/gg_ipc).  
+The associated [README](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/samples/node/gg_ipc/README.md) contains instructions for how to perform a local greengrass deployment of the sample
 as a component.
 
 ## Greengrass IPC Client

lib/echotestrpc/client.ts

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0.
  */
 
+/* This file is generated */
+
 
 /**
  * @packageDocumentation

lib/echotestrpc/model.ts

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0.
  */
 
+/* This file is generated */
+
 
 /**
  * @packageDocumentation

lib/echotestrpc/model_utils.ts

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0.
  */
 
+/* This file is generated */
+
 import * as eventstream_rpc_utils from "../eventstream_rpc_utils";
 import * as model from "./model";
 import {eventstream} from "aws-crt";

lib/eventstream_rpc.ts

@@ -168,6 +168,7 @@ export class RpcError extends Error {
     /** Optional service-specific modelled error data */
     readonly serviceError?: any;
 
+    /** @internal */
     constructor(model: RpcErrorModel) {
         super(model.description);
 

samples/node/gg_ipc/README.md

@@ -0,0 +1,33 @@
+# Node: Greengrass IPC
+
+[**Return to main sample list**](../../README.md)
+
+This sample uses the AWS IoT [Greengrass IPC Client](https://aws.github.io/aws-iot-device-sdk-js-v2/node/modules/greengrasscoreipc) to defined a Greengrass component that subscribes to MQTT messages
+on a topic in AWS IoT Core and periodically publishes messages to that topic.
+
+Note: For this sample to work, you must have configured and installed the AWS Greengrass software on the local host.  The IAM role
+assumed by the Greengrass Nucleus must also include permissions to connect, subscribe, and publish to AWS IoT Core.
+
+## Deploying the Component
+
+First, go to the `./artifacts/com.amazon.RpcTest/1.0.0` folder and run the following command:
+
+``` sh
+npm install
+```
+
+Then, from this folder, run the following Greengrass CLI command:
+
+Linux:
+``` sh
+sudo <path-to-greengrass-cli-executable> deployment create --recipeDir ./recipes --artifactDir ./artifacts --merge "com.amazon.RpcTest=1.0.0"
+```
+
+Windows:
+``` sh
+<path-to-greengrass-cli-executable> deployment create --recipeDir ./recipes --artifactDir ./artifacts --merge "com.amazon.RpcTest=1.0.0"
+```
+
+Check your nucleus logs and component log for details about the success of the deployment and component execution.  See 
+the [AWS Greengrass Documentation](https://docs.aws.amazon.com/greengrass/v2/developerguide) for more
+details about Greengrass components, Greengrass IPC, and the Greengrass CLI.

samples/node/gg_ipc/artifacts/com.amazon.RpcTest/1.0.0/index.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+import {eventstream_rpc, greengrasscoreipc} from 'aws-iot-device-sdk-v2';
+import {once} from "events";
+import {toUtf8} from "@aws-sdk/util-utf8-browser";
+
+type Args = { [index: string]: any };
+
+const yargs = require('yargs');
+
+yargs.command('*', false, (yargs: any) => {
+}, main).parse();
+
+async function main(argv: Args) {
+    try {
+        let client : greengrasscoreipc.Client = greengrasscoreipc.createClient();
+
+        await client.connect();
+
+        await client.subscribeToIoTCore({
+            topicName: "hello/world",
+            qos: greengrasscoreipc.model.QOS.AT_LEAST_ONCE
+        }).on("message", (message: greengrasscoreipc.model.IoTCoreMessage) => {
+            if (message.message) {
+                console.log(`Message received on topic '${message.message.topicName}': '${toUtf8(new Uint8Array(message.message.payload as ArrayBuffer))}'`);
+            }
+        }).activate();
+
+        setInterval(async () => {
+            await client.publishToIoTCore({
+                topicName: "hello/world",
+                payload: "Hello from a component!",
+                qos : greengrasscoreipc.model.QOS.AT_LEAST_ONCE
+            });
+        }, 10000);
+
+        await once(client, greengrasscoreipc.Client.DISCONNECTION);
+
+        await client.close();
+    } catch (err) {
+        console.log("Aw shucks: " + (err as eventstream_rpc.RpcError) .toString());
+    }
+}