@stackql/provider-utils 0.4.3 → 0.4.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackql/provider-utils",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "Utilities for building StackQL providers from OpenAPI specifications.",
   "type": "module",
   "main": "./src/index.js",

package/src/docgen/helpers.js

@@ -23,18 +23,56 @@ export function getIndefiniteArticle(resourceName) {
   return article;
 }
 
+/**
+ * Sanitizes HTML with special handling for allowed tags and backticked content
+ * @param {string} text - The text to sanitize
+ * @return {string} - The sanitized text
+ */
 export function sanitizeHtml(text) {
-  return text
+  if (!text) return '';
+  
+  // Special handling for code tags - temporarily replace them with placeholders
+  // that won't get escaped in the general sanitization
+  let result = text
+    // Replace <code> tags with a safe placeholder
+    .replace(/<code>/g, '___CODE_OPEN___')
+    .replace(/<\/code>/g, '___CODE_CLOSE___');
+  
+  // Then apply the general sanitization
+  result = result
     .replace(/{/g, '&#123;')
     .replace(/}/g, '&#125;')
     .replace(/>/g, '&gt;')
     .replace(/</g, '&lt;')
     // edge case
     .replace(/&#125;_&#123;/g, '&#125;&#95;&#123;')
-    .replace(/\n/g, '<br />')
+    .replace(/\n/g, '<br />');
+  
+  // Fix 1: Replace &lt;br&gt;, &lt;br/&gt;, &lt;p&gt;, &lt;/p&gt; back to their literal HTML tags
+  // Make sure <br> is always self-closing for MDX compatibility
+  result = result
+    .replace(/&lt;br\s*\/?&gt;/gi, '<br />')
+    .replace(/&lt;p&gt;/gi, '<p>')
+    .replace(/&lt;\/p&gt;/gi, '</p>');
+  
+  // Fix 2: Find any &lt; or &gt; inside backticks and convert them back to < and >
+  // We need to handle the backtick content by finding pairs of backticks
+  result = result.replace(/`([^`]*)`/g, (match, content) => {
+    // Convert &lt; and &gt; back to < and > only within backticked content
+    const fixedContent = content
+      .replace(/&lt;/g, '<')
+      .replace(/&gt;/g, '>');
+    return '`' + fixedContent + '`';
+  });
+  
+  // Finally, restore the code tags
+  result = result
+    .replace(/___CODE_OPEN___/g, '<code>')
+    .replace(/___CODE_CLOSE___/g, '</code>');
+  
+  return result;
 }
 
-
 export function getSqlMethodsWithOrderedFields(resourceData, dereferencedAPI, sqlVerb) {
     const methods = {};
 
@@ -215,7 +253,12 @@ function formatProperties(respProps) {
             if (typeof fieldValue != 'string') {
                 continue;
             } else {
-                additionalDescriptionPaths.push(`${fieldName}: ${String(fieldValue)}`);
+                // Specifically wrap pattern fields in code tags
+                if (fieldName === 'pattern') {
+                    additionalDescriptionPaths.push(`${fieldName}: <code>${String(fieldValue)}</code>`);
+                } else {
+                    additionalDescriptionPaths.push(`${fieldName}: ${String(fieldValue)}`);
+                }
             }
         }
         
@@ -224,7 +267,6 @@ function formatProperties(respProps) {
         // Store formatted property details
         allProperties[propName] = {
             type: typeString,
-            // description: escapeHtml(fullDescription),
             description: fullDescription
         };
     }

package/src/providerdev/split.js

@@ -65,11 +65,11 @@ function retServiceNameAndDesc(providerName, opItem, pathKey, svcDiscriminator,
   else if (svcDiscriminator === "path") {
     const pathParts = pathKey.replace(/^\//, '').split('/');
     if (pathParts.length > 0) {
-      // Find the first path segment that is not 'api' or 'v{number}'
+      // Find the first path segment that is not 'api', 'v{number}', or '{apiVersion}'
       for (const part of pathParts) {
         const lowerPart = part.toLowerCase();
-        // Skip if it's 'api' or matches version pattern 'v1', 'v2', etc.
-        if (lowerPart === 'api' || /^v\d+$/.test(lowerPart)) {
+        // Skip if it's 'api', matches version pattern 'v1', 'v2', etc., or is '{apiVersion}'
+        if (lowerPart === 'api' || /^v\d+$/.test(lowerPart) || /^\{.*version\}$/i.test(part)) {
           continue;
         }
         service = lowerPart.replace(/-/g, '_').replace(/ /g, '_').replace(/\./g, '_');
@@ -78,7 +78,7 @@ function retServiceNameAndDesc(providerName, opItem, pathKey, svcDiscriminator,
       serviceDesc = `${providerName} ${service} API`;
     }
   }
-  
+
   // Check if service should be skipped
   if (service === "skip") {
     return ["skip", ""];

package/src/utils.js

@@ -9,7 +9,7 @@ import logger from './logger.js';
  */
 export function camelToSnake(name) {
   const s1 = name.replace(/([a-z0-9])([A-Z][a-z]+)/g, '$1_$2');
-  return s1.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase();
+  return s1.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase().replace(/-/g, '_');
 }
 
 /**