Great HTML report, not handlbar-ized

Author: bryancross

get-workspace-admins/README.md

@@ -4,31 +4,32 @@ This directory contains scripts to retrieve information about Postman workspaces
 
 ## Scripts
 
-- `get-team-workspaces.js`: Retrieves all Postman workspaces with visibility set to 'team'
+- `get-team-workspaces.js`: Retrieves all Postman workspaces with visibility set to 'team' and generates an HTML report of workspace admins
 
 ## Usage
 
 ### Prerequisites
 
 - Node.js (v14 or later recommended)
 - A Postman API key with read access to your workspaces
+- Handlebars (will be installed when you run `npm install`)
 
 ### Setup
 
 1. Ensure you're in the project root directory
 2. Install dependencies if you haven't already:
    ```
-   npm install
+   npm install handlebars
    ```
 
 3. Set your Postman API key as an environment variable:
    ```
    export POSTMAN_API_KEY="your-api-key-here"
    ```
 
-### Retrieving Team Workspaces
+### Retrieving Team Workspaces and Admins
 
-Run the script to fetch all workspaces with 'team' visibility:
+Run the script to fetch all workspaces with 'team' visibility and their admin users:
 
 ```
 node get-workspace-admins/get-team-workspaces.js [output-directory]
@@ -38,12 +39,12 @@ If `output-directory` is not specified, data will be saved to `../postman-export
 
 ## Output
 
-The script will create the following file:
+The script will create the following files:
 
 - `team-workspaces.json`: Contains metadata for all workspaces with 'team' visibility
+- `workspace-admins-report.json`: Contains workspace details and information about their admin users
+- `admin-report.html`: HTML report displaying workspace admins in a formatted table
 
-## Next Steps
+## Customizing the HTML Report
 
-Future updates will include:
-- Retrieving admin users for each team workspace
-- Detailed user information for workspace administrators
+The HTML report is generated using a Handlebars template. You can customize the appearance by modifying the `report-template.hbs` file in the `get-workspace-admins` directory.

get-workspace-admins/create-admin-report.js

@@ -11,12 +11,14 @@
  * 
  * Output:
  * - team-workspaces.json: Contains all team workspaces metadata
- * - workspace-admins.json: Contains workspace IDs, names, types, and admin user IDs
+ * - workspace-admins-report.json: Contains workspace IDs, names, types, and admin user details
+ * - admin-report.html: HTML report of workspace admins rendered using the Handlebars template
  */
 
 const axios = require('axios');
 const fs = require('fs');
 const path = require('path');
+const handlebars = require('handlebars');
 let curReportItem = {};
 let adminReport = [];
 let finalReport = {};
@@ -87,6 +89,107 @@ async function getTeamWorkspaces() {
   }
 }
 
+/**
+ * Generate a static HTML report from the workspace admins report data
+ * @param {string} reportJsonPath - Path to the workspace admins JSON report
+ * @param {string} templatePath - Path to the Handlebars template file
+ * @param {string} outputPath - Path where the HTML report should be saved
+ */
+async function generateHtmlReport(reportJsonPath, templatePath, outputPath) {
+  try {
+    console.log('Generating HTML report...');
+    
+    // Check if report JSON exists
+    if (!fs.existsSync(reportJsonPath)) {
+      console.error(`Error: Report JSON file not found at ${reportJsonPath}`);
+      return false;
+    }
+    
+    // Check if template exists
+    if (!fs.existsSync(templatePath)) {
+      console.error(`Error: Template file not found at ${templatePath}`);
+      return false;
+    }
+    
+    // Ensure the output directory exists
+    const outputDir = path.dirname(outputPath);
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir, { recursive: true });
+      console.log(`Created output directory: ${outputDir}`);
+    }
+    
+    // Read the template and report data
+    const styleTemplate = fs.readFileSync(templatePath, 'utf-8');
+    const reportData = JSON.parse(fs.readFileSync(reportJsonPath, 'utf-8'));
+    
+    // Create a complete HTML template with the styles
+    const fullTemplate = `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Postman Workspace Admins Report</title>
+    ${styleTemplate}
+</head>
+<body>
+    <h1>Postman Workspace Admins Report</h1>
+    <p>Generated: {{generated_at}}</p>
+    
+    <table class="tftable">
+        <tr>
+            <th>Workspace</th>
+            <th>Type</th>
+            <th>Visibility</th>
+            <th>Admin User</th>
+            <th>Username</th>
+            <th>Email</th>
+        </tr>
+        {{#each workspaces}}
+            {{#each admin_users}}
+                <tr>
+                    {{#if @index}}
+                        <td></td>
+                        <td></td>
+                        <td></td>
+                    {{else}}
+                        <td>{{../workspace_name}}</td>
+                        <td>{{../workspace_type}}</td>
+                        <td>{{../workspace_visibility}}</td>
+                    {{/if}}
+                    <td>{{user_name}}</td>
+                    <td>{{user_username}}</td>
+                    <td>{{user_email}}</td>
+                </tr>
+            {{else}}
+                <tr>
+                    <td>{{workspace_name}}</td>
+                    <td>{{workspace_type}}</td>
+                    <td>{{workspace_visibility}}</td>
+                    <td colspan="3">No admin users found</td>
+                </tr>
+            {{/each}}
+        {{/each}}
+    </table>
+</body>
+</html>
+`;
+
+    // Compile and render the template
+    const template = handlebars.compile(fullTemplate);
+    const htmlOutput = template(reportData);
+    
+    // Write the HTML output to the file
+    fs.writeFileSync(outputPath, htmlOutput);
+    console.log(`HTML report generated successfully: ${outputPath}`);
+    
+    return true;
+  } catch (error) {
+    console.error('Error generating HTML report:', error.message);
+    return false;
+  }
+}
+
 /**
  * Get admin users for a specific workspace with detailed user information
  * @param {string} workspaceId - The ID of the workspace to get admins for
@@ -216,6 +319,11 @@ async function main() {
     fs.writeFileSync(adminsFilePath, JSON.stringify(finalReport, null, 2));
     console.log(`\nSaved workspace admin report to: ${adminsFilePath}`);
 
+    // Generate HTML report
+    const templatePath = path.join(__dirname, 'report-template.hbs');
+    const htmlOutputPath = path.join(outputDir, 'admin-report.html');
+    await generateHtmlReport(adminsFilePath, templatePath, htmlOutputPath);
+    
   } catch (error) {
     console.error('Error in main execution:', error);
     process.exit(1);

get-workspace-admins/get-team-workspaces.js

@@ -21,6 +21,7 @@
     "get-team-workspaces": "node get-workspace-admins/get-team-workspaces.js"
   },
   "dependencies": {
-    "axios": "^1.12.2"
+    "axios": "^1.12.2",
+    "handlebars": "^4.7.8"
   }
 }