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

package/macros/glossary.js

@@ -27,6 +27,11 @@ module.exports.register = function (registry, config = {}) {
 
       const terms = termFiles.map(file => {
         const content = file.contents.toString()
+        // Split content by lines and get the first non-empty line as the title
+        const lines = content.split('\n').map(line => line.trim())
+        const firstNonEmptyLine = lines.find(line => line.length > 0)
+        // Remove leading '=' characters (AsciiDoc syntax) and trim whitespace
+        const pageTitle = firstNonEmptyLine ? firstNonEmptyLine.replace(/^=+\s*/, '') : '#'
         const attributes = {}
 
         let match
@@ -50,6 +55,7 @@ module.exports.register = function (registry, config = {}) {
           term: attributes['term-name'],
           def: attributes['hover-text'],
           category: attributes['category'] || '',
+          pageTitle,
           content
         }
 
@@ -76,13 +82,16 @@ module.exports.register = function (registry, config = {}) {
     }
   }
 
-  //characters to replace by '-' in generated idprefix
-  const IDRX = /[/ _.-]+/g
+  // Characters to replace by '-' in generated idprefix
+  const IDRX = /[\/ _.-]+/g
 
-  function termId (term) {
-    return term.toLowerCase().replace(IDRX, '-')
+  function termId(term) {
+    // Remove brackets before replacing other characters
+    const noBracketsTerm = term.replace(/[\[\]\(\)]/g, '') // Remove brackets
+    return noBracketsTerm.toLowerCase().replace(IDRX, '-')
   }
 
+
   const TRX = /(<[a-z]+)([^>]*>.*)/
 
   function glossaryInlineMacro () {
@@ -91,7 +100,7 @@ module.exports.register = function (registry, config = {}) {
       self.named('glossterm')
       //Specifying the regexp allows spaces in the term.
       self.$option('regexp', /glossterm:([^[]+)\[(|.*?[^\\])\]/)
-      self.positionalAttributes(['definition', 'customText']);
+      self.positionalAttributes(['definition', 'customText']); // Allows for specifying custom link text
       self.process(function (parent, target, attributes) {
         const term = attributes.term || target
         const customText = attributes.customText || term;
@@ -110,9 +119,11 @@ module.exports.register = function (registry, config = {}) {
         }
         const logTerms = document.hasAttribute('glossary-log-terms')
         var definition;
+        var pageTitle;
         const index = context.gloss.findIndex((candidate) => candidate.term === term)
         if (index >= 0) {
           definition = context.gloss[index].def
+          pageTitle = context.gloss[index].pageTitle
         } else {
           definition = attributes.definition;
         }
@@ -138,7 +149,7 @@ module.exports.register = function (registry, config = {}) {
         if ((termExistsInContext && links) || (links && customLink)) {
           inline = customLink
             ? self.createInline(parent, 'anchor', customText, { type: 'link', target: customLink, attributes: { ...attrs, window: '_blank', rel: 'noopener noreferrer' } })
-            : self.createInline(parent, 'anchor', customText, { type: 'xref', target: `${glossaryPage}#${termId(term)}`, reftext: customText, attributes: attrs })
+            : self.createInline(parent, 'anchor', customText, { type: 'xref', target: `${glossaryPage}#${termId(pageTitle)}`, reftext: customText, attributes: attrs })
         } else {
           inline = self.createInline(parent, 'quoted', customText, { attributes: attrs })
         }

package/macros/rp-connect-components.js

@@ -2,16 +2,19 @@
 
 module.exports.register = function (registry, context) {
   function filterComponentTable() {
-    // Retrieve and standardize filter inputs
     const nameInput = document.getElementById('componentTableSearch').value.trim().toLowerCase();
     const typeFilter = Array.from(document.querySelector('#typeFilter').selectedOptions).map(option => option.value);
 
-    // Check if the supportFilter element exists
+    // Check for the existence of support and enterprise license filters (optional)
     const supportFilterElement = document.querySelector('#supportFilter');
     const supportFilter = supportFilterElement
       ? Array.from(supportFilterElement.selectedOptions).map(option => option.value)
       : [];
 
+    // Get the 'support=enterprise' query parameter from the URL
+    const params = getQueryParams();
+    const enterpriseSupportFilter = params.support === 'enterprise';  // Check if 'support=enterprise' is in the URL
+
     const table = document.getElementById('componentTable');
     const trs = table.getElementsByTagName('tr');
 
@@ -19,34 +22,26 @@ module.exports.register = function (registry, context) {
       const row = trs[i];
       const nameTd = row.querySelector('td[id^="componentName-"]');
       const typeTd = row.querySelector('td[id^="componentType-"]');
-      const supportTd = row.querySelector('td[id^="componentSupport-"]');
-      const typeDropdown = typeTd ? typeTd.querySelector('.type-dropdown') : null;
+      const supportTd = row.querySelector('td[id^="componentSupport-"]'); // Support column, if present
+      const enterpriseSupportTd = row.querySelector('td[id^="componentLicense-"]'); // Enterprise License column, if present
 
-      if (nameTd && typeTd) {
-        const nameText = nameTd.textContent.trim().toLowerCase();
+      if (typeTd) {  // Ensure that at least the Type column is present
+        const nameText = nameTd ? nameTd.textContent.trim().toLowerCase() : '';
         const typeText = typeTd.textContent.trim().toLowerCase().split(', ').map(item => item.trim());
         const supportText = supportTd ? supportTd.textContent.trim().toLowerCase() : '';
+        const enterpriseSupportText = enterpriseSupportTd ? enterpriseSupportTd.textContent.trim().toLowerCase() : '';  // Yes or No
 
         // Determine if the row should be shown
         const showRow =
-          ((!nameInput || nameText.includes(nameInput)) &&
-            (typeFilter.length === 0 || typeFilter.some(value => typeText.includes(value))) &&
-            (!supportTd || supportFilter.length === 0 || supportFilter.some(value => supportText.includes(value)))
+          ((!nameInput || nameText.includes(nameInput)) &&  // Filter by name if present
+           (typeFilter.length === 0 || typeFilter.some(value => typeText.includes(value))) &&  // Filter by type
+           (!supportTd || supportFilter.length === 0 || supportFilter.some(value => supportText.includes(value))) &&  // Filter by support if present
+           (!enterpriseSupportFilter || !enterpriseSupportTd || supportText.includes('enterprise') || enterpriseSupportText === 'yes') // Filter by enterprise support if 'support=enterprise' is in the URL
           );
 
         row.style.display = showRow ? '' : 'none';
-
-        if (showRow && typeFilter.length > 0 && typeDropdown) {
-          const matchingOption = Array.from(typeDropdown.options).find(option =>
-            typeFilter.includes(option.text.toLowerCase())
-          );
-          if (matchingOption) {
-            typeDropdown.value = matchingOption.value;
-            updateComponentUrl(typeDropdown, false);
-          }
-        }
       } else {
-        row.style.display = 'none'; // Hide row if essential cells are missing
+        row.style.display = 'none'; // Hide row if the Type column is missing
       }
     }
   }
@@ -289,8 +284,9 @@ function generateConnectorsHTMLTable(connectors, isCloud) {
           const params = {};
           const searchParams = new URLSearchParams(window.location.search);
           searchParams.forEach((value, key) => {
-            params[key] = value;
+            params[key] = value.toLowerCase();
           });
+
           return params;
         }
 
@@ -304,24 +300,26 @@ function generateConnectorsHTMLTable(connectors, isCloud) {
 
         // Initialize Choices.js for type dropdowns
         document.addEventListener('DOMContentLoaded', function() {
-        const params = getQueryParams();
-        if (params.search) {
-          document.getElementById('componentTableSearch').value = params.search;
-        }
-        if (params.type) {
-          document.getElementById('typeFilter').value = params.type;
-        }
-          if (params.support) {
-            document.getElementById('supportFilter').value = params.support;
+          const params = getQueryParams();
+          const search = document.getElementById('componentTableSearch');
+          const typeFilter = document.getElementById('typeFilter');
+          const supportFilter = document.getElementById('supportFilter');
+          if (params.search && search) {
+            search.value = params.search;
+          }
+          if (params.type && typeFilter) {
+            typeFilter.value = params.type;
           }
-        
-        filterComponentTable();
-        const typeDropdowns = document.querySelectorAll('.type-dropdown');
-        typeDropdowns.forEach(dropdown => {
-          new Choices(dropdown, { 
-            searchEnabled: false, 
-            allowHTML: true,
-            removeItemButton: true });
+          if (params.support && supportFilter) {
+            supportFilter.value = params.support;
+          }
+          filterComponentTable();
+          const typeDropdowns = document.querySelectorAll('.type-dropdown');
+          typeDropdowns.forEach(dropdown => {
+            new Choices(dropdown, {
+              searchEnabled: false,
+              allowHTML: true,
+              removeItemButton: true });
           });
         });
         </script>`;
@@ -410,4 +408,4 @@ function generateConnectorsHTMLTable(connectors, isCloud) {
       return self.createBlock(parent, 'pass', typeDropdown + enterpriseAdmonition);
     });
   });
-};
+};

package/package.json

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