Merge branch 'master' into task/ws-channel-unsubscription

Author: Grégory Saive

.travis.yml

@@ -8,4 +8,17 @@ cache:
     - "node_modules"
 before_script:
   - npm run build
-script: npm run test:coveralls
+script: 
+  - npm run test:coveralls
+before_deploy:
+  - npm install --global typedoc
+  - typedoc --out ts-docs src
+deploy:
+  provider: pages
+  skip_cleanup: true
+  keep-history: true
+  local_dir: ts-docs
+  github_token: $GITHUB_TOKEN
+  on:
+    branch: master
+  

README.md

@@ -16,6 +16,10 @@ with the NEM2 (a.k.a Catapult)
 - NodeJS 9.X.X
 - NodeJS 10.X.X
 
+## Installation
+
+```npm install nem2-sdk rxjs```
+
 ## Documentation and Getting Started
 
 Get started and learn more about nem2-sdk-typescript-javascript, check the [official documentation][docs].
@@ -47,4 +51,4 @@ Licensed under the [Apache License 2.0](LICENSE)
 [self]: https://github.com/nemtech/nem2-sdk-typescript-javascript
 [docs]: http://nemtech.github.io/getting-started/setup-workstation.html
 [issues]: https://github.com/nemtech/nem2-sdk-typescript-javascript/issues
-[sdk-ref]: http://nemtech.github.io/nem2-sdk-typescript-javascript
+[sdk-ref]: http://nemtech.github.io/nem2-sdk-typescript-javascript

src/infrastructure/Listener.ts

@@ -104,6 +104,7 @@ export class Listener {
                 this.webSocket.onerror = (err) => {
                     console.log('WebSocket Error ');
                     console.log(err);
+                    reject(err);
                 };
                 this.webSocket.onmessage = (msg) => {
                     const message = JSON.parse(msg.data as string);
@@ -155,6 +156,17 @@ export class Listener {
         });
     }
 
+  /**
+     * returns a boolean that repressents the open state
+     * @returns a boolean
+     */
+    public isOpen(): boolean {
+        if(this.webSocket){
+            return this.webSocket.readyState === WebSocket.OPEN;
+        }
+        return false;
+    }
+    
     /**
      * Close web socket connection.
      * @returns void

src/model/transaction/Transaction.ts

@@ -158,12 +158,12 @@ export abstract class Transaction {
     }
 
     /**
-     * @description re-aplly a given value to the transaction in an immutable way
+     * @description reapply a given value to the transaction in an immutable way
      * @param {Deadline} deadline
      * @returns {Transaction}
      * @memberof Transaction
      */
-    public replyGiven(deadline: Deadline = Deadline.create()): Transaction {
+    public reapplyGiven(deadline: Deadline = Deadline.create()): Transaction {
         if (this.isUnannounced()) {
             return Object.assign({__proto__: Object.getPrototypeOf(this)}, this, {deadline});
         }

test/infrastructure/Listener.spec.ts

@@ -23,4 +23,25 @@ describe('Listener', () => {
         expect('ws://localhost:3000/ws').to.be.equal(listener.url);
         listener.close();
     });
+
+    describe('isOpen', () => {
+        it('should return false when listener is created and not opened', () => {
+            const listener = new Listener('ws://localhost:3000');
+            expect(listener.isOpen()).to.be.false;
+            listener.close();
+        });
+    });
+
+    describe('onerror', () => {
+        it('should reject because of wrong server url', async () => {
+            const listener = new Listener('https://notcorrecturl:0000');
+            await listener.open()
+                .then((result) => {
+                    throw new Error('This should not be called when expecting error');
+                })
+                .catch((error) => {
+                    expect(error.toString()).to.be.equal("Error: getaddrinfo ENOTFOUND notcorrecturl notcorrecturl:0000");
+                })
+        });
+    });
 });

test/model/transaction/Transaction.spec.ts

@@ -99,7 +99,7 @@ describe('Transaction', () => {
         });
     });
 
-    describe('replyGiven', () => {
+    describe('reapplyGiven', () => {
         it('should throw an error if the transaction is announced', () => {
             const transaction = new FakeTransaction(TransactionType.TRANSFER,
                 NetworkType.MIJIN_TEST,
@@ -111,7 +111,7 @@ describe('Transaction', () => {
                 new TransactionInfo(UInt64.fromUint(100), 1, 'id_hash', 'hash', 'hash'),
             );
             expect(() => {
-                transaction.replyGiven(Deadline.create());
+                transaction.reapplyGiven(Deadline.create());
             }).to.throws('an Announced transaction can\'t be modified');
         });
         it('should return a new transaction', () => {
@@ -124,7 +124,7 @@ describe('Transaction', () => {
                 undefined,
             );
 
-            const newTransaction = transaction.replyGiven(Deadline.create());
+            const newTransaction = transaction.reapplyGiven(Deadline.create());
             expect(newTransaction).to.not.equal(transaction);
         });
         it('should overide deadline properly', () => {
@@ -138,7 +138,7 @@ describe('Transaction', () => {
             );
 
             const newDeadline = Deadline.create(3);
-            const newTransaction = transaction.replyGiven(newDeadline);
+            const newTransaction = transaction.reapplyGiven(newDeadline);
             const equal = newTransaction.deadline.value.equals(transaction.deadline.value);
             const after = newTransaction.deadline.value.isAfter(transaction.deadline.value);
             expect(newTransaction.deadline).to.be.equal(newDeadline);