@stackql/provider-utils 0.1.1 → 0.1.3

package/README.md

@@ -74,12 +74,6 @@ async function testDocGen() {
             providerDir: './test-data/output/src/myservice/v00.00.00000',
             outputDir: './test-output',
             providerDataDir: './test-data/provider-data',
-            stackqlConfig: {
-                host: 'localhost',
-                port: 5444,
-                user: 'stackql',
-                database: 'stackql'
-            }
         });
         
         console.log('Documentation generated successfully:', result);
@@ -157,20 +151,9 @@ components:
           - $ref: '#/components/x-stackQL-resources/examples/methods/list'
 ```
 
-### 3. Start StackQL Server
+### 3. Run the Test
 
 ```bash
-# In a separate terminal
-stackql srv \
-  --pgsrv.port=5444 \
-  --pgsrv.tls=false \
-  --loglevel=INFO
-```
-
-### 4. Run the Test
-
-```bash
-sh start-stackql-server.sh tests/docgen
 node tests/docgen/test-docgen.js
 ```
 
@@ -186,12 +169,6 @@ const options = {
     providerDir: './output/src/github/v00.00.00000',
     outputDir: './docs',
     providerDataDir: './config/provider-data',
-    stackqlConfig: {
-        host: 'localhost',
-        port: 5444,
-        user: 'stackql',
-        database: 'stackql'
-    }
 };
 
 const result = await docgen.generateDocs(options);
@@ -207,18 +184,6 @@ console.log(`Output location: ${result.outputPath}`);
 | `providerDir` | string | Path to provider spec directory | Required |
 | `outputDir` | string | Directory for generated documentation | Required |
 | `providerDataDir` | string | Directory containing provider header files | Required |
-| `stackqlConfig` | object | StackQL server connection configuration | See below |
-
-#### StackQL Config Options
-
-```javascript
-{
-    host: 'localhost',  // StackQL server host
-    port: 5444,         // StackQL server port
-    user: 'stackql',    // Database user
-    database: 'stackql' // Database name
-}
-```
 
 ## Directory Structure Requirements
 
@@ -227,7 +192,6 @@ console.log(`Output location: ${result.outputPath}`);
 provider-data/
 ├── headerContent1.txt    # Provider introduction
 ├── headerContent2.txt    # Additional provider info
-└── stackql-provider-registry.mdx (optional)
 ```
 
 ### Provider Spec Directory
@@ -244,22 +208,14 @@ output/src/{provider}/v00.00.00000/
 ```
 docs/{provider}-docs/
 ├── index.md
-├── stackql-provider-registry.mdx
-└── providers/
-    └── {provider}/
-        └── {service}/
-            ├── index.md
-            └── {resource}/
-                └── index.md
+└── {service}/
+    ├── index.md
+    └── {resource}/
+        └── index.md
 ```
 
 ## Troubleshooting
 
-### StackQL Server Connection Issues
-- Ensure StackQL server is running: `stackql srv --pgsrv.port=5444`
-- Check if port 5444 is available
-- Verify connection settings in `stackqlConfig`
-
 ### Missing Provider Data
 - Ensure `headerContent1.txt` and `headerContent2.txt` exist in provider data directory
 - Check file permissions
@@ -290,10 +246,6 @@ const result = await docgen.generateDocs({
     providerDir: './providers/src/aws/v00.00.00000',
     outputDir: './documentation',
     providerDataDir: './config/aws',
-    stackqlConfig: {
-        host: 'localhost',
-        port: 5444
-    }
 });
 ```
 

package/package.json

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

package/src/docgen/generator.js

@@ -11,39 +11,29 @@ export async function generateDocs(options) {
     const {
         providerName,
         providerDir,        // e.g., 'output/src/heroku/v00.00.00000'
-        outputDir,          // e.g., 'docs'
+        outputDir,          // e.g., 'website'
         providerDataDir,    // e.g., 'config/provider-data'
-        // stackqlConfig = {
-        //     host: 'localhost',
-        //     port: 5444,
-        //     user: 'stackql',
-        //     database: 'stackql'
-        // }
     } = options;
 
     console.log(`documenting ${providerName}...`);
 
-    const docsDir = path.join(outputDir, `${providerName}-docs`);
+    const docsDir = path.join(outputDir, `docs`);
    
-    // Clean existing docs
-    fs.existsSync(`${docsDir}/index.md`) && fs.unlinkSync(`${docsDir}/index.md`);
-    fs.existsSync(`${docsDir}/providers`) && fs.rmSync(`${docsDir}/providers`, { recursive: true, force: true });
+    // Remove directory if it exists, then create it fresh
+    fs.existsSync(docsDir) && fs.rmSync(docsDir, { recursive: true, force: true });
+    fs.mkdirSync(docsDir, { recursive: true });
 
     // Check for provider data files
-console.log(providerDataDir);
-try {
-    const files = fs.readdirSync(providerDataDir);
-    console.log('Files in providerDataDir:', files);
-} catch (err) {
-    console.error('Error reading providerDataDir:', err.message);
-}
-
-
-
+    console.log(providerDataDir);
+    try {
+        const files = fs.readdirSync(providerDataDir);
+        console.log('Files in providerDataDir:', files);
+    } catch (err) {
+        console.error('Error reading providerDataDir:', err.message);
+    }
 
     const headerContent1Path = path.join(providerDataDir, 'headerContent1.txt');
     const headerContent2Path = path.join(providerDataDir, 'headerContent2.txt');
-    const mdxPath = path.join(providerDataDir, 'stackql-provider-registry.mdx');
 
     if (!fs.existsSync(headerContent1Path) || !fs.existsSync(headerContent2Path)) {
         throw new Error(`Missing headerContent1.txt or headerContent2.txt in ${providerDataDir}`);
@@ -68,16 +58,16 @@ try {
         servicesForIndex.push(serviceName);
         const filePath = path.join(serviceDir, file);
         totalServicesCount++;
-        const serviceFolder = `${docsDir}/providers/${providerName}/${serviceName}`;
+        const serviceFolder = `${docsDir}/${serviceName}`;
         await createDocsForService(filePath, providerName, serviceName, serviceFolder);
     }
 
     console.log(`Processed ${totalServicesCount} services`);
 
     // Count total resources
-    totalResourcesCount = fs.readdirSync(`${docsDir}/providers/${providerName}`, { withFileTypes: true })
+    totalResourcesCount = fs.readdirSync(`${docsDir}`, { withFileTypes: true })
         .filter(dirent => dirent.isDirectory())
-        .map(dirent => fs.readdirSync(`${docsDir}/providers/${providerName}/${dirent.name}`).length)
+        .map(dirent => fs.readdirSync(`${docsDir}/${dirent.name}`).length)
         .reduce((a, b) => a + b, 0);
 
     console.log(`Processed ${totalResourcesCount} resources`);
@@ -92,14 +82,10 @@ try {
 
     const indexContent = `${headerContent1}
 
-:::info Provider Summary
+:::info[Provider Summary] 
 
-<div class="row">
-<div class="providerDocColumn">
-<span>total services:&nbsp;<b>${totalServicesCount}</b></span><br />
-<span>total resources:&nbsp;<b>${totalResourcesCount}</b></span><br />
-</div>
-</div>
+total services: __${totalServicesCount}__  
+total resources: __${totalResourcesCount}__  
 
 :::
 
@@ -121,12 +107,6 @@ ${servicesToMarkdown(providerName, secondColumnServices)}
     fs.writeFileSync(indexPath, indexContent);
     console.log(`Index file created at ${indexPath}`);
 
-    // Copy MDX file if exists
-    if (fs.existsSync(mdxPath)) {
-        fs.copyFileSync(mdxPath, path.join(docsDir, 'stackql-provider-registry.mdx'));
-        console.log(`MDX file copied`);
-    }
-
     return {
         totalServices: totalServicesCount,
         totalResources: totalResourcesCount,
@@ -258,18 +238,14 @@ keywords:
   - cloud inventory
 description: Query, deploy and manage ${providerName} resources using SQL
 custom_edit_url: null
-image: /img/providers/${providerName}/stackql-${providerName}-provider-featured-image.png
+image: /img/stackql-${providerName}-provider-featured-image.png
 ---
 
 ${serviceName} service documentation.
 
-:::info Service Summary
+:::info[Service Summary]
 
-<div class="row">
-<div class="providerDocColumn">
-<span>total resources:&nbsp;<b>${totalResources}</b></span><br />
-</div>
-</div>
+total resources: __${totalResources}__  
 
 :::
 
@@ -287,12 +263,12 @@ ${secondColumnLinks}
 function generateResourceLinks(providerName, serviceName, resources) {
     // Generate resource links for the service index
     const resourceLinks = resources.map((resource) => {
-        return `<a href="/providers/${providerName}/${serviceName}/${resource.name}/">${resource.name}</a>`;
+        return `<a href="/${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="/providers/${providerName}/${service}/">${service}</a><br />`).join('\n');
+    return servicesList.map(service => `<a href="/${service}/">${service}</a><br />`).join('\n');
 }

package/src/docgen/helpers.js

@@ -388,9 +388,9 @@ function getHttpOperationInfo(dereferencedAPI, path, httpVerb, mediaType, openAP
         throw new Error(`HTTP verb '${httpVerb}' not found for path '${path}'`);
     }
     
-    // get op description
-    const opDescription = dereferencedAPI.paths[path][httpVerb].description || '';
-   
+    // Get operation description and replace curly braces with HTML entities
+    const opDescription = (dereferencedAPI.paths[path][httpVerb].description || '').replace(/\{/g, '{').replace(/\}/g, '}');
+
     // Extract request body if it exists
     let requestBody = {};
     if (dereferencedAPI.paths[path][httpVerb].requestBody && 

package/src/docgen/resource/overview.js

@@ -18,7 +18,7 @@ keywords:
   - cloud inventory
 description: Query, deploy and manage ${providerName} resources using SQL
 custom_edit_url: null
-image: /img/providers/${providerName}/stackql-${providerName}-provider-featured-image.png
+image: /img/stackql-${providerName}-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';