@forsakringskassan/docs-generator 2.28.11 → 2.29.1

package/dist/index.mjs

@@ -4,8 +4,8 @@ const require = $createRequire(import.meta.url);
 
 import fs from 'node:fs/promises';
 import path from 'node:path/posix';
-import { g as globSync, m as minimatch, M as MarkdownIt, d as dedent, e as closest, f as distance, h as fm, i as isCI, j as glob, k as moduleImporter, l as cliProgress, t as tinylr, w as watch, n as createInstance, o as fse } from './vendor-CMzqoPR8.mjs';
-import { g as generateId, p as parseInfostring, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, f as findTag, b as getOutputFilePath, d as htmlencode, e as exampleWorkerUrl, c as createMarkdownRenderer, j as generateExample } from './create-markdown-renderer-DcyK76t5.mjs';
+import { g as globSync, m as minimatch, M as MarkdownIt, d as dedent, b as closest, e as distance, f as fm, i as isCI, h as glob, j as moduleImporter, k as cliProgress, t as tinylr, w as watch, l as createInstance, n as fse } from './vendor-CUZpvssc.mjs';
+import { g as generateId, p as parseInfostring, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, f as findTag, b as getOutputFilePath, d as htmlencode, e as exampleWorkerUrl, c as createMarkdownRenderer, j as generateExample } from './create-markdown-renderer-xNUEILpa.mjs';
 import path$1 from 'node:path';
 import require$$1 from 'crypto';
 import 'node:crypto';
@@ -15,7 +15,7 @@ import { codeFrameColumns } from '@babel/code-frame';
 import { parse } from 'vue-docgen-api';
 import { parse as parse$2 } from '@babel/parser';
 import traverseModule from '@babel/traverse';
-import { parse as parse$1, compileScript as compileScript$1, compileTemplate } from '@vue/compiler-sfc';
+import { parse as parse$1, compileScript as compileScript$1, compileTemplate } from 'vue/compiler-sfc';
 import fs__default, { existsSync, readFileSync, copyFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import { compileStringAsync, NodePackageImporter } from 'sass';
@@ -27,7 +27,6 @@ import 'fs';
 import 'node:events';
 import 'node:stream';
 import 'node:string_decoder';
-import 'typescript';
 import 'constants';
 import 'stream';
 import 'util';
@@ -47,7 +46,7 @@ import 'tls';
 import 'tty';
 import 'querystring';
 import 'vue';
-import './vue3-CprzF_70.mjs';
+import './vue3-CRwEnRGE.mjs';
 
 function toArray$2(value) {
   return Array.isArray(value) ? value : [value];
@@ -284,8 +283,8 @@ function slugify(value) {
   return value.toLowerCase().replace(/\//g, "--").replace(/[^a-z]+/g, "-").replace(/(^-+|-+$)/, "");
 }
 
-const md$5 = MarkdownIt();
-md$5.renderer.rules.fence = (tokens, idx, _options, collected) => {
+const md$6 = MarkdownIt();
+md$6.renderer.rules.fence = (tokens, idx, _options, collected) => {
   const { content, info } = tokens[idx];
   const { language, tags } = parseInfostring(info);
   if (language === "import") {
@@ -306,7 +305,7 @@ function findExamples$1(doc) {
     return [];
   }
   const collected = [];
-  md$5.render(doc.body, collected);
+  md$6.render(doc.body, collected);
   return collected;
 }
 function getSuffix(tags) {
@@ -373,8 +372,8 @@ function extractExamplesProcessor(options) {
   };
 }
 
-const md$4 = MarkdownIt();
-md$4.renderer.rules.fence = (tokens, idx, _options, collected) => {
+const md$5 = MarkdownIt();
+md$5.renderer.rules.fence = (tokens, idx, _options, collected) => {
   const { content, info, map } = tokens[idx];
   const { language: rawLanguage, tags } = parseInfostring(info);
   const hashContent = `${map?.[0]}:${map?.[1]}:${info}:${content}`;
@@ -412,7 +411,7 @@ function findExamples(doc) {
     return [];
   }
   const collected = [];
-  md$4.render(doc.body, collected);
+  md$5.render(doc.body, collected);
   return collected;
 }
 function manifestPageFromDocument(doc) {
@@ -1239,30 +1238,91 @@ function translateSlotBindings(slot) {
   }
   return translatedBindings;
 }
+function filterModels(rawProps, rawEvents) {
+  const modelEvents = rawEvents.filter((it) => it.name.startsWith("update:"));
+  const rawModels = modelEvents.map((it) => {
+    const propName = it.name.slice("update:".length);
+    const prop = rawProps.find((it2) => it2.name === propName);
+    if (!prop) {
+      return null;
+    }
+    return {
+      ...prop,
+      name: propName === "modelValue" ? "v-model" : `v-model:${propName}`
+    };
+  });
+  const models = rawModels.filter((model) => model !== null);
+  const events = rawEvents.filter((it) => !it.name.startsWith("update:"));
+  const props = rawProps.filter((prop) => {
+    const hasModelName = models.some(
+      (model) => model.name.slice("v-model:".length) === prop.name
+    );
+    return !(hasModelName || prop.name.startsWith("modelValue"));
+  });
+  return { models, props, events };
+}
 async function translateAPI(filePath) {
   const api = await parse(filePath);
-  const props = api.props ? translateProps(api.props) : [];
-  const events = api.events ? translateEvents(api.events) : [];
+  const rawProps = api.props ? translateProps(api.props) : [];
+  const rawEvents = api.events ? translateEvents(api.events) : [];
+  const { models, props, events } = filterModels(rawProps, rawEvents);
   const slots = api.slots ? translateSlots(api.slots) : [];
-  for (const event of events) {
-    if (!event.name.startsWith("update:")) {
-      continue;
-    }
-    const prop = event.name.slice("update:".length);
-    const entry = props.find((it) => it.name === prop);
-    if (entry) {
-      entry.name = prop === "modelValue" ? "v-model" : `v-model:${prop}`;
-    }
-  }
   return {
     name: api.displayName,
     slug: slugify(api.displayName),
+    models,
     props,
     events,
     slots
   };
 }
 
+const md$4 = MarkdownIt();
+const EMPTY_CHAR$4 = "‐";
+function render$5(text) {
+  return text ? md$4.render(text) : EMPTY_CHAR$4;
+}
+function renderInline$4(text) {
+  return text ? md$4.renderInline(text) : EMPTY_CHAR$4;
+}
+function generateModelTable(slug, models) {
+  return (
+    /* HTML */
+    `
+        <next-heading-level id="${slug}-models">
+            <a class="header-anchor" href="#${slug}-models">Models</a>
+        </next-heading-level>
+        <dl class="docs-api docs-api--models">
+            ${models.map((model) => {
+      const { name } = model;
+      const id = `${slug}-model-${slugify(name)}`;
+      return (
+        /* HTML */
+        `
+                        <dt>
+                            <code id="${id}"
+                                ><a class="docs-api__anchor" href="#${id}"
+                                    ><span class="docs-api__name"
+                                        >${htmlencode(name)}</span
+                                    >: ${htmlencode(model.type ?? "unknown")}</a
+                                ></code
+                            >
+                            ${model.required ? "" : `<span class="docs-tag docs-tag--default">Optional</span>`}
+                            ${model.deprecated === null ? "" : `<span class="docs-tag docs-tag--deprecated">Deprecated</span>`}
+                        </dt>
+                        <dd>
+                            ${render$5(model.description)}
+                            ${model.default ? `<p class="doc-api__item">Default: <code>${htmlencode(model.default.value)}</code></p>` : ""}
+                            ${model.deprecated ? `<p class="doc-api__item docs-deprecated">Deprecated: ${renderInline$4(model.deprecated)}</p>` : ""}
+                        </dd>
+                    `
+      );
+    }).join("")}
+        </dl>
+    `
+  );
+}
+
 const md$3 = MarkdownIt();
 const EMPTY_CHAR$3 = "&#8208;";
 function render$4(text) {
@@ -1661,6 +1721,9 @@ function parseAPI(filePath, api) {
   const parsedPath = path$1.parse(relative);
   const componentName = parsedPath.name;
   let html = "";
+  if (api.models.length) {
+    html += generateModelTable(api.slug, api.models);
+  }
   if (api.props.length) {
     html += generatePropTable(api.slug, api.props);
   }