wrekenfile-converter 2.0.6 → 2.1.0

package/dist/v2/utils/constants.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Wrekenfile version to use for v2 converters
+ */
+export declare const WREKENFILE_VERSION = "2.1.0";
+/**
+ * Default base URL when none can be extracted
+ */
+export declare const DEFAULT_BASE_URL = "https://api.default.com";
+/**
+ * Common base URL variable names in Postman collections
+ */
+export declare const BASE_URL_VARIABLE_NAMES: string[];
+/**
+ * Sensitive keys that should be masked in DEFAULTS
+ */
+export declare const SENSITIVE_KEYS: string[];
+/**
+ * YAML dump options
+ */
+export declare const YAML_DUMP_OPTIONS: {
+    indent: number;
+    lineWidth: number;
+    noRefs: boolean;
+    sortKeys: boolean;
+    quotingType: "\"";
+    forceQuotes: boolean;
+};
+/**
+ * Execution mode constants
+ */
+export declare const EXECUTION_MODE_ASYNC = "async";
+/**
+ * ASYNC section constants
+ */
+export declare const ASYNC_RETURNS_RESULT = "result";
+/**
+ * Type constants
+ */
+export declare const TYPE_VOID = "VOID";
+export declare const TYPE_ANY = "ANY";
+/**
+ * Body type constants
+ */
+export declare const BODYTYPE_RAW = "raw";
+/**
+ * Default HTTP scheme
+ */
+export declare const DEFAULT_HTTP_SCHEME = "https";
+/**
+ * YAML document separators to remove
+ */
+export declare const YAML_DOCUMENT_SEPARATOR_START = "---";
+export declare const YAML_DOCUMENT_SEPARATOR_END = "...";
+export declare const YAML_SEPARATOR_LINES: string[];
+/**
+ * Method group type prefixes
+ */
+export declare const GROUP_PREFIX_HTTP = "http:";
+export declare const GROUP_PREFIX_SDK = "sdk:";
+export declare const GROUP_PREFIX_OTHER = "other:";
+/**
+ * Mini-wrekenfile filename prefix
+ */
+export declare const MINI_FILENAME_PREFIX = "mini-";
+/**
+ * YAML file extension
+ */
+export declare const YAML_EXTENSION = ".yaml";
+/**
+ * Default mini-wrekenfiles output directory
+ */
+export declare const DEFAULT_MINI_OUTPUT_DIR = "./mini-wrekenfiles";
+/**
+ * Filename sanitization regex patterns
+ */
+export declare const FILENAME_INVALID_CHARS: RegExp;
+export declare const FILENAME_MULTIPLE_HYPHENS: RegExp;
+export declare const FILENAME_LEADING_TRAILING_HYPHENS: RegExp;
+export declare const FILENAME_LEADING_SLASHES: RegExp;
+export declare const FILENAME_TRAILING_SLASHES: RegExp;

package/dist/v2/utils/constants.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FILENAME_TRAILING_SLASHES = exports.FILENAME_LEADING_SLASHES = exports.FILENAME_LEADING_TRAILING_HYPHENS = exports.FILENAME_MULTIPLE_HYPHENS = exports.FILENAME_INVALID_CHARS = exports.DEFAULT_MINI_OUTPUT_DIR = exports.YAML_EXTENSION = exports.MINI_FILENAME_PREFIX = exports.GROUP_PREFIX_OTHER = exports.GROUP_PREFIX_SDK = exports.GROUP_PREFIX_HTTP = exports.YAML_SEPARATOR_LINES = exports.YAML_DOCUMENT_SEPARATOR_END = exports.YAML_DOCUMENT_SEPARATOR_START = exports.DEFAULT_HTTP_SCHEME = exports.BODYTYPE_RAW = exports.TYPE_ANY = exports.TYPE_VOID = exports.ASYNC_RETURNS_RESULT = exports.EXECUTION_MODE_ASYNC = exports.YAML_DUMP_OPTIONS = exports.SENSITIVE_KEYS = exports.BASE_URL_VARIABLE_NAMES = exports.DEFAULT_BASE_URL = exports.WREKENFILE_VERSION = void 0;
+/**
+ * Shared constants for v2 converters
+ */
+const versions_1 = require("../../versions");
+/**
+ * Wrekenfile version to use for v2 converters
+ */
+exports.WREKENFILE_VERSION = versions_1.WREKENFILE_V2_VERSION;
+/**
+ * Default base URL when none can be extracted
+ */
+exports.DEFAULT_BASE_URL = 'https://api.default.com';
+/**
+ * Common base URL variable names in Postman collections
+ */
+exports.BASE_URL_VARIABLE_NAMES = [
+    'url',
+    'baseUrl',
+    'base_url',
+    'baseURL',
+    'api_url',
+    'apiUrl',
+];
+/**
+ * Sensitive keys that should be masked in DEFAULTS
+ */
+exports.SENSITIVE_KEYS = [
+    'api_key',
+    'api-key',
+    'x-api-key',
+    'signature',
+    'x-signature',
+    'authorization',
+    'token',
+    'password',
+    'secret',
+];
+/**
+ * YAML dump options
+ */
+exports.YAML_DUMP_OPTIONS = {
+    indent: 2,
+    lineWidth: -1,
+    noRefs: true,
+    sortKeys: false,
+    quotingType: '"',
+    forceQuotes: false,
+};
+/**
+ * Execution mode constants
+ */
+exports.EXECUTION_MODE_ASYNC = 'async';
+/**
+ * ASYNC section constants
+ */
+exports.ASYNC_RETURNS_RESULT = 'result';
+/**
+ * Type constants
+ */
+exports.TYPE_VOID = 'VOID';
+exports.TYPE_ANY = 'ANY';
+/**
+ * Body type constants
+ */
+exports.BODYTYPE_RAW = 'raw';
+/**
+ * Default HTTP scheme
+ */
+exports.DEFAULT_HTTP_SCHEME = 'https';
+/**
+ * YAML document separators to remove
+ */
+exports.YAML_DOCUMENT_SEPARATOR_START = '---';
+exports.YAML_DOCUMENT_SEPARATOR_END = '...';
+exports.YAML_SEPARATOR_LINES = ['===', '___'];
+/**
+ * Method group type prefixes
+ */
+exports.GROUP_PREFIX_HTTP = 'http:';
+exports.GROUP_PREFIX_SDK = 'sdk:';
+exports.GROUP_PREFIX_OTHER = 'other:';
+/**
+ * Mini-wrekenfile filename prefix
+ */
+exports.MINI_FILENAME_PREFIX = 'mini-';
+/**
+ * YAML file extension
+ */
+exports.YAML_EXTENSION = '.yaml';
+/**
+ * Default mini-wrekenfiles output directory
+ */
+exports.DEFAULT_MINI_OUTPUT_DIR = './mini-wrekenfiles';
+/**
+ * Filename sanitization regex patterns
+ */
+exports.FILENAME_INVALID_CHARS = /[^a-zA-Z0-9-_]/g;
+exports.FILENAME_MULTIPLE_HYPHENS = /-+/g;
+exports.FILENAME_LEADING_TRAILING_HYPHENS = /^-|-$/g;
+exports.FILENAME_LEADING_SLASHES = /^\/+/;
+exports.FILENAME_TRAILING_SLASHES = /\/+$/;

package/dist/v2/utils/response-utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Shared utilities for processing responses in v2 converters
+ */
+/**
+ * Generate descriptive RETURNVAR name based on operation and response code
+ */
+export declare function generateReturnVarName(operationId: string, code: string): string;
+/**
+ * Generate descriptive WHEN clause for error responses with HTTP status code
+ */
+export declare function generateErrorWhen(response: any, code: string): string;

package/dist/v2/utils/response-utils.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * Shared utilities for processing responses in v2 converters
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateReturnVarName = generateReturnVarName;
+exports.generateErrorWhen = generateErrorWhen;
+/**
+ * Generate descriptive RETURNVAR name based on operation and response code
+ */
+function generateReturnVarName(operationId, code) {
+    const baseName = operationId.replace(/([A-Z])/g, '_$1').toLowerCase().replace(/^_/, '');
+    if (code === '200') {
+        // For 200 OK, use operation name with _result suffix
+        return `${baseName}_result`;
+    }
+    else {
+        // For other 2xx codes (201, 202, etc.), use operation name with status code
+        return `${baseName}_${code}`;
+    }
+}
+/**
+ * Generate descriptive WHEN clause for error responses with HTTP status code
+ */
+function generateErrorWhen(response, code) {
+    const statusCode = parseInt(code);
+    if (response && typeof response === 'object' && response.description) {
+        return `${response.description} (HTTP ${code})`;
+    }
+    else if (statusCode >= 400 && statusCode < 500) {
+        return `Client error (HTTP ${code})`;
+    }
+    else if (statusCode >= 500) {
+        return `Server error (HTTP ${code})`;
+    }
+    else {
+        return `HTTP ${code}`;
+    }
+}

package/dist/v2/utils/yaml-utils.d.ts

@@ -0,0 +1,4 @@
+export declare function cleanYaml(yamlString: string): string;
+export declare function checkYamlForHiddenChars(yamlString: string): void;
+export declare function validateYaml(yamlString: string): void;
+export declare function removeTypeQuotes(yamlString: string): string;

package/dist/v2/utils/yaml-utils.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanYaml = cleanYaml;
+exports.checkYamlForHiddenChars = checkYamlForHiddenChars;
+exports.validateYaml = validateYaml;
+exports.removeTypeQuotes = removeTypeQuotes;
+const js_yaml_1 = require("js-yaml");
+const constants_1 = require("./constants");
+const TAB_REPLACEMENT = '  ';
+const NON_BREAKING_SPACE = '\u00A0';
+const NEWLINE = '\n';
+const DOUBLE_NEWLINE = '\n\n';
+const CONTROL_CHARS_REGEX = /[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/g;
+const TAB_REGEX = /\t/g;
+const NON_BREAKING_SPACE_REGEX = /[\u00A0]/g;
+const CRLF_REGEX = /\r\n/g;
+const TRAILING_WHITESPACE_REGEX = /[ \t]+$/gm;
+const EXCESSIVE_NEWLINES_REGEX = /\n{3,}/g;
+const LEADING_WHITESPACE_REGEX = /^\s+/;
+const TRAILING_WHITESPACE_NEWLINES_REGEX = /[\s\n]+$/;
+function cleanYaml(yamlString) {
+    let cleaned = yamlString
+        .replace(TAB_REGEX, TAB_REPLACEMENT)
+        .replace(NON_BREAKING_SPACE_REGEX, ' ')
+        .replace(CONTROL_CHARS_REGEX, '')
+        .replace(CRLF_REGEX, NEWLINE)
+        .replace(TRAILING_WHITESPACE_REGEX, '');
+    const lines = cleaned.split(NEWLINE);
+    const filteredLines = [];
+    let isFirstLine = true;
+    for (const line of lines) {
+        const trimmed = line.trim();
+        if (trimmed === constants_1.YAML_DOCUMENT_SEPARATOR_START && !isFirstLine) {
+            continue;
+        }
+        if (trimmed === constants_1.YAML_DOCUMENT_SEPARATOR_END) {
+            continue;
+        }
+        if (constants_1.YAML_SEPARATOR_LINES.includes(trimmed)) {
+            continue;
+        }
+        filteredLines.push(line);
+        if (trimmed !== '') {
+            isFirstLine = false;
+        }
+    }
+    cleaned = filteredLines.join(NEWLINE)
+        .replace(EXCESSIVE_NEWLINES_REGEX, DOUBLE_NEWLINE)
+        .replace(LEADING_WHITESPACE_REGEX, '')
+        .replace(TRAILING_WHITESPACE_NEWLINES_REGEX, '');
+    if (cleaned) {
+        cleaned += NEWLINE;
+    }
+    return cleaned;
+}
+function checkYamlForHiddenChars(yamlString) {
+    const lines = yamlString.split(NEWLINE);
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        const lineNum = i + 1;
+        if (TAB_REGEX.test(line)) {
+            throw new Error(`YAML contains a TAB character at line ${lineNum}:\n${line}`);
+        }
+        if (NON_BREAKING_SPACE_REGEX.test(line)) {
+            throw new Error(`YAML contains a non-breaking space (U+00A0) at line ${lineNum}:\n${line}`);
+        }
+        if (CONTROL_CHARS_REGEX.test(line)) {
+            throw new Error(`YAML contains a non-printable character at line ${lineNum}:\n${line}`);
+        }
+    }
+}
+function validateYaml(yamlString) {
+    try {
+        (0, js_yaml_1.load)(yamlString);
+    }
+    catch (e) {
+        throw new Error(`Generated YAML is invalid: ${e.message}`);
+    }
+}
+const BLOCK_SCALAR_REGEX = /^(\s+)(-?\s*)(TYPE|RETURNTYPE):\s*\|\-\s*\n(\s+)(\[\]STRUCT\([^)]+\)|\[\][A-Z]+)/gm;
+const STRUCT_QUOTED_REGEX = /(TYPE|RETURNTYPE):\s*"STRUCT\(([^)]+)\)"/g;
+const ARRAY_TYPE_REGEX = /^(\s+)(-?\s*)(TYPE|RETURNTYPE):\s*(\[\]STRUCT\([^)]+\)|\[\][A-Z]+)(\s*)$/gm;
+const QUOTE_START_REGEX = /^["']/;
+function removeTypeQuotes(yamlString) {
+    yamlString = yamlString.replace(BLOCK_SCALAR_REGEX, (match, indent, arrayPrefix, key, valueIndent, value) => {
+        return `${indent}${arrayPrefix}${key}: ${value}`;
+    });
+    yamlString = yamlString.replace(STRUCT_QUOTED_REGEX, '$1: STRUCT($2)');
+    yamlString = yamlString.replace(ARRAY_TYPE_REGEX, (match, indent, arrayPrefix, key, value, trailing) => {
+        if (!QUOTE_START_REGEX.test(value)) {
+            return `${indent}${arrayPrefix}${key}: "${value}"${trailing}`;
+        }
+        return match;
+    });
+    return yamlString;
+}

package/dist/versions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Wrekenfile version constants
+ */
+export declare const WREKENFILE_V1_VERSION = "1.2";
+export declare const WREKENFILE_V2_VERSION = "2.1.0";
+/**
+ * Get the default version (latest)
+ */
+export declare const DEFAULT_WREKENFILE_VERSION = "2.1.0";

package/dist/versions.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_WREKENFILE_VERSION = exports.WREKENFILE_V2_VERSION = exports.WREKENFILE_V1_VERSION = void 0;
+/**
+ * Wrekenfile version constants
+ */
+exports.WREKENFILE_V1_VERSION = '1.2';
+exports.WREKENFILE_V2_VERSION = '2.1.0';
+/**
+ * Get the default version (latest)
+ */
+exports.DEFAULT_WREKENFILE_VERSION = exports.WREKENFILE_V2_VERSION;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrekenfile-converter",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "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",
@@ -29,6 +29,9 @@
   "files": [
     "dist/**/*",
     "README.md",
+    "USAGE.md",
+    "LOCAL_TESTING.md",
+    "QUICK_START.md",
     "wrekenfile.md"
   ],
   "exports": {
@@ -37,20 +40,15 @@
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
-    "./converter": {
-      "import": "./dist/openapi-to-wreken.js",
-      "require": "./dist/openapi-to-wreken.js",
-      "types": "./dist/openapi-to-wreken.d.ts"
+    "./v1": {
+      "import": "./dist/v1/index.js",
+      "require": "./dist/v1/index.js",
+      "types": "./dist/v1/index.d.ts"
     },
-    "./converter-v2": {
-      "import": "./dist/openapi-v2-to-wrekenfile.js",
-      "require": "./dist/openapi-v2-to-wrekenfile.js",
-      "types": "./dist/openapi-v2-to-wrekenfile.d.ts"
-    },
-    "./converter-postman": {
-      "import": "./dist/postman-to-wrekenfile.js",
-      "require": "./dist/postman-to-wrekenfile.js",
-      "types": "./dist/postman-to-wrekenfile.d.ts"
+    "./v2": {
+      "import": "./dist/v2/index.js",
+      "require": "./dist/v2/index.js",
+      "types": "./dist/v2/index.d.ts"
     },
     "./validator": {
       "import": "./dist/wrekenfile-validator.js",

package/dist/openapi-to-wrekenfile.js

@@ -1,10 +0,0 @@
-"use strict";
-// Defensive fixes for OpenAPI v3 schema traversal
-// 1. Guard all property accesses ($ref, type, properties, items, allOf, oneOf, anyOf) with checks for existence and correct type
-// 2. Guard all calls to getTypeFromSchema or similar with checks for defined/object
-// 3. Apply these checks in all recursive struct extraction and interface extraction logic
-// Example for a recursive schema traversal:
-// if (schema && typeof schema === 'object' && schema.$ref) { ... }
-// if (prop && typeof prop === 'object' && prop.type === 'array' && prop.items) { ... }
-// ...
-// Please apply these patterns throughout the file, especially in struct extraction and interface extraction functions.