@forsakringskassan/docs-generator 1.29.2 → 1.30.0

package/dist/compile-example.js

@@ -4,22 +4,24 @@ var path$1 = require('node:path');
 var esbuild = require('esbuild');
 var vue = require('vue');
 var vue2 = require('./vue2-BJo6OAwR.js');
-var vue3 = require('./vue3-DoboNqXW.js');
+var vue3 = require('./vue3-CjV_X9qw.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-D7cNMveZ.js');
+require('./vendor-xbC24N4h.js');
 require('node:url');
 require('fs');
 require('node:fs');
 require('node:fs/promises');
-require('events');
-require('stream');
-require('string_decoder');
+require('node:events');
+require('node:stream');
+require('node:string_decoder');
 require('constants');
+require('stream');
 require('util');
 require('assert');
 require('path');
 require('readline');
+require('events');
 require('child_process');
 require('node:buffer');
 require('node:child_process');

package/dist/{create-markdown-renderer-IsFf8Wbo.js → create-markdown-renderer-Bo7YoF2w.js}

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

package/dist/index.d.ts

@@ -260,6 +260,27 @@ export declare interface MatomoOptions {
  */
 export declare function matomoProcessor(options: MatomoOptions & ProcessorOptions): Processor;
 
+/**
+ * Options for {@link motdProcessor}.
+ *
+ * @public
+ */
+export declare interface MOTDOptions {
+    /** Enables/disables the MOTD processor. */
+    enabled?: boolean;
+    /** Name of the container to render content in. */
+    container?: string;
+    /** Message to display */
+    message: string;
+}
+
+/**
+ * Display a MOTD style message.
+ *
+ * @public
+ */
+export declare function motdProcessor(options: MOTDOptions): Processor;
+
 /**
  * Read a JSON file with arbitrary navigation entries.
  *
@@ -568,11 +589,14 @@ export declare interface VendorDefinitionDescriptor {
 
 /**
  * Display a banner with message when path dosen't start with /latest.
+ *
  * @param message - Message to display in banner, may contain html-template.
+ * @param container - Where the content will be inserted.
  *
  * @public
+ * @deprecated Use the `motdProcessor` instead.
  */
-export declare function versionBannerProcessor(message: string, container: string): Processor;
+export declare const versionBannerProcessor: (message: string, container: string) => Processor;
 
 /**
  * Injects the package name and version into the document.

package/dist/index.js

@@ -2,8 +2,8 @@
 
 var fs = require('node:fs/promises');
 var path = require('node:path');
-var vendor = require('./vendor-D7cNMveZ.js');
-var createMarkdownRenderer = require('./create-markdown-renderer-IsFf8Wbo.js');
+var vendor = require('./vendor-xbC24N4h.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-Bo7YoF2w.js');
 var require$$1 = require('crypto');
 require('node:crypto');
 var vueDocgenApi = require('vue-docgen-api');
@@ -12,22 +12,24 @@ var fs$1 = require('node:fs');
 var sass = require('sass');
 var node_url = require('node:url');
 var esbuild = require('esbuild');
-var node_util = require('node:util');
+var util = require('node:util');
 var nunjucks = require('nunjucks');
 var vue = require('vue');
 var vue2 = require('./vue2-BJo6OAwR.js');
-var vue3 = require('./vue3-DoboNqXW.js');
+var vue3 = require('./vue3-CjV_X9qw.js');
 var express = require('express');
 var childProcess = require('node:child_process');
 require('fs');
-require('events');
-require('stream');
-require('string_decoder');
+require('node:events');
+require('node:stream');
+require('node:string_decoder');
 require('constants');
+require('stream');
 require('util');
 require('assert');
 require('path');
 require('readline');
+require('events');
 require('child_process');
 require('node:buffer');
 require('node:process');
@@ -1230,7 +1232,7 @@ async function render(doc, docs, nav, vendors, options) {
     sortNavigationTree(sidenav);
   }
   const njk = new nunjucks.Environment(loader, { autoescape: false });
-  const asyncRender = node_util.promisify(njk.render);
+  const asyncRender = util.promisify(njk.render);
   const renderTemplate = asyncRender.bind(njk);
   const template = findTemplate(doc.fileInfo, doc);
   const templateData = {
@@ -2021,6 +2023,41 @@ function manifestProcessor(options) {
   };
 }
 
+function normalizeOptions(options) {
+  const defaults = {
+    enabled: true,
+    container: "body:begin"
+  };
+  return { ...defaults, ...options };
+}
+function motdProcessor(options) {
+  const { enabled, container, message } = normalizeOptions(options);
+  return {
+    name: "motd-processor",
+    after: "generate-docs",
+    handler(context) {
+      if (!enabled) {
+        return;
+      }
+      context.addTemplateBlock(container, "version-banner", {
+        filename: "partials/version-banner.html",
+        data: { message }
+      });
+    }
+  };
+}
+function versionBannerProcessorDeprecated(message, container) {
+  return motdProcessor({
+    enabled: true,
+    container,
+    message
+  });
+}
+const versionBannerProcessor = util.deprecate(
+  versionBannerProcessorDeprecated,
+  "versionBannerProcessor() is deprecated, use motdProcessor() instead"
+);
+
 function themeSelectProcessor() {
   return {
     name: "theme-select-processor",
@@ -2162,19 +2199,6 @@ function versionProcessor(pkg, container, options) {
   };
 }
 
-function versionBannerProcessor(message, container) {
-  return {
-    name: "version-banner-processor",
-    after: "generate-docs",
-    handler(context) {
-      context.addTemplateBlock(container, "version-banner", {
-        filename: "partials/version-banner.html",
-        data: { message }
-      });
-    }
-  };
-}
-
 function generateIndex(entries) {
   const index = {
     terms: [],
@@ -2276,6 +2300,7 @@ exports.frontMatterFileReader = frontMatterFileReader;
 exports.livereloadProcessor = livereloadProcessor;
 exports.manifestProcessor = manifestProcessor;
 exports.matomoProcessor = matomoProcessor;
+exports.motdProcessor = motdProcessor;
 exports.navigationFileReader = navigationFileReader;
 exports.searchProcessor = searchProcessor;
 exports.selectableVersionProcessor = selectableVersionProcessor;

package/dist/markdown.js

@@ -1,20 +1,22 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-IsFf8Wbo.js');
-require('./vendor-D7cNMveZ.js');
-require('node:path');
+var createMarkdownRenderer = require('./create-markdown-renderer-Bo7YoF2w.js');
+require('./vendor-xbC24N4h.js');
 require('node:url');
+require('node:path');
 require('fs');
 require('node:fs');
 require('node:fs/promises');
-require('events');
-require('stream');
-require('string_decoder');
+require('node:events');
+require('node:stream');
+require('node:string_decoder');
 require('constants');
+require('stream');
 require('util');
 require('assert');
 require('path');
 require('readline');
+require('events');
 require('child_process');
 require('node:buffer');
 require('node:child_process');

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.7"
+      "packageVersion": "7.44.1"
     }
   ]
 }