docs: add comments and examples

+ use response from implicit auth in get auth header

README.md

@@ -92,6 +92,10 @@ The topics have the following structure:
 
 ```
 project.operator.vehicleType.vehicleID.[send|receive].messageType
+# eg 
+soar.noc.autosub.ah1.send.platform-mission 
+# or 
+soar.po.ecosub.eco1.receive.platform-status
 ```
 
 Subscriptions may contain single-word wildcards (*) or multi-word wildcards (#).

dist/adapter.esm.js

@@ -47,7 +47,7 @@ class Adapter {
     if (!this.tokenValid())
       return this.auth().then((response) => {
         return {
-          Authorization: `Bearer ${this.credentials.token}`,
+          Authorization: `Bearer ${response.data.token}`,
         };
       });
     else {

dist/adapter.js

@@ -49,7 +49,7 @@ class Adapter {
     if (!this.tokenValid())
       return this.auth().then((response) => {
         return {
-          Authorization: `Bearer ${this.credentials.token}`,
+          Authorization: `Bearer ${response.data.token}`,
         };
       });
     else {

dist/protocol.esm.js

@@ -59,6 +59,9 @@ class GenericProtocol {
 
   /**
    * Invoked on receiving a message from the backbone 
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the decode method
    * @param {string} type 
    * @param {object} message 
    * @returns {*}
@@ -69,6 +72,9 @@ class GenericProtocol {
 
   /**
    * Optionally invoked before delivering a message to the backbone
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the encode method
    * @param {string} type 
    * @param {*} message 
    * @returns {object}

dist/protocol.js

@@ -61,6 +61,9 @@ class GenericProtocol {
 
   /**
    * Invoked on receiving a message from the backbone 
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the decode method
    * @param {string} type 
    * @param {object} message 
    * @returns {*}
@@ -71,6 +74,9 @@ class GenericProtocol {
 
   /**
    * Optionally invoked before delivering a message to the backbone
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the encode method
    * @param {string} type 
    * @param {*} message 
    * @returns {object}

src/adapter/index.js

@@ -47,7 +47,7 @@ export class Adapter {
     if (!this.tokenValid())
       return this.auth().then((response) => {
         return {
-          Authorization: `Bearer ${this.credentials.token}`,
+          Authorization: `Bearer ${response.data.token}`,
         };
       });
     else {

src/protocol/index.js

@@ -59,6 +59,9 @@ export class GenericProtocol {
 
   /**
    * Invoked on receiving a message from the backbone 
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the decode method
    * @param {string} type 
    * @param {object} message 
    * @returns {*}
@@ -69,6 +72,9 @@ export class GenericProtocol {
 
   /**
    * Optionally invoked before delivering a message to the backbone
+   * 
+   * Whilst type isn't used in the generic stub it will 
+   * be needed by sub-classes overriding the encode method
    * @param {string} type 
    * @param {*} message 
    * @returns {object}