@asyncapi/converter 0.11.0 → 1.0.0

package/README.md

@@ -2,48 +2,64 @@
 
 Convert [AsyncAPI](https://asyncapi.com) documents older to newer versions.
 
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+<!-- toc is generated with GitHub Actions do not remove toc markers -->
+
+<!-- toc -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  * [From CLI](#from-cli)
+  * [In JS](#in-js)
+  * [In TS](#in-ts)
+- [Known missing features](#known-missing-features)
+- [Development](#development)
+- [Contribution](#contribution)
+- [Contributors ✨](#contributors-%E2%9C%A8)
+
+<!-- tocstop -->
+
 ## Installation
 
 ```sh
-npm i -g @asyncapi/converter
+npm i @asyncapi/converter
 ```
 
 ## Usage
 
 ### From CLI
 
-Minimal example:
+To convert an AsyncAPi document in the console needs the official [AsyncAPI CLI](https://github.com/asyncapi/cli).
 
-```sh
-asyncapi-converter streetlights.yml
+If you don't have CLI installed, run this command to install the CLI globally on your system:
 
-# Result:
-asyncapi: '2.0.0'
-channels:
-...
+```sh
+npm install -g @asyncapi/cli
 ```
 
-Specify the application id:
+Minimal usage example with output given:
 
 ```sh
-asyncapi-converter --id=urn:com.asynapi.streetlights streetlights.yml
+asyncapi convert streetlights.yml -o streetlights2.yml
 
 # Result:
 asyncapi: '2.0.0'
-id: 'urn:com.asynapi.streetlights'
+channels:
 ...
 ```
 
-Save the result in a file by stream:
+Convert to specific version:
 
 ```sh
-asyncapi-converter streetlights.yml > streetlights2.yml
-```
-
-Save the result in a file by `-o, --output` flag:
+asyncapi convert streetlights.yml -o streetlights2.yml -t 2.3.0
 
-```sh
-asyncapi-converter streetlights.yml -o streetlights2.yml
+# Result:
+asyncapi: '2.3.0'
+channels:
+...
 ```
 
 ### In JS
@@ -84,3 +100,42 @@ try {
 ## Known missing features
 
 * When converting from 1.x to 2.x, Streaming APIs (those using `stream` instead of `topics` or `events`) are converted correctly but information about framing type and delimiter is missing until a [protocolInfo](https://github.com/asyncapi/extensions-catalog/issues/1) for that purpose is created.
+
+## Development
+
+1. Setup project by installing dependencies `npm install`
+2. Write code and tests.
+3. Make sure all tests pass `npm test`
+
+## Contribution
+
+Read [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/magicmatatjahu"><img src="https://avatars.githubusercontent.com/u/20404945?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maciej Urbańczyk</b></sub></a><br /><a href="#maintenance-magicmatatjahu" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/converter-js/commits?author=magicmatatjahu" title="Code">💻</a> <a href="https://github.com/asyncapi/converter-js/issues?q=author%3Amagicmatatjahu" title="Bug reports">🐛</a> <a href="https://github.com/asyncapi/converter-js/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/asyncapi/converter-js/commits?author=magicmatatjahu" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/converter-js/commits?author=magicmatatjahu" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.fmvilas.com/"><img src="https://avatars.githubusercontent.com/u/242119?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fran Méndez</b></sub></a><br /><a href="#maintenance-fmvilas" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/converter-js/commits?author=fmvilas" title="Code">💻</a> <a href="https://github.com/asyncapi/converter-js/issues?q=author%3Afmvilas" title="Bug reports">🐛</a> <a href="https://github.com/asyncapi/converter-js/pulls?q=is%3Apr+reviewed-by%3Afmvilas" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/asyncapi/converter-js/commits?author=fmvilas" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/converter-js/commits?author=fmvilas" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.brainfart.dev/"><img src="https://avatars.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lukasz Gornicki</b></sub></a><br /><a href="#maintenance-derberg" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/converter-js/commits?author=derberg" title="Code">💻</a> <a href="https://github.com/asyncapi/converter-js/issues?q=author%3Aderberg" title="Bug reports">🐛</a> <a href="https://github.com/asyncapi/converter-js/pulls?q=is%3Apr+reviewed-by%3Aderberg" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/asyncapi/converter-js/commits?author=derberg" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/converter-js/commits?author=derberg" title="Documentation">📖</a> <a href="#infra-derberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/germanschnyder"><img src="https://avatars.githubusercontent.com/u/1844525?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Germán Schnyder</b></sub></a><br /><a href="https://github.com/asyncapi/converter-js/commits?author=germanschnyder" title="Code">💻</a> <a href="https://github.com/asyncapi/converter-js/commits?author=germanschnyder" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/bszwarc"><img src="https://avatars.githubusercontent.com/u/17266942?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Barbara Czyż</b></sub></a><br /><a href="#infra-bszwarc" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/depimomo"><img src="https://avatars.githubusercontent.com/u/12368942?v=4?s=100" width="100px;" alt=""/><br /><sub><b>depimomo</b></sub></a><br /><a href="https://github.com/asyncapi/converter-js/commits?author=depimomo" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/crypto-cmd"><img src="https://avatars.githubusercontent.com/u/54287503?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Orville Daley</b></sub></a><br /><a href="https://github.com/asyncapi/converter-js/commits?author=crypto-cmd" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://www.arctype.co/"><img src="https://avatars.githubusercontent.com/u/549273?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ryan R Sundberg</b></sub></a><br /><a href="https://github.com/asyncapi/converter-js/commits?author=sundbry" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/lib/convert.js

@@ -68,9 +68,8 @@ function from__1_1_0__to__1_2_0(asyncapi, _) {
     asyncapi.asyncapi = '1.2.0';
     return asyncapi;
 }
-function from__1_2_0__to__2_0_0_rc1(asyncapi, options) {
+function from__1_2_0__to__2_0_0_rc1(asyncapi, _) {
     asyncapi.asyncapi = '2.0.0-rc1';
-    asyncapi.id = options.id || `urn:${asyncapi.info.title.toLowerCase().split(' ').join('.')}`;
     if (asyncapi.servers) {
         const security = asyncapi.security;
         asyncapi.servers = asyncapi.servers.map((server) => {
@@ -116,9 +115,8 @@ function from__1_2_0__to__2_0_0_rc1(asyncapi, options) {
     delete asyncapi.security;
     return asyncapi;
 }
-function from__2_0_0_rc1__to__2_0_0_rc2(asyncapi, options) {
+function from__2_0_0_rc1__to__2_0_0_rc2(asyncapi, _) {
     asyncapi.asyncapi = '2.0.0-rc2';
-    asyncapi.id = asyncapi.id || options.id;
     if (asyncapi.servers) {
         const serverMap = {};
         asyncapi.servers.forEach((server, index) => {
@@ -170,14 +168,10 @@ function from__2_0_0_rc1__to__2_0_0_rc2(asyncapi, options) {
                 delete parameter.name;
         });
     }
-    if (!options.id)
-        delete asyncapi.id;
     return asyncapi;
 }
-function from__2_0_0_rc2__to__2_0_0(asyncapi, options) {
+function from__2_0_0_rc2__to__2_0_0(asyncapi, _) {
     asyncapi.asyncapi = '2.0.0';
-    if (!options.id)
-        delete asyncapi.id;
     return asyncapi;
 }
 function from__2_0_0__to__2_1_0(asyncapi, _) {

package/lib/interfaces.d.ts

@@ -3,5 +3,4 @@ export declare type AsyncAPIDocument = {
 } & Record<string, any>;
 export declare type ConvertVersion = '1.1.0' | '1.2.0' | '2.0.0-rc1' | '2.0.0-rc2' | '2.0.0' | '2.1.0' | '2.2.0' | '2.3.0' | '2.4.0';
 export interface ConvertOptions {
-    id?: string;
 }

package/package.json

@@ -1,10 +1,7 @@
 {
 	"name": "@asyncapi/converter",
-	"version": "0.11.0",
+	"version": "1.0.0",
 	"description": "Convert AsyncAPI documents from older to newer versions.",
-	"bin": {
-		"asyncapi-converter": "cli.js"
-	},
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"scripts": {
@@ -12,7 +9,8 @@
 		"test": "cross-env CI=true NODE_ENV=test jest --coverage",
 		"lint": "echo 'no linter configured yet'",
 		"release": "semantic-release",
-		"generate:assets": "echo 'No additional assets need to be generated at the moment'",
+		"generate:assets": "npm run generate:readme:toc",
+		"generate:readme:toc": "markdown-toc -i README.md",
 		"bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
 		"prepublishOnly": "npm run build"
 	},
@@ -24,7 +22,6 @@
 	],
 	"files": [
 		"/lib",
-		"cli.js",
 		"./README.md",
 		"./LICENSE"
 	],
@@ -42,7 +39,6 @@
 	"author": "Fran Mendez <fmvilas@gmail.com> (fmvilas.com)",
 	"license": "Apache-2.0",
 	"dependencies": {
-		"commander": "^8.3.0",
 		"js-yaml": "^3.14.1"
 	},
 	"devDependencies": {
@@ -56,10 +52,11 @@
 		"conventional-changelog-conventionalcommits": "^4.6.3",
 		"cross-env": "^7.0.3",
 		"jest": "^27.5.1",
-		"semantic-release": "^18.0.1",
+		"semantic-release": "^19.0.3",
 		"ts-jest": "^27.1.3",
 		"ts-node": "^10.7.0",
-		"typescript": "^4.6.2"
+		"typescript": "^4.6.2",
+		"markdown-toc": "^1.2.0"
 	},
 	"release": {
 		"branches": [

package/cli.js

@@ -1,66 +0,0 @@
-#!/usr/bin/env node
-
-const path = require('path');
-const fs = require('fs');
-const program = require('commander');
-const packageInfo = require('./package.json');
-const converter = require('./lib');
-
-const red = text => `\x1b[31m${text}\x1b[0m`;
-
-let asyncapiFile;
-let version;
-let output;
-
-const parseArguments = (asyncAPIPath, v) => {
-  asyncapiFile = path.resolve(asyncAPIPath);
-  version = v;
-}
-
-const parseOutput = (filePath) => {
-  output = path.resolve(filePath);
-}
-
-const showErrorAndExit = err => {
-  console.error(red('Something went wrong:'));
-  console.error(red(err.stack || err.message));
-  process.exit(1);
-};
-
-program
-  .version(packageInfo.version)
-  .arguments('<document> [version]')
-  .action(parseArguments)
-  .option('--id <id>', 'application id (defaults to a generated one)')
-  .option('-o, --output <outputFile>', 'file where to put the converted AsyncAPI document', parseOutput)
-  .parse(process.argv);
-
-if (!asyncapiFile) {
-  console.error(red('> Path to AsyncAPI file not provided.'));
-  program.help(); // This exits the process
-}
-if (!version) {
-  version = '2.4.0';
-}
-
-try {
-  const asyncapi = fs.readFileSync(asyncapiFile, 'utf-8');
-  let converted = converter.convert(asyncapi, version, {
-    id: program.id,
-  });
-
-  // JSON case
-  if (typeof converted === 'object') {
-    converted = JSON.stringify(converted, undefined, 2);
-  }
-
-  if (output) {
-    fs.writeFileSync(output, converted, 'utf-8');
-  } else {
-    console.log(converted);
-  }
-} catch (e) {
-  showErrorAndExit(e);
-}
-
-process.on('unhandledRejection', showErrorAndExit);