Release of Version 1.4.0

README.md

@@ -0,0 +1,173 @@
+<div id="content">
+
+<div id="filecontents">
+
+# AWS Greengrass Core SDK for JavaScript
+
+The **AWS Greengrass Core SDK for JavaScript** allows developers to write JavaScript Lambda functions which will run within Greengrass.
+
+## Overview
+
+This document provides instructions for preparing your Greengrass Core environment to run Lambda functions written in JavaScript. It also includes examples on how to develop a Lambda function in JavaScript as well as packaging and running an example Hello World file in JavaScript for your Greengrass core.
+
+## Preparing your Greengrass to run NodeJS Lambda functions
+
+The environment where Greengrass is running on needs to be able to run NodeJS 8.10 applications.
+
+*   Install NodeJS 8.10 for your platform. You can download the newest NodeJS from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
+*   When you untar the package downloaded from NodeJS website, you will find `node` file under `bin` directory.
+*   Copy the file to _**/usr/bin**_ or _**/usr/local/bin**_ folder.
+*   Rename the file to _**nodejs8.10**_
+*   Make sure the file is not a symlink.
+
+## Getting Started - Hello World
+
+*   Copy `samples/HelloWorld` folder to your workspace.
+*   Create a folder `node_modules` under `HelloWorld` folder.
+*   Unzip aws-greengrass-core-sdk-js.zip into the folder. It should create a folder HelloWorld/node_modules/aws-greengrass-core-sdk
+*   Zip up the content of HelloWorld folder so that the index.js is on the top of the zip file structure.
+*   Go to AWS Lambda Console.
+*   Create a new function.
+*   Choose the Runtime as `Node.js 8.10`
+*   Upload the zip file in _Lambda function code_ section.
+*   Handler is _index.handler_
+*   Choose any role as the role is not used within Greengrass.
+*   After creating the function, publish the Lambda.
+*   Create an Alias and point to the Published version (not $LATEST).
+*   Go to your Greengrass Group and add the Lambda under Lambdas section.
+*   Click on the Lambda and change the _Lambda lifecycle_ to _Make this function long-lived and keep it running indefinitely._
+*   Add a Subscription with the following configuration:
+    *   Source: Lambda which you just created and added to the group
+    *   Target: IoT Cloud
+    *   Topic: hello/world
+*   Deploy. A message from your Lambda should be published to the topic _hello/world_ in the cloud every 5 seconds. You can check this by going to AWS IoT's _Test_ page and subscribing to topic _hello/world_.
+
+## Including aws-greengrass-core-sdk with your function
+
+Unzip the SDK into your node_modules folder of your function. This should create a aws-greengrass-core-sdk folder which includes the SDK.
+
+## Logging in NodeJS Lambdas
+
+Your _console.log_ operation will be logged as INFO. A _console.error_ operation will be logged as ERROR. Currently, our NodeJS SDK only allows you to log at INFO or ERROR level only.
+
+## Supported Datatypes
+
+From GGC version 1.5, you can send both JSON and binary data as a payload when you invoking other Lambdas or publishing a message using IotData service. In order to make your lambda be able to handle binary payload, you need to configure the lambda in Greengrass console to mark it using binary input payload so that GGC can know how to deal with the data.
+
+## Supported Context
+
+In Greengrass, you can send a context object in a JSON format to be passed to another Lambda that is being invoked. The context format looks like this: `{ custom: { customData: 'customData', }, }`
+
+## Compatibility
+
+</div>
+
+<div class="section" id="compatibility">
+
+## Compatibility[¶](#compatibility "Permalink to this headline")
+
+As new features are added to AWS Greengrass, previous versions of the Greengrass SDK will be incompatible with newer versions of the AWS Greengrass core. The following table lists the compatible SDKs for all GGC releases.
+
+
+<table style="width:50%">
+
+<tbody>
+
+<tr>
+
+<th>GGC Version</th>
+
+<th>Compatible SDK Versions</th>
+
+</tr>
+
+<tr>
+
+<td>1.0.x-1.6.x</td>
+
+<td>1.0.x-1.2.x</td>
+
+</tr>
+
+<tr>
+
+<td>1.7.x-1.8.x</td>
+
+<td>1.0.x-1.3.x</td>
+
+</tr>
+
+<tr>
+
+<td>1.9.x</td>
+
+<td>1.0.x-1.4.x</td>
+
+</tr>
+
+</tbody>
+
+</table>
+
+</div>
+
+<div class="Section" id="1.4.0updates">
+
+## 1.4.0 Updates[¶](#1.4.0updates "Permalink to this headline")
+
+Added support for Node.js 8.10 Lambda runtime. Lambda functions that use Node.js 8.10 runtime can now run on an AWS IoT Greengrass core. (Existing Lambda functions that use Node.js 6.10 runtime can still run on Greengrass core, but they can’t be updated after 5/30/2019\. Please refer to [AWS Lambda Runtimes Support Policy](https://docs.aws.amazon.com/lambda/latest/dg/runtime-support-policy.html).)
+
+</div>
+
+<div class="Section" id="1.3.1updates">
+
+## 1.3.1 Updates[¶](#1.3.1updates "Permalink to this headline")
+
+Improved log level granularity.
+
+</div>
+
+<div class="Section" id="1.3.0updates">
+
+## 1.3.0 Updates[¶](#1.3.0updates "Permalink to this headline")
+
+SDK supports SecretsManager client.
+
+</div>
+
+<div class="Section" id="1.2.0updates">
+
+## 1.2.0 Updates[¶](#1.2.0updates "Permalink to this headline")
+
+SDK and GGC compatibility check takes place in the background.
+
+</div>
+
+<div class="Section" id="1.1.0updates">
+
+## 1.1.0 Updates[¶](#1.1.0updates "Permalink to this headline")
+
+Lambda only accepted payload in JSON format. With this update, Invoking or publishing binary payload to a lambda is supported.
+
+</div>
+
+<div class="Section" id="1.0.1updates">
+
+## 1.0.1 Updates[¶](#1.0.1updates "Permalink to this headline")
+
+SShadow operations were not receiving responses from the local shadow properly. This has been fixed.
+
+Lambda Invoke function's InvocationType's default value was Event. This has been changed to RequestResponse.
+
+</div>
+
+## Getting Help
+
+*   [Ask on a Greengrass forum](https://forums.aws.amazon.com/forum.jspa?forumID=254)
+
+## License
+
+Apache 2.0</div>
+
+</div>
+

aws-greengrass-core-sdk/index.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ */
+exports.GreengrassInterfaceVersion = '1.3';
+exports.Lambda = require('./lambda');
+exports.IotData = require('./iotdata');
+exports.SecretsManager = require('./secretsmanager');

aws-greengrass-core-sdk/iotdata.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ */
+
+const Buffer = require('buffer').Buffer;
+
+const Lambda = require('./lambda');
+const Util = require('./util');
+const GreengrassCommon = require('aws-greengrass-common-js');
+
+const envVars = GreengrassCommon.envVars;
+const MY_FUNCTION_ARN = envVars.MY_FUNCTION_ARN;
+const SHADOW_FUNCTION_ARN = envVars.SHADOW_FUNCTION_ARN;
+const ROUTER_FUNCTION_ARN = envVars.ROUTER_FUNCTION_ARN;
+
+class IotData {
+    constructor() {
+        this.lambda = new Lambda();
+    }
+
+    getThingShadow(params, callback) {
+        /*
+         * Call shadow lambda to obtain current shadow state.
+         * @param {object} params object contains parameters for the call
+         * REQUIRED: 'thingName' the name of the thing
+         */
+        const thingName = Util.getRequiredParameter(params, 'thingName');
+        if (thingName === undefined) {
+            callback(new Error('"thingName" is a required parameter.'), null);
+            return;
+        }
+
+        const payload = '';
+        this._shadowOperation('get', thingName, payload, callback);
+    }
+
+    updateThingShadow(params, callback) {
+        /*
+         * Call shadow lambda to update current shadow state.
+         * @param {object} params object contains parameters for the call
+         * REQUIRED: 'thingName' the name of the thing
+         *           'payload'   the state information in JSON format
+         */
+        const thingName = Util.getRequiredParameter(params, 'thingName');
+        if (thingName === undefined) {
+            callback(new Error('"thingName" is a required parameter.'), null);
+            return;
+        }
+
+        const payload = Util.getRequiredParameter(params, 'payload');
+        if (payload === undefined) {
+            callback(new Error('"payload" is a required parameter.'), null);
+            return;
+        }
+
+        this._shadowOperation('update', thingName, payload, callback);
+    }
+
+    deleteThingShadow(params, callback) {
+        /*
+         * Call shadow lambda to delete the shadow state.
+         * @param {object} params object contains parameters for the call
+         * REQUIRED: 'thingName' the name of the thing
+         */
+        const thingName = Util.getRequiredParameter(params, 'thingName');
+        if (thingName === undefined) {
+            callback(new Error('"thingName" is a required parameter.'), null);
+            return;
+        }
+
+        const payload = '';
+        this._shadowOperation('delete', thingName, payload, callback);
+    }
+
+    publish(params, callback) {
+        /*
+         * Publishes state information.
+         * @param {object} params object contains parameters for the call
+         * REQUIRED: 'topic'   the topic name to be published
+         *           'payload' the state information in JSON format
+         */
+        const topic = Util.getRequiredParameter(params, 'topic');
+        if (topic === undefined) {
+            callback(new Error('"topic" is a required parameter'), null);
+            return;
+        }
+
+        const payload = Util.getRequiredParameter(params, 'payload');
+        if (payload === undefined) {
+            callback(new Error('"payload" is a required parameter'), null);
+            return;
+        }
+
+        const context = {
+            custom: {
+                source: MY_FUNCTION_ARN,
+                subject: topic,
+            },
+        };
+
+        const buff = Buffer.from(JSON.stringify(context));
+        const clientContext = buff.toString('base64');
+
+        const invokeParams = {
+            FunctionName: ROUTER_FUNCTION_ARN,
+            InvocationType: 'Event',
+            ClientContext: clientContext,
+            Payload: payload,
+        };
+
+        console.log(`Publishing message on topic "${topic}" with Payload "${payload}"`);
+
+        this.lambda.invoke(invokeParams, (err, data) => {
+            if (err) {
+                callback(err, null);            // an error occurred
+            } else {
+                callback(null, data);           // successful response
+            }
+        });
+    }
+
+    _shadowOperation(operation, thingName, payload, callback) {
+        const topic = `$aws/things/${thingName}/shadow/${operation}`;
+        const context = {
+            custom: {
+                subject: topic,
+            },
+        };
+
+        const clientContext = Buffer.from(JSON.stringify(context)).toString('base64');
+        const invokeParams = {
+            FunctionName: SHADOW_FUNCTION_ARN,
+            ClientContext: clientContext,
+            Payload: payload,
+        };
+
+        console.log(`Calling shadow service on topic "${topic}" with payload "${payload}"`);
+        this.lambda.invoke(invokeParams, (err, data) => {
+            if (err) {
+                callback(err, null);
+            } else {
+                callback(null, data);
+            }
+        });
+    }
+}
+
+module.exports = IotData;