@forsakringskassan/docs-generator 2.11.4 → 2.12.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-CGUitvvB.js');
+var vue3 = require('./vue3-rkJOanAd.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-WsR_tA03.js');
+require('./vendor-CJBsNZrh.js');
 require('node:url');
 require('fs');
 require('node:fs');

package/dist/{create-markdown-renderer-B1v_YUfy.js → create-markdown-renderer-D5z4jt-T.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var vendor = require('./vendor-WsR_tA03.js');
+var vendor = require('./vendor-CJBsNZrh.js');
 var path = require('node:path/posix');
 var path$1 = require('node:path');
 require('crypto');

package/dist/index.d.ts

@@ -77,7 +77,7 @@ declare interface Document_2 {
     /** Document outline (i.e. the heading structure) */
     outline: DocumentOutline;
     /** format of body */
-    format: "markdown" | "html" | "json";
+    format: "markdown" | "html" | "json" | "redirect";
     tags: string[];
     template: string;
     fileInfo: FileInfo;
@@ -254,6 +254,13 @@ export declare interface GeneratorSiteOptions {
     lang?: string;
 }
 
+/**
+ * Creates redirects using html-files with meta redirects.
+ *
+ * @public
+ */
+export declare function htmlRedirectProcessor(): Processor;
+
 /**
  * @public
  */
@@ -266,6 +273,7 @@ export declare interface Manifest {
     pages: Array<{
         path: string;
         title: string;
+        redirect: null | string;
         outline: Array<{
             heading: string;
             anchor: string;
@@ -387,6 +395,7 @@ export declare interface NormalizedDocumentAttributes {
     href?: string;
     /** normalized sortorder (defaults to Infinity) */
     sortorder: number;
+    redirectFrom: string[];
 }
 
 /**
@@ -416,6 +425,7 @@ export declare interface ProcessorContext {
     readonly topnav: NavigationSection;
     readonly sidenav: NavigationSection;
     readonly resources: ResourceTask[];
+    readonly outputFolder: string;
     addDocument(document: Document_2 | Document_2[]): void;
     addVendorAsset(asset: VendorAsset | VendorAsset[]): void;
     /**
@@ -503,6 +513,15 @@ export declare interface ProcessorRuntime {
  */
 export declare type ProcessorStage = "generate-docs" | "generate-nav" | "assets" | "render";
 
+/**
+ * Generate a netlify-style `_redirects` file.
+ *
+ * @public
+ * @param prefix - Prefix to append to all urls, set to subdirectory if you're deploying to a subdirectory.
+ * @param filename - Output filename (relative to output folder).
+ */
+export declare function redirectFileProcessor(prefix?: string, filename?: string): Processor;
+
 /**
  * Represents a resource to be copied from `from` to `to`.
  *

package/dist/index.js

@@ -1,10 +1,10 @@
 'use strict';
 
 var fs = require('node:fs/promises');
-var vendor = require('./vendor-WsR_tA03.js');
+var vendor = require('./vendor-CJBsNZrh.js');
 var path = require('node:path');
 var require$$1 = require('crypto');
-var createMarkdownRenderer = require('./create-markdown-renderer-B1v_YUfy.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D5z4jt-T.js');
 var node_child_process = require('node:child_process');
 var path$1 = require('node:path/posix');
 require('node:crypto');
@@ -17,7 +17,7 @@ var Module = require('node:module');
 var esbuild$1 = require('esbuild');
 var nunjucks = require('nunjucks');
 var vue = require('vue');
-var vue3 = require('./vue3-CGUitvvB.js');
+var vue3 = require('./vue3-rkJOanAd.js');
 var express = require('express');
 require('fs');
 require('node:events');
@@ -311,15 +311,22 @@ function findExamples(doc) {
   return collected;
 }
 function manifestPageFromDocument(doc) {
-  const { fileInfo } = doc;
+  const { body, fileInfo, format } = doc;
   return {
     path: createMarkdownRenderer.getOutputFilePath("", fileInfo),
     title: doc.attributes.title ?? doc.name ?? "",
+    redirect: format === "redirect" ? body : null,
     outline: flattenOutline(doc.outline),
     examples: findExamples(doc)
   };
 }
 
+function line(page) {
+  if (page.redirect) {
+    return `${page.path} -> ${page.redirect}`;
+  }
+  return page.path;
+}
 function renderMarkdown(manifest) {
   return [
     "## Documentation manifest",
@@ -327,7 +334,7 @@ function renderMarkdown(manifest) {
     "> Do not edit this file. It is a automatically generated by `@forsakringskassan/docs-generator`.",
     "",
     "```",
-    ...manifest.pages.map((it) => it.path),
+    ...manifest.pages.map(line),
     "```",
     ""
   ].join("\n");
@@ -433,6 +440,157 @@ function themeSelectProcessor() {
   };
 }
 
+function dump(value) {
+  return `<pre>${JSON.stringify(value, null, 2)}</pre>`;
+}
+
+function json(value) {
+  return JSON.stringify(value, null, 2);
+}
+
+function isExternalUrl(url) {
+  return url.startsWith("http://") || url.startsWith("https://") || url.startsWith("//");
+}
+function isAbsoluteUrl(url) {
+  return url.startsWith("/");
+}
+function relative(url, { fileInfo }) {
+  if (isExternalUrl(url)) {
+    return url;
+  }
+  if (isAbsoluteUrl(url)) {
+    url = `.${url}`;
+  }
+  url = createMarkdownRenderer.normalizePath(url);
+  const outputPath = createMarkdownRenderer.normalizePath(fileInfo.path);
+  if (outputPath === url || `${outputPath}/` === url) {
+    return "./";
+  }
+  const relative2 = path$1.relative(outputPath, url);
+  const prefix = relative2.startsWith(".") ? "" : "./";
+  const suffix = url.endsWith("/") ? "/" : "";
+  return [prefix, relative2, suffix].join("");
+}
+
+function take(haystack, key, value) {
+  return haystack.filter((it) => it[key] === value);
+}
+
+const template = (dst) => (
+  /* HTML */
+  `
+    <!doctype html>
+    <html lang="en">
+        <head>
+            <meta http-equiv="refresh" content="0; url=${dst}" />
+        </head>
+        <body>
+            <p>
+                This page has moved to
+                <a href="${dst}"> ${dst} </a>.
+            </p>
+        </body>
+    </html>
+`
+);
+function htmlRedirectProcessor() {
+  return {
+    name: "html-redirect-processor",
+    after: "render",
+    async handler(context) {
+      const { docs, outputFolder } = context;
+      for (const doc of docs.filter(haveOutput)) {
+        if (doc.format !== "redirect") {
+          continue;
+        }
+        const filePath = createMarkdownRenderer.getOutputFilePath(outputFolder, doc.fileInfo);
+        const dst = relative(doc.body, doc);
+        const content = template(dst);
+        await fs.mkdir(path$1.dirname(filePath), { recursive: true });
+        await fs.writeFile(filePath, vendor.dedent(content), "utf-8");
+      }
+    }
+  };
+}
+
+function isRedirect(doc) {
+  return doc.format === "redirect";
+}
+function redirectFileProcessor(prefix = "/", filename = "_redirects") {
+  return {
+    name: "redirect-file-processor",
+    after: "render",
+    async handler(context) {
+      const { docs } = context;
+      const lines = docs.filter(haveOutput).filter(isRedirect).map((doc) => {
+        const src = createMarkdownRenderer.normalizePath(
+          doc.fileInfo.path,
+          doc.fileInfo.outputName
+        );
+        const dst = doc.body;
+        return `${prefix}${src} ${prefix}${dst} 301
+`;
+      });
+      const filePath = path$1.join(context.outputFolder, filename);
+      await fs.mkdir(path$1.dirname(filePath), { recursive: true });
+      await fs.writeFile(filePath, lines.join(""), "utf-8");
+      context.log(filename, "generated");
+    }
+  };
+}
+
+function getRedirects(docs) {
+  return docs.map((it) => {
+    const { fileInfo } = it;
+    const { path, outputName } = fileInfo;
+    if (outputName === false) {
+      return [];
+    }
+    return it.attributes.redirectFrom.map((jt) => {
+      return {
+        from: jt.startsWith("/") ? jt.slice(1) : jt,
+        to: createMarkdownRenderer.normalizePath(path, outputName)
+      };
+    });
+  }).flat();
+}
+
+function redirectProcessor() {
+  return {
+    name: "redirect-processor",
+    after: "generate-docs",
+    async handler(context) {
+      const redirects = getRedirects(context.docs);
+      for (const redirect of redirects) {
+        const { dir, base, name } = path$1.parse(redirect.from);
+        context.addDocument({
+          id: `redirect:${redirect.from}-${redirect.to}`,
+          name: `${redirect.from}-${redirect.to}`,
+          alias: [],
+          visible: false,
+          attributes: {
+            sortorder: Infinity,
+            redirectFrom: []
+          },
+          body: redirect.to,
+          outline: [],
+          format: "redirect",
+          tags: [],
+          template: "redirect",
+          fileInfo: {
+            path: dir,
+            name,
+            fullPath: "virtual:redirect",
+            outputName: base
+          }
+        });
+      }
+      const s = redirects.length === 1 ? "" : "s";
+      context.log(redirects.length, `redirect${s} found`);
+    }
+  };
+}
+
 function selectableVersionProcessor(pkg, container, options) {
   const { enabled = true, message = "Det finns en nyare version" } = options ?? {};
   return {
@@ -721,6 +879,7 @@ function parseFile$1(filePath, basePath, content) {
       status: attributes.status,
       badge: getBadge(attributes),
       component: getComponent(attributes),
+      redirectFrom: toArray$1(attributes.redirect_from ?? []),
       sortorder: attributes.sortorder ?? Infinity
     },
     body: blocks.body,
@@ -899,7 +1058,7 @@ function parseAPI(filePath, api) {
     name: `vue:${componentName}`,
     alias: [],
     visible: false,
-    attributes: { sortorder: Infinity },
+    attributes: { sortorder: Infinity, redirectFrom: [] },
     body: html,
     outline: [],
     format: "html",
@@ -980,7 +1139,8 @@ function parseFile(filePath, basePath, content) {
     attributes: {
       title,
       href,
-      sortorder: attributes.sortorder ?? Infinity
+      sortorder: attributes.sortorder ?? Infinity,
+      redirectFrom: []
     },
     body: content,
     outline: [],
@@ -1451,6 +1611,9 @@ function generateNavtree(docs) {
     return parent;
   }
   for (const doc of docs) {
+    if (doc.format === "redirect") {
+      continue;
+    }
     const [name, isSection] = pathFromDoc(doc);
     const title = doc.attributes.shortTitle ?? doc.attributes.title ?? doc.fileInfo.name;
     const sortorder = doc.attributes.sortorder;
@@ -1633,42 +1796,6 @@ Make sure the name is correct and the template file exists in one of the listed
   }
 }
 
-function dump(value) {
-  return `<pre>${JSON.stringify(value, null, 2)}</pre>`;
-}
-
-function json(value) {
-  return JSON.stringify(value, null, 2);
-}
-
-function isExternalUrl(url) {
-  return url.startsWith("http://") || url.startsWith("https://") || url.startsWith("//");
-}
-function isAbsoluteUrl(url) {
-  return url.startsWith("/");
-}
-function relative(url, { fileInfo }) {
-  if (isExternalUrl(url)) {
-    return url;
-  }
-  if (isAbsoluteUrl(url)) {
-    url = `.${url}`;
-  }
-  url = createMarkdownRenderer.normalizePath(url);
-  const outputPath = createMarkdownRenderer.normalizePath(fileInfo.path);
-  if (outputPath === url || `${outputPath}/` === url) {
-    return "./";
-  }
-  const relative2 = path$1.relative(outputPath, url);
-  const prefix = relative2.startsWith(".") ? "" : "./";
-  const suffix = url.endsWith("/") ? "/" : "";
-  return [prefix, relative2, suffix].join("");
-}
-
-function take(haystack, key, value) {
-  return haystack.filter((it) => it[key] === value);
-}
-
 class MissingTemplateError extends Error {
   searchDir;
   constructor(fileInfo, template, format, searchDir) {
@@ -1990,7 +2117,11 @@ function nunjucksProcessor(options) {
           }
         });
       }
+      const formats = ["markdown", "json"];
       const docs = context.docs.filter((it) => {
+        if (!formats.includes(it.format)) {
+          return false;
+        }
         return it.fileInfo.outputName;
       });
       progressbar.start(docs.length, 0, {
@@ -1998,7 +2129,7 @@ function nunjucksProcessor(options) {
       });
       const generatedFiles = [];
       try {
-        for (const doc of context.docs) {
+        for (const doc of docs) {
           const filePath = await renderDocument(doc);
           if (filePath) {
             generatedFiles.push(filePath);
@@ -2296,7 +2427,7 @@ async function stage(stage2, context, processors, { verbose } = { verbose: true
   }
   return generatedFiles;
 }
-function createContext(templateLoader) {
+function createContext(outputFolder, templateLoader) {
   let docs = [];
   let vendors = [];
   const resources = [];
@@ -2334,6 +2465,7 @@ function createContext(templateLoader) {
     get sidenav() {
       return sidenav;
     },
+    outputFolder,
     addDocument(document) {
       docs = [...docs, ...toArray(document)];
     },
@@ -2464,10 +2596,11 @@ class Generator {
   async manifest(sourceFiles) {
     const processors = [
       fileReaderProcessor(sourceFiles),
+      redirectProcessor(),
       ...this.processors
     ];
     const templateLoader = createTemplateLoader([]);
-    const context = createContext(templateLoader);
+    const context = createContext("", templateLoader);
     await stage("generate-docs", context, processors, { verbose: false });
     const docs = context.docs.filter(haveOutput);
     const pages = docs.map(manifestPageFromDocument);
@@ -2488,6 +2621,7 @@ class Generator {
     await this._prepareFolders();
     const processors = [
       fileReaderProcessor(sourceFiles),
+      redirectProcessor(),
       vendorProcessor(assetFolder, this.vendor),
       cssAssetProcessor(assetFolder, this.styles, { cwd }),
       jsAssetProcessor(assetFolder, this.scripts),
@@ -2509,7 +2643,7 @@ class Generator {
     ];
     compileProcessorRuntime(this, (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.js', document.baseURI).href)), processors);
     const templateLoader = createTemplateLoader(templateFolders);
-    const context = createContext(templateLoader);
+    const context = createContext(outputFolder, templateLoader);
     const generatedFiles = [
       await stage("generate-docs", context, processors),
       await stage("generate-nav", context, processors),
@@ -2580,7 +2714,9 @@ function extractTerms(doc) {
   }
 }
 function isIndexable(doc) {
-  return Boolean(doc.visible && doc.fileInfo.outputName);
+  return Boolean(
+    doc.visible && doc.fileInfo.outputName && doc.format !== "redirect"
+  );
 }
 function getTerms(doc) {
   return {
@@ -2609,7 +2745,8 @@ function searchProcessor() {
         alias: [],
         visible: false,
         attributes: {
-          sortorder: Infinity
+          sortorder: Infinity,
+          redirectFrom: []
         },
         body,
         outline: [],
@@ -2639,12 +2776,14 @@ exports.availableProcessors = availableProcessors;
 exports.cookieProcessor = cookieProcessor;
 exports.defineSources = defineSources;
 exports.frontMatterFileReader = frontMatterFileReader;
+exports.htmlRedirectProcessor = htmlRedirectProcessor;
 exports.livereloadProcessor = livereloadProcessor;
 exports.manifestProcessor = manifestProcessor;
 exports.matomoProcessor = matomoProcessor;
 exports.motdProcessor = motdProcessor;
 exports.navigationFileReader = navigationFileReader;
 exports.processorRuntimeName = processorRuntimeName;
+exports.redirectFileProcessor = redirectFileProcessor;
 exports.searchProcessor = searchProcessor;
 exports.selectableVersionProcessor = selectableVersionProcessor;
 exports.sourceUrlProcessor = sourceUrlProcessor;

package/dist/markdown.d.ts

@@ -27,7 +27,7 @@ declare interface Document_2 {
     /** Document outline (i.e. the heading structure) */
     outline: DocumentOutline;
     /** format of body */
-    format: "markdown" | "html" | "json";
+    format: "markdown" | "html" | "json" | "redirect";
     tags: string[];
     template: string;
     fileInfo: FileInfo;
@@ -221,6 +221,7 @@ export declare interface NormalizedDocumentAttributes {
     href?: string;
     /** normalized sortorder (defaults to Infinity) */
     sortorder: number;
+    redirectFrom: string[];
 }
 
 /**

package/dist/markdown.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-B1v_YUfy.js');
-require('./vendor-WsR_tA03.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D5z4jt-T.js');
+require('./vendor-CJBsNZrh.js');
 require('node:url');
 require('node:path');
 require('fs');