@scalar/postman-to-openapi 0.1.49 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @scalar/postman-to-openapi
 
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [18b1be9]
+  - @scalar/oas-utils@0.2.128
+
+## 0.2.0
+
+### Minor Changes
+
+- 018e8b2: feat: import Postman post-response scripts
+
+### Patch Changes
+
+- 018e8b2: feat: cleaner Postman import (no 'default' tag, no made up responses)
+- 018e8b2: fix: /raw and / paths are handled specifically
+- Updated dependencies [bf961b1]
+- Updated dependencies [a176b7e]
+  - @scalar/oas-utils@0.2.127
+
 ## 0.1.49
 
 ### Patch Changes

package/dist/convert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AASxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AA2BhD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,MAAM,GAAG,WAAW,CAAC,QAAQ,CAsK3F"}
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AASxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AA2BhD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,MAAM,GAAG,WAAW,CAAC,QAAQ,CA+J3F"}

package/dist/convert.js

@@ -88,17 +88,8 @@ export function convert(postmanCollection) {
             for (const [pathKey, pathItem] of Object.entries(itemPaths)) {
                 // Convert colon-style params to curly brace style
                 const normalizedPathKey = normalizePath(pathKey);
-                /**
-                 * this is a bit of a hack to skip empty paths only if they have no parameters
-                 * because there is a test where if I remove the empty path it breaks the test
-                 * but there is another test where if I leave the empty path it breaks the test
-                 * so I added this check to only remove the empty path if all the methods on it have no parameters
-                 */
-                if (normalizedPathKey === '/') {
-                    const allMethodsHaveEmptyParams = Object.values(pathItem || {}).every((method) => !method.parameters || method.parameters.length === 0);
-                    if (allMethodsHaveEmptyParams) {
-                        continue;
-                    }
+                if (!pathItem) {
+                    continue;
                 }
                 if (!openapi.paths[normalizedPathKey]) {
                     openapi.paths[normalizedPathKey] = pathItem;
@@ -109,18 +100,6 @@ export function convert(postmanCollection) {
                         ...pathItem,
                     };
                 }
-                // Handle the /raw endpoint specifically
-                if (normalizedPathKey === '/raw' && pathItem?.post) {
-                    if (pathItem.post.requestBody?.content['text/plain']) {
-                        pathItem.post.requestBody.content['application/json'] = {
-                            schema: {
-                                type: 'object',
-                                examples: [],
-                            },
-                        };
-                        delete pathItem.post.requestBody.content['text/plain'];
-                    }
-                }
             }
             // Merge security schemes from the current item
             if (itemComponents?.securitySchemes) {
@@ -173,5 +152,17 @@ export function convert(postmanCollection) {
     if (Object.keys(openapi.components || {}).length === 0) {
         delete openapi.components;
     }
-    return openapi;
+    // Remove undefined properties recursively
+    const removeUndefined = (obj) => {
+        if (Array.isArray(obj)) {
+            return obj.map(removeUndefined).filter((item) => item !== undefined);
+        }
+        if (obj && typeof obj === 'object') {
+            return Object.fromEntries(Object.entries(obj)
+                .map(([key, value]) => [key, removeUndefined(value)])
+                .filter(([_, value]) => value !== undefined));
+        }
+        return obj;
+    };
+    return removeUndefined(openapi);
 }

package/dist/helpers/itemHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"itemHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/itemHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAU/C;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtB,UAAU,GAAE,MAAM,EAAO,EACzB,UAAU,GAAE,MAAW,GACtB;IACD,KAAK,EAAE,WAAW,CAAC,WAAW,CAAA;IAC9B,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAA;CACzC,CAqIA"}
+{"version":3,"file":"itemHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/itemHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAW/C;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtB,UAAU,GAAE,MAAM,EAAO,EACzB,UAAU,GAAE,MAAW,GACtB;IACD,KAAK,EAAE,WAAW,CAAC,WAAW,CAAA;IAC9B,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAA;CACzC,CA2IA"}

package/dist/helpers/itemHelpers.js

@@ -1,6 +1,7 @@
 import { processAuth } from './authHelpers.js';
 import { parseMdTable } from './md-utils.js';
 import { extractParameters } from './parameterHelpers.js';
+import { processPostResponseScripts } from './postResponseScripts.js';
 import { extractRequestBody } from './requestBodyHelpers.js';
 import { extractResponses } from './responseHelpers.js';
 import { extractPathFromUrl, extractPathParameterNames, normalizePath } from './urlHelpers.js';
@@ -57,12 +58,17 @@ export function processItem(item, parentTags = [], parentPath = '') {
             ? request.description
             : (request.description?.content ?? '');
     const operationObject = {
-        tags: parentTags.length > 0 ? [parentTags.join(' > ')] : ['default'],
+        tags: parentTags.length > 0 ? [parentTags.join(' > ')] : undefined,
         summary,
         description,
         responses: extractResponses(response || [], item),
         parameters: [],
     };
+    // Add post-response scripts if present
+    const postResponseScript = processPostResponseScripts(item.event);
+    if (postResponseScript) {
+        operationObject['x-post-response'] = postResponseScript;
+    }
     // Only add operationId if it was explicitly provided
     if (operationId) {
         operationObject.operationId = operationId;

package/dist/helpers/postResponseScripts.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Processes Postman test scripts and converts them to OpenAPI x-post-response extension
+ */
+export declare function processPostResponseScripts(events?: any[]): string | undefined;
+//# sourceMappingURL=postResponseScripts.d.ts.map

package/dist/helpers/postResponseScripts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postResponseScripts.d.ts","sourceRoot":"","sources":["../../src/helpers/postResponseScripts.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,GAAE,GAAG,EAAO,GAAG,MAAM,GAAG,SAAS,CASjF"}

package/dist/helpers/postResponseScripts.js

@@ -0,0 +1,12 @@
+/**
+ * Processes Postman test scripts and converts them to OpenAPI x-post-response extension
+ */
+export function processPostResponseScripts(events = []) {
+    // Find test event
+    const testEvent = events.find((event) => event.listen === 'test');
+    if (!testEvent?.script?.exec) {
+        return undefined;
+    }
+    // Join script lines into a single string
+    return testEvent.script.exec.join('\n').trim();
+}

package/dist/helpers/responseHelpers.d.ts

@@ -5,5 +5,5 @@ import type { Item, Response } from '../types.js';
  * Processes response status codes, descriptions, headers, and body content,
  * inferring schemas from example responses when possible.
  */
-export declare function extractResponses(responses: Response[], item?: Item): OpenAPIV3_1.ResponsesObject;
+export declare function extractResponses(responses: Response[], item?: Item): OpenAPIV3_1.ResponsesObject | undefined;
 //# sourceMappingURL=responseHelpers.d.ts.map

package/dist/helpers/responseHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responseHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/responseHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAc,IAAI,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAI1D;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC,eAAe,CA8ChG"}
+{"version":3,"file":"responseHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/responseHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAc,IAAI,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAI1D;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC,eAAe,GAAG,SAAS,CAwC5G"}

package/dist/helpers/responseHelpers.js

@@ -37,14 +37,8 @@ export function extractResponses(responses, item) {
             };
         }
     });
-    // If no responses and no status codes, return default 200
     if (Object.keys(responseMap).length === 0) {
-        responseMap['200'] = {
-            description: 'Successful response',
-            content: {
-                'application/json': {},
-            },
-        };
+        return undefined;
     }
     return responseMap;
 }

package/package.json

@@ -19,7 +19,7 @@
     "export",
     "scalar"
   ],
-  "version": "0.1.49",
+  "version": "0.2.1",
   "engines": {
     "node": ">=18"
   },
@@ -38,8 +38,8 @@
   ],
   "module": "dist/index.js",
   "dependencies": {
-    "@scalar/oas-utils": "0.2.126",
-    "@scalar/openapi-types": "0.2.0"
+    "@scalar/openapi-types": "0.2.0",
+    "@scalar/oas-utils": "0.2.128"
   },
   "devDependencies": {
     "vite": "^5.4.10",