@stackql/provider-utils 0.5.7 → 0.5.8

package/package.json

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

package/src/docgen/helpers.js

@@ -159,6 +159,7 @@ export function getSqlMethodsWithOrderedFields(resourceData, dereferencedAPI, sq
                     optionalParams: optionalParams || {},
                     requestBody: requestBody || {},
                     rawRespProps: respProps,
+                    methodConfig: methodData.config || null,
                 };
 
                 // Format and sort the properties using our helper functions
@@ -177,7 +178,7 @@ export function getSqlMethodsWithOrderedFields(resourceData, dereferencedAPI, sq
     }
 
     for (const thisMethod of resourceData.sqlVerbs[sqlVerb]) {
-        const {path, httpVerb, mediaType, openAPIDocKey, objectKey, methodName} = getHttpOperationForSqlVerb(thisMethod.$ref, resourceData);
+        const {path, httpVerb, mediaType, openAPIDocKey, objectKey, methodName, methodConfig} = getHttpOperationForSqlVerb(thisMethod.$ref, resourceData);
         const {respProps, respDescription, opDescription, opSummary, requestBody} = getHttpOperationInfo(dereferencedAPI, path, httpVerb, mediaType, openAPIDocKey, objectKey);
         const {requiredParams, optionalParams} = getHttpOperationParams(dereferencedAPI, path, httpVerb);
 
@@ -191,6 +192,7 @@ export function getSqlMethodsWithOrderedFields(resourceData, dereferencedAPI, sq
             optionalParams: optionalParams || {},
             requestBody: requestBody || {},
             rawRespProps: respProps,
+            methodConfig: methodConfig || null,
         };
 
         // Format and sort the properties using our helper functions
@@ -255,12 +257,19 @@ function formatProperties(respProps) {
         // Get the base description
         let fullDescription = propDetails.description || '';
         fullDescription = fullDescription.replace(/\n/g, ' ');
+
+        // Collect enum values from enum or x-enum keys
+        const enumValues = propDetails['enum'] || propDetails['x-enum'];
+        if (Array.isArray(enumValues) && enumValues.length > 0) {
+            fullDescription += ` (${enumValues.join(', ')})`;
+        }
+
         let additionalDescriptionPaths = [];
 
         // Add all other fields to description parts
         for (const [fieldName, fieldValue] of Object.entries(propDetails)) {
             // Skip the fields we're handling separately
-            if (fieldName === 'type' || fieldName === 'format' || fieldName === 'description') {
+            if (fieldName === 'type' || fieldName === 'format' || fieldName === 'description' || fieldName === 'enum' || fieldName === 'x-enum') {
                 continue;
             }
 
@@ -362,13 +371,14 @@ function getHttpOperationForSqlVerb(sqlVerbRef, resourceData){
     const httpVerb = operationRef.split('/').pop()
     const path = operationRef.split('/')[0].replaceAll('~1','/');
 
-    return { 
-        path, 
-        httpVerb, 
-        mediaType: methodObj.response.mediaType,  
+    return {
+        path,
+        httpVerb,
+        mediaType: methodObj.response.mediaType,
         openAPIDocKey: methodObj.response.openAPIDocKey,
         objectKey: methodObj.response.objectKey || false,
-        methodName 
+        methodName,
+        methodConfig: methodObj.config || null
     }
 }
 
@@ -595,6 +605,12 @@ export function generateSchemaJsonFromProps(respProps, depth = 0, maxDepth = 4)
         let propType = prop.type || 'object';
         let propDesc = sanitizeHtml(prop.description || '');
 
+        // Collect enum values from enum or x-enum keys
+        const enumValues = prop['enum'] || prop['x-enum'];
+        if (Array.isArray(enumValues) && enumValues.length > 0) {
+            propDesc += ` (${enumValues.join(', ')})`;
+        }
+
         // Add format info to type string if available
         if (prop.format) {
             propType += ` (${prop.format})`;

package/src/docgen/resource/examples/insert-example.js

@@ -40,16 +40,21 @@ export function createInsertExamples(providerName, serviceName, resourceName, re
         // Create SQL example
         content += '\n\n```sql\nINSERT INTO ' + providerName + '.' + serviceName + '.' + resourceName + ' (\n';
         
-        // Add requestBody fields prefixed with data__ (excluding read-only props)
-        const reqBodyProps = methodDetails.requestBody?.properties 
+        // Add requestBody fields (excluding read-only props)
+        // If requestBodyTranslate.algorithm is 'naive', do not prefix with data__
+        const hasNaiveTranslate = methodDetails.methodConfig?.requestBodyTranslate?.algorithm === 'naive';
+
+        const reqBodyProps = methodDetails.requestBody?.properties
             ? Object.entries(methodDetails.requestBody.properties)
                 .filter(([_, propDetails]) => propDetails.readOnly !== true)
                 .map(([propName]) => propName)
             : [];
 
         const requiredBodyProps = methodDetails.requestBody?.required ? methodDetails.requestBody.required : [];
-            
-        const dataProps = reqBodyProps.map(prop => 'data__' + prop);
+
+        const dataProps = hasNaiveTranslate
+            ? reqBodyProps
+            : reqBodyProps.map(prop => 'data__' + prop);
         
         // Combine data props with params
         const requiredParams = Object.keys(methodDetails.requiredParams || {});
@@ -62,11 +67,18 @@ export function createInsertExamples(providerName, serviceName, resourceName, re
         // Start SELECT statement
         content += '\n)\nSELECT \n';
         
+        // Build a set of body prop names for quick lookup
+        const bodyPropSet = new Set(reqBodyProps);
+
         // Add values placeholders
         const valueLines = allFields.map(field => {
-            const isDataField = field.startsWith('data__');
-            const paramName = isDataField ? field.substring(6) : field;
-            
+            const isDataField = hasNaiveTranslate
+                ? bodyPropSet.has(field)
+                : field.startsWith('data__');
+            const paramName = isDataField
+                ? (hasNaiveTranslate ? field : field.substring(6))
+                : field;
+
             // Check for required body props
             let isRequiredBodyParam = false;
             if(isDataField){
@@ -78,13 +90,13 @@ export function createInsertExamples(providerName, serviceName, resourceName, re
             // Check if it's a number or boolean type
             let isNumber = false;
             let isBoolean = false;
-            
+
             if (isDataField && methodDetails.requestBody?.properties?.[paramName]) {
                 const propType = methodDetails.requestBody.properties[paramName].type;
                 isNumber = propType === 'number' || propType === 'integer';
                 isBoolean = propType === 'boolean';
             }
-            
+
             if (isNumber || isBoolean) {
                 return '{{ ' + paramName + ' }}' + (isRequiredBodyParam ? ' /* required */' : '');
             } else {

package/src/docgen/resource/examples/update-example.js

@@ -42,95 +42,100 @@ export function createUpdateExamples(providerName, serviceName, resourceName, re
         content += '\n\n```sql\n';
         content += (isReplace ? 'REPLACE ' : 'UPDATE ') + providerName + '.' + serviceName + '.' + resourceName;
         
+        // If requestBodyTranslate.algorithm is 'naive', do not prefix with data__
+        const hasNaiveTranslate = methodDetails.methodConfig?.requestBodyTranslate?.algorithm === 'naive';
+
         // Add SET clause with requestBody fields (excluding read-only props)
         content += '\nSET \n';
-        
+
         // Get request body fields (excluding read-only props)
-        const reqBodyProps = methodDetails.requestBody?.properties 
+        const reqBodyProps = methodDetails.requestBody?.properties
             ? Object.entries(methodDetails.requestBody.properties)
                 .filter(([_, propDetails]) => propDetails.readOnly !== true)
                 .map(([propName]) => propName)
             : [];
-        
-        // Add data__ prefixed fields to SET clause
+
+        // Add fields to SET clause (with or without data__ prefix)
         if (reqBodyProps.length > 0) {
             const setLines = reqBodyProps.map(prop => {
                 const propDetails = methodDetails.requestBody.properties[prop];
                 const isNumber = propDetails.type === 'number' || propDetails.type === 'integer';
                 const isBoolean = propDetails.type === 'boolean';
-                
+                const fieldName = hasNaiveTranslate ? prop : 'data__' + prop;
+
                 if (isNumber || isBoolean) {
-                    return 'data__' + prop + ' = {{ ' + prop + ' }}';
+                    return fieldName + ' = {{ ' + prop + ' }}';
                 } else {
-                    return 'data__' + prop + ' = \'{{ ' + prop + ' }}\'';
+                    return fieldName + ' = \'{{ ' + prop + ' }}\'';
                 }
             });
-            
+
             content += setLines.join(',\n');
         } else {
             content += '-- No updatable properties';
         }
-        
+
         // Add WHERE clause with parameters
         const requiredParams = Object.keys(methodDetails.requiredParams || {});
         const optionalParams = Object.keys(methodDetails.optionalParams || {});
-        
+
         // Get required body props (excluding read-only props)
-        const requiredBodyProps = methodDetails.requestBody?.required 
-            ? methodDetails.requestBody.required.filter(prop => 
-                methodDetails.requestBody.properties[prop] && 
+        const requiredBodyProps = methodDetails.requestBody?.required
+            ? methodDetails.requestBody.required.filter(prop =>
+                methodDetails.requestBody.properties[prop] &&
                 methodDetails.requestBody.properties[prop].readOnly !== true)
             : [];
-        
+
         if (requiredParams.length > 0 || requiredBodyProps.length > 0 || optionalParams.length > 0) {
 
             content += '\nWHERE \n';
-            
+
             // Add required parameters
             let clauseCount = 0;
-            
+
             // Add required query/path/header params
             requiredParams.forEach(param => {
                 if (clauseCount > 0) content += '\nAND ';
                 content += param + ' = \'{{ ' + param + ' }}\' --required';
                 clauseCount++;
             });
-            
+
             // Add required body params (only non-readonly ones)
             requiredBodyProps.forEach(prop => {
                 if (clauseCount > 0) content += '\nAND ';
-                
+
                 const propDetails = methodDetails.requestBody.properties[prop];
                 const isBoolean = propDetails.type === 'boolean';
-                
+                const fieldName = hasNaiveTranslate ? prop : 'data__' + prop;
+
                 if (isBoolean) {
-                    content += 'data__' + prop + ' = {{ ' + prop + ' }} --required';
+                    content += fieldName + ' = {{ ' + prop + ' }} --required';
                 } else {
-                    content += 'data__' + prop + ' = \'{{ ' + prop + ' }}\' --required';
+                    content += fieldName + ' = \'{{ ' + prop + ' }}\' --required';
                 }
-                
+
                 clauseCount++;
             });
-            
+
             // Add optional parameters
             optionalParams.forEach(param => {
                 if (clauseCount > 0) content += '\nAND ';
-                
+
                 // For boolean parameters, we can add a comment about their default value
                 const paramDetails = methodDetails.optionalParams[param];
                 const isBoolean = paramDetails.type === 'boolean';
                 const defaultValue = paramDetails.default;
-                
+
                 if (isBoolean) {
                     content += param + ' = {{ ' + param + '}}';
                 } else {
                     content += param + ' = \'{{ ' + param + '}}\'';
                 }
-                
+
                 if (isBoolean && defaultValue !== undefined) {
                     content += ' -- default: ' + defaultValue;
                 }
-                
+
                 clauseCount++;
             });
         }

package/src/docgen/resource/methods.js

@@ -9,15 +9,18 @@ const getRequiredBodyParams = (methodDetails, accessType) => {
     if (!['insert', 'update', 'replace', 'exec'].includes(accessType)) {
         return [];
     }
-    
+
     // Get required body params if they exist
     const requiredBodyProps = methodDetails.requestBody?.required ? methodDetails.requestBody.required : [];
-    
-    // For insert, update, and replace, prefix with data__
-    if (['insert', 'update', 'replace'].includes(accessType)) {
+
+    // Check if requestBodyTranslate.algorithm is 'naive' - if so, don't prefix with data__
+    const hasNaiveTranslate = methodDetails.methodConfig?.requestBodyTranslate?.algorithm === 'naive';
+
+    // For insert, update, and replace, prefix with data__ (unless naive translate is set)
+    if (['insert', 'update', 'replace'].includes(accessType) && !hasNaiveTranslate) {
         return requiredBodyProps.map(prop => `data__${prop}`);
     } else {
-        // For exec, don't prefix
+        // For exec or naive translate, don't prefix
         return requiredBodyProps;
     }
 };

package/src/providerdev/generate.js

@@ -177,6 +177,8 @@ export async function generate(options) {
     providerId,
     servers = null,
     providerConfig = null,
+    serviceConfig = null,
+    naiveReqBodyTranslate = false,
     skipFiles = []
   } = options;
 
@@ -217,8 +219,19 @@ export async function generate(options) {
     return false;
   }
   
+  // Parse serviceConfig if provided
+  let serviceConfigJson = null;
+  if (serviceConfig) {
+    try {
+      serviceConfigJson = JSON.parse(serviceConfig);
+    } catch (error) {
+      logger.error(`❌ Failed to parse service config JSON: ${error.message}`);
+      return false;
+    }
+  }
+
   const providerServices = {};
-  
+
   try {
     const files = fs.readdirSync(inputDir);
     
@@ -302,10 +315,22 @@ export async function generate(options) {
           const pathRef = encodeRefPath(pathKey, verb);
           const responseInfo = getSuccessResponseInfo(operation);
           
-          const methodEntry = {
-            operation: { $ref: pathRef },
-            response: responseInfo
-          };
+          const methodEntry = {};
+
+          // Add requestBodyTranslate config for methods with request bodies
+          if (naiveReqBodyTranslate && ['post', 'put', 'patch'].includes(verb)) {
+            // Check if the operation actually has a request body
+            if (operation.requestBody) {
+              methodEntry.config = {
+                requestBodyTranslate: {
+                  algorithm: 'naive'
+                }
+              };
+            }
+          }
+
+          methodEntry.operation = { $ref: pathRef };
+          methodEntry.response = responseInfo;
 
           // Add objectKey to the response info if it exists in the manifest and is for a GET operation
           if (entry.stackql_object_key && verb === 'get') {
@@ -344,7 +369,12 @@ export async function generate(options) {
           return false;
         }
       }
-      
+
+      // Inject x-stackQL-config if serviceConfig is provided
+      if (serviceConfigJson) {
+        spec['x-stackQL-config'] = serviceConfigJson;
+      }
+
       // Write enriched spec (always as YAML, ensuring .yaml extension)
       const outputFilename = filename.endsWith('.json') 
         ? filename.replace(/\.json$/, '.yaml')