npm - @forsakringskassan/docs-generator - Versions diffs - 2.20.0 → 2.21.1 - Mend

@forsakringskassan/docs-generator 2.20.0 → 2.21.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/index.d.ts +5 -2
package/dist/index.js +71 -32
package/dist/index.js.map +1 -1
package/dist/tsdoc-metadata.json +1 -1
package/package.json +1 -1
package/templates/base.template.html +4 -0

package/dist/index.d.ts CHANGED Viewed

@@ -19,7 +19,7 @@ export declare interface CompileOptions {
      *
      * - `head` - the asset is injected in `<head>`
      * - `body` - the asset is injected in `<body>`
-     * - `none` (default) - the asset is not injected.
+     * - `none` (default) - the asset is not injected (but is available in importmap)
      */
     appendTo: "none" | "head" | "body";
     /**
@@ -222,6 +222,7 @@ declare class Generator_2 {
     private markdownOptions;
     constructor(options: GeneratorOptions);
     compileScript(name: string, src: string | URL, options?: Partial<CompileOptions>, buildOptions?: {
+        format?: "iife" | "cjs" | "esm";
         define?: Record<string, string>;
     }): void;
     compileStyle(name: string, src: string | URL, options?: Partial<CompileOptions>): void;
@@ -510,8 +511,9 @@ export declare interface ProcessorContext {
     /* Excluded from this release type: hasTemplate */
     setTopNavigation(root: NavigationSection): void;
     setSideNavigation(root: NavigationSection): void;
-    getAllTemplateData(): Record<string, unknown>;
+    getAllTemplateData(): TemplateData & Record<string, unknown>;
     getTemplateData<K extends keyof TemplateData>(key: K): TemplateData[K] | undefined;
+    getTemplateData<K extends keyof TemplateData>(key: K, defaultValue: TemplateData[K]): TemplateData[K];
     getTemplateData(key: string): unknown;
     setTemplateData<K extends keyof TemplateData>(key: string, value: TemplateData[K]): void;
     setTemplateData(key: string, value: unknown): void;
@@ -564,6 +566,7 @@ export declare interface ProcessorRuntime {
     name?: string;
     /** Build options (passed to compileScript) */
     buildOptions?: {
+        format?: "iife" | "cjs" | "esm";
         define?: Record<string, string>;
     };
 }

package/dist/index.js CHANGED Viewed

@@ -1595,6 +1595,7 @@ async function compileStyle(assetFolder, name, src, options) {
       filename,
       publicPath: `./assets/${filename}`,
       integrity,
+      format: "stylesheet",
       size: stat.size,
       type: "css"
     };
@@ -1616,9 +1617,9 @@ function cssAssetProcessor(assetFolder, assets, options) {
     name: "css-asset-processor",
     after: "assets",
     async handler(context) {
-      const assetInfo = context.getTemplateData("assets") ?? {};
-      const head = context.getTemplateData("injectHead") ?? [];
-      const body = context.getTemplateData("injectBody") ?? [];
+      const assetInfo = context.getTemplateData("assets", {});
+      const head = context.getTemplateData("injectHead", []);
+      const body = context.getTemplateData("injectBody", []);
       for (const asset of toSorted$1(assets, byPriority$1)) {
         const info = await compileStyle(
           assetFolder,
@@ -1628,7 +1629,10 @@ function cssAssetProcessor(assetFolder, assets, options) {
         );
         const attrs = serializeAttrs(asset.options.attributes);
         const inject = { ...info, attrs: Array.from(attrs).join(" ") };
-        assetInfo[asset.name] = info;
+        assetInfo[asset.name] = {
+          ...info,
+          importmap: false
+        };
         switch (asset.options.appendTo) {
           case "none":
             break;
@@ -1639,11 +1643,8 @@ function cssAssetProcessor(assetFolder, assets, options) {
             body.push(inject);
             break;
         }
-        context.setTemplateData("injectHead", head);
-        context.setTemplateData("injectBody", body);
         context.log(info.filename, formatSize(info.size));
       }
-      context.setTemplateData("assets", assetInfo);
     }
   };
 }
@@ -1652,11 +1653,16 @@ function esbuild(options) {
   return esbuild$1.build(options);
 }
+function toExternalVendor(vendor) {
+  return typeof vendor === "string" ? vendor : vendor.package;
+}
 async function compileScript(options) {
   const {
     assetFolder,
     name,
     src,
+    assets,
+    vendor,
     buildOptions,
     fs: fs$1 = fs
   } = options;
@@ -1664,13 +1670,15 @@ async function compileScript(options) {
   try {
     const entryPoints = [src instanceof URL ? node_url.fileURLToPath(src) : src];
     const outfile = path$1.join("temp", `asset-${name}.js`);
+    const external = [...assets, ...vendor.map(toExternalVendor)];
+    const format = buildOptions.format ?? "esm";
     await esbuild({
       entryPoints,
       outfile,
       bundle: true,
-      format: "iife",
+      format,
       platform: "browser",
-      external: ["vue", "@fkui/vue"],
+      external,
       tsconfig: path$1.join(__dirname, "../tsconfig-examples.json"),
       ...buildOptions,
       define: {
@@ -1691,6 +1699,7 @@ async function compileScript(options) {
       filename,
       publicPath: `./assets/${filename}`,
       integrity,
+      format,
       size: stat.size,
       type: "js"
     };
@@ -1706,24 +1715,33 @@ function byPriority({ options: a }, { options: b }) {
 function toSorted(values, comparator) {
   return [...values].sort(comparator);
 }
-function jsAssetProcessor(assetFolder, assets) {
+function isExternal(asset) {
+  return asset.options.appendTo === "none";
+}
+function jsAssetProcessor(assetFolder, assets, vendor) {
+  const externalAssets = assets.filter(isExternal).map((it) => it.name);
   return {
     name: "js-asset-processor",
     after: "assets",
     async handler(context) {
-      const assetInfo = context.getTemplateData("assets") ?? {};
-      const head = context.getTemplateData("injectHead") ?? [];
-      const body = context.getTemplateData("injectBody") ?? [];
+      const assetInfo = context.getTemplateData("assets", {});
+      const head = context.getTemplateData("injectHead", []);
+      const body = context.getTemplateData("injectBody", []);
       for (const asset of toSorted(assets, byPriority)) {
         const info = await compileScript({
           assetFolder,
           name: asset.name,
           src: asset.src,
+          assets: externalAssets,
+          vendor,
           buildOptions: asset.buildOptions
         });
         const attrs = serializeAttrs(asset.options.attributes);
         const inject = { ...info, attrs: Array.from(attrs).join(" ") };
-        assetInfo[asset.name] = info;
+        assetInfo[asset.name] = {
+          ...info,
+          importmap: externalAssets.includes(asset.name)
+        };
         switch (asset.options.appendTo) {
           case "none":
             break;
@@ -1734,8 +1752,6 @@ function jsAssetProcessor(assetFolder, assets) {
             body.push(inject);
             break;
         }
-        context.setTemplateData("injectHead", head);
-        context.setTemplateData("injectBody", body);
         context.log(info.filename, formatSize(info.size));
       }
     }
@@ -2262,16 +2278,25 @@ async function render(doc, docs, nav, vendors, options) {
     sidenav,
     vendors,
     importmap(doc2) {
-      const imports = Object.fromEntries(
-        vendors.map((it) => {
+      const assets = Object.values(templateData.assets).filter(
+        (it) => it.importmap
+      );
+      const imports = Object.fromEntries([
+        ...vendors.map((it) => {
           return [it.package, relative(it.publicPath, doc2)];
+        }),
+        ...assets.map((it) => {
+          return [it.name, relative(it.publicPath, doc2)];
         })
-      );
-      const integrity = Object.fromEntries(
-        vendors.map((it) => {
+      ]);
+      const integrity = Object.fromEntries([
+        ...vendors.map((it) => {
+          return [relative(it.publicPath, doc2), it.integrity];
+        }),
+        ...assets.map((it) => {
           return [relative(it.publicPath, doc2), it.integrity];
         })
-      );
+      ]);
       const importmap = { imports, integrity };
       return JSON.stringify(importmap, null, 2);
     }
@@ -2717,7 +2742,7 @@ function createContext(outputFolder, templateLoader) {
     children: [],
     visible: true
   };
-  const templateData = {};
+  const templateData = /* @__PURE__ */ new Map();
   return {
     get docs() {
       return docs;
@@ -2769,13 +2794,20 @@ function createContext(outputFolder, templateLoader) {
       sidenav = root;
     },
     getAllTemplateData() {
-      return templateData;
+      return Object.fromEntries(templateData.entries());
     },
-    getTemplateData(key) {
-      return templateData[key];
+    getTemplateData(key, defaultValue) {
+      if (templateData.has(key)) {
+        return templateData.get(key);
+      } else if (defaultValue) {
+        templateData.set(key, defaultValue);
+        return defaultValue;
+      } else {
+        return void 0;
+      }
     },
     setTemplateData(key, value) {
-      templateData[key] = value;
+      templateData.set(key, value);
     }
   };
 }
@@ -2813,10 +2845,17 @@ class Generator {
     this.sourceFiles = [];
     this.markdownOptions = options.markdown;
     const bootstrapUrl = new URL("runtime-bootstrap.js", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.js', document.baseURI).href)));
-    this.compileScript("bootstrap", bootstrapUrl, {
-      appendTo: "head",
-      priority: 100
-    });
+    this.compileScript(
+      "bootstrap",
+      bootstrapUrl,
+      {
+        appendTo: "head",
+        priority: 100
+      },
+      {
+        format: "iife"
+      }
+    );
   }
   compileScript(name, src, options, buildOptions) {
     this.scripts.push({
@@ -2896,7 +2935,7 @@ class Generator {
       redirectProcessor(),
       vendorProcessor(assetFolder, this.vendor),
       cssAssetProcessor(assetFolder, this.styles, { cwd }),
-      jsAssetProcessor(assetFolder, this.scripts),
+      jsAssetProcessor(assetFolder, this.scripts, this.vendor),
       staticResourcesProcessor(assetFolder, this.resources),
       navigationProcessor(),
       nunjucksProcessor({