Merge pull request #125 from EOSIO/develop

Release 4.0.0

.gitignore

@@ -12,5 +12,6 @@ examples/**/package-lock.json
 
 # Editor files
 .idea/
+.vscode/
 
 dist/

.npmignore

@@ -1,14 +1,19 @@
-src
-tsconfig.json
-tslint.json
 dist/**/*.test.*
-examples/
+dist/testHelpers/
 docs/
+examples/
+scripts/
+src/
+.eslintrc.json
+.gitignore
 .idea
-yarn-error.log
+.npmignore
+.npmrc.template
+.nvmrc
 .travis.yml
-.eslintrc.json
+CONTRIBUTING.md
 README.md
-build-docs.sh
-scripts/*
-.npmrc.template
+tsconfig.json
+tslint.json
+yarn.lock
+yarn-error.log

.nvmrc

@@ -1 +1 @@
-8.9.4
+10.15.1

.travis.yml

@@ -1,29 +1,42 @@
 sudo: false
 language: node_js
 node_js:
-  - '10.0.0'
+- '11.6.0'
 before_install:
-  - npm i -g [email protected]
-  - npm install -g typescript
+- npm i -g [email protected]
+- npm install -g typescript
 stages:
-  - test
-  - name: deploy
-    if: (NOT type IN (pull_request)) AND (branch = develop)
+- test
+- name: publish-edge
+  if: (NOT type IN (pull_request)) AND (branch = develop)
+- name: publish-latest
+  # Travis assigns the tag to branch for some reason. This matches any valid semver version.
+  if: branch =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$
 jobs:
   include:
-    - stage: test
-      name: "Lint and Test"
-      script:
-        - npm run lint
-        - npm run test
-    - stage: deploy    
-      name: "Deploy to NPM"
-      script:
-        - npm run build
-      deploy:
-        provider: script
-        skip_cleanup: true
-        script: 
-          - ./scripts/publish.sh
-        on:
-          branch: develop
+  - stage: test
+    name: "Lint and Test"
+    script:
+    - npm run lint
+    - npm run test
+  - stage: publish-edge
+    name: "Publish @edge to NPM"
+    script:
+    - npm run build
+    deploy:
+      provider: script
+      skip_cleanup: true
+      script: ./scripts/publish-edge.sh
+      on:
+        branch: develop
+  - stage: publish-latest
+    name: "Publish @latest to NPM"
+    script:
+    - npm run build
+    deploy:
+      provider: script
+      skip_cleanup: true
+      script: ./scripts/publish-latest.sh
+      on:
+        all_branches: true
+        condition: $TRAVIS_TAG =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$

README.md

@@ -83,6 +83,8 @@ This library provides the following classes:
 
 * [**`BaseActionWatcher`**](https://eosio.github.io/demux-js/classes/baseactionwatcher.html): Base class that implements a ready-to-use Action Watcher
 
+* [**`ExpressActionWatcher`**](https://eosio.github.io/demux-js/classes/expressactionwatcher.html): Exposes the API methods from the BaseActionWatcher through an Express server
+
 In order to process actions, we need the following things:
 
 - An implementation of an `AbstractActionReader`
@@ -91,10 +93,47 @@ In order to process actions, we need the following things:
 
 After we have these things, we need to:
 
-- Instantiate the implemented `AbstractActionHandler`, passing in the `HandlerVersion` and any other needed configuration
 - Instantiate the implemented `AbstractActionReader` with any needed configuration
-- Instantiate a `BaseActionWatcher`, passing in the above Handler and Reader instances
-- Call `watch()` on the Watcher
+- Instantiate the implemented `AbstractActionHandler`, passing in the `HandlerVersion` and any other needed configuration
+- Instantiate the `BaseActionWatcher` (or a subclass), passing in the Action Handler and Action Watcher instances
+- Start indexing via the Action Watcher's `watch()` method (by either calling it directly or otherwise)
+
+
+#### Example
+
+```javascript
+const { BaseActionWatcher, ExpressActionWatcher } = require("demux")
+const { MyActionReader } = require("./MyActionReader")
+const { MyActionHandler } = require("./MyActionHandler")
+const { handlerVersions } = require("./handlerVersions")
+const { readerConfig, handlerConfig, pollInterval, portNumber } = require("./config")
+
+const actionReader = new MyActionReader(readerConfig)
+const actioHandler = new MyActionHandler(handlerVersions, handlerConfig)
+```
+Then, either
+```javascript
+const watcher = new BaseActionWatcher(
+  actionReader,
+  actionHandler,
+  pollInterval,
+)
+
+watcher.watch()
+```
+Or,
+```javascript
+const expressWatcher = new ExpressActionWatcher(
+  actionReader,
+  actionHandler,
+  pollInterval,
+  portNumber,
+)
+
+expressWatcher.listen()
+
+// You can then make a POST request to `/start` on your configured endpoint
+```
 
 ### [**API documentation**](https://eosio.github.io/demux-js/)