@forsakringskassan/docs-generator 3.7.0 → 3.9.0

package/dist/index.d.mts

@@ -298,6 +298,24 @@ declare class Generator_2 {
         format?: "iife" | "cjs" | "esm";
         define?: Record<string, string>;
     }): void;
+    /**
+     * Compile a worker script.
+     *
+     * This is mostly the same as {@link Generator.compileScript} with some differences:
+     *
+     * - The script is written directly to `outputFolder` instead of `assetFolder` (i.e. to the web root).
+     * - The output filename does not include a hash.
+     *
+     * @public
+     * @since %version%
+     * @param name - Asset name.
+     * @param src - Asset entrypoint.
+     * @param buildOptions - Options passed to `esbuild`.
+     */
+    compileWorker(name: string, src: string | URL, buildOptions?: {
+        format?: "iife" | "cjs" | "esm";
+        define?: Record<string, string>;
+    }): void;
     compileStyle(name: string, src: string | URL, options?: Partial<CompileOptions>): void;
     /**
      * @param dst - Destination directory relative to asset folder.
@@ -616,6 +634,15 @@ export declare interface PackageJson {
     };
 }
 
+/* Excluded from this release type: PartialFile */
+
+/**
+ * Read partial documents for insertion in other markdown documents.
+ *
+ * @public
+ */
+export declare function partialFileReader(filePath: string): Promise<DocumentPartial[]>;
+
 /**
  * Generates links to code playgrounds.
  *

package/dist/index.mjs

@@ -1304,6 +1304,45 @@ function generateNavtree(docs) {
   };
 }
 
+function sortNavigationTree(tree) {
+  tree.children.sort((a, b) => {
+    if (a.sortorder < b.sortorder) {
+      return -1;
+    }
+    if (a.sortorder > b.sortorder) {
+      return 1;
+    }
+    const titleA = a.title.toUpperCase();
+    const titleB = b.title.toUpperCase();
+    if (titleA < titleB) {
+      return -1;
+    }
+    if (titleA > titleB) {
+      return 1;
+    }
+    return 0;
+  });
+  for (const child of tree.children) {
+    if (isNavigationSection(child)) {
+      sortNavigationTree(child);
+    }
+  }
+}
+
+function navigationProcessor() {
+  return {
+    stage: "generate-nav",
+    name: "navigation-processor",
+    handler(context) {
+      const pages = context.docs.filter(isDocumentPage);
+      const navtree = generateNavtree(pages);
+      sortNavigationTree(navtree);
+      context.setTopNavigation(navtree);
+      context.setSideNavigation(navtree);
+    }
+  };
+}
+
 function generateNavigation(entries, navtree) {
   return {
     key: ".",
@@ -1342,6 +1381,7 @@ function topnavProcessor(filename, title) {
       const parsed = JSON.parse(content);
       const pages = context.docs.filter(isDocumentPage);
       const navtree = generateNavtree(pages);
+      sortNavigationTree(navtree);
       const rootNode = generateNavigation(parsed, navtree);
       context.setTopNavigation({
         title,
@@ -1736,7 +1776,7 @@ function getComponent(attrs) {
   }
   return toArray$1(attrs.component).map(normalizeComponent);
 }
-function parseFile$1(filePath, basePath, content) {
+function parseFile$2(filePath, basePath, content) {
   const relative = basePath ? path__default.relative(basePath, normalizePath(filePath)) : normalizePath(filePath);
   const parsed = path__default.parse(relative);
   const blocks = fm(content);
@@ -1782,7 +1822,7 @@ function parseFile$1(filePath, basePath, content) {
 }
 async function frontMatterFileReader(filePath, basePath) {
   const content = await fs.readFile(filePath, "utf8");
-  const doc = parseFile$1(filePath, basePath, content);
+  const doc = parseFile$2(filePath, basePath, content);
   return [doc];
 }
 
@@ -2549,7 +2589,7 @@ function fileReaderProcessor(sourceFiles) {
   };
 }
 
-function parseFile(filePath, basePath, content) {
+function parseFile$1(filePath, basePath, content) {
   const attributes = JSON.parse(content);
   const { title, href } = attributes;
   if (!title) {
@@ -2588,10 +2628,31 @@ function parseFile(filePath, basePath, content) {
 }
 async function navigationFileReader(filePath, basePath) {
   const content = await fs.readFile(filePath, "utf8");
-  const doc = parseFile(filePath, basePath, content);
+  const doc = parseFile$1(filePath, basePath, content);
   return [doc];
 }
 
+function parseFile(filePath, content) {
+  const parsed = JSON.parse(content);
+  return parsed.map((it) => {
+    return {
+      kind: "partial",
+      id: it.id,
+      name: it.id,
+      alias: [],
+      body: it.body,
+      format: it.format,
+      fileInfo: {
+        fullPath: filePath
+      }
+    };
+  });
+}
+async function partialFileReader(filePath) {
+  const content = await fs.readFile(filePath, "utf8");
+  return parseFile(filePath, content);
+}
+
 async function compileSassString(dst, style) {
   const result = await compileStringAsync(style, {
     style: "expanded",
@@ -2676,9 +2737,11 @@ function toExternalVendor(vendor) {
 }
 async function compileScript(options) {
   const {
-    assetFolder,
     name,
     src,
+    rootDir,
+    outputFolder,
+    outputName,
     assets,
     vendor,
     buildOptions,
@@ -2707,15 +2770,19 @@ async function compileScript(options) {
     const content = await fs$1.readFile(outfile, "utf8");
     const fingerprint = getFingerprint(content);
     const integrity = getIntegrity(content);
-    const filename = `${name}-${fingerprint}.js`;
-    const dst = path__default.join(assetFolder, filename);
+    const filename = `${outputName}.js`.replaceAll("[name]", () => name).replaceAll("[hash]", () => fingerprint);
+    const dst = path__default.join(outputFolder, filename);
+    const publicPath = path__default.posix.join(
+      path__default.posix.relative(rootDir, outputFolder),
+      filename
+    );
     await fs$1.mkdir(path__default.dirname(dst), { recursive: true });
     await fs$1.rename(outfile, dst);
     const stat = await fs$1.stat(dst);
     return {
       name,
       filename,
-      publicPath: `./assets/${filename}`,
+      publicPath: `./${publicPath}`,
       integrity,
       format,
       size: stat.size,
@@ -2735,7 +2802,7 @@ function byPriority({ options: a }, { options: b }) {
 function isExternal(asset) {
   return asset.options.appendTo === "none";
 }
-function jsAssetProcessor(assetFolder, assets, vendor) {
+function jsAssetProcessor(rootDir, assets, vendor) {
   const externalAssets = assets.filter(isExternal).map((it) => it.name);
   return {
     name: "js-asset-processor",
@@ -2746,9 +2813,11 @@ function jsAssetProcessor(assetFolder, assets, vendor) {
       const body = context.getTemplateData("injectBody", []);
       for (const asset of assets.toSorted(byPriority)) {
         const info = await compileScript({
-          assetFolder,
           name: asset.name,
           src: asset.src,
+          rootDir,
+          outputFolder: asset.outputFolder,
+          outputName: asset.outputName,
           assets: externalAssets,
           vendor,
           buildOptions: asset.buildOptions
@@ -2856,6 +2925,12 @@ var translation$1 = {
 		instructions: "<kbd>Esc</kbd> to close <kbd>Arrow up/down</kbd> to navigate <kbd>Enter</kbd> to select",
 		title: "Search",
 		placeholder: "Type to begin searching"
+	},
+	"mobile-nav": {
+		close: "Close",
+		menu: "Menu",
+		"aria-label": "Open/close menu",
+		nav: "Mobile primary"
 	}
 };
 var langEn = {
@@ -2890,51 +2965,18 @@ var translation = {
 		instructions: "<kbd>Esc</kbd> för att stänga <kbd>Pil upp/ner</kbd> för att navigera <kbd>Enter</kbd> för att välja",
 		title: "Sök",
 		placeholder: "Skriv för att börja söka"
+	},
+	"mobile-nav": {
+		close: "Stäng",
+		menu: "Meny",
+		"aria-label": "Öppen/stängd meny",
+		nav: "Mobile primär"
 	}
 };
 var langSv = {
 	translation: translation
 };
 
-function sortNavigationTree(tree) {
-  tree.children.sort((a, b) => {
-    if (a.sortorder < b.sortorder) {
-      return -1;
-    }
-    if (a.sortorder > b.sortorder) {
-      return 1;
-    }
-    const titleA = a.title.toUpperCase();
-    const titleB = b.title.toUpperCase();
-    if (titleA < titleB) {
-      return -1;
-    }
-    if (titleA > titleB) {
-      return 1;
-    }
-    return 0;
-  });
-  for (const child of tree.children) {
-    if (isNavigationSection(child)) {
-      sortNavigationTree(child);
-    }
-  }
-}
-
-function navigationProcessor() {
-  return {
-    stage: "generate-nav",
-    name: "navigation-processor",
-    handler(context) {
-      const pages = context.docs.filter(isDocumentPage);
-      const navtree = generateNavtree(pages);
-      sortNavigationTree(navtree);
-      context.setTopNavigation(navtree);
-      context.setSideNavigation(navtree);
-    }
-  };
-}
-
 const templateUrl = new URL("../templates", import.meta.url);
 const templateDirectory = fileURLToPath(templateUrl);
 
@@ -3887,9 +3929,12 @@ class Generator {
     });
   }
   compileScript(name, src, options, buildOptions) {
+    const { assetFolder } = this;
     this.scripts.push({
       name,
       src,
+      outputFolder: assetFolder,
+      outputName: "[name]-[hash]",
       options: {
         appendTo: "none",
         attributes: {},
@@ -3901,6 +3946,37 @@ class Generator {
       }
     });
   }
+  /**
+   * Compile a worker script.
+   *
+   * This is mostly the same as {@link Generator.compileScript} with some differences:
+   *
+   * - The script is written directly to `outputFolder` instead of `assetFolder` (i.e. to the web root).
+   * - The output filename does not include a hash.
+   *
+   * @public
+   * @since %version%
+   * @param name - Asset name.
+   * @param src - Asset entrypoint.
+   * @param buildOptions - Options passed to `esbuild`.
+   */
+  compileWorker(name, src, buildOptions) {
+    const { outputFolder } = this;
+    this.scripts.push({
+      name,
+      src,
+      outputFolder,
+      outputName: "[name]",
+      options: {
+        appendTo: "none",
+        attributes: {},
+        priority: 0
+      },
+      buildOptions: {
+        ...buildOptions
+      }
+    });
+  }
   compileStyle(name, src, options) {
     this.styles.push({
       name,
@@ -3983,7 +4059,7 @@ class Generator {
       redirectProcessor(),
       vendorProcessor(assetFolder, this.vendor),
       cssAssetProcessor(assetFolder, this.styles),
-      jsAssetProcessor(assetFolder, this.scripts, this.vendor),
+      jsAssetProcessor(outputFolder, this.scripts, this.vendor),
       staticResourcesProcessor(assetFolder, this.resources),
       navigationProcessor(),
       nunjucksProcessor({
@@ -4059,5 +4135,5 @@ class Generator {
   }
 }
 
-export { Generator, apiExtractorProcessor, availableProcessors, cookieProcessor, defineSources, extractExamplesProcessor, frontMatterFileReader, htmlRedirectProcessor, isRelease, livereloadProcessor, manifestProcessor, matomoProcessor, motdProcessor, navigationFileReader, playgroundProcessor, processorRuntimeName, redirectFileProcessor, searchProcessor, selectableVersionProcessor, sourceUrlProcessor, topnavProcessor, versionBannerProcessor, versionProcessor, vueFileReader };
+export { Generator, apiExtractorProcessor, availableProcessors, cookieProcessor, defineSources, extractExamplesProcessor, frontMatterFileReader, htmlRedirectProcessor, isRelease, livereloadProcessor, manifestProcessor, matomoProcessor, motdProcessor, navigationFileReader, partialFileReader, playgroundProcessor, processorRuntimeName, redirectFileProcessor, searchProcessor, selectableVersionProcessor, sourceUrlProcessor, topnavProcessor, versionBannerProcessor, versionProcessor, vueFileReader };
 //# sourceMappingURL=index.mjs.map