@asyncapi/converter 0.8.0 → 0.11.0

package/lib/helpers.js

@@ -1,109 +0,0 @@
-const _ = require('lodash');
-const yaml = require('js-yaml');
-const helpers = module.exports;
-
-helpers.serialize = (text) => {
-    if (typeof text === 'object') {
-        return {
-            isYAML: false,
-            parsed: text,
-        };
-    }
-
-    try {
-        const maybeJSON = JSON.parse(text);
-        if (typeof maybeJSON === 'object') {
-            return {
-                isYAML: false,
-                parsed: maybeJSON,
-            };
-        }
-
-        // if `maybeJSON` is object, then we have 100% sure that we operate on JSON, 
-        // but if it's `string` then we have option that it can be YAML but it doesn't have to be
-        return {
-            isYAML: true,
-            parsed: yaml.safeLoad(text)
-        };
-    } catch (e) {
-        try {
-            // try to parse again YAML, because the text itself may not have a JSON representation and cannot be represented as a JSON object/string
-            return {
-                isYAML: true,
-                parsed: yaml.safeLoad(text)
-            };
-        } catch (err) {
-            throw new Error('AsyncAPI document must be a valid JSON or YAML document.');
-        }
-    }
-};
-
-helpers.dotsToSlashes = topic => topic.replace(/\./g, '/');
-
-helpers.eventToChannel = event => {
-    const out = {};
-    if (event.receive) {
-        out.publish = {
-            message: {
-                oneOf: event.receive
-            }
-        }
-    }
-    if (event.send) {
-        out.subscribe = {
-            message: {
-                oneOf: event.send
-            }
-        }
-    }
-
-    return out;
-};
-
-helpers.streamToChannel = event => {
-    const out = {};
-    if (event.read) {
-        out.publish = {
-            message: {
-                oneOf: event.read
-            }
-        }
-    }
-    if (event.write) {
-        out.subscribe = {
-            message: {
-                oneOf: event.write
-            }
-        }
-    }
-
-    return out;
-};
-
-const objectToSchema = obj => {
-    const schema = { type: 'object', properties: {} };
-    _.each(obj, (prop, propName) => {
-        schema.properties[propName] = prop;
-    });
-    return obj;
-};
-
-helpers.convertMessage = message => {
-    if (message.oneOf) {
-        message.oneOf.forEach(m => {
-            if (m.protocolInfo) {
-                m.bindings = m.protocolInfo;
-                delete m.protocolInfo;
-            }
-            
-            if (m.headers) m.headers = objectToSchema(m.headers);
-        });
-    } else {
-        if (message.protocolInfo) {
-            message.bindings = message.protocolInfo;
-            delete message.protocolInfo;
-        }
-
-        if (message.headers) message.headers = objectToSchema(message.headers);
-    }
-}

package/test/index.js

@@ -1,257 +0,0 @@
-const assert = require('assert');
-const fs = require('fs');
-const path = require("path");
-const { convert } = require('../lib');
-const { serialize } = require('../lib/helpers');
-
-describe('#convert', () => {
-    it('should not convert to lowest version', () => {
-        assert.throws(
-            () => convert(`asyncapi: '2.1.0'`, '2.0.0'),
-            /^Error: Cannot downgrade from 2.1.0 to 2.0.0.$/
-        );
-    });
-
-    it('should not convert from non existing version', () => {
-        assert.throws(
-            () => convert(`asyncapi: '2.0.0-rc3'`, '2.1.0'),
-            /^Error: Cannot convert from 2.0.0-rc3 to 2.1.0.$/
-        );
-    });
-
-    it('should not convert to this same version', () => {
-        assert.throws(
-            () => convert(`asyncapi: '2.1.0'`, '2.1.0'),
-            /^Error: Cannot convert to the same version.$/
-        );
-    });
-
-    it('should convert from 1.0.0 to 2.0.0-rc1', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc1', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc1');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.1.0 to 2.0.0-rc1', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc1', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc1');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.2.0 to 2.0.0-rc1', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc1', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc1');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.2.0 to 2.0.0-rc1 - stream', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'gitter-streaming.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc1', 'gitter-streaming.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc1');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.2.0 to 2.0.0-rc1 - events', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'slack-rtm.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc1', 'slack-rtm.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc1');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.0.0 to 2.0.0-rc2', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc2', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc2');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.1.0 to 2.0.0-rc2', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc2', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc2');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.2.0 to 2.0.0-rc2 - stream', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'gitter-streaming.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc2', 'gitter-streaming.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc2');
-        assertResults(output, result);
-    });
-    
-    it('should convert from 1.2.0 to 2.0.0-rc2 - events', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'slack-rtm.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc2', 'slack-rtm.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc2');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.2.0 to 2.0.0-rc2', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0-rc2', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0-rc2');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.0.0 to 2.0.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.1.0 to 2.0.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.2.0 to 2.0.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0-rc1 to 2.0.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0-rc1', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0-rc2 to 2.0.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0-rc2', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.0.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.0.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.0.0 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.1.0 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 1.2.0 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '1.2.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0-rc1 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0-rc1', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0-rc2 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0-rc2', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0 to 2.1.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.1.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0 to 2.2.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.2.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.2.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.1.0 to 2.2.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.2.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.2.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.1.0 to 2.3.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.1.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.3.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.3.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.2.0 to 2.3.0', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.2.0', 'streetlights.yml'), 'utf8');
-        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.3.0', 'streetlights.yml'), 'utf8');
-        const result = convert(input, '2.3.0');
-        assertResults(output, result);
-    });
-
-    it('should convert from 2.0.0 to 2.1.0 (JSON case)', () => {
-        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0', 'streetlights.json'), 'utf8');
-        let output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.json'), 'utf8');
-        let result = convert(input, '2.1.0');
-
-        output = JSON.stringify(JSON.parse(output));
-        result = JSON.stringify(JSON.parse(JSON.stringify(result)));
-        assert.strictEqual(output, result);
-    });
-});
-
-describe('#serialize', () => {
-    it('should serialize JSON', () => {
-        const input = '{"foo": "bar"}';
-        const output = serialize(input);
-        assert.strictEqual(output.isYAML, false);
-        assert.deepEqual(output.parsed, {foo: "bar"});
-    });
-
-    it('should serialize YAML', () => {
-        const input = 'foo: bar';
-        const output = serialize(input);
-        assert.strictEqual(output.isYAML, true);
-        assert.deepEqual(output.parsed, {foo: "bar"});
-    });
-
-    it('should serialize YAML (with JSON syntax)', () => {
-        const input = '{foo: bar}';
-        const output = serialize(input);
-        assert.strictEqual(output.isYAML, true);
-        assert.deepEqual(output.parsed, {foo: "bar"});
-    });
-
-    it('should throw error', () => {
-        const input = '%{foo: bar}';
-        try {
-            serialize(input);
-        } catch(e) {
-            assert.strictEqual(e.message, 'AsyncAPI document must be a valid JSON or YAML document.');
-        }
-    });
-});
-
-/*
-  It is a helper required for testing on windows. It can't be solved by editor configuration and the end line setting because expected result is converted during tests.
-  We need to remove all line breaks from the string
-*/
-function removeLineBreaks(str) {
-    return str.replace(/\r?\n|\r/g, '')
-}
-
-function assertResults(output, result){
-    assert.strictEqual(removeLineBreaks(output), removeLineBreaks(result));
-}

package/test/input/1.0.0/streetlights.yml

@@ -1,120 +0,0 @@
-asyncapi: '1.0.0'
-info:
-  title: Streetlights API
-  version: '1.0.0'
-  description: |
-    The Smartylighting Streetlights API allows you to remotely manage the city lights.
-
-    ### Check out its awesome features:
-
-    * Turn a specific streetlight on/off 🌃
-    * Dim a specific streetlight 😎
-    * Receive real-time information about environmental lighting conditions 📈
-  license:
-    name: Apache 2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0
-baseTopic: smartylighting.streetlights.1.0
-
-servers:
-  - url: api.streetlights.smartylighting.com:{port}
-    scheme: mqtt
-    description: Test broker
-    variables:
-      port:
-        description: Secure connection (TLS) is available through port 8883.
-        default: '1883'
-        enum:
-          - '1883'
-          - '8883'
-
-security:
-  - apiKey: []
-
-topics:
-  event.{streetlightId}.lighting.measured:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    publish:
-      $ref: '#/components/messages/lightMeasured'
-
-  action.{streetlightId}.turn.on:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/turnOnOff'
-
-  action.{streetlightId}.turn.off:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/turnOnOff'
-
-  action.{streetlightId}.dim:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/dimLight'
-
-components:
-  messages:
-    lightMeasured:
-      summary: Inform about environmental lighting conditions for a particular streetlight.
-      payload:
-        $ref: "#/components/schemas/lightMeasuredPayload"
-    turnOnOff:
-      summary: Command a particular streetlight to turn the lights on or off.
-      payload:
-        $ref: "#/components/schemas/turnOnOffPayload"
-    dimLight:
-      summary: Command a particular streetlight to dim the lights.
-      payload:
-        $ref: "#/components/schemas/dimLightPayload"
-
-  schemas:
-    lightMeasuredPayload:
-      type: object
-      properties:
-        lumens:
-          type: integer
-          minimum: 0
-          description: Light intensity measured in lumens.
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    turnOnOffPayload:
-      type: object
-      properties:
-        command:
-          type: string
-          enum:
-            - on
-            - off
-          description: Whether to turn on or off the light.
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    dimLightPayload:
-      type: object
-      properties:
-        percentage:
-          type: integer
-          description: Percentage to which the light should be dimmed to.
-          minimum: 0
-          maximum: 100
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    sentAt:
-      type: string
-      format: date-time
-      description: Date and time when the message was sent.
-
-  securitySchemes:
-    apiKey:
-      type: apiKey
-      in: user
-      description: Provide your API key as the user and leave the password empty.
-
-  parameters:
-    streetlightId:
-      name: streetlightId
-      description: The ID of the streetlight.
-      schema:
-        type: string

package/test/input/1.1.0/streetlights.yml

@@ -1,120 +0,0 @@
-asyncapi: '1.1.0'
-info:
-  title: Streetlights API
-  version: '1.0.0'
-  description: |
-    The Smartylighting Streetlights API allows you to remotely manage the city lights.
-
-    ### Check out its awesome features:
-
-    * Turn a specific streetlight on/off 🌃
-    * Dim a specific streetlight 😎
-    * Receive real-time information about environmental lighting conditions 📈
-  license:
-    name: Apache 2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0
-baseTopic: smartylighting.streetlights.1.0
-
-servers:
-  - url: api.streetlights.smartylighting.com:{port}
-    scheme: mqtt
-    description: Test broker
-    variables:
-      port:
-        description: Secure connection (TLS) is available through port 8883.
-        default: '1883'
-        enum:
-          - '1883'
-          - '8883'
-
-security:
-  - apiKey: []
-
-topics:
-  event.{streetlightId}.lighting.measured:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    publish:
-      $ref: '#/components/messages/lightMeasured'
-
-  action.{streetlightId}.turn.on:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/turnOnOff'
-
-  action.{streetlightId}.turn.off:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/turnOnOff'
-
-  action.{streetlightId}.dim:
-    parameters:
-      - $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      $ref: '#/components/messages/dimLight'
-
-components:
-  messages:
-    lightMeasured:
-      summary: Inform about environmental lighting conditions for a particular streetlight.
-      payload:
-        $ref: "#/components/schemas/lightMeasuredPayload"
-    turnOnOff:
-      summary: Command a particular streetlight to turn the lights on or off.
-      payload:
-        $ref: "#/components/schemas/turnOnOffPayload"
-    dimLight:
-      summary: Command a particular streetlight to dim the lights.
-      payload:
-        $ref: "#/components/schemas/dimLightPayload"
-
-  schemas:
-    lightMeasuredPayload:
-      type: object
-      properties:
-        lumens:
-          type: integer
-          minimum: 0
-          description: Light intensity measured in lumens.
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    turnOnOffPayload:
-      type: object
-      properties:
-        command:
-          type: string
-          enum:
-            - on
-            - off
-          description: Whether to turn on or off the light.
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    dimLightPayload:
-      type: object
-      properties:
-        percentage:
-          type: integer
-          description: Percentage to which the light should be dimmed to.
-          minimum: 0
-          maximum: 100
-        sentAt:
-          $ref: "#/components/schemas/sentAt"
-    sentAt:
-      type: string
-      format: date-time
-      description: Date and time when the message was sent.
-
-  securitySchemes:
-    apiKey:
-      type: apiKey
-      in: user
-      description: Provide your API key as the user and leave the password empty.
-
-  parameters:
-    streetlightId:
-      name: streetlightId
-      description: The ID of the streetlight.
-      schema:
-        type: string