@forsakringskassan/docs-generator 3.12.0 → 3.13.0

package/dist/{format-code.worker-CoZR-v_f.mjs → format-code.worker-C_xPgPcX.mjs}

@@ -2,7 +2,7 @@ import { createRequire as $createRequire } from "node:module";
 
 const require = $createRequire(import.meta.url);
 
-import { r as runAsWorker, f as format2, a as resolveConfig } from './vendor-BesEHnwj.mjs';
+import { r as runAsWorker, f as format2, a as resolveConfig } from './vendor-BLfCdre8.mjs';
 import 'node:url';
 import 'node:path';
 import 'fs';
@@ -54,4 +54,4 @@ async function formatCode(source, filepath) {
 runAsWorker(formatCode);
 
 export { formatCode };
-//# sourceMappingURL=format-code.worker-CoZR-v_f.mjs.map
+//# sourceMappingURL=format-code.worker-C_xPgPcX.mjs.map

package/dist/{format-code.worker-CoZR-v_f.mjs.map → format-code.worker-C_xPgPcX.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"format-code.worker-CoZR-v_f.mjs","sources":["../src/utils/format-code.worker.ts"],"sourcesContent":["import { type Options, format as prettier, resolveConfig } from \"prettier\";\nimport { runAsWorker } from \"synckit\";\n\nconst configCache = new Map<string, Options | null>();\n\nasync function getConfig(filepath: string): Promise<Options | null> {\n    const cached = configCache.get(filepath);\n    if (cached !== undefined) {\n        return cached;\n    }\n    const options = await resolveConfig(filepath);\n    configCache.set(filepath, options);\n    return options;\n}\n\n/**\n * @internal\n */\nexport async function formatCode(\n    source: string,\n    filepath: string,\n): Promise<string> {\n    const options = await getConfig(filepath);\n    const formatted = await prettier(source, { ...options, filepath });\n    return formatted.trim();\n}\n\n/* eslint-disable-next-line unicorn/no-top-level-side-effects -- required for worker to function */\nrunAsWorker(formatCode);\n"],"names":["prettier"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAM,WAAA,uBAAkB,GAAA,EAA4B;AAEpD,eAAe,UAAU,QAAA,EAA2C;AAChE,EAAA,MAAM,MAAA,GAAS,WAAA,CAAY,GAAA,CAAI,QAAQ,CAAA;AACvC,EAAA,IAAI,WAAW,MAAA,EAAW;AACtB,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,MAAM,OAAA,GAAU,MAAM,aAAA,CAAc,QAAQ,CAAA;AAC5C,EAAA,WAAA,CAAY,GAAA,CAAI,UAAU,OAAO,CAAA;AACjC,EAAA,OAAO,OAAA;AACX;AAKA,eAAsB,UAAA,CAClB,QACA,QAAA,EACe;AACf,EAAA,MAAM,OAAA,GAAU,MAAM,SAAA,CAAU,QAAQ,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,MAAMA,OAAA,CAAS,MAAA,EAAQ,EAAE,GAAG,OAAA,EAAS,UAAU,CAAA;AACjE,EAAA,OAAO,UAAU,IAAA,EAAK;AAC1B;AAGA,WAAA,CAAY,UAAU,CAAA;;"}
+{"version":3,"file":"format-code.worker-C_xPgPcX.mjs","sources":["../src/utils/format-code.worker.ts"],"sourcesContent":["import { type Options, format as prettier, resolveConfig } from \"prettier\";\nimport { runAsWorker } from \"synckit\";\n\nconst configCache = new Map<string, Options | null>();\n\nasync function getConfig(filepath: string): Promise<Options | null> {\n    const cached = configCache.get(filepath);\n    if (cached !== undefined) {\n        return cached;\n    }\n    const options = await resolveConfig(filepath);\n    configCache.set(filepath, options);\n    return options;\n}\n\n/**\n * @internal\n */\nexport async function formatCode(\n    source: string,\n    filepath: string,\n): Promise<string> {\n    const options = await getConfig(filepath);\n    const formatted = await prettier(source, { ...options, filepath });\n    return formatted.trim();\n}\n\n/* eslint-disable-next-line unicorn/no-top-level-side-effects -- required for worker to function */\nrunAsWorker(formatCode);\n"],"names":["prettier"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAM,WAAA,uBAAkB,GAAA,EAA4B;AAEpD,eAAe,UAAU,QAAA,EAA2C;AAChE,EAAA,MAAM,MAAA,GAAS,WAAA,CAAY,GAAA,CAAI,QAAQ,CAAA;AACvC,EAAA,IAAI,WAAW,MAAA,EAAW;AACtB,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,MAAM,OAAA,GAAU,MAAM,aAAA,CAAc,QAAQ,CAAA;AAC5C,EAAA,WAAA,CAAY,GAAA,CAAI,UAAU,OAAO,CAAA;AACjC,EAAA,OAAO,OAAA;AACX;AAKA,eAAsB,UAAA,CAClB,QACA,QAAA,EACe;AACf,EAAA,MAAM,OAAA,GAAU,MAAM,SAAA,CAAU,QAAQ,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,MAAMA,OAAA,CAAS,MAAA,EAAQ,EAAE,GAAG,OAAA,EAAS,UAAU,CAAA;AACjE,EAAA,OAAO,UAAU,IAAA,EAAK;AAC1B;AAGA,WAAA,CAAY,UAAU,CAAA;;"}

package/dist/index.d.mts

@@ -350,7 +350,32 @@ declare class Generator_2 {
      *
      * @public
      */
-    manifest(sourceFiles: SourceFiles[]): Promise<Manifest>;
+    manifest(): Promise<Manifest>;
+    /**
+     * Generate a manifest listing all generated documents that will be present
+     * in `outputFolder`.
+     *
+     * Note: this only collects documents from the `generate-docs` stage,
+     * potential documents generated at later stages will not be present.
+     *
+     * @public
+     * @deprecated Pass in the sourceFiles in the construction options instead.
+     */
+    manifest(explicitSourceFiles: SourceFiles[]): Promise<Manifest>;
+    /**
+     * Build the documentation project.
+     *
+     * @public
+     * @returns A promise resolving to a list of generated files.
+     */
+    build(): Promise<string[]>;
+    /**
+     * Build the documentation project.
+     *
+     * @public
+     * @deprecated Pass in the sourceFiles in the construction options instead.
+     * @returns A promise resolving to a list of generated files.
+     */
     build(sourceFiles: SourceFiles[]): Promise<string[]>;
     /**
      * Start a development server hosting the generated documentation.
@@ -383,6 +408,10 @@ export declare interface GeneratorOptions {
     processors?: Processor[];
     /** List of vendor assets to compile */
     vendor?: VendorDefinition[];
+    /**
+     * List of source files to build documents from.
+     */
+    sourceFiles?: SourceFiles[];
     /** Path to file with exported `setup` function, responsible for mounting of component.
      * `function setup(options: { rootComponent: string, selector: string }): void`
      */

package/dist/index.mjs

@@ -3,12 +3,12 @@ import { createRequire as $createRequire } from "node:module";
 const require = $createRequire(import.meta.url);
 
 import { ApiItemKind, ApiModel } from '@microsoft/api-extractor-model';
-import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-BesEHnwj.mjs';
+import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-BLfCdre8.mjs';
 import path__default from 'node:path';
 import crypto from 'node:crypto';
 import path from 'node:path/posix';
 import { exec, execSync } from 'node:child_process';
-import { g as generateId, f as formatCode, p as parseInfostring, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, m as filePath, c as createMarkdownRenderer, o as generateExample } from './create-markdown-renderer-C7-7Tads.mjs';
+import { g as generateId, f as formatCode, p as parseInfostring, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, m as filePath, c as createMarkdownRenderer, o as generateExample } from './create-markdown-renderer-DwLB6VT1.mjs';
 import { DocExcerpt } from '@microsoft/tsdoc';
 import fs from 'node:fs/promises';
 import util, { promisify, styleText } from 'node:util';
@@ -2049,6 +2049,7 @@ function parseFile$2(filePath, basePath, content) {
       path: ["", "."].includes(urlpath) ? "." : `./${normalizePath(urlpath)}`,
       name: filename,
       fullPath: normalizePath(filePath),
+      /* eslint-disable-next-line unicorn/prefer-logical-operator-over-ternary -- false positive? */
       outputName: include ? `${filename}.html` : false
     }
   };
@@ -2983,9 +2984,10 @@ async function compileScript(options) {
     fs: fs$1 = fs
   } = options;
   const iconLib = process.env.DOCS_ICON_LIB ?? "@fkui/icon-lib-default";
+  const sanitizedName = name.replaceAll(/[^a-z0-9-]+/gi, "_");
   try {
     const entryPoints = [src instanceof URL ? fileURLToPath(src) : src];
-    const outfile = path__default.join("temp", `asset-${name}.js`);
+    const outfile = path__default.join("temp", `asset-${sanitizedName}.js`);
     const external = [...assets, ...vendor.map(toExternalVendor)];
     const format = buildOptions.format ?? "esm";
     await esbuild({
@@ -3005,7 +3007,7 @@ async function compileScript(options) {
     const content = await fs$1.readFile(outfile, "utf8");
     const fingerprint = getFingerprint(content);
     const integrity = getIntegrity(content);
-    const filename = `${outputName}.js`.replaceAll("[name]", () => name).replaceAll("[hash]", () => fingerprint);
+    const filename = `${outputName}.js`.replaceAll("[name]", () => sanitizedName).replaceAll("[hash]", () => fingerprint);
     const dst = path__default.join(outputFolder, filename);
     const publicPath = path__default.posix.join(
       path__default.posix.relative(rootDir, outputFolder),
@@ -4154,7 +4156,7 @@ class Generator {
     this.scripts = [];
     this.styles = [];
     this.resources = [];
-    this.sourceFiles = [];
+    this.sourceFiles = options.sourceFiles ?? [];
     this.markdownOptions = options.markdown;
     const bootstrapUrl = new URL("runtime-bootstrap.mjs", import.meta.url);
     this.compileScript(
@@ -4244,16 +4246,14 @@ class Generator {
       to: dst
     });
   }
-  /**
-   * Generate a manifest listing all generated documents that will be present
-   * in `outputFolder`.
-   *
-   * Note: this only collects documents from the `generate-docs` stage,
-   * potential documents generated at later stages will not be present.
-   *
-   * @public
-   */
-  async manifest(sourceFiles) {
+  async manifest(explicitSourceFiles) {
+    if (explicitSourceFiles) {
+      this.sourceFiles = explicitSourceFiles;
+      console.error(
+        "[docs-generator] deprecated: passing in `sourceFiles` as a parameter to `Generator.manifest()` is deprecated, should be passed into the constructor options instead."
+      );
+    }
+    const { sourceFiles } = this;
     const processors = [
       fileReaderProcessor(sourceFiles),
       redirectProcessor(),
@@ -4274,8 +4274,13 @@ class Generator {
     });
     return { pages };
   }
-  async build(sourceFiles) {
-    this.sourceFiles = sourceFiles;
+  async build(explicitSourceFiles) {
+    if (explicitSourceFiles) {
+      this.sourceFiles = explicitSourceFiles;
+      console.error(
+        "[docs-generator] deprecated: passing in `sourceFiles` as a parameter to `Generator.build()` is deprecated, should be passed into the constructor options instead."
+      );
+    }
     const {
       site,
       outputFolder,
@@ -4284,6 +4289,7 @@ class Generator {
       exampleFolders,
       templateFolders,
       setupPath,
+      sourceFiles,
       markdownOptions
     } = this;
     const examplePatterns = this.exampleFolders.map((it) => `${it}/**/*`);
@@ -4348,7 +4354,7 @@ class Generator {
       outputFolder,
       watch,
       rebuild: (_filePath) => {
-        return this.build(sourceFiles);
+        return this.build();
       }
     });
   }