@stackql/provider-utils 0.2.1 → 0.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackql/provider-utils",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Utilities for building StackQL providers from OpenAPI specifications.",
   "type": "module",
   "main": "./src/index.js",
@@ -35,7 +35,7 @@
   "license": "MIT",
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.1",
-    "@stackql/deno-openapi-dereferencer": "npm:@jsr/stackql__deno-openapi-dereferencer@^0.3.0",
+    "@stackql/deno-openapi-dereferencer": "npm:@jsr/stackql__deno-openapi-dereferencer@^0.3.1",
     "js-yaml": "^4.1.0",
     "pluralize": "^8.0.0"
   },

package/src/docgen/generator.js

@@ -18,10 +18,11 @@ export async function generateDocs(options) {
     console.log(`documenting ${providerName}...`);
 
     const docsDir = path.join(outputDir, `docs`);
+    const servicesDir = path.join(docsDir, `services`);
    
     // Remove directory if it exists, then create it fresh
     fs.existsSync(docsDir) && fs.rmSync(docsDir, { recursive: true, force: true });
-    fs.mkdirSync(docsDir, { recursive: true });
+    fs.mkdirSync(servicesDir, { recursive: true });
 
     // Check for provider data files
     console.log(providerDataDir);
@@ -58,16 +59,16 @@ export async function generateDocs(options) {
         servicesForIndex.push(serviceName);
         const filePath = path.join(serviceDir, file);
         totalServicesCount++;
-        const serviceFolder = `${docsDir}/${serviceName}`;
+        const serviceFolder = `${servicesDir}/${serviceName}`;
         await createDocsForService(filePath, providerName, serviceName, serviceFolder);
     }
 
     console.log(`Processed ${totalServicesCount} services`);
 
     // Count total resources
-    totalResourcesCount = fs.readdirSync(`${docsDir}`, { withFileTypes: true })
+    totalResourcesCount = fs.readdirSync(`${servicesDir}`, { withFileTypes: true })
         .filter(dirent => dirent.isDirectory())
-        .map(dirent => fs.readdirSync(`${docsDir}/${dirent.name}`).length)
+        .map(dirent => fs.readdirSync(`${servicesDir}/${dirent.name}`).length)
         .reduce((a, b) => a + b, 0);
 
     console.log(`Processed ${totalResourcesCount} resources`);
@@ -264,12 +265,12 @@ ${secondColumnLinks}
 function generateResourceLinks(providerName, serviceName, resources) {
     // Generate resource links for the service index
     const resourceLinks = resources.map((resource) => {
-        return `<a href="/${serviceName}/${resource.name}/">${resource.name}</a>`;
+        return `<a href="/services/${serviceName}/${resource.name}/">${resource.name}</a>`;
     });
     return resourceLinks.join('<br />\n');
 }
 
 // Function to convert services to markdown links
 function servicesToMarkdown(providerName, servicesList) {
-    return servicesList.map(service => `<a href="/${service}/">${service}</a><br />`).join('\n');
+    return servicesList.map(service => `<a href="/services/${service}/">${service}</a><br />`).join('\n');
 }

package/src/docgen/helpers.js

@@ -386,28 +386,87 @@ function getHttpOperationInfo(dereferencedAPI, path, httpVerb, mediaType, openAP
     }
 
     const schema = responseObj.content[mediaType].schema;
-    
+
+    const { respProps, respDescription } = getHttpRespBody(schema, objectKey);
+
+    return {
+        respProps,
+        respDescription: responseObj.description ? responseObj.description : respDescription,
+        opDescription,
+        requestBody
+    };
+}
+
+// function getHttpRespBody(schema, objectKey) {
+
+//     if (schema.type === 'array') {
+//         return {
+//          respProps: schema.items.properties || {},
+//          respDescription: schema.items.description || '',
+//         }
+//     } else if (schema.type === 'object') {
+//         return {
+//          respProps: schema.properties || {},
+//          respDescription: schema.description || '',
+//         };
+//     } else {
+//         return {
+//             respProps: {},
+//             respDescription: '',
+//         };
+//     }
+
+
+// }
+
+function getHttpRespBody(schema, objectKey) {
+
     if (schema.type === 'array') {
         return {
-            respProps: schema.items.properties || {},
-            respDescription: schema.items.description || responseObj.description || '',
-            opDescription,
-            requestBody
-        };
+         respProps: schema.items.properties || {},
+         respDescription: schema.items.description || '',
+        }
     } else if (schema.type === 'object') {
-        return {
-            respProps: schema.properties || {},
-            respDescription: schema.description || responseObj.description || '',
-            opDescription,
-            requestBody
-        };
+        if(objectKey){
+            // if objectKey contains [*] print something
+            if (objectKey.includes('[*]')) {
+                // complex object key
+                console.log(`Complex Object Key : ${objectKey}`);
+                const parts = objectKey.split('[*]');
+                const complexObjectKey = parts[1].replace('.', '');
+                console.log(`Item of Interest : ${complexObjectKey}`);
+                const respProps = schema.properties.items.additionalProperties.properties[complexObjectKey].items.properties;
+                console.info(respProps);
+                const respDescription = schema.properties.items.additionalProperties.properties[complexObjectKey].items.description || schema.properties.items.description || '';
+                console.log(respDescription);
+                return {
+                    respProps: respProps || {},
+                    respDescription: respDescription,
+                };
+
+            } else {
+                // simple object key
+                console.log(`Simple Object Key : ${objectKey}`);
+                const simpleObjectKey = objectKey.replace('$.', '');
+                const respProps = schema.properties[simpleObjectKey].items.properties;
+                console.info(respProps);
+                const respDescription = schema.properties[simpleObjectKey].items.description || schema.description || '';
+                console.log(respDescription);
+                return {
+                    respProps: respProps || {},
+                    respDescription: respDescription,
+                };
+            }
+        } else {
+                return {
+                    respProps: schema.properties || {},
+                    respDescription: schema.description || '',
+                };
+        }
     } else {
-        // For primitive types or when schema structure is unexpected
         return {
             respProps: {},
-            respDescription: schema.description || responseObj.description || '',
-            opDescription,
-            requestBody
+            respDescription: '',
         };
     }
 }