@asyncapi/converter 1.6.2 → 2.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -19,8 +19,6 @@ Convert [AsyncAPI](https://asyncapi.com) documents older to newer versions and y
 - [Known missing features](#known-missing-features)
 - [OpenAPI 3.0 to AsyncAPI 3.0 Conversion](#openapi-30-to-asyncapi-30-conversion)
     + [Limitations](#limitations)
-  * [Postman Collection to AsyncAPI conversion](#postman-collection-to-asyncapi-conversion)
-    + [Limitations](#limitations-1)
 - [Development](#development)
 - [Contribution](#contribution)
 - [Contributors ✨](#contributors-%E2%9C%A8)
@@ -241,48 +239,6 @@ The perspective option can be set to either 'server' (default) or 'client'.
 
 - External to internal references: The converter does not support scenarios where an external schema file references internal components of the OpenAPI document. In such cases, manual adjustment of the converted document may be necessary.
 
-### Postman Collection to AsyncAPI conversion
-
-The converter now also supports conversion from postman collection to AsyncAPI 3.0. This feature enables easy transition of existing postman collection to any AsyncAPI 3.0 documents.
-
-To use this new conversion feature:
-
-```js
-const fs = require('fs');
-const { convertPostman } = require('@asyncapi/converter')
-try {
-  const postman = fs.readFileSync('postman-collection.yml', 'utf-8')
-  const asyncapi = convertPostman(postman, '3.0.0');
-  console.log(asyncapi);
-} catch (e) {
-  console.error(e);
-}
-```
-
-When converting from postman collection to AsyncAPI you can now specify the perspective of the conversion using the `perspective` option. This allows you to choose whether the conversion should be from an application or client point of view
-
-```js
-const { convertPostman } = require('@asyncapi/converter')
-try {
-  const postman = fs.readFileSync('postman-collection.yml', 'utf-8')
-  const asyncapi = convertPostman(postman, '3.0.0', { perspective: 'client' });
-  console.log(asyncapi);
-} catch (e) {
-  console.error(e);
-}
-```
-
-The perspective option can be set to either 'server' (default) or 'client'. 
-
-- With `server` perspective: `action` becomes `receive`
-
-- With `client` perspective: `action` becomes `send`
-
-#### Limitations
-
-- External to internal references: The converter does not support scenarios where an external schema file references internal components of the OpenAPI document. In such cases, manual adjustment of the converted document may be necessary.
-
-
 ## Development
 
 1. Setup project by installing dependencies `npm install`

package/lib/convert.d.ts

@@ -1,7 +1,5 @@
-import type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions, OpenAPIDocument, OpenAPIToAsyncAPIOptions, PostmanToAsyncAPIOptions } from './interfaces';
+import type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions, OpenAPIDocument, OpenAPIToAsyncAPIOptions } from './interfaces';
 export declare function convert(input: string, version: AsyncAPIConvertVersion, options?: ConvertOptions): string;
 export declare function convert(input: AsyncAPIDocument, version: AsyncAPIConvertVersion, options?: ConvertOptions): AsyncAPIDocument;
 export declare function convertOpenAPI(input: string, version: OpenAPIConvertVersion, options?: OpenAPIToAsyncAPIOptions): string;
 export declare function convertOpenAPI(input: OpenAPIDocument, version: OpenAPIConvertVersion, options?: OpenAPIToAsyncAPIOptions): AsyncAPIDocument;
-export declare function convertPostman(input: string, version: OpenAPIConvertVersion, options?: PostmanToAsyncAPIOptions): string;
-export declare function convertPostman(input: Record<string, any>, version: OpenAPIConvertVersion, options?: PostmanToAsyncAPIOptions): AsyncAPIDocument;

package/lib/convert.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertPostman = exports.convertOpenAPI = exports.convert = void 0;
+exports.convertOpenAPI = exports.convert = void 0;
 const js_yaml_1 = require("js-yaml");
 const first_version_1 = require("./first-version");
 const second_version_1 = require("./second-version");
 const third_version_1 = require("./third-version");
 const openapi_1 = require("./openapi");
-const postman_collection_1 = require("./postman-collection");
 const utils_1 = require("./utils");
 /**
  * Value for key (version) represents the function which converts specification from previous version to the given as key.
@@ -55,13 +54,3 @@ function convertOpenAPI(input, version, options = {}) {
     return convertedAsyncAPI;
 }
 exports.convertOpenAPI = convertOpenAPI;
-function convertPostman(input, version, options = {}) {
-    const { format, document } = (0, utils_1.serializeInput)(input);
-    const postmantoAsyncapiConverter = postman_collection_1.converters[version];
-    const convertedAsyncAPI = postmantoAsyncapiConverter(document, options);
-    if (format === "yaml") {
-        return (0, js_yaml_1.dump)(convertedAsyncAPI, { skipInvalid: true });
-    }
-    return convertedAsyncAPI;
-}
-exports.convertPostman = convertPostman;

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export { convert, convertOpenAPI, convertPostman } from './convert';
+export { convert, convertOpenAPI } from './convert';
 export type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions } from './interfaces';

package/lib/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertPostman = exports.convertOpenAPI = exports.convert = void 0;
+exports.convertOpenAPI = exports.convert = void 0;
 var convert_1 = require("./convert");
 Object.defineProperty(exports, "convert", { enumerable: true, get: function () { return convert_1.convert; } });
 Object.defineProperty(exports, "convertOpenAPI", { enumerable: true, get: function () { return convert_1.convertOpenAPI; } });
-Object.defineProperty(exports, "convertPostman", { enumerable: true, get: function () { return convert_1.convertPostman; } });

package/lib/interfaces.d.ts

@@ -7,7 +7,7 @@ export declare type AsyncAPIDocument = {
 export declare type OpenAPIDocument = {
     openapi: string;
 } & Record<string, any>;
-export declare type AsyncAPIConvertVersion = '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' | '2.5.0' | '2.6.0' | '3.0.0';
+export declare type AsyncAPIConvertVersion = '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' | '2.5.0' | '2.6.0' | '3.0.0' | '3.1.0';
 export declare type OpenAPIConvertVersion = '3.0.0';
 export declare type ConvertV2ToV3Options = {
     idGenerator?: (data: {
@@ -29,14 +29,9 @@ export declare type OpenAPIToAsyncAPIOptions = {
 export declare type ConvertOptions = {
     v2tov3?: ConvertV2ToV3Options;
     openAPIToAsyncAPI?: OpenAPIToAsyncAPIOptions;
-    postmanToAsyncAPI?: PostmanToAsyncAPIOptions;
-};
-export declare type PostmanToAsyncAPIOptions = {
-    perspective?: 'client' | 'server';
 };
 /**
  * PRIVATE TYPES
  */
 export declare type ConvertFunction = (asyncapi: AsyncAPIDocument, options: ConvertOptions) => AsyncAPIDocument;
 export declare type ConvertOpenAPIFunction = (openapi: OpenAPIDocument, options: OpenAPIToAsyncAPIOptions) => AsyncAPIDocument;
-export declare type ConvertPostmanFunction = (postman: any, options: PostmanToAsyncAPIOptions) => AsyncAPIDocument;

package/lib/third-version.js

@@ -4,7 +4,13 @@ exports.converters = void 0;
 const utils_1 = require("./utils");
 exports.converters = {
     '3.0.0': from__2_6_0__to__3_0_0,
+    '3.1.0': from__3_0_0__to__3_1_0,
 };
+function from__3_0_0__to__3_1_0(asyncapi, options) {
+    // v3.1 only adds ROS bindings, so no only version bump is needed
+    asyncapi.asyncapi = '3.1.0';
+    return asyncapi;
+}
 function from__2_6_0__to__3_0_0(asyncapi, options) {
     var _a;
     asyncapi.asyncapi = '3.0.0';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@asyncapi/converter",
-	"version": "1.6.2",
+	"version": "2.0.0",
 	"description": "Convert AsyncAPI documents from older to newer versions.",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -40,14 +40,13 @@
 	"dependencies": {
 		"@asyncapi/parser": "^3.1.0",
 		"js-yaml": "^3.14.1",
-		"path": "^0.12.7",
-		"postman2openapi": "^1.2.1"
+		"path": "^0.12.7"
 	},
 	"devDependencies": {
 		"@jest/types": "^27.5.1",
 		"@types/jest": "^27.4.1",
 		"@types/js-yaml": "^4.0.5",
-		"conventional-changelog-conventionalcommits": "^5.0.0",
+		"conventional-changelog-conventionalcommits": "^9.1.0",
 		"cross-env": "^7.0.3",
 		"jest": "^27.5.1",
 		"markdown-toc": "^1.2.0",

package/lib/postman-collection.d.ts

@@ -1,2 +0,0 @@
-import { ConvertPostmanFunction } from 'interfaces';
-export declare const converters: Record<string, ConvertPostmanFunction>;

package/lib/postman-collection.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.converters = void 0;
-const postman2openapi_1 = require("postman2openapi");
-const openapi_1 = require("./openapi");
-exports.converters = {
-    '3.0.0': from_postman_to_asyncapi
-};
-function from_postman_to_asyncapi(postman, options = {}) {
-    const perspective = options.perspective;
-    const openapi = (0, postman2openapi_1.transpile)(postman);
-    const asyncapi = (0, openapi_1.from_openapi_to_asyncapi)(openapi, { perspective: perspective });
-    return asyncapi;
-}