doc fix an npm build fix

Author: stevendavelaar

.npmignore

@@ -10,7 +10,7 @@ examples
 docs
 docshim.js
 jsdoc.json
-ts
+/ts
 tslint.json
 THIRDPARTY.md
 CONTRIBUTING.md

CUSTOM_COMPONENT.md

@@ -48,11 +48,11 @@ module.exports = {
   }
 }
 ```
-The old style of defining the `invoke` function using the `done` callback argument is still supported:
+The old style of defining the `invoke` function using the `done` callback argument is still supported (with `conversation` as the old name for the `context` argument):
 
 ```javascript
-  invoke: (context, done) => {
-    context.reply('hello world');
+  invoke: (conversation, done) => {
+    conversation.reply('hello world');
     done();
   }
 }
@@ -64,7 +64,7 @@ In addition, you no longer have to remember to call `done()` at every place in y
 
 When using typescript, the custom component class should implement the `CustomComponent` interface which requires two methods to be present: 
 - the `metadata` method that should return an object of type `CustomComponentMetadata`.
-- the `invoke` method that should accept two arguments, the context of type `CustomComponentContext` and a callback of type `InvocationCallback`.
+- the `invoke` method that should accept one argument, the context of type `CustomComponentContext`.
 
 ```typescript
 import {CustomComponent,  CustomComponentMetadata, CustomComponentContext, InvocationCallback }  from '@oracle/bots-node-sdk/lib';
@@ -79,7 +79,7 @@ export class HelloWorld implements CustomComponent {
     }
   }
 
-  public async invoke(conversation: CustomComponentContext): Promise<void> {
+  public async invoke(context: CustomComponentContext): Promise<void> {
     context.reply('hello world');
   }
 }

ENTITY_EVENT_HANDLER.md

@@ -21,7 +21,7 @@
 
 An entity event handler (EEH) works in concert with a `System.ResolveEntities` (RE) or `System.CommonResponse` (CRC) component that is defined in the YAML dialog flow to resolve a composite bag entity. An EEH is deployed in a custom component service, in the same way as a custom component, but does not have its own state in the YAML. The RE or CRC component identifies a series of events which you can write event handlers for in an EEH component. Whenever such an event occurs, the RE or CRC component will check whether an EEH is registered with the composite bag entity, and whether the EEH has a handler defined for this specific event. If this is the case, the RE or CRC component will invoke the event handler method in the EEH.
 
-This event-driven approach makes it much easier for a developer to execute the right code at the right moment while resolving the composite bag entity. Furthermore, it provides full control over the bot messages that are sent to the user, any "candidate" message generated by CRC or RE can always be replaced by writing a corresponding event handler.
+This event-driven approach makes it much easier for you to execute the right code at the right moment while resolving the composite bag entity. Furthermore, it provides full control over the bot messages that are sent to the user, any "candidate" message generated by CRC or RE can always be replaced by writing a corresponding event handler.
 
 While freemarker expressions can still be used in the various fields of a composite bag item, you can choose to avoid writing any freemarker expressions by including the appropriate handlers in his EEH using Javascript.
 
@@ -103,9 +103,9 @@ export class MyEntityEventHandler implements EntityEventHandler {
 ## Writing Event Handler Functions  <a name="writing">
 
 The first argument of each event method is the `event` object. The properties available in this object depend on the type of event.
-See the list of supported entity events for information pn which properties are available with which event.
+See the list of supported entity events for information on which properties are available with which event.
 
-The second argument each event method  is the `context` object. This object references the [EntityResolutionContext](https://oracle.github.io/bots-node-sdk/EntityResolutionContext.html) that provides access to many convenience methods to create your event handler logic.
+The second argument of each event method  is the `context` object. This object references the [EntityResolutionContext](https://oracle.github.io/bots-node-sdk/EntityResolutionContext.html) that provides access to many convenience methods to create your event handler logic.
 
 More information on creating conversation messages from an event handler can be found [here](https://github.com/oracle/bots-node-sdk/blob/master/MESSAGE_MODEL.md).
 
@@ -128,7 +128,7 @@ The table below lists all entity level events currently supported:
 
 | Event | Description | Event Properties |
 |--|--|--|
-| validate | Handler for entity-level validations that include two or more bag item values. Validation errors can be registered by calling context.addValidationError(itemName,errorMessage). If validation should fail, this handler should return false. if validation fails, NONE of the item values provided by the user in the last user message will be updated.<br/><br/>NOTE: This handler is called when at least one bag item value has changed. | <ul><li><b>newValues</b>: JSONObject with key-value pairs where key is the item name and value the new item value.</li><li><b>oldValues</b>: JSONObject with key-value pairs where key is the item name and value the old item value.</li><li><b>currentItem</b>: name of item currently being resolved.</li></ul>
+| validate | Handler for entity-level validations that include two or more bag item values. Validation errors can be registered by calling `context.addValidationError(itemName,errorMessage)`. If validation should fail, this handler should return false. if validation fails, NONE of the item values provided by the user in the last user message will be updated.<br/><br/>NOTE: This handler is called when at least one bag item value has changed. | <ul><li><b>newValues</b>: JSONObject with key-value pairs where key is the item name and value the new item value.</li><li><b>oldValues</b>: JSONObject with key-value pairs where key is the item name and value the old item value.</li><li><b>currentItem</b>: name of item currently being resolved.</li></ul>
 | publishMessage | Generic fallback handler that is called when item-specific prompt or disambiguate handler is not specified. | <ul><li><b>currentItem</b>: name of item currently being resolved.</li><li><b>promptCount</b>: number of times the user is prompted for current item (only set in case of prompt event).</li><li><b>disambiguationValues</b>: list of values that matches the user input (only set in case of disambiguate event).</li></ul>
 | maxPromptsReached | Generic fallback handler when item-specific handler for reaching max prompts is not specified. | <ul><li><b>currentItem</b>: name of item currently being resolved.</li><li><b>promptCount</b>: number of times the user is prompted for current item (only set in case of prompt event).</li></ul>
 | resolved | Function that gets called when the composite bag entity is resolved. You will typically use this function to call some backend API to complete the transaction which the composite bag entity collected the data for. If the backend API call return some errors, possibly forcing you to re-prompt for some invalid bag items, you can do so by simply clearing those bag items. The RE/CRC component will notice the entity is not fully resolved after all, and will resume prompting for missing bag items. | none
@@ -148,7 +148,7 @@ The table below lists all entity-item level events currently supported:
 
 ## Code Samples <a name="samples">
 
-The samples below use an Expense composite bag entity, which has the following items:
+The samples below use an `Expense` composite bag entity, which has the following items:
 
 | Name | Type | Entity Name |
 |--|--|--|
@@ -158,7 +158,7 @@ The samples below use an Expense composite bag entity, which has the following i
 | Type | Entity | ExpenseType
 
 ### How to conditionally prompt for an item <a name="prompt">
-We only want to prompt for a receipt when the expense amount is greater than 25 dollars. This can be achieved by adding the shouldPrompt event handler for an item
+We only want to prompt for a receipt when the expense amount is greater than 25 dollars. This can be achieved by adding the `shouldPrompt` event handler for an item
 
 ```javascript
 items: {
@@ -169,7 +169,7 @@ items: {
   }
 ```
   
-Note here that the Amount item returns a CURRENCY JSON object, and amount property inside this object holds the amount value.
+Note here that the `Amount` item returns a `CURRENCY` JSON object, and `amount` property inside this object holds the amount value.
 
 ### How to validate an item <a name="validate">
 Here is the event handler to enforce the expense amount is at least 5:
@@ -186,7 +186,7 @@ items: {
   }
 ```
 
-Note how we obtain the new value from the validation event object. And since the Amount item value is a CURRENCY JSON object, we need to obtain the amount property from it.  We use the `addValidationError` function to register the error message . We could also have used `conversation.reply()` directly. The difference is that when using `conversation.reply()` further processing in the RE/CRC component is stopped, so other items that just got a value are not validated.
+Note how we obtain the new value from the validation event object. And since the `Amount` item value is a CURRENCY JSON object, we need to obtain the `amount` property from it.  We use the `addValidationError` function to register the error message . We could also have used `conversation.reply()` directly. The difference is that when using `conversation.reply()` further processing in the RE/CRC component is stopped, so other items that just got a value are not validated.
 
 To read the validation error message from the skill resource bundle, instead of hardcoding the text, the translate function can be used:
 

README.md

@@ -31,7 +31,7 @@ This section explains the basic CLI commands to get your component service up an
 bots-node-sdk init MyComponentService
 ```
 
-This creates a new commponent service named `MyComponentService` in a directory by the same name.
+This creates a new component service named `MyComponentService` in a directory by the same name.
 The component service includes one sample custom component named `helloWorld`.
 
 ### Adding a Custom Component to Existing Service
@@ -103,12 +103,12 @@ See the README.md created in your scaffolded typescript project for more informa
 <!--[nodoc]-->
 - [Using the CLI](https://github.com/oracle/bots-node-sdk/blob/master/bin/CLI.md) - Command line capabilities to facilitate writing custom components and entity event handlers.
 - [Writing Custom Components](https://github.com/oracle/bots-node-sdk/blob/master/CUSTOM_COMPONENT.md) - Guidelines and tips for writing custom components.
-- [Writing Entity Event Handlers](https://github.com/oracle/bots-node-sdk/blob/master/ENTIY_EVENT_HANDLER.md) - Guidelines and tips for writing entity event handlers.
-- [Conversation Messaging](https://github.com/oracle/bots-node-sdk/blob/master/MESSAGE_MODEL.md) - Creating conversation messages from custom code
+- [Writing Entity Event Handlers](https://github.com/oracle/bots-node-sdk/blob/master/ENTITY_EVENT_HANDLER.md) - Guidelines and tips for writing entity event handlers.
+- [Conversation Messaging](https://github.com/oracle/bots-node-sdk/blob/master/MESSAGE_MODEL.md) - Creating conversation messages from custom code.
 - [Writing Webhooks](https://github.com/oracle/bots-node-sdk/blob/master/WEBHOOK.md) - Integrate with custom messaging channels using incoming/outgoing webhook.
 - [Unit Testing](https://github.com/oracle/bots-node-sdk/blob/master/testing/TESTING.md) - Unit testing facilities.
 - [Documentation](https://oracle.github.io/bots-node-sdk) - Full SDK documentation.
-- [Release Notes](https://github.com/oracle/bots-node-sdk/blob/master/RELEASE_NOTES.md) - List of new features and fixed issues for each release
+- [Release Notes](https://github.com/oracle/bots-node-sdk/blob/master/RELEASE_NOTES.md) - List of new features and fixed issues for each release.
 <!--[/nodoc]-->
 
 ## Contributing

bin/CLI.md

@@ -1,7 +1,6 @@
 # CLI Developer Tools
 
-This SDK includes a CLI with developer-oriented productivity tools.
-Presently these tools are geared towards **Custom Component** development.
+This SDK includes a command-line intertace (CLI) to help you creating and packaging custom components and entity event handlers.
 
 ```text
 Usage: bots-node-sdk [options] <subcommand> [options]
@@ -36,9 +35,9 @@ bots-node-sdk init
 bots-node-sdk init my-project
 ```
 
-> Creates a fresh Custom Component package in an empty directory
+> Creates a fresh custom component service package in an empty directory
 
-As an alterative approach, install `@oracle/bots-node-sdk` as a dependency
+As an alternative approach, install `@oracle/bots-node-sdk` as a dependency
 dependency to your application, and use commands accordingly.
 
 ```shell
@@ -50,16 +49,16 @@ npm install --save-dev @oracle/bots-node-sdk
 $(npm bin)/bots-node-sdk init
 ```
 
-> Initializes a new Custom Component package from within an existing node project.
+> Initializes a new custom component service package from within an existing node project.
 
 ## Usage
 
 | Command | Feature | Description |
 |--|--|--|
-| `init` | Components | Generates source code for Custom Component projects |
+| `init` | Components | Generates source code for custom component service projects |
 | `init component` | Components | Adds a component to an existing project |
-| `service` | Components | Starts a local server for hosting a Component Package |
-| `pack` | Components | Validates project and creates a deployable Component Package artifact |
+| `service` | Components | Starts a local server for hosting a component package |
+| `pack` | Components | Validates project and creates a deployable component package |
 
 ### 1. Start a project: `init [options] [dest]`
 
@@ -78,7 +77,7 @@ projects with more components. If provided, `[dest]` or `--name` will be used fo
 ### 2. Add Components: `init component <name> <type> <dest>`
 
 This command will create a _new_ custom component or event handler within an **existing** component
-package, and write to the `<dest>` output path. If the output path is not specified, the component will be written to the `components` directory or `src\components` directory when using typesript. If this directory doesn't exist it will be created.
+package, and write to the `<dest>` output path. If the output path is not specified, the component will be written to the `components` directory or `src\components` directory when using typescript. If this directory doesn't exist it will be created.
 The component `<name>` and `<type>` are required and `<type>` should be set to `[c]ustom` or `[e]ntityEventHandler`.
 
 For example, to create a new entity event handler component named `resolvePizza`, you can use the following command:
@@ -104,9 +103,7 @@ A node supervisor may also be used in the same way.
 
 ### 4. Package for Deployment: `pack [options]`
 
-Most often, custom implementations can be packaged with `npm pack` or `zip`
-depending on the deployment target. The `pack` command here is intended to
-provide validation and convenience methods for creating a deployable artifact.
+The `npm pack` command can be used to package the component service as a `.tgz` file that can be uploaded to the ODA embedded container.
 
 | Option | Description | Default |
 |--|--|--|