@forsakringskassan/docs-generator 2.18.0 → 2.19.0

package/dist/compile-example.js

@@ -3,10 +3,10 @@
 var path$1 = require('node:path');
 var esbuild = require('esbuild');
 var vue = require('vue');
-var vue3 = require('./vue3-CEAR7ggN.js');
+var vue3 = require('./vue3-BhdC7RZQ.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-Bagon7WF.js');
+require('./vendor-BHA4LIog.js');
 require('node:url');
 require('fs');
 require('node:fs');
@@ -56,7 +56,7 @@ function virtualEntryPlugin(entries) {
             namespace: pluginName
           };
         } else {
-          return undefined;
+          return void 0;
         }
       });
       build.onLoad({ filter: /.*/, namespace: pluginName }, (args) => {
@@ -140,3 +140,4 @@ async function run() {
   await compileExample(batch);
 }
 run();
+//# sourceMappingURL=compile-example.js.map

package/dist/compile-example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile-example.js","sources":["../src/esbuild/virtual-entry-plugin.ts","../src/compile-example.ts"],"sourcesContent":["import path from \"node:path/posix\";\nimport { type Plugin } from \"esbuild\";\n\nconst pluginName = \"virtual-entry\";\n\nexport type VirtualEntries = Record<string, string>;\n\nexport function virtualEntryPlugin(entries: VirtualEntries): Plugin {\n    function haveEntry(key: string): boolean {\n        return Boolean(entries[key]);\n    }\n\n    function getEntry(key: string): string {\n        return entries[key];\n    }\n\n    return {\n        name: pluginName,\n        setup(build) {\n            build.onResolve({ filter: /.*/ }, (args) => {\n                if (args.kind === \"entry-point\" && haveEntry(args.path)) {\n                    return {\n                        path: args.path,\n                        namespace: pluginName,\n                    };\n                } else {\n                    return undefined;\n                }\n            });\n            build.onLoad({ filter: /.*/, namespace: pluginName }, (args) => {\n                const contents = getEntry(args.path);\n                return {\n                    contents,\n                    loader: \"ts\",\n                    resolveDir: path.dirname(args.path),\n                };\n            });\n        },\n    };\n}\n","import path from \"node:path\";\nimport { type Plugin, build as esbuild } from \"esbuild\";\nimport { version } from \"vue\";\nimport { vuePlugin as Vue3Plugin } from \"plugin-vue3\";\nimport { virtualEntryPlugin } from \"./esbuild\";\nimport { type ExampleBatch } from \"./examples\";\n\nconst vueMajor = parseInt(version.split(\".\", 2)[0], 10) as 2 | 3;\nconst tsconfig = path.join(__dirname, \"../tsconfig-examples.json\");\n\nfunction stripExtension(filename: string): string {\n    return filename.replace(\".js\", \"\");\n}\n\nfunction VuePlugin(): Plugin {\n    switch (vueMajor) {\n        case 2:\n            throw new Error(\n                \"Vue 2 is no longer supported, upgrade to Vue 3 or downgrade docs-generator\",\n            );\n        case 3:\n            return Vue3Plugin();\n    }\n}\n\nasync function compileExample(batch: ExampleBatch): Promise<void> {\n    const { outputFolder: outdir, external, tasks } = batch;\n    const entryPoints = tasks.map((it) => {\n        return { in: it.sourceFile, out: stripExtension(it.outputFile) };\n    });\n    const virtualEntries = tasks.map((it): [key: string, value: string] => {\n        return [`./${it.sourceFile}`, it.sourcecode];\n    });\n    const iconLib = process.env.DOCS_ICON_LIB ?? \"@fkui/icon-lib-default\";\n    try {\n        await esbuild({\n            entryPoints,\n            outdir,\n            bundle: true,\n            format: \"iife\",\n            platform: \"browser\",\n            external,\n            tsconfig,\n            define: {\n                \"process.env.NODE_ENV\": JSON.stringify(\"development\"),\n                \"process.env.DOCS_ICON_LIB\": JSON.stringify(iconLib),\n            },\n            plugins: [\n                virtualEntryPlugin(Object.fromEntries(virtualEntries)),\n                VuePlugin(),\n            ],\n        });\n    } catch (err) {\n        /* eslint-disable-next-line no-console -- expected to log */\n        console.error(err);\n        process.exitCode = 1;\n    }\n}\n\nasync function readBatchData(): Promise<ExampleBatch> {\n    const { stdin } = process;\n    return new Promise((resolve, reject) => {\n        const chunks: Buffer[] = [];\n        stdin.on(\"data\", (chunk) => {\n            chunks.push(chunk);\n        });\n        stdin.on(\"end\", () => {\n            const content = Buffer.concat(chunks).toString(\"utf-8\");\n            const parsed = JSON.parse(content);\n            resolve(parsed);\n        });\n        stdin.on(\"error\", (error) => {\n            reject(error);\n        });\n    });\n}\n\nasync function run(): Promise<void> {\n    const batch = await readBatchData();\n    await compileExample(batch);\n}\n\nrun();\n"],"names":["version","path","Vue3Plugin","esbuild"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAM,UAAa,GAAA,eAAA;AAIZ,SAAS,mBAAmB,OAAiC,EAAA;AAChE,EAAA,SAAS,UAAU,GAAsB,EAAA;AACrC,IAAO,OAAA,OAAA,CAAQ,OAAQ,CAAA,GAAG,CAAC,CAAA;AAAA;AAG/B,EAAA,SAAS,SAAS,GAAqB,EAAA;AACnC,IAAA,OAAO,QAAQ,GAAG,CAAA;AAAA;AAGtB,EAAO,OAAA;AAAA,IACH,IAAM,EAAA,UAAA;AAAA,IACN,MAAM,KAAO,EAAA;AACT,MAAA,KAAA,CAAM,UAAU,EAAE,MAAA,EAAQ,IAAK,EAAA,EAAG,CAAC,IAAS,KAAA;AACxC,QAAA,IAAI,KAAK,IAAS,KAAA,aAAA,IAAiB,SAAU,CAAA,IAAA,CAAK,IAAI,CAAG,EAAA;AACrD,UAAO,OAAA;AAAA,YACH,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,SAAW,EAAA;AAAA,WACf;AAAA,SACG,MAAA;AACH,UAAO,OAAA,MAAA;AAAA;AACX,OACH,CAAA;AACD,MAAM,KAAA,CAAA,MAAA,CAAO,EAAE,MAAQ,EAAA,IAAA,EAAM,WAAW,UAAW,EAAA,EAAG,CAAC,IAAS,KAAA;AAC5D,QAAM,MAAA,QAAA,GAAW,QAAS,CAAA,IAAA,CAAK,IAAI,CAAA;AACnC,QAAO,OAAA;AAAA,UACH,QAAA;AAAA,UACA,MAAQ,EAAA,IAAA;AAAA,UACR,UAAY,EAAA,IAAA,CAAK,OAAQ,CAAA,IAAA,CAAK,IAAI;AAAA,SACtC;AAAA,OACH,CAAA;AAAA;AACL,GACJ;AACJ;;AChCA,MAAM,QAAA,GAAW,SAASA,WAAQ,CAAA,KAAA,CAAM,KAAK,CAAC,CAAA,CAAE,CAAC,CAAA,EAAG,EAAE,CAAA;AACtD,MAAM,QAAW,GAAAC,MAAA,CAAK,IAAK,CAAA,SAAA,EAAW,2BAA2B,CAAA;AAEjE,SAAS,eAAe,QAA0B,EAAA;AAC9C,EAAO,OAAA,QAAA,CAAS,OAAQ,CAAA,KAAA,EAAO,EAAE,CAAA;AACrC;AAEA,SAAS,SAAoB,GAAA;AACzB,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,CAAA;AACD,MAAA,MAAM,IAAI,KAAA;AAAA,QACN;AAAA,OACJ;AAAA,IACJ,KAAK,CAAA;AACD,MAAA,OAAOC,qBAAW,EAAA;AAAA;AAE9B;AAEA,eAAe,eAAe,KAAoC,EAAA;AAC9D,EAAA,MAAM,EAAE,YAAA,EAAc,MAAQ,EAAA,QAAA,EAAU,OAAU,GAAA,KAAA;AAClD,EAAA,MAAM,WAAc,GAAA,KAAA,CAAM,GAAI,CAAA,CAAC,EAAO,KAAA;AAClC,IAAO,OAAA,EAAE,IAAI,EAAG,CAAA,UAAA,EAAY,KAAK,cAAe,CAAA,EAAA,CAAG,UAAU,CAAE,EAAA;AAAA,GAClE,CAAA;AACD,EAAA,MAAM,cAAiB,GAAA,KAAA,CAAM,GAAI,CAAA,CAAC,EAAqC,KAAA;AACnE,IAAA,OAAO,CAAC,CAAK,EAAA,EAAA,EAAA,CAAG,UAAU,CAAA,CAAA,EAAI,GAAG,UAAU,CAAA;AAAA,GAC9C,CAAA;AACD,EAAM,MAAA,OAAA,GAAU,OAAQ,CAAA,GAAA,CAAI,aAAiB,IAAA,wBAAA;AAC7C,EAAI,IAAA;AACA,IAAA,MAAMC,aAAQ,CAAA;AAAA,MACV,WAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAQ,EAAA,IAAA;AAAA,MACR,MAAQ,EAAA,MAAA;AAAA,MACR,QAAU,EAAA,SAAA;AAAA,MACV,QAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAQ,EAAA;AAAA,QACJ,sBAAA,EAAwB,IAAK,CAAA,SAAA,CAAU,aAAa,CAAA;AAAA,QACpD,2BAAA,EAA6B,IAAK,CAAA,SAAA,CAAU,OAAO;AAAA,OACvD;AAAA,MACA,OAAS,EAAA;AAAA,QACL,kBAAmB,CAAA,MAAA,CAAO,WAAY,CAAA,cAAc,CAAC,CAAA;AAAA,QACrD,SAAU;AAAA;AACd,KACH,CAAA;AAAA,WACI,GAAK,EAAA;AAEV,IAAA,OAAA,CAAQ,MAAM,GAAG,CAAA;AACjB,IAAA,OAAA,CAAQ,QAAW,GAAA,CAAA;AAAA;AAE3B;AAEA,eAAe,aAAuC,GAAA;AAClD,EAAM,MAAA,EAAE,OAAU,GAAA,OAAA;AAClB,EAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACpC,IAAA,MAAM,SAAmB,EAAC;AAC1B,IAAM,KAAA,CAAA,EAAA,CAAG,MAAQ,EAAA,CAAC,KAAU,KAAA;AACxB,MAAA,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,KACpB,CAAA;AACD,IAAM,KAAA,CAAA,EAAA,CAAG,OAAO,MAAM;AAClB,MAAA,MAAM,UAAU,MAAO,CAAA,MAAA,CAAO,MAAM,CAAA,CAAE,SAAS,OAAO,CAAA;AACtD,MAAM,MAAA,MAAA,GAAS,IAAK,CAAA,KAAA,CAAM,OAAO,CAAA;AACjC,MAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,KACjB,CAAA;AACD,IAAM,KAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAU,KAAA;AACzB,MAAA,MAAA,CAAO,KAAK,CAAA;AAAA,KACf,CAAA;AAAA,GACJ,CAAA;AACL;AAEA,eAAe,GAAqB,GAAA;AAChC,EAAM,MAAA,KAAA,GAAQ,MAAM,aAAc,EAAA;AAClC,EAAA,MAAM,eAAe,KAAK,CAAA;AAC9B;AAEA,GAAI,EAAA;;"}

package/dist/{create-markdown-renderer-CaJTFjAd.js → create-markdown-renderer-CbE5KJoX.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var vendor = require('./vendor-Bagon7WF.js');
+var vendor = require('./vendor-BHA4LIog.js');
 var path = require('node:path/posix');
 var path$1 = require('node:path');
 require('crypto');
@@ -8,7 +8,11 @@ var crypto = require('node:crypto');
 require('node:child_process');
 var fs = require('node:fs');
 var vue = require('vue');
-var vue3 = require('./vue3-CEAR7ggN.js');
+var vue3 = require('./vue3-BhdC7RZQ.js');
+
+function isDocumentPage(doc) {
+  return doc.kind === "page";
+}
 
 function findDocument(haystack, needle) {
   const match = haystack.find((it) => {
@@ -131,6 +135,105 @@ function getExampleName(filename) {
   return path$1.parse(filename).name;
 }
 
+const vueMajor = parseInt(vue.version.split(".", 2)[0], 10);
+function vueGenerator() {
+  switch (vueMajor) {
+    case 2:
+      throw new Error(
+        "Vue 2 is no longer supported, upgrade to Vue 3 or downgrade docs-generator"
+      );
+    case 3:
+      return vue3.generateCode;
+  }
+}
+function generateExample(options) {
+  const { language } = options;
+  if (language === "import") {
+    const parsed = parseImport(options.source);
+    const filename = getExampleImport(
+      options.exampleFolders,
+      parsed.filename
+    );
+    const language2 = parsed.extension;
+    const comments = parsed.comments;
+    const content = fs.readFileSync(filename, "utf-8");
+    const example = generateExample({
+      ...options,
+      source: content,
+      language: language2,
+      filename
+    });
+    return { ...example, comments };
+  }
+  switch (language) {
+    case "vue":
+      return generateVueExample(options);
+    case "html":
+      return generateStaticExample(options);
+    default:
+      return generateStaticExample(options);
+  }
+}
+function generateVueExample(options) {
+  const { filename, source, parent, setupPath, tags } = options;
+  const fn = vueGenerator();
+  const slug = getExampleName(filename);
+  const fingerprint = getFingerprint(source);
+  const { markup, sourcecode, output } = fn({
+    filename,
+    slug,
+    fingerprint,
+    code: source,
+    setupPath
+  });
+  if (output) {
+    return {
+      source,
+      language: options.language,
+      comments: [],
+      tags,
+      markup,
+      output,
+      runtime: true,
+      task: {
+        outputFile: output,
+        sourcecode,
+        sourceFile: filename,
+        parent
+      }
+    };
+  } else {
+    return {
+      source: sourcecode,
+      language: "plaintext",
+      comments: [],
+      tags,
+      markup,
+      output: null,
+      runtime: true,
+      task: null
+    };
+  }
+}
+function generateStaticExample(options) {
+  const { filename, source, language, tags } = options;
+  const slug = getExampleName(filename);
+  const fingerprint = getFingerprint(source);
+  const asset = `${slug}-${fingerprint}.${language}`;
+  const runtimeLanguages = ["html"];
+  const runtime = runtimeLanguages.includes(language);
+  return {
+    source,
+    language: options.language,
+    comments: [],
+    tags,
+    markup: source,
+    output: runtime ? asset : null,
+    runtime,
+    task: null
+  };
+}
+
 function normalizeLanguage(lang) {
   switch (lang) {
     case "ts":
@@ -142,6 +245,14 @@ function normalizeLanguage(lang) {
   }
 }
 
+function parseInfostring(infostring) {
+  const [rawLanguage, ...rawTags] = infostring.trim().split(/\s+/);
+  return {
+    language: normalizeLanguage(rawLanguage),
+    tags: rawTags
+  };
+}
+
 function removeLinesInline(lines, { begin, end }) {
   for (let i = begin; i <= end; i++) {
     lines[i] = "";
@@ -238,114 +349,6 @@ function transformCode(code, lang) {
   return code;
 }
 
-const vueMajor = parseInt(vue.version.split(".", 2)[0], 10);
-function vueGenerator() {
-  switch (vueMajor) {
-    case 2:
-      throw new Error(
-        "Vue 2 is no longer supported, upgrade to Vue 3 or downgrade docs-generator"
-      );
-    case 3:
-      return vue3.generateCode;
-  }
-}
-function generateExample(options) {
-  const { language } = options;
-  if (language === "import") {
-    const parsed = parseImport(options.source);
-    const filename = getExampleImport(
-      options.exampleFolders,
-      parsed.filename
-    );
-    const language2 = parsed.extension;
-    const comments = parsed.comments;
-    const content = fs.readFileSync(filename, "utf-8");
-    const source = transformCode(content, language2);
-    const example = generateExample({
-      ...options,
-      source,
-      language: language2,
-      filename
-    });
-    return { ...example, comments };
-  }
-  switch (language) {
-    case "vue":
-      return generateVueExample(options);
-    case "html":
-      return generateStaticExample(options);
-    default:
-      return generateStaticExample(options);
-  }
-}
-function generateVueExample(options) {
-  const { filename, source, parent, setupPath, tags } = options;
-  const fn = vueGenerator();
-  const slug = getExampleName(filename);
-  const fingerprint = getFingerprint(source);
-  const { markup, sourcecode, output } = fn({
-    filename,
-    slug,
-    fingerprint,
-    code: source,
-    setupPath
-  });
-  if (output) {
-    return {
-      source,
-      language: options.language,
-      comments: [],
-      tags,
-      markup,
-      output,
-      runtime: true,
-      task: {
-        outputFile: output,
-        sourcecode,
-        sourceFile: filename,
-        parent
-      }
-    };
-  } else {
-    return {
-      source: sourcecode,
-      language: "plaintext",
-      comments: [],
-      tags,
-      markup,
-      output: null,
-      runtime: true,
-      task: null
-    };
-  }
-}
-function generateStaticExample(options) {
-  const { filename, source, language, tags } = options;
-  const slug = getExampleName(filename);
-  const fingerprint = getFingerprint(source);
-  const asset = `${slug}-${fingerprint}.${language}`;
-  const runtimeLanguages = ["html"];
-  const runtime = runtimeLanguages.includes(language);
-  return {
-    source,
-    language: options.language,
-    comments: [],
-    tags,
-    markup: source,
-    output: runtime ? asset : null,
-    runtime,
-    task: null
-  };
-}
-
-function parseInfostring(infostring) {
-  const [rawLanguage, ...rawTags] = infostring.trim().split(/\s+/);
-  return {
-    language: normalizeLanguage(rawLanguage),
-    tags: rawTags
-  };
-}
-
 class SoftError extends Error {
   code;
   details;
@@ -447,6 +450,17 @@ const linkTag = {
         }
       );
     }
+    if (!isDocumentPage(linked)) {
+      throw new SoftError(
+        "ELINKPARTIAL",
+        `Cannot link to partial document "${key}"`,
+        {
+          key,
+          hash,
+          title: explicitTitle
+        }
+      );
+    }
     const url = getRelativeUrl(doc, linked);
     const title = getLinkTitle(linked, key, explicitTitle);
     return `<a href="${url}${hash ?? ""}">${title}</a>`;
@@ -560,7 +574,7 @@ function getSource(content, language, tags, { namedExamples }) {
 function codePreview(options) {
   const { generateExample } = options;
   return (md) => {
-    md.renderer.rules.fence = fence.bind(undefined, md);
+    md.renderer.rules.fence = fence.bind(void 0, md);
   };
   function fence(_md, tokens, idx, _options, env) {
     const { fileInfo } = env;
@@ -605,7 +619,7 @@ function codePreview(options) {
     const highlightedCode = replaceAtLink(
       highlight({ source: transformedCode, language: example.language })
     );
-    const testId = findTestId(tags);
+    const testId = findTestId(tags) ?? findTag(tags, "name")?.value;
     const liveExample = tags.includes("live-example");
     const staticCode = example.runtime === false || tags.includes("static");
     const noMarkup = tags.includes("nomarkup");
@@ -794,9 +808,11 @@ function altContainer(context) {
   return (tokens, index) => {
     const token = tokens[index];
     const needle = token.info;
+    const tags = token.info.trim().split(/\s+/);
     const doc = findDocument(docs, needle);
     if (doc && doc.format === "markdown") {
-      return md.render(doc.body, env);
+      const body = typeof doc.body === "string" ? doc.body : doc.body(tags);
+      return md.render(body, env);
     }
     return md.render(token.content, env);
   };
@@ -807,6 +823,7 @@ function apiContainer(context) {
   return (tokens, index) => {
     const token = tokens[index];
     const needle = token.content.trim();
+    const tags = token.info.trim().split(/\s+/);
     const doc = findDocument(docs, needle);
     if (!doc) {
       return handleSoftError(
@@ -817,7 +834,9 @@ function apiContainer(context) {
         )
       );
     }
-    if (included.has(doc.id)) {
+    const key = [doc.id, ...tags].join("|");
+    const loop = included.get(doc.id);
+    if (loop && loop !== context.doc.id) {
       return handleSoftError(
         new SoftError(
           "EINCLUDERECURSION",
@@ -825,15 +844,16 @@ function apiContainer(context) {
         )
       );
     }
-    included.add(doc.id);
+    included.set(key, context.doc.id);
+    const body = typeof doc.body === "string" ? doc.body : doc.body(tags);
     if (doc.format === "html") {
-      return doc.body.replace(
+      return body.replace(
         /* replace `<next-heading-level>` and `</next-heading-level>` with actual h-tags */
         /(?<=<\/?)next-heading-level/g,
         `h${String(env.currentHeading + 1)}`
       );
     }
-    const content = md.render(doc.body, env);
+    const content = md.render(body, env);
     return (
       /* HTML */
       ` <div>${content}</div> `
@@ -988,11 +1008,14 @@ function containerParser(md, options) {
     md.renderer.rules[`doc_${kind}`] = fn;
   }
 }
-function containerRenderer(docs, env, included, handleSoftError, options) {
+function containerRenderer(doc, docs, env, included, handleSoftError, options) {
   return function(md) {
     const context = {
       md,
       env,
+      get doc() {
+        return doc();
+      },
       docs,
       included,
       handleSoftError
@@ -1049,7 +1072,16 @@ function createMarkdownRenderer(options) {
     currentHeading: 1,
     namedExamples: /* @__PURE__ */ new Map()
   };
-  const included = /* @__PURE__ */ new Set();
+  let currentDoc = null;
+  const getCurrentDocument = () => {
+    if (!currentDoc) {
+      throw new Error(
+        "Internal error: getting current document before rendering has started"
+      );
+    }
+    return currentDoc;
+  };
+  const included = /* @__PURE__ */ new Map();
   const md = vendor.MarkdownIt({
     html: true
   });
@@ -1066,16 +1098,24 @@ function createMarkdownRenderer(options) {
     })
   );
   md.use(
-    containerRenderer(docs, env, included, options.handleSoftError, {
-      messagebox: { title: {}, ...options.messagebox }
-    })
+    containerRenderer(
+      getCurrentDocument,
+      docs,
+      env,
+      included,
+      options.handleSoftError,
+      {
+        messagebox: { title: {}, ...options.messagebox }
+      }
+    )
   );
   md.use(table());
   md.use(codeInline());
   return {
     render(doc, content) {
+      currentDoc = doc;
       included.clear();
-      included.add(doc.id);
+      included.set(doc.id, doc.id);
       env.fileInfo = doc.fileInfo;
       env.ids = /* @__PURE__ */ new Set();
       const html = md.render(content, env);
@@ -1099,5 +1139,7 @@ exports.getFingerprint = getFingerprint;
 exports.getOutputFilePath = getOutputFilePath;
 exports.hasTag = hasTag;
 exports.htmlencode = htmlencode;
+exports.isDocumentPage = isDocumentPage;
 exports.normalizePath = normalizePath;
 exports.parseInfostring = parseInfostring;
+//# sourceMappingURL=create-markdown-renderer-CbE5KJoX.js.map