@redpanda-data/docs-extensions-and-macros 3.6.2 → 3.6.4

package/extensions/generate-rp-connect-info.js

@@ -5,7 +5,7 @@ const Papa = require('papaparse');
 const CSV_PATH = 'redpanda_connect.csv'
 const GITHUB_OWNER = 'redpanda-data'
 const GITHUB_REPO = 'rp-connect-docs'
-const GITHUB_REF = 'connect-csv'
+const GITHUB_REF = 'main'
 /* const csvUrl = 'https://localhost:3000/csv';
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'; */
 

package/extensions/util/customStringify.js

@@ -0,0 +1,19 @@
+function customStringify(obj) {
+    return JSON.stringify(obj, (key, value) => {
+        if (value instanceof Map) {
+            return {
+                type: 'Map',
+                value: Array.from(value.entries())
+            };
+        } else if (value instanceof Set) {
+            return {
+                type: 'Set',
+                value: Array.from(value)
+            };
+        } else if (typeof value === 'function') {
+            return value.toString();
+        } else {
+            return value;
+        }
+    }, 2);
+}

package/macros/rp-connect-components.js

@@ -1,7 +1,6 @@
 'use strict';
 
 module.exports.register = function (registry, context) {
-
   function filterComponentTable() {
     // Retrieve and standardize filter inputs
     const nameInput = document.getElementById('componentTableSearch').value.trim().toLowerCase();
@@ -56,93 +55,116 @@ module.exports.register = function (registry, context) {
 
   function processConnectors(parsedData) {
     return parsedData.data.reduce((connectors, row) => {
-      const { connector, commercial_name, type, support_level, is_cloud_supported, is_licensed, url } = row;
-      let isCloudSupported = is_cloud_supported === 'y'
-      if (!connectors[connector]) {
-        connectors[connector] = {
-          types: new Map(),
-          supportLevels: new Map(),
-          isLicensed: is_licensed === 'y' ? 'Yes' : 'No',
-          isCloudConnectorSupported : isCloudSupported,
-          urls: new Set()
-        };
-      }
-      connectors[connector].types.set(capitalize(type), { url, isCloudSupported });
-      if (url) connectors[connector].urls.add(url);
-      if (!connectors[connector].supportLevels.has(support_level)) {
-        connectors[connector].supportLevels.set(support_level, new Set());
-      }
-      connectors[connector].supportLevels.get(support_level).add(commercial_name);
-      return connectors;
+        const { connector, commercial_name, type, support_level, is_cloud_supported, is_licensed, url } = row;
+        const isCloudSupported = is_cloud_supported === 'y';
+
+        if (!connectors[connector]) {
+            connectors[connector] = {
+                types: new Map(),
+                supportLevels: new Map(),
+                isLicensed: is_licensed === 'y' ? 'Yes' : 'No',
+                isCloudConnectorSupported: false, 
+                urls: new Set()
+            };
+        }
+        connectors[connector].types.set(capitalize(type), { url });
+
+        // Check at the connector level if any type supports cloud
+        if (isCloudSupported) {
+            connectors[connector].isCloudConnectorSupported = true;
+        }
+
+        // Update supportLevels with commercial name and cloud support info
+        if (!connectors[connector].supportLevels.has(support_level)) {
+            connectors[connector].supportLevels.set(support_level, []);
+        }
+
+        connectors[connector].supportLevels.get(support_level).push({
+            commercial_name,
+            isCloudSupported
+        });
+
+        if (url) connectors[connector].urls.add(url);
+
+        return connectors;
     }, {});
-  }
+}
 
 
-  function generateConnectorsHTMLTable(connectors, isCloud) {
-    return Object.entries(connectors).map(([connector, details], id) => {
+
+function generateConnectorsHTMLTable(connectors, isCloud) {
+  return Object.entries(connectors).map(([connector, details], id) => {
       const { types, supportLevels, isCloudConnectorSupported, isLicensed, urls } = details;
       const firstUrl = urls.size > 0 ? urls.values().next().value : null;
 
       const typesArray = Array.from(types.entries())
-      .map(([type, { url, isCloudSupported }]) => {
-          if(isCloud){
-            if (isCloudSupported) {
-                return url ? `<a href="${url}/">${type}</a>` : `<span>${type}</span>`;
-            } else {
-                return '';
-            }
-        }
-        else{
+      .map(([type, { url }]) => {
           return url ? `<a href="${url}/">${type}</a>` : `<span>${type}</span>`;
-        }
       })
       .filter(item => item !== '');
 
       const typesStr = typesArray.join(', ');
 
       const supportLevelStr = Array.from(supportLevels.entries())
-        .map(([level, names]) => `<p><b>${capitalize(level)}</b>: ${Array.from(names).join(', ')}</p>`)
-        .join('');
+      .sort(([levelA], [levelB]) => levelA.localeCompare(levelB))  // Sort by level alphabetically
+      .map(([level, commercialNames]) => {
+          let filteredNames = commercialNames;
+
+          if (isCloud) {
+              filteredNames = commercialNames
+                  .filter(({ isCloudSupported }) => isCloudSupported)
+                  .map(({ commercial_name }) => commercial_name);
+          } else {
+              filteredNames = commercialNames.map(({ commercial_name }) => commercial_name);
+          }
+          filteredNames = [...new Set(filteredNames)];
+          if (filteredNames.length === 0) return '';
+          if (supportLevels.size === 1) {
+              return `<p>${capitalize(level)}</p>`;
+          } else {
+              return `<p><b>${capitalize(level)}</b>: ${filteredNames.join(', ')}</p>`;
+          }
+      })
+      .filter(item => item !== '')
+      .join('');
 
       const connectorNameHtml = firstUrl
-        ? `<code><a href="${firstUrl}/">${connector}</a></code>`
-        : `<code><span>${connector}</span></code>`;
+          ? `<code><a href="${firstUrl}/">${connector}</a></code>`
+          : `<code><span>${connector}</span></code>`;
 
       if (isCloud) {
-        if (isCloudConnectorSupported) {
-          return `
-            <tr id="row-${id}">
-              <td class="tableblock halign-left valign-top" id="componentName-${id}">
-                <p class="tableblock">${connectorNameHtml}</p>
-              </td>
-              <td class="tableblock halign-left valign-top" id="componentType-${id}">
-                <p class="tableblock">${typesStr}</p>
-              </td>
-            </tr>`;
-        } else {
-          return '';
-        }
+          if (isCloudConnectorSupported && supportLevelStr.trim() !== '') {
+              return `
+                  <tr id="row-${id}">
+                      <td class="tableblock halign-left valign-top" id="componentName-${id}">
+                          <p class="tableblock">${connectorNameHtml}</p>
+                      </td>
+                      <td class="tableblock halign-left valign-top" id="componentType-${id}">
+                          <p class="tableblock">${typesStr}</p>
+                      </td>
+                  </tr>`;
+          } else {
+              return '';
+          }
       } else {
-        return `
-          <tr id="row-${id}">
-            <td class="tableblock halign-left valign-top" id="componentName-${id}">
-              <p class="tableblock">${connectorNameHtml}</p>
-            </td>
-            <td class="tableblock halign-left valign-top" id="componentType-${id}">
-              <p class="tableblock">${typesStr}</p>
-            </td>
-            <td class="tableblock halign-left valign-top" id="componentSupport-${id}">
-              <p class="tableblock">${supportLevelStr.trim()}</p>
-            </td>
-            <td class="tableblock halign-left valign-top" id="componentLicense-${id}">
-              <p class="tableblock">${isLicensed}</p>
-            </td>
-          </tr>`;
+          return `
+              <tr id="row-${id}">
+                  <td class="tableblock halign-left valign-top" id="componentName-${id}">
+                      <p class="tableblock">${connectorNameHtml}</p>
+                  </td>
+                  <td class="tableblock halign-left valign-top" id="componentType-${id}">
+                      <p class="tableblock">${typesStr}</p>
+                  </td>
+                  <td class="tableblock halign-left valign-top" id="componentSupport-${id}">
+                      <p class="tableblock">${supportLevelStr.trim()}</p>
+                  </td>
+                  <td class="tableblock halign-left valign-top" id="componentLicense-${id}">
+                      <p class="tableblock">${isLicensed}</p>
+                  </td>
+              </tr>`;
       }
-    }).filter(row => row !== '').join(''); // Filter out empty rows
-  }
-
-
+  }).filter(row => row !== '').join(''); // Filter out empty rows
+}
 
   let tabsCounter = 1; // Counter for generating unique IDs
 
@@ -220,7 +242,7 @@ module.exports.register = function (registry, context) {
 
       const createOptions = (values) =>
         Array.from(values)
-          .map(value => `<option selected value="${value}">${capitalize(value)}</option>`)
+          .map(value => `<option selected value="${value}">${capitalize(value).replace("_"," ")}</option>`)
           .join('');
 
       let tableHtml = `
@@ -240,7 +262,7 @@ module.exports.register = function (registry, context) {
       }
 
       tableHtml += `</div>
-        <table class="tableblock frame-all grid-all stripes-even no-clip stretch component-table" id="componentTable">
+        <table class="tableblock frame-all grid-all stripes-even no-clip stretch component-table sortable" id="componentTable">
           <colgroup>
             ${isCloud
           ? '<col style="width: 50%;"><col style="width: 50%;">'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.6.2",
+  "version": "3.6.4",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",