refocus on NLP + deprecate converse

Author: Willy Blandin

.gitignore

@@ -1,2 +1,3 @@
-dist
+/dist
 node_modules
+.DS_Store

CHANGES.md

@@ -1,3 +1,7 @@
+## v4.3.0
+- `converse` and `runActions` are deprecated
+- `interactive` now calls `message`
+
 ## v4.2.0
 
 - support actions that do not return promises

README.md

@@ -31,36 +31,16 @@ See `examples/messenger.js` for a thoroughly documented tutorial.
 
 The Wit module provides a Wit class with the following methods:
 * `message` - the Wit [message](https://wit.ai/docs/http/20160330#get-intent-via-text-link) API
-* `converse` - the low-level Wit [converse](https://wit.ai/docs/http/20160330#converse-link) API
-* `runActions` - a higher-level method to the Wit converse API
 
 You can also require a library function to test out your bot in the terminal. `require('node-wit').interactive`
 
 ### Wit class
 
 The Wit constructor takes the following parameters:
 * `accessToken` - the access token of your Wit instance
-* `actions` - (optional if only using `.message()`) the object with your actions
 * `logger` - (optional) the object handling the logging.
 * `apiVersion` - (optional) the API version to use instead of the recommended one
 
-The `actions` object has action names as properties, and action functions as values.
-Action implementations must return Promises (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-You must provide at least an implementation for the special action `send`.
-
-* `send` takes 2 parameters: `request` and `response`
-* custom actions take 1 parameter: `request`
-
-#### Request
-* `sessionId` (string) - a unique identifier describing the user session
-* `context` (object) - the object representing the session state
-* `text` (string) - the text message sent by your end-user
-* `entities` (object) - the entities extracted by Wit's NLU
-
-#### Response
-* `text` (string) - The text your bot needs to send to the user (as described in your Wit.ai Stories)
-* `quickreplies`
-
 The `logger` object should implement the methods `debug`, `info`, `warn` and `error`.
 They can receive an arbitrary number of parameters to log.
 For convenience, we provide a `Logger` class, taking a log level parameter
@@ -71,25 +51,13 @@ const {Wit, log} = require('node-wit');
 
 const client = new Wit({
   accessToken: MY_TOKEN,
-  actions: {
-    send(request, response) {
-      return new Promise(function(resolve, reject) {
-        console.log(JSON.stringify(response));
-        return resolve();
-      });
-    },
-    myAction({sessionId, context, text, entities}) {
-      console.log(`Session ${sessionId} received ${text}`);
-      console.log(`The current context is ${JSON.stringify(context)}`);
-      console.log(`Wit extracted ${JSON.stringify(entities)}`);
-      return Promise.resolve(context);
-    }
-  },
   logger: new log.Logger(log.DEBUG) // optional
 });
+
+console.log(client.message('set an alarm tomorrow at 7am'));
 ```
 
-### message
+### .message()
 
 The Wit [message](https://wit.ai/docs/http/20160330#get-intent-via-text-link) API.
 
@@ -107,7 +75,21 @@ client.message('what is the weather in London?', {})
 .catch(console.error);
 ```
 
-### runActions
+### interactive
+
+Starts an interactive conversation with your bot.
+
+Example:
+```js
+const {interactive} = require('node-wit');
+interactive(client);
+```
+
+See the [docs](https://wit.ai/docs) for more information.
+
+### .runActions()
+
+**DEPRECATED** See [our blog post](https://wit.ai/blog/2017/07/27/sunsetting-stories) for a migration plan.
 
 A higher-level method to the Wit converse API.
 `runActions` resets the last turn on new messages and errors.
@@ -138,7 +120,9 @@ client.runActions(sessionId, 'what is the weather in London?', context0)
 
 See `./examples/messenger.js` for a full-fledged example
 
-### converse
+### .converse()
+
+**DEPRECATED** See [our blog post](https://wit.ai/blog/2017/07/27/sunsetting-stories) for a migration plan.
 
 The low-level Wit [converse](https://wit.ai/docs/http/20160330#converse-link) API.
 
@@ -157,19 +141,6 @@ client.converse('my-user-session-42', 'what is the weather in London?', {})
 .catch(console.error);
 ```
 
-### interactive
-
-Starts an interactive conversation with your bot.
-
-Example:
-```js
-const {interactive} = require('node-wit');
-interactive(client);
-```
-
-See the [docs](https://wit.ai/docs) for more information.
-
-
 ## Changing the API version
 
 On 2016, May 11th, the /message API was updated to reflect the new Bot Engine model: intent are now entities.

lib/interactive.js

@@ -3,13 +3,8 @@
 const {DEFAULT_MAX_STEPS} = require('./config');
 const logger = require('./log.js');
 const readline = require('readline');
-const uuid = require('uuid');
 
-module.exports = (wit, initContext, maxSteps) => {
-  let context = typeof initContext === 'object' ? initContext : {};
-  const sessionId = uuid.v1();
-
-  const steps = maxSteps ? maxSteps : DEFAULT_MAX_STEPS;
+module.exports = (wit, context) => {
   const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout,
@@ -25,9 +20,9 @@ module.exports = (wit, initContext, maxSteps) => {
     if (!line) {
       return prompt();
     }
-    wit.runActions(sessionId, line, context, steps)
-    .then((ctx) => {
-      context = ctx;
+    wit.message(line, context)
+    .then((rsp) => {
+      console.log(JSON.stringify(rsp));
       prompt();
     })
     .catch(err => console.error(err))

lib/wit.js

@@ -208,6 +208,7 @@ const validate = (opts) => {
   };
   opts.logger = opts.logger || new log.Logger(log.INFO);
   if (opts.actions) {
+    opts.logger.warn('Stories and POST /converse have been deprecated. This will break in February 2018!');
     opts.actions = validateActions(opts.logger, opts.actions);
   }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-wit",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Wit.ai Node.js SDK",
   "keywords": [
     "wit",
@@ -13,7 +13,7 @@
   ],
   "main": "index.js",
   "scripts": {
-    "test": "mocha ./tests/lib.js"
+    "test": "mocha --timeout 10000 ./tests/lib.js"
   },
   "repository": "https://github.com/wit-ai/node-wit",
   "author": "The Wit Team <[email protected]>",