feat: initial intent API implementation

lib/models/channel-parameter.js

@@ -1,35 +1,16 @@
-const { mix } = require('./utils');
-
-const Base = require('./base');
-const Schema = require('./schema');
-
-const MixinDescription = require('../mixins/description');
-const MixinSpecificationExtensions = require('../mixins/specification-extensions');
+module.exports = {};
 
 /**
- * Implements functions to deal with a ChannelParameter object.
+ * 
  * @class
- * @alias module:@asyncapi/parser#ChannelParameter
- * @extends Base
- * @mixes MixinDescription
- * @mixes MixinSpecificationExtensions
- * @returns {ChannelParameter}
+ * @alias module:@asyncapi/parser#IntentChannelParameter
  */
-class ChannelParameter extends Base {
-  /**
-   * @returns {string}
-   */
-  location() {
-    return this._json.location;
-  }
-
+class IntentChannelParameter {
   /**
-   * @returns {Schema}
-   */
-  schema() {
-    if (!this._json.schema) return null;
-    return new Schema(this._json.schema);
-  }
+  * 
+  * @returns {string}
+  */
+  name() { return 'param name'; }    
 }
 
-module.exports = mix(ChannelParameter, MixinDescription, MixinSpecificationExtensions);
+module.exports.IntentChannelParameter = IntentChannelParameter;

lib/models/channel.js

@@ -1,102 +1,96 @@
-const { createMapOfType, getMapValueOfType, mix } = require('./utils');
 
-const Base = require('./base');
-const ChannelParameter = require('./channel-parameter');
-const PublishOperation = require('./publish-operation');
-const SubscribeOperation = require('./subscribe-operation');
-
-const MixinDescription = require('../mixins/description');
-const MixinBindings = require('../mixins/bindings');
-const MixinSpecificationExtensions = require('../mixins/specification-extensions');
+module.exports = {};  
+const ParserError = require('../errors/parser-error');
+// eslint-disable-next-line no-unused-vars
+const { IntentMessage } = require('./message');
+const { IntentOperation } = require('./operation');
+const { IntentChannelParameter } = require('./channel-parameter');
+const { IntentOperations } = require('./operations');
+const { OperationTypes } = require('./operation-types');
+const utils = require('../utils');
 
 /**
- * Implements functions to deal with a Channel object.
+ * 
  * @class
- * @alias module:@asyncapi/parser#Channel
- * @extends Base
- * @mixes MixinDescription
- * @mixes MixinBindings
- * @mixes MixinSpecificationExtensions
- * @returns {Channel}
+ * @alias module:@asyncapi/parser#IntentChannel
  */
-class Channel extends Base {
+class IntentChannel {
   /**
-   * @returns {Object<string, ChannelParameter>}
+   * 
+   * @param {string} document 
+   * @param {string} channelId 
    */
-  parameters() {
-    return createMapOfType(this._json.parameters, ChannelParameter);
+  constructor(document, channelId) {
+    if (document === undefined || document === null || channelId === undefined || channelId === null) throw new ParserError(`Invalid JSON to instantiate the ${this.constructor.name} object.`);
+    this.document = document;
+    this.channelId = channelId;
   }
 
   /**
-   * @param {string} name - Name of the parameter.
-   * @returns {ChannelParameter}
+   * @returns {IntentOperations}
    */
-  parameter(name) {
-    return getMapValueOfType(this._json.parameters, name, ChannelParameter);
+  operations() { 
+    // TODO should this be done in the constructor so we don't have to do it everytime this method is called?
+    const operations = [];
+    if (utils.isVersion2(this.document.json())) { // Ideally we should directly pass the version so we dont need to get from the document
+      const channel = this.document.channel(this.channelId); // In v2.x channel id is the path
+      if (channel !== undefined && channel !== null) {
+        if (channel.hasSubscribe()) operations.push(new IntentOperation(this.document, this.channelId, [OperationTypes.Send]));
+        if (channel.hasPublish()) operations.push(new IntentOperation(this.document, this.channelId, [OperationTypes.Receive]));
+      }
+    }
+    return new IntentOperations(operations);
   }
 
   /**
-   * @returns {boolean}
+   * @returns {string}
    */
-  hasParameters() {
-    return !!this._json.parameters;
-  }
+  id() { return this.channelId; }
 
   /**
-   * @returns {boolean}
+   * @returns {string}
    */
-  hasServers() {
-    return !!this._json.servers;
-  }
+  path() { return 'some/test/path'; }
 
   /**
-   * @returns {String[]}
+   * @returns {IntentMessage[]}
    */
-  servers() {
-    if (!this._json.servers) return [];
-    return this._json.servers;
-  }
-
+  messages() { return [new IntentMessage(this.document, this.operations[0])];}
+
   /**
-   * @param {number} index - Index of the server.
-   * @returns {String}
+   * 
+   * @param {string} bindingProtocol 
+   * @returns {boolean}
    */
-  server(index) {
-    if (!this._json.servers) return null;
-    if (typeof index !== 'number') return null;
-    if (index > this._json.servers.length - 1) return null;
-    return this._json.servers[+index];
-  }
-
+  hasBinding(bindingProtocol) { return true; }
   /**
-   * @returns {PublishOperation}
-   */
-  publish() {
-    if (!this._json.publish) return null;
-    return new PublishOperation(this._json.publish);
-  }
+    * 
+    * @param {string} bindingProtocol 
+    * @returns {any|undefined} 
+    */
+  binding(bindingProtocol) {return {};}
 
   /**
-   * @returns {SubscribeOperation}
+   * 
+   * @returns {boolean}
    */
-  subscribe() {
-    if (!this._json.subscribe) return null;
-    return new SubscribeOperation(this._json.subscribe);
-  }
-
+  hasParameters() { return true; }
   /**
-   * @returns {boolean}
+   * 
+   * @returns {IntentChannelParameter[]|undefined}
    */
-  hasPublish() {
-    return !!this._json.publish;
-  }
+  parameters() { return [new IntentChannelParameter()];}
 
   /**
+   * 
    * @returns {boolean}
    */
-  hasSubscribe() {
-    return !!this._json.subscribe;
-  }
+  hasDescription() { return true; }
+  /**
+    * 
+    * @returns {string|undefined} 
+    */
+  description() {return 'some test description';}
 }
 
-module.exports = mix(Channel, MixinDescription, MixinBindings, MixinSpecificationExtensions);
+module.exports.IntentChannel = IntentChannel;

lib/models/channels.js

@@ -0,0 +1,70 @@
+
+module.exports = {};
+// eslint-disable-next-line no-unused-vars
+const { IntentChannel } = require('./channel');
+
+/**
+ * 
+ * @class
+ * @alias module:@asyncapi/parser#IntentChannels
+ */
+class IntentChannels {
+  /**
+   * 
+   * @param {IntentChannel[]} channels 
+   */
+  constructor(channels) {
+    this.channels = channels;
+  } 
+
+  /**
+   * @returns {IntentChannel[]}
+   */
+  filterBySend() { 
+    return this.filterBy((channel) => {
+      return channel.operations().filterBySend().lenght > 0;
+    }); 
+  }
+
+  /**
+   * @returns {IntentChannel[]}
+   */
+  filterByReceive() { 
+    return this.filterBy((channel) => {
+      return channel.operations().filterByReceive().lenght > 0;
+    }); 
+  }
+
+  /**
+   * @returns {IntentChannel[]}
+   */
+  filterById(channelId) { 
+    return this.filterBy((channel) => {
+      if (channel.path() === channelId) return true; // TODO Test!!
+    }); 
+  }
+
+  /**
+   * @returns {IntentChannel[]}
+   */
+  filterBy(callbackFn) { 
+    return this.channels.filter(callbackFn); 
+  }
+
+  /**
+   * @returns {IntentChannel[]}
+   */
+  all() { 
+    return this.channels; 
+  }
+
+  /**
+   * @returns boolean
+   */
+  isEmpty() {
+    return this.channels.length === 0;
+  }
+}
+
+module.exports.IntentChannels = IntentChannels;
+

lib/models/contact.js

@@ -1,39 +1,40 @@
-
-const { mix } = require('./utils');
-
-const Base = require('./base');
-
-const MixinSpecificationExtensions = require('../mixins/specification-extensions');
+module.exports = {}; 
 
 /**
- * Implements functions to deal with the Contact object.
+ * 
  * @class
- * @alias module:@asyncapi/parser#Contact
- * @extends Base
- * @mixes MixinSpecificationExtensions
- * @returns {Contact}
+ * @alias module:@asyncapi/parser#IntentContact
  */
-class Contact extends Base {
+class IntentContact {
   /**
-   * @returns {string}
+   * 
+   * @returns {boolean}
    */
-  name() {
-    return this._json.name;
-  }
-
+  hasName() { return true; }
   /**
-   * @returns {string}
+   * @returns {string|undefined}
    */
-  url() {
-    return this._json.url;
-  }
+  name() {return 'some name'; }
+
+  /**
+   * 
+   * @returns {boolean}
+   */
+  hasUrl() { return true; }
+  /**
+   * @returns {string|undefined}
+   */
+  url() {return 'test.com'; }
 
   /**
-   * @returns {string}
+   * 
+   * @returns {boolean}
+   */
+  hasEmail() { return true; }
+  /**
+   * @returns {string|undefined}
    */
-  email() {
-    return this._json.email;
-  }
+  email() {return 'test@test.com'; }
 }
 
-module.exports = mix(Contact, MixinSpecificationExtensions);
+module.exports.IntentContact = IntentContact;

lib/models/correlation-id.js

@@ -1,26 +1,28 @@
-const { mix } = require('./utils');
-
-const Base = require('./base');
-
-const MixinDescription = require('../mixins/description');
-const MixinSpecificationExtensions = require('../mixins/specification-extensions');
+module.exports = {};
 
 /**
  * Implements functions to deal with a CorrelationId object.
  * @class
- * @alias module:@asyncapi/parser#CorrelationId
- * @extends Base
- * @mixes MixinDescription
- * @mixes MixinSpecificationExtensions
- * @returns {CorrelationId}
+ * @alias module:@asyncapi/parser#IntentCorrelationId
  */
-class CorrelationId extends Base {
+class IntentCorrelationId {
+  /**
+   * @returns {boolean}
+   */
+  hasDescription() { return true; }
+  /**
+   * @returns {string|undefined}
+   */
+  description() { return 'a message description'; }
+
+  /**
+   * @returns {boolean}
+   */
+  hasLocation() { return true; }
   /**
-   * @returns {string}
+   * @returns {string|undefined}
    */
-  location() {
-    return this._json.location;
-  }
+  location() { return '$message.header#/correlationId'; }
 }
 
-module.exports = mix(CorrelationId, MixinSpecificationExtensions, MixinDescription);
+module.exports.IntentCorrelationId = IntentCorrelationId;