@forsakringskassan/docs-generator 3.5.0 → 3.6.0

package/dist/{format-code.worker-Y0WP8Vzk.mjs.map → format-code.worker-BmU4wqqU.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"format-code.worker-Y0WP8Vzk.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-BmU4wqqU.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

@@ -616,6 +616,68 @@ export declare interface PackageJson {
     };
 }
 
+/**
+ * Generates links to code playgrounds.
+ *
+ * @public
+ */
+export declare function playgroundProcessor(options: PlaygroundProcessorOptions): Processor;
+
+/**
+ * Options for a playground entry.
+ *
+ * @public
+ */
+export declare interface PlaygroundProcessorEntry {
+    /**
+     * Unique identifier for this playground.
+     */
+    readonly id: string;
+    /**
+     * Name of template variable with the playground URL to inject.
+     *
+     * If unspecified, no template variable will be available.
+     */
+    readonly variable?: string;
+    /**
+     * The URL format.
+     *
+     * The following placeholders are available:
+     *
+     * - `base64`: Base64 encoded payload (use "atou" to decode unicode codepoints).
+     * - `zlibBase64`: zlib base64 encoded payload.
+     */
+    readonly urlFormat: string;
+    /**
+     * Path to a folder with files to inject into the playground url.
+     *
+     * If unspecified, no files will be injected by default.
+     */
+    readonly folder?: string;
+    /**
+     * Serialize the files to a string for using in the url generation.
+     *
+     * Default is `JSON.stringify()`.
+     */
+    serialize?(this: void, context: {
+        readonly files: Map<string, string>;
+    }): string | Promise<string>;
+}
+
+/**
+ * Options for {@link playgroundProcessor}.
+ *
+ * @public
+ */
+export declare interface PlaygroundProcessorOptions extends ProcessorOptions {
+    /**
+     * List of playgrounds available.
+     *
+     * Default is empty array (no playgrounds enabled)
+     */
+    readonly entries?: PlaygroundProcessorEntry[];
+}
+
 /**
  * @public
  */

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 MarkdownIt, d as dedent, g as closest, h as distance, i as fm, j as isCI, m as moduleImporter, k as cliProgress, l as tinylr, w as watch, n as createInstance, o as fse, p as inter } from './vendor-BeEO8YMF.mjs';
+import { t as ts, Z as Ze, M as MarkdownItCallable, s as strToU8, z as zlibSync, g as strFromU8, d as dedent, h as closest, i as distance, j as fm, 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-C6ojgz0W.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, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, j as htmlencode, k as filePath, c as createMarkdownRenderer, l as generateExample } from './create-markdown-renderer-BuSu2H7E.mjs';
+import { g as generateId, f as formatCode, p as parseInfostring, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, j as htmlencode, k as filePath, c as createMarkdownRenderer, l as generateExample } from './create-markdown-renderer-BjMECUwq.mjs';
 import { DocExcerpt } from '@microsoft/tsdoc';
 import fs from 'node:fs/promises';
 import util, { promisify, styleText } from 'node:util';
@@ -586,8 +586,9 @@ const documentAttributeKeys = [
   "redirect_from"
 ];
 
-const md$6 = MarkdownIt();
-md$6.renderer.rules.fence = (tokens, idx, _options, collected) => {
+const md$6 = MarkdownItCallable();
+md$6.renderer.rules.fence = (tokens, idx, _options, rawEnv) => {
+  const { collected } = rawEnv;
   const { content, info } = tokens[idx];
   const { language, tags } = parseInfostring(info);
   if (language === "import") {
@@ -608,7 +609,7 @@ function findExamples$1(doc) {
     return [];
   }
   const collected = [];
-  md$6.render(doc.body, collected);
+  md$6.render(doc.body, { collected });
   return collected;
 }
 function getSuffix(tags) {
@@ -674,7 +675,7 @@ function extractExamplesProcessor(options) {
   };
 }
 
-const md$5 = MarkdownIt();
+const md$5 = MarkdownItCallable();
 md$5.renderer.rules.fence = (tokens, idx, _options, env) => {
   const { collected, exampleFileMatcher } = env;
   const { content, info, map } = tokens[idx];
@@ -866,6 +867,88 @@ const versionBannerProcessor = util.deprecate(
   "versionBannerProcessor() is deprecated, use motdProcessor() instead"
 );
 
+function utoa(value) {
+  return btoa(unescape(encodeURIComponent(value)));
+}
+const encoder = {
+  base64(value) {
+    return utoa(value);
+  },
+  zlibBase64(value) {
+    const buffer = strToU8(value);
+    const zipped = zlibSync(buffer, { level: 9 });
+    const binary = strFromU8(zipped);
+    return btoa(binary);
+  }
+};
+function defaultSerializer(context) {
+  const { files } = context;
+  return JSON.stringify(Object.fromEntries(files));
+}
+function normalizeEntry(entry) {
+  return {
+    variable: null,
+    folder: null,
+    ...entry,
+    serialize: entry.serialize ?? defaultSerializer
+  };
+}
+function normalizeEntries(entries) {
+  if (!entries) {
+    return [];
+  }
+  return entries.map(normalizeEntry);
+}
+async function getFiles(entry) {
+  const { folder: cwd } = entry;
+  const result = /* @__PURE__ */ new Map();
+  if (!cwd) {
+    return result;
+  }
+  const filenames = await Array.fromAsync(fs.glob("**", { cwd }));
+  const sorted = filenames.toSorted((a, b) => a.localeCompare(b));
+  for (const filename of sorted) {
+    const filePath = path__default.join(cwd, filename);
+    const st = await fs.lstat(filePath);
+    if (!st.isFile()) {
+      continue;
+    }
+    const content = await fs.readFile(filePath, "utf8");
+    result.set(filename, content);
+  }
+  return result;
+}
+function encode(key, value) {
+  const fn = encoder[key] ?? (() => void 0);
+  return fn(value);
+}
+async function generateUrl(entry) {
+  const files = await getFiles(entry);
+  const payload = await entry.serialize({ files });
+  const lazyEvaluation = new Proxy({}, { get: (_, k) => encode(k, payload) });
+  return encodeURI(interpolate(entry.urlFormat, lazyEvaluation));
+}
+function playgroundProcessor(options) {
+  const { enabled = true } = options;
+  const entries = normalizeEntries(options.entries);
+  return {
+    after: "generate-docs",
+    name: "playground-processor",
+    async handler(context) {
+      if (!enabled) {
+        return;
+      }
+      for (const entry of entries) {
+        if (!entry.variable) {
+          continue;
+        }
+        const url = await generateUrl(entry);
+        context.setTemplateData(entry.variable, url);
+      }
+    }
+  };
+}
+
 function dump(value) {
   return `<pre>${JSON.stringify(value, null, 2)}</pre>`;
 }
@@ -1507,6 +1590,7 @@ function searchProcessor() {
 }
 
 const availableProcessors = [
+  playgroundProcessor({ entries: [] }),
   cookieProcessor(),
   manifestProcessor(),
   matomoProcessor({ siteId: "", trackerUrl: "" }),
@@ -1888,7 +1972,7 @@ function findTranslations(filename, content) {
   return result;
 }
 
-const md$4 = MarkdownIt();
+const md$4 = MarkdownItCallable();
 const EMPTY_CHAR$4 = "&#8208;";
 const EM_DASH$2 = `<span role="presentation">&mdash;</span>`;
 function render$5(text) {
@@ -1942,7 +2026,7 @@ function generateEventTable(slug, events) {
   );
 }
 
-const md$3 = MarkdownIt();
+const md$3 = MarkdownItCallable();
 const EMPTY_CHAR$3 = "&#8208;";
 function render$4(text) {
   return text ? md$3.render(text) : EMPTY_CHAR$3;
@@ -1988,7 +2072,7 @@ function generateModelTable(slug, models) {
   );
 }
 
-const md$2 = MarkdownIt();
+const md$2 = MarkdownItCallable();
 const EMPTY_CHAR$2 = "&#8208;";
 function render$3(text) {
   return text ? md$2.render(text) : EMPTY_CHAR$2;
@@ -2034,7 +2118,7 @@ function generatePropTable(slug, props) {
   );
 }
 
-const md$1 = MarkdownIt();
+const md$1 = MarkdownItCallable();
 const EMPTY_CHAR$1 = "&#8208;";
 const EM_DASH$1 = `<span role="presentation">&mdash;</span>`;
 function render$2(text) {
@@ -2088,7 +2172,7 @@ function generateSlotTable(slug, slots) {
   );
 }
 
-const md = MarkdownIt();
+const md = MarkdownItCallable();
 const EMPTY_CHAR = "&#8208;";
 const EM_DASH = `<span role="presentation">&mdash;</span>`;
 function render$1(text) {
@@ -3975,5 +4059,5 @@ class Generator {
   }
 }
 
-export { Generator, apiExtractorProcessor, availableProcessors, cookieProcessor, defineSources, extractExamplesProcessor, frontMatterFileReader, htmlRedirectProcessor, isRelease, livereloadProcessor, manifestProcessor, matomoProcessor, motdProcessor, navigationFileReader, processorRuntimeName, redirectFileProcessor, searchProcessor, selectableVersionProcessor, sourceUrlProcessor, topnavProcessor, versionBannerProcessor, versionProcessor, vueFileReader };
+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 };
 //# sourceMappingURL=index.mjs.map