spec-up-t 1.2.3 → 1.2.4

package/templates/template.html

@@ -122,8 +122,7 @@
         <a id="logo" href="${specLogoLink}">
             <img class="d-print-none m-1" src="${specLogo}" alt="" />
         </a>
-        <!-- <a class="navbar-brand col-md-3 col-lg-2 me-0 px-3 fs-6 text-white" href="#">Spec-Up-T</a> -->
-
+        
         <!-- Spacer to push the following elements to the right -->
         <div class="flex-grow-1"></div>
 

package/assets/js/insert-xrefs.js

@@ -1,370 +0,0 @@
-/**
- * @file This file fetches and displays commit hashes by matching elements with `x-term-reference` class against the `allXTrefs` global object.
- * Example:
- * const allXTrefs = {
-      "xtrefs": [
-         {
-            "externalSpec": "test-1",
-            "term": "Aal",
-            "repoUrl": "https://github.com/blockchainbird/spec-up-xref-test-1",
-            "terms_dir": "spec/term-definitions",
-            "owner": "blockchainbird",
-            "repo": "spec-up-xref-test-1",
-            "site": "https://blockchainbird.github.io/spec-up-xref-test-1/",
-            "commitHash": [
-            "f66951f1d378490289caab9c51141b44a0438365",
-            "content": "[[def: AAL]]:\n\n~ See: [[ref: authenticator assurance level]].\n\n~ This is an addition, for testing purposes.\n"
-            ]
-         },
-         {…}
-      ]
-   };
- * @author Kor Dwarshuis
- * @version 0.0.1
- * @license MIT
- * @since 2024-06-09
- */
-
-
-
-function fetchCommitHashes() {
-
-   let tipMap = new WeakMap();
-
-   async function insertGitHubTermRealTime(match, element) {
-      const div = document.createElement('div');
-      div.classList.add('fetched-xref-term');
-      div.classList.add('transcluded-xref-term');
-      div.innerHTML = "<p class='loadertext'>Loading external reference</p><div class='loader'></div>";
-      element.parentNode.insertBefore(div, element.nextSibling);
-
-      // Promise.all waits for both termPromise and delayPromise to complete if termPromise finishes within 2000 ms.If termPromise takes longer than 2000 ms, the delay is effectively bypassed because Promise.all only cares about both promises finishing, regardless of the time taken by each.
-
-      // Start fetching the GitHub term asynchronously
-      const termPromise = fetchGitHubTerm(savedToken, match);
-
-      // Create a delay of 2000 ms
-      const delayPromise = new Promise(resolve => setTimeout(resolve, 2000));
-
-      // Wait for whichever completes last between termPromise and delayPromise. The square brackets are used for array destructuring. In this context, the code is awaiting the resolution of multiple promises (termPromise and delayPromise) using Promise.all. The result of Promise.all is an array, and the square brackets are used to extract the first element of that array into the variable term.
-      const [term] = await Promise.all([termPromise, delayPromise]);
-
-      const timestamp = Date.now();
-      const date = new Date(timestamp);
-      const options = {
-         year: 'numeric',
-         month: 'long',
-         day: 'numeric',
-         hour: '2-digit',
-         minute: '2-digit',
-         second: '2-digit'
-      };
-      const humanReadableDate = date.toLocaleDateString('en-US', options);
-
-      // Now that either both are complete or the term has taken longer than 2000 ms, continue with your code
-      div.innerHTML = "<p class='transclusion-heading'>Current definition</p><small>" + humanReadableDate + "</small>" + term;
-   }
-   // Check if allXTrefs is undefined or does not exist
-   if (typeof allXTrefs === 'undefined' || allXTrefs === null) {
-      console.log('allXTrefs is not defined or does not exist. We will continue without it.');
-      return;
-   }
-
-   // Load GitHub API token from local storage if it exists
-   const savedToken = localStorage.getItem('githubToken');
-
-   // Markdown parser, assuming markdown-it and markdown-it-deflist are globally available
-   const md = window.markdownit().use(window.markdownitDeflist);
-
-   // A: Debounce function to delay execution, so the error message is not displayed too often, since we do not know of often and how many times the error will be triggered.
-   function debounce(func, wait) {
-      let timeout;
-      return function (...args) {
-         clearTimeout(timeout);
-         timeout = setTimeout(() => func.apply(this, args), wait);
-      };
-   }
-
-   // B: Debounced “GitHub API rate limit exceeded” error message
-   const debouncedError = debounce(() => {
-      notyf.error('GitHub API rate limit exceeded. See <a target="_blank" rel="noopener" href="https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token">documentation</a> for more info.');
-   }, 3000); // Delay in milliseconds
-
-   /**
- * Fetches the content of a term file from GitHub using the GitHub API.
- * Compares the fetched content with the locally stored version and displays the diff in a modal.
- * 
- * @param {string} savedToken - GitHub API token for authentication
- * @param {Object} match - The matched term object containing repository and term information
- */
-   function fetchGitHubContent(savedToken, match) {
-      // Create a headers object with the Authorization header if a GitHub API token is set
-      const headers = {};
-      if (savedToken && savedToken.length > 0) {
-         headers['Authorization'] = `token ${savedToken}`;
-      }
-
-      fetch('https://api.github.com/repos/' + match.owner + '/' + match.repo + '/contents/' + match.terms_dir + '/' + match.term.replace(/ /g, '-').toLowerCase() + '.md', { headers: headers })
-         .then(response => {
-            if (response.status === 403 && response.headers.get('X-RateLimit-Remaining') === '0') {
-               const resetTime = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
-               console.error(`❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
-
-               // Call the debounced error function
-               debouncedError();
-               return true;
-            } else {
-               console.log(`ℹ️ Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
-            }
-
-            return response.json();
-         })
-         .then(data => {
-            // Decode base64 encoded content
-            const decodedContent = atob(data.content);
-
-            // Diff the content of the current term-file with the content of stored version
-            // See https://www.npmjs.com/package/diff , examples
-            const diff = Diff.diffChars(match.content, decodedContent),
-               fragment = document.createDocumentFragment();
-
-            diff.forEach((part) => {
-               // green for additions, red for deletions
-               // grey for common parts
-               const color = part.added ? 'green' :
-                  part.removed ? 'red' : 'grey';
-
-               const backgroundColor = part.added ? '#ddd' :
-                  part.removed ? '#ddd' : 'white';
-
-               span = document.createElement('span');
-               span.style.color = color;
-               span.style.backgroundColor = backgroundColor;
-
-               span.appendChild(document
-                  .createTextNode(part.value));
-               fragment.appendChild(span);
-            });
-            // Create a temporary container to hold the fragment
-            const tempContainer = document.createElement('div');
-            tempContainer.innerHTML = '<h1>Diff xref (local snapshot) and latest version</h1>';
-            tempContainer.appendChild(fragment);
-            // Replace newlines with <br> tags
-            tempContainer.innerHTML = tempContainer.innerHTML.replace(/\n/g, '<br>');
-            showModal(tempContainer.innerHTML);
-         })
-         .catch(error => {
-            console.error('Error fetching content:', error);
-         });
-   }
-
-   async function fetchGitHubTerm(savedToken, match) {
-      function processSpecUpMarkdown(markdown) {
-
-         // Replace all occurrences of [[def: ]] with ''
-         const defRegex = /\[\[def: ([^\]]+)\]\]/g;
-         markdown = markdown.replace(defRegex, '');
-
-         // // Replace all occurrences of [[ref: ]] with <a href="#"></a>
-         // const refRegex = /\[\[ref: ([^\]]+)\]\]/g;
-         // markdown = markdown.replace(refRegex, '<a class="x-term-reference" data-local-href="ref:$1">$1</a>');
-
-         return md.render(markdown);
-      }
-
-      const headers = {};
-      if (savedToken && savedToken.length > 0) {
-         headers['Authorization'] = `token ${savedToken}`;
-      }
-
-      try {
-         const response = await fetch('https://api.github.com/repos/' + match.owner + '/' + match.repo + '/contents/' + match.terms_dir + '/' + match.term.replace(/ /g, '-').toLowerCase() + '.md', { headers: headers });
-
-         if (response.status === 403 && response.headers.get('X-RateLimit-Remaining') === '0') {
-            const resetTime = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
-            console.error(`❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
-
-            debouncedError();
-            return true;
-         } else {
-            console.log(`ℹ️ Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://blockchainbird.github.io/spec-up-t-website/docs/getting-started/github-token for more info.`);
-         }
-
-         const data = await response.json();
-         const decodedContent = atob(data.content);
-         const processedContent = processSpecUpMarkdown(decodedContent);
-         return processedContent;
-      } catch (error) {
-         console.error('Error fetching content:', error);
-      }
-   }
-
-   // get all elements with class “x-term-reference”
-   const elements = document.querySelectorAll('.x-term-reference');
-
-   elements.forEach((element) => {
-      // Get the value of the data-local-href attribute
-      const href = element.getAttribute('data-local-href');
-
-      // split href on “:” and create array
-      const splitHref = href.split(':');
-
-      // allXTrefs is an object that is available in the global scope
-      allXTrefs.xtrefs.forEach((match) => {
-
-         //TODO: remove toLowerCase() or not?
-         if (match.externalSpec === splitHref[1] && match.term.toLowerCase() === splitHref[2].toLowerCase()) {
-
-            // If no commit hash is found, display a message and return
-            if (!match.commitHash) {
-               /**
-                * Error message element shown when no cross-reference is found
-                * Displayed directly after the term reference element
-                */
-               const noXTrefFoundMessage = document.createElement('span');
-               noXTrefFoundMessage.classList.add('no-xref-found-message');
-               noXTrefFoundMessage.innerHTML = 'No xref found.';
-               element.parentNode.insertBefore(noXTrefFoundMessage, element.nextSibling);
-
-               return
-            };
-
-            // To be used in the future
-            const commitHashShort = match.commitHash && match.commitHash ? match.commitHash.substring(0, 7) : 'No hash';
-
-            // Comment out all UI elements except tooltip
-            
-            // Diff of the latest commit hash of a term file and the referenced commit hash
-
-            // Button that links to GitHub comparison between referenced commit and current main branch
-            // Shows the difference between the referenced version and latest version on GitHub
-
-            const diff = document.createElement('a');
-            diff.href = 'https://github.com/' + match.owner + '/' + match.repo + '/compare/' + match.commitHash + '../main';
-            diff.target = '_blank';
-            diff.rel = 'noopener noreferrer';
-            diff.classList.add('diff', 'xref-info-links', 'btn');
-            diff.innerHTML = '<svg icon><use xlink:href="#svg-github"></use></svg> Xref &lt; &gt; <svg icon><use xlink:href="#svg-github"></use></svg> Now';
-            diff.title = 'A Diff between the current commit hash of the definition and the commit hash referenced when the link was created.';
-            element.parentNode.insertBefore(diff, element.nextSibling);
-
-            // Latest version of a term-file
-
-            // Button that links to the latest version of the term file on GitHub
-            // Takes the user to the most current version in the repository
-
-            const latestVersion = document.createElement('a');
-            latestVersion.href = 'https://github.com/' + match.owner + '/' + match.repo + '/blob/main/' + match.terms_dir + '/' + match.term.replace(/ /g, '-').toLowerCase() + '.md';
-            latestVersion.target = '_blank';
-            latestVersion.rel = 'noopener noreferrer';
-            latestVersion.classList.add('latest-version', 'xref-info-links', 'btn');
-            latestVersion.innerHTML = '<svg icon><use xlink:href="#svg-github"></use></svg> Now';
-            latestVersion.title = 'Go to the repo page of the definition‘s latest version.';
-            diff.parentNode.insertBefore(latestVersion, element.nextSibling);
-
-            // Exact commit hash at the time of referencing the file
-
-            // Button that links to the exact commit version of the term file referenced in the document
-            // Shows the historical version that was used when creating the reference
-
-            const exactCommitHash = document.createElement('a');
-            exactCommitHash.href = 'https://github.com/' + match.owner + '/' + match.repo + '/blob/' + match.commitHash + '/' + match.terms_dir + '/' + match.term.replace(/ /g, '-').toLowerCase() + '.md';
-            exactCommitHash.target = '_blank';
-            exactCommitHash.rel = 'noopener noreferrer';
-            exactCommitHash.classList.add('exact-commit-hash', 'xref-info-links', 'btn');
-            exactCommitHash.innerHTML = '<svg icon><use xlink:href="#svg-github"></use></svg> Xref';
-            exactCommitHash.title = 'Go to the repo page of the definition‘s version referenced when the link was created.';
-            latestVersion.parentNode.insertBefore(exactCommitHash, element.nextSibling);
-
-            // Diff of the latest version and the referenced version in a modal
-
-            // Button that opens a modal showing the diff between referenced version and latest version
-            // Displays changes inline within the current page context
-
-            const showDiffModal = document.createElement('button');
-            showDiffModal.classList.add('show-diff-modal', 'xref-info-links', 'btn');
-            showDiffModal.innerHTML = 'Xref &lt; &gt; <svg icon><use xlink:href="#svg-github"></use></svg> Now';
-            showDiffModal.title = 'Show diff between the latest version and the referenced version';
-            latestVersion.parentNode.insertBefore(showDiffModal, element.nextSibling);
-            showDiffModal.addEventListener('click', function (event) {
-               event.preventDefault();
-               fetchGitHubContent(savedToken, match);
-            });
-
-            // The stored version of the term-file
-            // Button that opens a modal showing only the locally stored version of the term
-            // Displays the exact content that was stored when the reference was created
-
-            const localStoredTerm = document.createElement('button');
-            localStoredTerm.classList.add('show-diff-modal', 'xref-info-links', 'btn');
-            localStoredTerm.innerHTML = 'Xref';
-            localStoredTerm.title = 'Show the stored version of the term-file';
-            showDiffModal.parentNode.insertBefore(localStoredTerm, element.nextSibling);
-
-
-
-            // Replace all occurrences of [[def: ]] with ''
-            const defRegex = /\[\[def: ([^\]]+)\]\]/g;
-            match.content = match.content.replace(defRegex, '');
-
-            // const content = md.render(match.content);
-            const content = match.content;
-            localStoredTerm.addEventListener('click', function (event) {
-               event.preventDefault();
-               showModal(`
-                    <h1>Term definition (local snapshot)</h1>
-                    <table>
-                      <tr>
-                        <th>Commit hash</th>
-                        <td>${match.commitHash}</td>
-                      </tr>
-                      <tr>
-                        <th>Content</th>
-                        <td>${content}</td>
-                      </tr>
-                    </table>
-                  `);
-            });
-
-            const div = document.createElement('div');
-            div.classList.add('local-snapshot-xref-term');
-            div.classList.add('transcluded-xref-term');
-            div.innerHTML = `<p class='transclusion-heading'>Snapshot</p><p>Commit Hash: ${match.commitHash}</p> ${content}`;
-            element.parentNode.insertBefore(div, element.nextSibling);
-            
-            insertGitHubTermRealTime(match, element);
-
-            // Tooltip functionality
-            delegateEvent('pointerover', '.x-term-reference', (e, anchor) => {
-               // Get the matching term from your data
-               const href = anchor.getAttribute('data-local-href');
-               const splitHref = href.split(':');
-
-               // Find matching term in allXTrefs
-               const match = allXTrefs.xtrefs.find(m =>
-                  m.externalSpec === splitHref[1] &&
-                  m.term.toLowerCase() === splitHref[2].toLowerCase());
-
-               if (!match || tipMap.has(anchor)) return;
-
-               // Create tooltip with content
-               let tip = {
-                  // content: md.render(match.content.replace(/\[\[def: ([^\]]+)\]\]/g, '')),
-                  // content: `<dl>` +  md.render(match.content.replace(/\[\[def: ([^\]]+)\]\]/g, '')) + `</dl>`,
-                  content: match.content.replace(/\[\[def: ([^\]]+)\]\]/g, ''),
-                  allowHTML: true,
-                  inlinePositioning: true
-               };
-
-               if (tip.content) tipMap.set(anchor, tippy(anchor, tip));
-            }, { passive: true });
-            
-            
-         }
-      });
-   });
-}
-
-document.addEventListener("DOMContentLoaded", function () {
-   fetchCommitHashes();
-});

package/src/create-term-relations.js

@@ -1,131 +0,0 @@
-/**
- * @file This file creates a json and a js file with an an object that contains the relations between terms
- * @author Kor Dwarshuis
- * @version 1.0.0
- * @since 2024-06-22
- */
-
-
-const fs = require('fs-extra');
-const path = require('path');
-const config = fs.readJsonSync('specs.json');
-const { shouldProcessFile } = require('./utils/file-filter');
-
-const specTermDirectoryName = config.specs.map(spec => spec.spec_directory + '/' + spec.spec_terms_directory);
-
-
-// Create a path for the output file in the project root
-
-// // A: to the directory that will be published
-// const outputPathJSON = path.join(config.specs[0].output_path, 'term-relations-data.json');
-// const outputPathJS = path.join(config.specs[0].output_path, 'term-relations-data.js');
-
-// B: to the “output” directory
-const outputPathJSON = path.join('output', 'term-relations-data.json');
-const outputPathJS = path.join('output', 'term-relations-data.js');
-
-// Create directory named “output” in the project root if it does not yet exist
-if (!fs.existsSync('output')) {
-    fs.mkdirSync('output');
-}
-
-// Create directory named “output” in the project root if it does not yet exist
-if (!fs.existsSync(config.specs[0].output_path)) {
-    fs.mkdirSync(config.specs[0].output_path);
-}
-
-function createTermRelations() {
-    let allDefs = {};
-    allDefs.defs = new Set();
-
-    // Go through all directories that contain files with a term and definition
-    specTermDirectoryName.forEach(specDirectory => {
-        // read directory
-        fs.readdirSync(specDirectory).forEach(file => {
-            // read file
-            if (shouldProcessFile(file)) {
-                const markdown = fs.readFileSync(`${specDirectory}/${file}`, 'utf8');
-
-                let regexDef = /\[\[def:.*?\]\]/g;
-                let regexRef = /\[\[ref:.*?\]\]/g;
-                let regexXref = /\[\[xref:.*?\]\]/g;
-
-                let entry = {};
-
-                if (regexDef.test(markdown)) {
-                    const defs = markdown.match(regexDef);
-                    let refs = markdown.match(regexRef);
-                    let xrefs = markdown.match(regexXref);
-
-                    defs.forEach(def => {
-                        // remove “[[def:” from the beginning of every value in allMatches
-                        def = def.replace(/\[\[def:/, '');
-
-                        // remove “]]” from the end of every value in allMatches
-                        def = def.replace(/\]\]/, '');
-
-                        // trim every entry of allMatches
-                        def = def.trim();
-
-                        // Split the input on the first comma
-                        let [term, rest] = def.split(/,(.+)/);
-
-                        // Trim the term
-                        term = term.trim();
-
-                        entry.term = term;
-                        // Split the rest into an array of synonyms if it exists, otherwise use a placeholder
-                        let synonyms = rest ? rest.split(',').map(s => s.trim()) : [];
-                        entry.synonyms = synonyms;
-                    });
-
-                    if (refs !== null) {
-                        entry.refs = [];
-                        refs.forEach(ref => {
-                            // remove “[[ref:” from the beginning of every value in allMatches
-                            ref = ref.replace(/\[\[ref:/, '');
-                            // remove “]]” from the end of every value in allMatches
-                            ref = ref.replace(/\]\]/, '');
-                            // trim every entry of allMatches
-                            ref = ref.trim();
-                            entry.refs.push(ref);
-                        });
-                    }
-
-                    if (xrefs !== null) {
-                        entry.xrefs = [];
-                        xrefs.forEach(xref => {
-                            // remove “[[xref:” from the beginning of every value in allMatches
-                            xref = xref.replace(/\[\[xref:/, '');
-                            // remove “]]” from the end of every value in allMatches
-                            xref = xref.replace(/\]\]/, '');
-                            // trim every entry of allMatches
-                            xref = xref.trim();
-                            entry.xrefs.push(xref);
-                        });
-                    }
-                }
-                allDefs.defs.add(entry);
-            }
-        });
-    })
-    // Convert the Set back to an Array if needed
-    allDefs.defs = Array.from(allDefs.defs);
-
-    // Convert allXrefsStr to a JSON string with indentation
-    const allDefsStr = JSON.stringify(allDefs, null, 2);
-
-    // Write the JSON code to a .json file
-    fs.writeFileSync(outputPathJSON, allDefsStr, 'utf8');
-
-
-    // Create the JS code for the assignment
-    const stringReadyForFileWrite = `const allTermRelations = ${allDefsStr};`;
-
-    // Write the JS code to a .js file
-    fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
-}
-
-module.exports = {
-    createTermRelations
-}