reffy 18.1.2 → 18.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reffy",
-  "version": "18.1.2",
+  "version": "18.2.0",
   "description": "W3C/WHATWG spec dependencies exploration companion. Features a short set of tools to study spec references as well as WebIDL term definitions and references found in W3C specifications.",
   "repository": {
     "type": "git",
@@ -35,18 +35,18 @@
   "dependencies": {
     "ajv": "8.17.1",
     "ajv-formats": "3.0.1",
-    "commander": "12.1.0",
+    "commander": "13.0.0",
     "fetch-filecache-for-crawling": "5.1.1",
-    "puppeteer": "23.11.1",
+    "puppeteer": "24.1.0",
     "semver": "^7.3.5",
-    "web-specs": "3.31.0",
+    "web-specs": "3.34.0",
     "webidl2": "24.4.1"
   },
   "devDependencies": {
     "mocha": "11.0.1",
-    "respec": "35.2.1",
+    "respec": "35.2.2",
     "respec-hljs": "2.1.1",
-    "rollup": "4.28.1",
+    "rollup": "4.30.1",
     "undici": "^7.0.0"
   },
   "overrides": {

package/src/browserlib/extract-dfns.mjs

@@ -85,6 +85,12 @@ function hasValidType(el) {
     'element-attr',
     'attr-value',
 
+    // CDDL types
+    'cddl-module',
+    'cddl-type',
+    'cddl-parameter',
+    'cddl-key',
+    'cddl-value',
 
     // URL scheme
     'scheme',
@@ -231,13 +237,15 @@ function definitionMapper(el, idToHeading, usesDfnDataModel) {
       [],
 
     // Definition is public if explicitly marked as exportable or if export has
-    // not been explicitly disallowed and its type is not "dfn", or if the spec
-    // is an old spec that does not use the "data-dfn-type" convention.
+    // not been explicitly disallowed and its type is not "dfn" or a CDDL type,
+    // or if the spec is an old spec that does not use the "data-dfn-type"
+    // convention.
     access: (!usesDfnDataModel ||
              el.hasAttribute('data-export') ||
              (!el.hasAttribute('data-noexport') &&
               el.hasAttribute('data-dfn-type') &&
-              el.getAttribute('data-dfn-type') !== 'dfn')) ?
+              el.getAttribute('data-dfn-type') !== 'dfn' &&
+              !el.getAttribute('data-dfn-type').startsWith('cddl-'))) ?
       'public' : 'private',
 
     // Whether the term is defined in a normative/informative section
@@ -293,6 +301,10 @@ export default function (spec, idToHeading = {}) {
   case "SVG2":
     preProcessSVG2();
     break;
+  case "rfc8610":
+    // RFC8610 defines CDDL
+    preProcessRFC8610();
+    break;
   }
 
   const definitions = [...document.querySelectorAll(definitionsSelector)];
@@ -861,3 +873,53 @@ function preProcessSVG2() {
   });
 
 }
+
+/**
+ * The CDDL RFC defines a standard prelude with a number of CDDL types that
+ * other specs that define CDDL make extensive use of. To be able to link back
+ * to these type definitions from other specs, we need these types to appear
+ * in the dfns extract of the RFC somehow.
+ *
+ * Now, the RFC only defines one ID for the appendix that contains the
+ * standard prelude. We need to "share" that ID across all types. To avoid
+ * introducing definitions that have the same ID and href, which could perhaps
+ * confuse tools that ingest the definitions, the approach taken here is to
+ * create a single definition that contains all the types as linking text.
+ */
+function preProcessRFC8610() {
+  // The RFC is defined as a set of pages (yuck!)
+  // The standard prelude is an appendix, let's look for it
+  const prePages = [...document.querySelectorAll('pre.newpage')];
+  const preludeStart = /<a [^>]*id=[^>]*>Appendix .<\/a>\.\s+Standard Prelude/;
+  const preludeEnd = /Figure \d+: CDDL Prelude/;
+  const preStart = prePages
+    .findIndex(pre => pre.innerHTML.match(preludeStart));
+  if (preStart === -1) {
+    // Can't find the expected prelude start text, not a good start!
+    return;
+  }
+  const preEnd = prePages
+    .findIndex((pre, idx) => idx >= preStart && pre.innerHTML.match(preludeEnd));
+  if (preEnd === -1) {
+    // Can't find the expected prelude ending text, not a good start!
+    return;
+  }
+
+  // Extract the list of types defined in the appendix
+  const preludeTypes = prePages.slice(preStart, preEnd + 1)
+    .map(pre => [...pre.innerHTML.matchAll(/^\s+([a-z0-9\-]+) = .*$/mg)]
+      .map(m => m[1])
+    )
+    .flat();
+
+  // Convert the appendix heading into a cddl-type definition that lists
+  // all CDDL types.
+  const el = prePages[preStart].querySelector(`a[id]`);
+  const dfn = document.createElement("dfn");
+  dfn.id = el.id;
+  dfn.dataset.dfnType = 'cddl-type';
+  dfn.dataset.lt = preludeTypes.join('|');
+  dfn.dataset.export = '';
+  dfn.textContent = el.textContent;
+  el.replaceWith(dfn);
+}