wrekenfile-converter 2.0.3 → 2.0.6

package/README.md

@@ -77,49 +77,79 @@ const variables = {}; // Optionally provide Postman environment variables
 const wrekenfileYaml = generateWrekenfileFromPostman(collection, variables);
 ```
 
----
+### Validate a Wrekenfile
 
-## CLI: Convert Postman Collection to Wrekenfile (Local/Dev Only)
+```typescript
+import { validateWrekenfile } from 'wrekenfile-converter';
 
-A standalone CLI script is provided for local development to convert a Postman collection JSON to a Wrekenfile YAML file. This script is **not included in the published library** and is safe to use only in your own repo.
+const result = validateWrekenfile('./Wrekenfile.yaml');
+console.log(result.isValid ? '✅ Valid' : '❌ Invalid');
+console.log(result.errors, result.warnings);
+```
 
-**Usage:**
+### Generate Mini Wrekenfiles
 
-```bash
-npx ts-node src/cli/cli-postman-to-wrekenfile.ts <postman_collection.json> <output_wrekenfile.yaml> [postman_environment.json]
+```typescript
+import { generateMiniWrekenfiles, MiniWrekenfile } from 'wrekenfile-converter';
+
+const miniFiles: MiniWrekenfile[] = generateMiniWrekenfiles('./Wrekenfile.yaml');
+// Each miniFile contains { content, metadata }
 ```
 
-Real example
+## CLI Tools
 
-```
-npx ts-node src/cli/cli-postman-to-wrekenfile.ts examples/transact_bridge_postman.json wrekenfile.yaml
+### Convert OpenAPI to Wrekenfile
+
+Generate a Wrekenfile YAML from an OpenAPI (YAML or JSON) spec:
+
+```bash
+npx ts-node src/cli/cli-openapi-to-wrekenfile.ts --input <openapi.yaml|json> [--output <wrekenfile.yaml>] [--cwd <dir>]
 ```
 
-- The third argument (environment file) is optional.
-- Prints helpful usage and error messages.
-- Does not affect library builds or usage as a dependency.
+**Options:**
+- `--input` or `-i`: Path to your OpenAPI YAML or JSON file (required)
+- `--output` or `-o`: Path to output Wrekenfile YAML (optional, defaults to `output_wrekenfile.yaml`)
+- `--cwd`: Working directory for resolving $refs (optional, defaults to the input file's directory)
 
----
+**Example:**
+```bash
+npx ts-node src/cli/cli-openapi-to-wrekenfile.ts --input examples/p3id_swagger.json --output wrekenfile.yaml --cwd .
+```
 
-### Validate a Wrekenfile
+### Convert Postman Collection to Wrekenfile
 
-```typescript
-import { validateWrekenfile } from 'wrekenfile-converter';
+Convert a Postman collection JSON to a Wrekenfile YAML file:
 
-const result = validateWrekenfile('./Wrekenfile.yaml');
-console.log(result.isValid ? '✅ Valid' : '❌ Invalid');
-console.log(result.errors, result.warnings);
+```bash
+npx ts-node src/cli/cli-postman-to-wrekenfile.ts <postman_collection.json> <output_wrekenfile.yaml> [postman_environment.json]
 ```
 
+**Example:**
+```bash
+npx ts-node src/cli/cli-postman-to-wrekenfile.ts examples/transact_bridge_postman.json wrekenfile.yaml
+```
+
+**Note:** The third argument (environment file) is optional.
+
 ### Generate Mini Wrekenfiles
 
-```typescript
-import { generateMiniWrekenfiles, MiniWrekenfile } from 'wrekenfile-converter';
+Generate mini Wrekenfiles for each endpoint from a main Wrekenfile YAML:
 
-const miniFiles: MiniWrekenfile[] = generateMiniWrekenfiles('./Wrekenfile.yaml');
-// Each miniFile contains { content, metadata }
+```bash
+npx ts-node src/cli/cli-mini-wrekenfile-generator.ts --input <wrekenfile.yaml> [--output <dir>]
+```
+
+**Options:**
+- `--input` or `-i`: Path to your main Wrekenfile YAML (required)
+- `--output` or `-o`: Output directory for mini Wrekenfiles (optional, defaults to `./mini-wrekenfiles`)
+
+**Example:**
+```bash
+npx ts-node src/cli/cli-mini-wrekenfile-generator.ts --input wrekenfile.yaml --output ./mini-wrekenfiles
 ```
 
+This will generate one mini Wrekenfile per endpoint in the specified output directory.
+
 ## API Reference
 
 ### Core Functions
@@ -191,6 +221,10 @@ src/
 ├── postman-to-wrekenfile.ts    # Postman converter
 ├── wrekenfile-validator.ts     # Validation logic
 ├── mini-wrekenfile-generator.ts # Mini chunk generator
+├── cli/                        # CLI tools
+│   ├── cli-openapi-to-wrekenfile.ts
+│   ├── cli-postman-to-wrekenfile.ts
+│   └── cli-mini-wrekenfile-generator.ts
 └── example-usage.ts            # Usage examples
 
 dist/                           # Compiled JavaScript + types
@@ -206,43 +240,4 @@ mini-wrekenfiles/               # Generated mini chunks (if you save them)
 
 ## License
 
-MIT 
-
-# Wrekenfile Tools
-
-## Generate Wrekenfile from OpenAPI
-
-You can generate a Wrekenfile YAML from an OpenAPI (YAML or JSON) spec using the CLI:
-
-```
-npx ts-node src/cli/cli-openapi-to-wrekenfile.ts --input <openapi.yaml|json> [--output <wrekenfile.yaml>] [--cwd <dir>]
-```
-
-- `--input` or `-i`: Path to your OpenAPI YAML or JSON file (required)
-- `--output` or `-o`: Path to output Wrekenfile YAML (optional, defaults to `output_wrekenfile.yaml`)
-- `--cwd`: Working directory for resolving $refs (optional, defaults to the input file's directory)
-
-**Example:**
-```
-npx ts-node src/cli/cli-openapi-to-wrekenfile.ts --input examples/p3id_swagger.json --output wrekenfile.yaml --cwd .
-```
-
----
-
-## Generate Mini Wrekenfiles from a Wrekenfile
-
-You can generate mini Wrekenfiles for each endpoint from a main Wrekenfile YAML using the CLI:
-
-```
-npx ts-node src/cli/cli-mini-wrekenfile-generator.ts --input <wrekenfile.yaml> [--output <dir>]
-```
-
-- `--input` or `-i`: Path to your main Wrekenfile YAML (required)
-- `--output` or `-o`: Output directory for mini Wrekenfiles (optional, defaults to `./mini-wrekenfiles`)
-
-**Example:**
-```
-npx ts-node src/cli/cli-mini-wrekenfile-generator.ts --input wrekenfile.yaml --output ./mini-wrekenfiles
-```
-
-This will generate one mini Wrekenfile per endpoint in the specified output directory. 
+MIT 

package/dist/openapi-to-wreken.js

@@ -256,39 +256,41 @@ function extractStructs(spec, baseDir) {
         }
     }
     // Extract inline schemas from operations
-    for (const [pathStr, methods] of Object.entries(spec.paths)) {
-        for (const [method, op] of Object.entries(methods)) {
-            const operationId = op.operationId || `${method}-${pathStr.replace(/[\/{}]/g, '-')}`;
-            // Extract request body schemas
-            if ((_b = op.requestBody) === null || _b === void 0 ? void 0 : _b.content) {
-                for (const [contentType, content] of Object.entries(op.requestBody.content)) {
-                    if (content && content.schema) {
-                        if (content.schema && content.schema.$ref) {
-                            const refName = content.schema.$ref.split('/').pop();
-                            if (refName)
-                                collectAllReferencedSchemas(resolveRef(content.schema.$ref, spec, baseDir), refName);
-                        }
-                        else if (content.schema && typeof content.schema === 'object') {
-                            const requestStructName = generateStructName(operationId, method, pathStr, 'Request');
-                            collectAllReferencedSchemas(content.schema, requestStructName);
+    if (spec.paths && typeof spec.paths === 'object') {
+        for (const [pathStr, methods] of Object.entries(spec.paths)) {
+            for (const [method, op] of Object.entries(methods)) {
+                const operationId = op.operationId || `${method}-${pathStr.replace(/[\/{}]/g, '-')}`;
+                // Extract request body schemas
+                if ((_b = op.requestBody) === null || _b === void 0 ? void 0 : _b.content) {
+                    for (const [contentType, content] of Object.entries(op.requestBody.content)) {
+                        if (content && content.schema) {
+                            if (content.schema && content.schema.$ref) {
+                                const refName = content.schema.$ref.split('/').pop();
+                                if (refName)
+                                    collectAllReferencedSchemas(resolveRef(content.schema.$ref, spec, baseDir), refName);
+                            }
+                            else if (content.schema && typeof content.schema === 'object') {
+                                const requestStructName = generateStructName(operationId, method, pathStr, 'Request');
+                                collectAllReferencedSchemas(content.schema, requestStructName);
+                            }
                         }
                     }
                 }
-            }
-            // Extract response schemas
-            if (op.responses) {
-                for (const [code, response] of Object.entries(op.responses)) {
-                    if (response && response.content) {
-                        for (const [contentType, content] of Object.entries(response.content)) {
-                            if (content && content.schema) {
-                                if (content.schema && content.schema.$ref) {
-                                    const refName = content.schema.$ref.split('/').pop();
-                                    if (refName)
-                                        collectAllReferencedSchemas(resolveRef(content.schema.$ref, spec, baseDir), refName);
-                                }
-                                else if (content.schema && typeof content.schema === 'object') {
-                                    const responseStructName = generateStructName(operationId, method, pathStr, `Response${code}`);
-                                    collectAllReferencedSchemas(content.schema, responseStructName);
+                // Extract response schemas
+                if (op.responses) {
+                    for (const [code, response] of Object.entries(op.responses)) {
+                        if (response && response.content) {
+                            for (const [contentType, content] of Object.entries(response.content)) {
+                                if (content && content.schema) {
+                                    if (content.schema && content.schema.$ref) {
+                                        const refName = content.schema.$ref.split('/').pop();
+                                        if (refName)
+                                            collectAllReferencedSchemas(resolveRef(content.schema.$ref, spec, baseDir), refName);
+                                    }
+                                    else if (content.schema && typeof content.schema === 'object') {
+                                        const responseStructName = generateStructName(operationId, method, pathStr, `Response${code}`);
+                                        collectAllReferencedSchemas(content.schema, responseStructName);
+                                    }
                                 }
                             }
                         }
@@ -488,6 +490,11 @@ function extractInterfaces(spec, baseDir) {
     const interfaces = {};
     // Valid HTTP methods
     const validMethods = ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'];
+    // Check if paths exists and is an object
+    if (!spec.paths || typeof spec.paths !== 'object') {
+        console.warn('Warning: No paths found in OpenAPI specification');
+        return interfaces;
+    }
     for (const [pathStr, methods] of Object.entries(spec.paths)) {
         for (const [method, op] of Object.entries(methods)) {
             // Skip extension fields (x-*) and only process valid HTTP methods

package/dist/openapi-v2-to-wrekenfile.js

@@ -427,8 +427,8 @@ function extractInterfaces(spec) {
             const returns = extractResponses(op, operationId, method, pathStr);
             interfaces[alias] = {
                 SUMMARY: op.summary || '',
-                DESCRIPTION: op.description || '',
                 DESC: generateDesc(op, method, pathStr),
+                TAGS: Array.isArray(op.tags) ? op.tags : [],
                 ENDPOINT: endpoint,
                 VISIBILITY: visibility,
                 HTTP: {

package/dist/postman-to-wrekenfile.js

@@ -70,11 +70,23 @@ function mapType(value) {
         return 'ANY';
     return 'ANY';
 }
+function getItemDescription(item) {
+    var _a, _b, _c, _d, _e;
+    let description = (_c = (_a = item === null || item === void 0 ? void 0 : item.description) !== null && _a !== void 0 ? _a : (_b = item === null || item === void 0 ? void 0 : item.request) === null || _b === void 0 ? void 0 : _b.description) !== null && _c !== void 0 ? _c : (_e = (_d = item === null || item === void 0 ? void 0 : item.request) === null || _d === void 0 ? void 0 : _d.body) === null || _e === void 0 ? void 0 : _e.description;
+    if (!description)
+        return '';
+    // Postman can store description as an object with { content: string }
+    if (typeof description === 'object' && typeof description.content === 'string') {
+        description = description.content;
+    }
+    if (typeof description !== 'string')
+        return '';
+    return description.replace(/<[^>]*>/g, '').replace(/\n+/g, ' ').trim();
+}
 function generateDesc(item, method, path) {
-    if (item.description) {
-        // Remove HTML tags and clean up description
-        return item.description.replace(/<[^>]*>/g, '').replace(/\n+/g, ' ').trim();
-    }
+    const cleaned = getItemDescription(item);
+    if (cleaned)
+        return cleaned;
     return `${method.toUpperCase()} ${path}`;
 }
 function generateStructName(itemName, method, path, suffix) {
@@ -423,12 +435,13 @@ function extractOperations(collection, variables) {
             return `${name} ${operationNameCount[name]}`;
         }
     }
-    function processItem(item) {
+    function processItem(item, parentName = null) {
         if (item.request) {
             const method = item.request.method || 'GET';
             const url = item.request.url;
             const path = extractPathFromUrl(url, variables);
             const itemName = item.name || 'unknown';
+            const immediateParentName = parentName || null;
             // Generate operation ID
             let operationId = itemName.toLowerCase().replace(/[^a-z0-9]/g, '-');
             operationId = getUniqueOperationName(operationId);
@@ -444,8 +457,8 @@ function extractOperations(collection, variables) {
             operations.push({
                 name: operationId,
                 SUMMARY: itemName || '',
-                DESCRIPTION: item.description ? item.description.replace(/<[^>]*>/g, '').replace(/\n+/g, ' ').trim() : '',
                 DESC: generateDesc(item, method, path),
+                TAGS: immediateParentName ? [immediateParentName] : (itemName ? [itemName] : []),
                 ENDPOINT: `"/${path}"`,
                 VISIBILITY: 'PUBLIC',
                 HTTP: {
@@ -459,12 +472,12 @@ function extractOperations(collection, variables) {
         }
         if (item.item) {
             for (const subItem of item.item) {
-                processItem(subItem);
+                processItem(subItem, item.name || parentName || null);
             }
         }
     }
     for (const item of collection.item) {
-        processItem(item);
+        processItem(item, null);
     }
     return operations;
 }
@@ -531,9 +544,24 @@ function generateWrekenfile(collection, variables) {
     wrekenfile += `INTERFACES:\n`;
     for (const operation of operations) {
         wrekenfile += `  ${operation.name}:\n`;
-        wrekenfile += `    SUMMARY: ${operation.SUMMARY}\n`;
-        wrekenfile += `    DESCRIPTION: ${operation.DESCRIPTION}\n`;
-        wrekenfile += `    DESC: ${operation.DESC}\n`;
+        // Quote SUMMARY and DESC if they contain special characters
+        const summary = operation.SUMMARY.includes(':') || operation.SUMMARY.includes('"') ? `"${operation.SUMMARY.replace(/"/g, '\\"')}"` : operation.SUMMARY;
+        const desc = operation.DESC.includes(':') || operation.DESC.includes('"') ? `"${operation.DESC.replace(/"/g, '\\"')}"` : operation.DESC;
+        wrekenfile += `    SUMMARY: ${summary}\n`;
+        wrekenfile += `    DESC: ${desc}\n`;
+        // TAGS
+        if (!operation.TAGS || operation.TAGS.length === 0) {
+            wrekenfile += `    TAGS: []\n`;
+        }
+        else {
+            wrekenfile += `    TAGS:\n`;
+            for (const tag of operation.TAGS) {
+                const tagVal = (typeof tag === 'string' && (tag.includes(':') || tag.includes('"')))
+                    ? `"${String(tag).replace(/"/g, '\\"')}"`
+                    : String(tag);
+                wrekenfile += `      - ${tagVal}\n`;
+            }
+        }
         wrekenfile += `    ENDPOINT: ${operation.ENDPOINT}\n`;
         wrekenfile += `    VISIBILITY: ${operation.VISIBILITY}\n`;
         wrekenfile += `    HTTP:\n`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrekenfile-converter",
-  "version": "2.0.3",
+  "version": "2.0.6",
   "description": "Convert OpenAPI and Postman specs to Wrekenfile format with mini-chunking for vector DB storage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",