@asyncapi/converter 1.5.0 → 1.6.0

package/README.md

@@ -17,7 +17,8 @@ Convert [AsyncAPI](https://asyncapi.com) documents older to newer versions and y
   * [In TS](#in-ts)
 - [Conversion 2.x.x to 3.x.x](#conversion-2xx-to-3xx)
 - [Known missing features](#known-missing-features)
-- [OpenAPI 3.0 to AsyncAPI 3.0 Conversion](#openapi-30-to-asyncapi-30-conversion)
+  * [OpenAPI 3.0 to AsyncAPI 3.0 Conversion](#openapi-30-to-asyncapi-30-conversion)
+    + [Limitations](#limitations)
 - [Development](#development)
 - [Contribution](#contribution)
 - [Contributors ✨](#contributors-%E2%9C%A8)
@@ -195,7 +196,7 @@ Conversion to version `3.x.x` from `2.x.x` has several assumptions that should b
         examples: ["test"]
   ```
 
-### OpenAPI 3.0 to AsyncAPI 3.0 Conversion
+## OpenAPI 3.0 to AsyncAPI 3.0 Conversion
 
 The converter now supports transformation from OpenAPI 3.0 to AsyncAPI 3.0. This feature enables easy transition of existing OpenAPI 3.0 documents to AsyncAPI 3.0.
 
@@ -203,11 +204,11 @@ To use this new conversion feature:
 
 ```js
 const fs = require('fs');
-const { convert } = require('@asyncapi/converter')
+const { convertOpenAPI } = require('@asyncapi/converter')
 
 try {
   const openapi = fs.readFileSync('openapi.yml', 'utf-8')
-  const asyncapi = convert(openapi, '3.0.0', { from: 'openapi' });
+  const asyncapi = convertOpenAPI(openapi, '3.0.0', { from: 'openapi' });
   console.log(asyncapi);
 } catch (e) {
   console.error(e);
@@ -217,11 +218,11 @@ try {
 When converting from OpenAPI 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 { convert } = require('@asyncapi/converter')
+const { convertOpenAPI } = require('@asyncapi/converter')
 
 try {
   const asyncapi2 = fs.readFileSync('asyncapi2.yml', 'utf-8')
-  const asyncapi3 = convert(asyncapi2, '3.0.0', { openAPIToAsyncAPI: { perspective: 'client' } });
+  const asyncapi3 = convertOpenAPI(asyncapi2, '3.0.0', { openAPIToAsyncAPI: { perspective: 'client' } });
   console.log(asyncapi3);
 } catch (e) {
   console.error(e);
@@ -238,6 +239,48 @@ 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`
@@ -275,4 +318,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/lib/convert.d.ts

@@ -1,5 +1,7 @@
-import type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions, OpenAPIDocument, OpenAPIToAsyncAPIOptions } from './interfaces';
+import type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions, OpenAPIDocument, OpenAPIToAsyncAPIOptions, PostmanToAsyncAPIOptions } 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,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertOpenAPI = exports.convert = void 0;
+exports.convertPostman = 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.
@@ -57,3 +58,13 @@ 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 } from './convert';
+export { convert, convertOpenAPI } from './convert';
 export type { AsyncAPIDocument, AsyncAPIConvertVersion, OpenAPIConvertVersion, ConvertOptions } from './interfaces';

package/lib/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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; } });

package/lib/interfaces.d.ts

@@ -29,9 +29,14 @@ 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/openapi.d.ts

@@ -1,2 +1,9 @@
-import { ConvertOpenAPIFunction } from "./interfaces";
+import { AsyncAPIDocument, ConvertOpenAPIFunction, OpenAPIToAsyncAPIOptions, OpenAPIDocument } from "./interfaces";
 export declare const converters: Record<string, ConvertOpenAPIFunction>;
+/**
+ * Converts an OpenAPI document to an AsyncAPI document.
+ * @param {OpenAPIDocument} openapi - The OpenAPI document to convert.
+ * @param {ConvertOptions} options - Conversion options.
+ * @returns {AsyncAPIDocument} The converted AsyncAPI document.
+ */
+export declare function from_openapi_to_asyncapi(openapi: OpenAPIDocument, options?: OpenAPIToAsyncAPIOptions): AsyncAPIDocument;

package/lib/openapi.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.converters = void 0;
+exports.from_openapi_to_asyncapi = exports.converters = void 0;
 const utils_1 = require("./utils");
 exports.converters = {
     '3.0.0': from_openapi_to_asyncapi,
@@ -27,6 +27,7 @@ function from_openapi_to_asyncapi(openapi, options = {}) {
     (0, utils_1.removeEmptyObjects)(asyncapi);
     return (0, utils_1.sortObjectKeys)(asyncapi, ['asyncapi', 'info', 'defaultContentType', 'servers', 'channels', 'operations', 'components']);
 }
+exports.from_openapi_to_asyncapi = from_openapi_to_asyncapi;
 /**
  * Converts openAPI info objects to asyncAPI info objects.
  * @param info - The openAPI info object to convert.

package/lib/postman-collection.d.ts

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

package/lib/postman-collection.js

@@ -0,0 +1,14 @@
+"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;
+}

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import type { AsyncAPIDocument, OpenAPIDocument } from "./interfaces";
-export declare function serializeInput(document: string | AsyncAPIDocument | OpenAPIDocument): {
+export declare function serializeInput(document: string | AsyncAPIDocument | OpenAPIDocument | Record<string, any>): {
     format: 'json' | 'yaml';
     document: AsyncAPIDocument | OpenAPIDocument;
 } | never;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@asyncapi/converter",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"description": "Convert AsyncAPI documents from older to newer versions.",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -39,7 +39,9 @@
 	"license": "Apache-2.0",
 	"dependencies": {
 		"@asyncapi/parser": "^3.1.0",
-		"js-yaml": "^3.14.1"
+		"js-yaml": "^3.14.1",
+		"path": "^0.12.7",
+		"postman2openapi": "^1.2.1"
 	},
 	"devDependencies": {
 		"@jest/types": "^27.5.1",