spec-up-t 1.0.76 → 1.0.77

package/assets/compiled/body.js

@@ -126,7 +126,7 @@ function tokenInput(){let t=document.createElement("button");t.classList.add("bu
 function pdfDownload(){fetch("index.pdf",{method:"HEAD"}).then(e=>{if(e.ok){let e=document.createElement("a");e.classList.add("button-pdf-download"),e.classList.add("btn"),e.target="_blank",e.rel="noopener noreferrer",e.href="index.pdf",e.title="Download this page as a PDF",e.innerHTML="PDF",document.querySelector("#container-search-h7vc6omi2hr2880").appendChild(e)}else console.log("PDF file does not exist. No PDF download button will be added.")}).catch(e=>{console.error("Error checking PDF file:",e)})}document.addEventListener("DOMContentLoaded",(function(){pdfDownload()}));
 function helpButtons(){const t=document.createElement("a");t.textContent="?",t.classList.add("help-button","btn"),t.title="Click to see the explanation of the buttons at the documentation website, in a new tab.",t.target="_blank",t.rel="noopener noreferrer",t.href="https://blockchainbird.github.io/spec-up-t-website/docs/general/specification#explanation-buttons",function(t){document.querySelectorAll("#content dl dt").forEach(e=>{e.appendChild(t.cloneNode(!0))})}(t)}document.addEventListener("DOMContentLoaded",helpButtons);
 function createAlphabetIndex(){const e=document.getElementById("alphabet-index-h7vc6omi2hr2880"),t=document.querySelector(".terms-and-definitions-list").querySelectorAll("dt"),n={};t.forEach(e=>{const t=e.querySelector("span");if(t&&t.id){const e=t.id,o=e.charAt(e.indexOf("term:")+5).toUpperCase();n[o]||(n[o]=t.id)}});const o=document.createElement("div");o.className="alphabet-index";const r=document.createElement("p");r.className="number-of-terms",r.textContent=`– There are ${t.length} terms –`;const c=e.parentNode;c.insertBefore(r,e.nextSibling),c.insertBefore(o,r.nextSibling),Object.keys(n).sort().forEach(e=>{const t=document.createElement("a");t.href="#"+n[e],t.textContent=e,o.appendChild(t)})}document.addEventListener("DOMContentLoaded",(function(){createAlphabetIndex()}));
-function collapseDefinitions(){const t=document.querySelectorAll("#content dl dd"),e=document.querySelectorAll(".collapse-all-defs-button");document.querySelectorAll("dt").forEach(t=>{const e=document.createElement("button");e.classList.add("collapse-all-defs-button","btn"),e.innerHTML="▲",e.setAttribute("id","toggleButton"),t.appendChild(e)}),document.addEventListener("click",n=>{n.target.classList.contains("collapse-all-defs-button")&&(!function(){const n=t[0].classList.contains("hidden");t.forEach(t=>{t.classList.toggle("hidden",!n),t.classList.toggle("visible",n)}),e.forEach(t=>{t.innerHTML=n?"▲":"▼",t.title=n?"Collapse all definitions":"Expand all definitions"})}(),n.target.scrollIntoView({behavior:"smooth",block:"start",inline:"nearest"}),setTimeout(()=>{window.scrollBy({top:-100,behavior:"smooth"})},500))})}document.addEventListener("DOMContentLoaded",(function(){collapseDefinitions()}));
+function collapseDefinitions(){const t=document.querySelectorAll("#content dl.terms-and-definitions-list dd"),e=document.querySelectorAll("#content dl.terms-and-definitions-list dt"),n=document.querySelectorAll(".collapse-all-defs-button");e.forEach(t=>{const e=document.createElement("button");e.classList.add("collapse-all-defs-button","btn"),e.innerHTML="▲",e.setAttribute("id","toggleButton"),t.appendChild(e)}),document.addEventListener("click",e=>{e.target.classList.contains("collapse-all-defs-button")&&(!function(){const e=t[0].classList.contains("hidden");t.forEach(t=>{t.classList.toggle("hidden",!e),t.classList.toggle("visible",e)}),n.forEach(t=>{t.innerHTML=e?"▲":"▼",t.title=e?"Collapse all definitions":"Expand all definitions"})}(),e.target.scrollIntoView({behavior:"smooth",block:"start",inline:"nearest"}),setTimeout(()=>{window.scrollBy({top:-100,behavior:"smooth"})},500))})}document.addEventListener("DOMContentLoaded",(function(){collapseDefinitions()}));
 /**
  * @file This file adds an href attribute to the snapshot link on the page via client side JS DOM manipulation.
  * @author Kor Dwarshuis

package/assets/js/collapse-definitions.js

@@ -1,5 +1,6 @@
 function collapseDefinitions() {
-    const dds = document.querySelectorAll('#content dl dd');
+    const dds = document.querySelectorAll('#content dl.terms-and-definitions-list > dd');
+    const dts = document.querySelectorAll('#content dl.terms-and-definitions-list > dt');
     const buttons = document.querySelectorAll('.collapse-all-defs-button');
 
     function toggleVisibility() {
@@ -15,7 +16,7 @@ function collapseDefinitions() {
     }
 
     // Add button as last child of every <dl>
-    document.querySelectorAll('dt').forEach(dt => {
+    dts.forEach(dt => {
         const button = document.createElement('button');
         button.classList.add('collapse-all-defs-button', 'btn');
         button.innerHTML = '▲';

package/index.js

@@ -55,7 +55,8 @@ module.exports = function (options = {}) {
   
   function createScriptElementWithXrefDataForEmbeddingInHtml() {
     // Test if xrefs-data.js exists, else make it an empty string
-    const inputPath = 'output/xrefs-data.js';
+    const inputPath = path.join('output', 'xrefs-data.js');
+
     let xrefsData = "";
     if (fs.existsSync(inputPath)) {
       xrefsData = '<script>' + fs.readFileSync(inputPath, 'utf8') + '</script>';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.76",
+  "version": "1.0.77",
   "description": "Technical specification drafting tool that generates rich specification documents from markdown. Forked from https://github.com/decentralized-identity/spec-up by Daniel Buchner (https://github.com/csuwildcat)",
   "main": "./index",
   "repository": {

package/src/create-term-index.js

@@ -21,7 +21,7 @@ function createTermIndex() {
     const config = fs.readJsonSync('specs.json');
     const specDirectories = config.specs.map(spec => spec.spec_directory);
     const specTermDirectoryName = config.specs.map(spec => spec.spec_terms_directory);
-    const outputPathJSON = './term-index.json';
+    const outputPathJSON = path.join('output', 'term-index.json');
     const files = fs.readdirSync(path.join(specDirectories[0], specTermDirectoryName[0]))
         .filter(file => !file.startsWith('_'));
 

package/src/get-xrefs-data.js

@@ -92,22 +92,44 @@ async function fetchTermInfoFromGithub(GITHUB_API_TOKEN, xref) {
 
 // Function to fetch the content of a file from a specific commit in a GitHub repository.
 async function fetchFileContentFromCommit(GITHUB_API_TOKEN, owner, repo, commitHash, filePath) {
-    try {
-        const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${commitHash}?recursive=1`;
-        const treeResponse = await fetch(treeUrl, { headers: setupFetchHeaders(GITHUB_API_TOKEN) });
-
-        if (treeResponse.ok) {
-            const treeData = await treeResponse.json();
-            const file = treeData.tree.find(item => item.path === filePath);
-            if (file) {
-                const fileContentResponse = await fetch(file.url);
-                const fileContentData = await fileContentResponse.json();
-                return Buffer.from(fileContentData.content, 'base64').toString('utf-8');
+    const MAX_RETRIES = 3;
+    let retries = 0;
+
+    while (retries < MAX_RETRIES) {
+        try {
+            const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${commitHash}?recursive=1`;
+            const treeResponse = await fetch(treeUrl, { headers: setupFetchHeaders(GITHUB_API_TOKEN) });
+
+            if (treeResponse.ok) {
+                const treeData = await treeResponse.json();
+                const file = treeData.tree.find(item => item.path === filePath);
+                if (file) {
+                    const fileContentResponse = await fetch(file.url);
+                    const fileContentData = await fileContentResponse.json();
+                    if (fileContentData.content) {
+                        return Buffer.from(fileContentData.content, 'base64').toString('utf-8');
+                    } else {
+                        console.error('Error: fileContentData.content is undefined');
+                    }
+                } else {
+                    console.error(`Error: File ${filePath} not found in commit ${commitHash}`);
+                }
+            } else if (treeResponse.status === 403 && treeResponse.headers.get('X-RateLimit-Remaining') === '0') {
+                const resetTime = treeResponse.headers.get('X-RateLimit-Reset');
+                const waitTime = resetTime ? (resetTime - Math.floor(Date.now() / 1000)) * 1000 : 60000;
+                console.warn(`Rate limit exceeded. Retrying in ${waitTime / 1000} seconds...`);
+                await new Promise(resolve => setTimeout(resolve, waitTime));
+                retries++;
+            } else {
+                console.error(`Error: Failed to fetch tree from ${treeUrl}`);
+                break;
             }
+        } catch (error) {
+            console.error(`Error fetching file content: ${error.message}`);
+            break;
         }
-    } catch (error) {
-        console.error(`\n   SPEC-UP-T: Error fetching file content: ${error.message}\n`);
     }
+
     return null;
 }
 

package/src/insert-term-index.js

@@ -18,8 +18,8 @@
 function insertTermIndex() {
     const fs = require('fs-extra');
     const path = require('path');
-    const config = fs.readJsonSync('./specs.json');
-    const terms = fs.readJsonSync('./term-index.json');
+    const config = fs.readJsonSync(path.join('specs.json'));
+    const terms = fs.readJsonSync(path.join('output', 'term-index.json'));
     const outputPathJSON = path.join('output', 'specs-generated.json');
     let specGenerated = config;
     let markdownPaths = specGenerated.specs[0].markdown_paths;

package/index.spec-up.js

@@ -1,366 +0,0 @@
-
-module.exports = function (options = {}) {
-
-  const {
-    fetchExternalSpecs,
-    validateReferences,
-    findExternalSpecByKey
-  } = require('./references.js');
-  const gulp = require('gulp');
-  const fs = require('fs-extra');
-  const path = require('path');
-  const findPkgDir = require('find-pkg-dir');
-  const modulePath = findPkgDir(__dirname);
-  let config = fs.readJsonSync('./specs.json');
-  let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
-  let externalReferences;
-  let references = [];
-  let definitions = [];
-
-  const katexRules = ['math_block', 'math_inline']
-  const replacerRegex = /\[\[\s*([^\s\[\]:]+):?\s*([^\]\n]+)?\]\]/img;
-  const replacerArgsRegex = /\s*,+\s*/;
-  const replacers = [
-    {
-      test: 'insert',
-      transform: function (path) {
-        if (!path) return '';
-        return fs.readFileSync(path, 'utf8');
-      }
-    }
-  ];
-
-  function applyReplacers(doc) {
-    return doc.replace(replacerRegex, function (match, type, args) {
-      let replacer = replacers.find(r => type.trim().match(r.test));
-      return replacer ? replacer.transform(...args.trim().split(replacerArgsRegex)) : match;
-    });
-  }
-
-  function normalizePath(path) {
-    return path.trim().replace(/\/$/g, '') + '/';
-  }
-
-  function renderRefGroup(type) {
-    let group = specGroups[type];
-    if (!group) return '';
-    let html = Object.keys(group).sort().reduce((html, name) => {
-      let ref = group[name];
-      return html += `
-        <dt id="ref:${name}">${name}</dt>
-        <dd>
-          <cite><a href="${ref.href}">${ref.title}</a></cite>. 
-          ${ref.authors.join('; ')}; ${ref.rawDate}. <span class="reference-status">Status: ${ref.status}</span>.
-        </dd>
-      `;
-    }, '<dl class="reference-list">')
-    return `\n${html}\n</dl>\n`;
-  }
-
-  function findKatexDist() {
-    const relpath = "node_modules/katex/dist";
-    const paths = [
-      path.join(process.cwd(), relpath),
-      path.join(__dirname, relpath),
-    ];
-    for (const abspath of paths) {
-      if (fs.existsSync(abspath)) {
-        return abspath
-      }
-    }
-    throw Error("katex distribution could not be located");
-  }
-
-  try {
-
-    var toc;
-    var specGroups = {};
-    const noticeTypes = {
-      note: 1,
-      issue: 1,
-      example: 1,
-      warning: 1,
-      todo: 1
-    };
-    const spaceRegex = /\s+/g;
-    const specNameRegex = /^spec$|^spec[-]*\w+$/i;
-    const terminologyRegex = /^def$|^ref$|^xref/i;
-    const specCorpus = fs.readJsonSync(modulePath + '/assets/compiled/refs.json');
-    const containers = require('markdown-it-container');
-    const md = require('markdown-it')({
-      html: true,
-      linkify: true,
-      typographer: true
-    })
-      .use(require('./src/markdown-it-extensions.js'), [
-        {
-          filter: type => type.match(terminologyRegex),
-          parse(token, type, primary) {
-            if (!primary) return;
-            if (type === 'def') {
-              definitions.push(token.info.args);
-              return token.info.args.reduce((acc, syn) => {
-                return `<span id="term:${syn.replace(spaceRegex, '-').toLowerCase()}">${acc}</span>`;
-              }, primary);
-            }
-            else if (type === 'xref') {
-              const url = findExternalSpecByKey(config, token.info.args[0]);
-              const term = token.info.args[1].replace(spaceRegex, '-').toLowerCase();
-              return `<a class="term-reference" data-local-href="#term:${token.info.args[0]}:${term}"
-                href="${url}#term:${term}">${token.info.args[1]}</a>`;
-            }
-            else {
-              references.push(primary);
-              return `<a class="term-reference" href="#term:${primary.replace(spaceRegex, '-').toLowerCase()}">${primary}</a>`;
-            }
-          }
-        },
-        {
-          filter: type => type.match(specNameRegex),
-          parse(token, type, name) {
-            if (name) {
-              let _name = name.replace(spaceRegex, '-').toUpperCase();
-              let spec = specCorpus[_name] ||
-                specCorpus[_name.toLowerCase()] ||
-                specCorpus[name.toLowerCase()] ||
-                specCorpus[name];
-              if (spec) {
-                spec._name = _name;
-                let group = specGroups[type] = specGroups[type] || {};
-                token.info.spec = group[_name] = spec;
-              }
-            }
-          },
-          render(token, type, name) {
-            if (name) {
-              let spec = token.info.spec;
-              if (spec) return `[<a class="spec-reference" href="#ref:${spec._name}">${spec._name}</a>]`;
-            }
-            else return renderRefGroup(type);
-          }
-        }
-      ])
-      .use(require('markdown-it-attrs'))
-      .use(require('markdown-it-chart').default)
-      .use(require('markdown-it-deflist'))
-      .use(require('markdown-it-references'))
-      .use(require('markdown-it-icons').default, 'font-awesome')
-      .use(require('markdown-it-ins'))
-      .use(require('markdown-it-mark'))
-      .use(require('markdown-it-textual-uml'))
-      .use(require('markdown-it-sub'))
-      .use(require('markdown-it-sup'))
-      .use(require('markdown-it-task-lists'))
-      .use(require('markdown-it-multimd-table'), {
-        multiline: true,
-        rowspan: true,
-        headerless: true
-      })
-      .use(containers, 'notice', {
-        validate: function (params) {
-          let matches = params.match(/(\w+)\s?(.*)?/);
-          return matches && noticeTypes[matches[1]];
-        },
-        render: function (tokens, idx) {
-          let matches = tokens[idx].info.match(/(\w+)\s?(.*)?/);
-          if (matches && tokens[idx].nesting === 1) {
-            let id;
-            let type = matches[1];
-            if (matches[2]) {
-              id = matches[2].trim().replace(/\s+/g, '-').toLowerCase();
-              if (noticeTitles[id]) id += '-' + noticeTitles[id]++;
-              else noticeTitles[id] = 1;
-            }
-            else id = type + '-' + noticeTypes[type]++;
-            return `<div id="${id}" class="notice ${type}"><a class="notice-link" href="#${id}">${type.toUpperCase()}</a>`;
-          }
-          else return '</div>\n';
-        }
-      })
-      .use(require('markdown-it-prism'))
-      .use(require('markdown-it-toc-and-anchor').default, {
-        tocClassName: 'toc',
-        tocFirstLevel: 2,
-        tocLastLevel: 4,
-        tocCallback: (_md, _tokens, html) => toc = html,
-        anchorLinkSymbol: '§',
-        anchorClassName: 'toc-anchor'
-      })
-      .use(require('@traptitech/markdown-it-katex'))
-
-    async function render(spec, assets) {
-      try {
-        noticeTitles = {};
-        specGroups = {};
-        console.log('Rendering: ' + spec.title);
-        return new Promise(async (resolve, reject) => {
-          Promise.all((spec.markdown_paths || ['spec.md']).map(_path => {
-            return fs.readFile(spec.spec_directory + _path, 'utf8').catch(e => reject(e))
-          })).then(async docs => {
-            const features = (({ source, logo }) => ({ source, logo }))(spec);
-            if (spec.external_specs && !externalReferences) {
-              externalReferences = await fetchExternalSpecs(spec);
-            }
-            let doc = docs.join("\n");
-            doc = applyReplacers(doc);
-            md[spec.katex ? "enable" : "disable"](katexRules);
-            const render = md.render(doc);
-            fs.writeFile(path.join(spec.destination, 'index.html'), `
-              <!DOCTYPE html>
-              <html lang="en">
-                <head>
-                  <meta charset="utf-8">
-                  <meta http-equiv="X-UA-Compatible" content="IE=edge">
-                  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-      
-                  <title>${spec.title}</title>
-
-                  <link href="https://fonts.googleapis.com/css2?family=Heebo:wght@300;400&display=swap" rel="stylesheet">
-
-                  ${assets.head}
-                </head>
-                <body features="${Object.keys(features).join(' ')}">
-                  
-                  ${assets.svg}
-      
-                  <main>
-      
-                    <header id="header" class="panel-header">
-                      <span id="toc_toggle" panel-toggle="toc">
-                        <svg icon><use xlink:href="#svg-nested-list"></use></svg>
-                      </span>
-                      <a id="logo" href="${spec.logo_link ? spec.logo_link : '#_'}">
-                        <img src="${spec.logo}" />
-                      </a>
-                      <span issue-count animate panel-toggle="repo_issues">
-                        <svg icon><use xlink:href="#svg-github"></use></svg>
-                      </span>
-                    </header>
-      
-                    <article id="content">
-                      ${render}
-                    </article>    
-      
-                  </main>
-      
-                  <slide-panels id="slidepanels">
-                    <slide-panel id="repo_issues" options="right">
-                      <header class="panel-header">
-                        <span>
-                          <svg icon><use xlink:href="#svg-github"></use></svg>
-                          <span issue-count></span>
-                        </span>
-                        <span class="repo-issue-toggle" panel-toggle="repo_issues">✕</span>
-                      </header>
-                      <ul id="repo_issue_list"></ul>
-                    </slide-panel>
-      
-                    <slide-panel id="toc">
-                      <header class="panel-header">
-                        <span>Table of Contents</span>
-                        <span panel-toggle="toc">✕</span>
-                      </header>
-                      <div id="toc_list">
-                        ${toc}
-                      </div>
-                    </slide-panel>
-                    
-                  </slide-panels>
-                  <div style="display: none;">
-                    ${externalReferences}
-                  </div>
-                </body>
-                <script>window.specConfig = ${JSON.stringify(spec)}</script>
-                ${assets.body}
-              </html>
-            `, function (err, data) {
-              if (err) {
-                reject(err);
-              }
-              else {
-                resolve();
-              }
-            });
-            validateReferences(references, definitions, render);
-            references = [];
-            definitions = [];
-          });
-        });
-      }
-      catch (e) {
-        console.error(e);
-      }
-    }
-
-    config.specs.forEach(spec => {
-      spec.spec_directory = normalizePath(spec.spec_directory);
-      spec.destination = normalizePath(spec.output_path || spec.spec_directory);
-
-      fs.ensureDirSync(spec.destination);
-
-      let assetTags = {
-        svg: fs.readFileSync(modulePath + '/assets/icons.svg', 'utf8') || ''
-      };
-
-      let customAssets = (spec.assets || []).reduce((assets, asset) => {
-        let ext = asset.path.split('.').pop();
-        if (ext === 'css') {
-          assets.css += `<link href="${asset.path}" rel="stylesheet"/>`;
-        }
-        if (ext === 'js') {
-          assets.js[asset.inject || 'body'] += `<script src="${asset.path}" ${asset.module ? 'type="module"' : ''} ></script>`;
-        }
-        return assets;
-      }, {
-        css: '',
-        js: { head: '', body: '' }
-      });
-
-      if (options.dev) {
-        assetTags.head = assets.head.css.map(_path => `<link href="${_path}" rel="stylesheet"/>`).join('') +
-          customAssets.css +
-          assets.head.js.map(_path => `<script src="${_path}"></script>`).join('') +
-          customAssets.js.head;
-        assetTags.body = assets.body.js.map(_path => `<script src="${_path}" data-manual></script>`).join('') +
-          customAssets.js.body;
-      }
-      else {
-        assetTags.head = `
-          <style>${fs.readFileSync(modulePath + '/assets/compiled/head.css', 'utf8')}</style>
-          ${customAssets.css}
-          <script>${fs.readFileSync(modulePath + '/assets/compiled/head.js', 'utf8')}</script>
-          ${customAssets.js.head}
-        `;
-        assetTags.body = `<script>${fs.readFileSync(modulePath + '/assets/compiled/body.js', 'utf8')}</script>
-                          ${customAssets.js.body}`;
-      }
-
-      if (spec.katex) {
-        const katexDist = findKatexDist();
-        assetTags.body += `<script>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.js'),
-          'utf8')}</script>`;
-        assetTags.body += `<style>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.css'),
-          'utf8')}</style>`;
-
-        fs.copySync(path.join(katexDist, 'fonts'), path.join(spec.destination, 'fonts'));
-      }
-
-      if (!options.nowatch) {
-        gulp.watch(
-          [spec.spec_directory + '**/*', '!' + path.join(spec.destination, 'index.html')],
-          render.bind(null, spec, assetTags)
-        )
-      }
-
-      render(spec, assetTags).then(() => {
-        if (options.nowatch) process.exit(0)
-      }).catch(() => process.exit(1));
-
-    });
-
-  }
-  catch (e) {
-    console.error(e);
-  }
-
-}

package/src/prepare-tref.js

@@ -1,7 +0,0 @@
-function prepareTref(tref) {
-
-
-
-}
-
-module.export = { prepareTref };