@frankframework/doc-library-core 1.0.0 → 1.0.3

package/README.md

@@ -1,17 +1,17 @@
-# FF! Doc Library for ESM / TS Applications
-
-The FF! Doc Library is a powerful and easy-to-use Node.js package designed to extract and process information from the `frankdoc.json`.
-This library simplifies working with the data structure and enables seamless integration with [FF! Reference](https://frankdoc.frankframework.org/#/search) and FF! Flow projects.
-No matter if you use React, Angular or vanilla JavaScript, FF! Doc Library has you covered.
-
-## Usage
-```js
-import { FFDoc } from '@frankframework/doc-library-core';
-```
-
-## Development
-### Build
-Run `pnpm build` to build the library project using Vite. The bundled and type definition files will be stored in the `dist/` directory.
-
-### Publishing
-Run `pnpm publish` in the this directory in order to publish the library to a package registry.
+# FF! Doc Library for ESM / TS Applications
+
+The FF! Doc Library is a powerful and easy-to-use Node.js package designed to extract and process information from the `frankdoc.json`.
+This library simplifies working with the data structure and enables seamless integration with [FF! Reference](https://frankdoc.frankframework.org/#/search) and FF! Flow projects.
+No matter if you use React, Angular or vanilla JavaScript, FF! Doc Library has you covered.
+
+## Usage
+```js
+import { FFDoc } from '@frankframework/doc-library-core';
+```
+
+## Development
+### Build
+Run `pnpm build` to build the library project using Vite. The bundled and type definition files will be stored in the `dist/` directory.
+
+### Publishing
+Run `pnpm publish` in the this directory in order to publish the library to a package registry.

package/dist/doc-library-core.js

@@ -1,96 +1,96 @@
-function d(r, n) {
-  const e = {};
-  for (const t of Object.values(r))
-    if (t.enum) {
-      const s = n[t.enum];
-      s && !e[t.enum] && (e[t.enum] = s);
+function h(r, e) {
+  const t = {};
+  for (const n of Object.values(r))
+    if (n.enum) {
+      const s = e[n.enum];
+      s && !t[n.enum] && (t[n.enum] = s);
     }
-  return e;
+  return t;
 }
-function h(r) {
+function d(r) {
   return Object.entries(r).reduce(
-    (n, [e, t]) => (n[t.mandatory === !0 ? "required" : "optional"][e] = t, n),
+    (e, [t, n]) => (e[n.mandatory === !0 ? "required" : "optional"][t] = n, e),
     { required: {}, optional: {} }
   );
 }
-function c(r, n, e) {
-  const t = {
+function c(r, e, t) {
+  const n = {
     attributesRequired: [],
     attributesOptional: [],
     forwards: {},
     enums: {},
     parentElements: []
   };
-  if (!r.parent) return t;
-  const s = n[r.parent];
-  if (!s) return t;
-  const i = c(s, n, e);
+  if (!r.parent) return n;
+  const s = e[r.parent];
+  if (!s) return n;
+  const i = c(s, e, t);
   if (i.parentElements.unshift(s.name), s.attributes) {
-    const { required: a, optional: l } = h(
+    const { required: l, optional: a } = d(
       s.attributes
     );
-    Object.values(a).length > 0 && i.attributesRequired.unshift({
-      parentElementName: s.name,
-      properties: a
-    }), Object.values(l).length > 0 && i.attributesOptional.unshift({
+    Object.values(l).length > 0 && i.attributesRequired.unshift({
       parentElementName: s.name,
       properties: l
-    }), i.enums = { ...i.enums, ...d(s.attributes, e) };
+    }), Object.values(a).length > 0 && i.attributesOptional.unshift({
+      parentElementName: s.name,
+      properties: a
+    }), i.enums = { ...i.enums, ...h(s.attributes, t) };
   }
   return s.forwards && (i.forwards = { ...i.forwards, ...s.forwards }), i;
 }
-function p(r, n, e) {
-  const t = c(r, n, e);
+function p(r, e, t) {
+  const n = c(r, e, t);
   return {
     ...r,
-    parentElements: t.parentElements,
+    parentElements: n.parentElements,
     attributes: {
-      ...f(t.attributesOptional),
-      ...f(t.attributesRequired),
+      ...f(n.attributesOptional),
+      ...f(n.attributesRequired),
       ...r.attributes
     },
-    forwards: { ...t.forwards, ...r.forwards },
-    enums: t.enums
+    forwards: { ...n.forwards, ...r.forwards },
+    enums: n.enums
   };
 }
 function f(r) {
-  let n = {};
-  for (const e of r)
-    n = { ...e.properties, ...n };
-  return n;
+  let e = {};
+  for (const t of r)
+    e = { ...t.properties, ...e };
+  return e;
 }
 class b {
-  getFiltersFromLabels(n) {
-    const e = {};
-    for (const [t, s] of Object.entries(n)) {
-      e[t] = {};
+  getFiltersFromLabels(e) {
+    const t = {};
+    for (const [n, s] of Object.entries(e)) {
+      t[n] = {};
       for (const i of s)
-        e[t][i] = [];
+        t[n][i] = [];
     }
-    return e;
+    return t;
   }
-  assignFrankDocElementsToFilters(n, e) {
-    for (const [t, s] of Object.entries(e))
+  assignFrankDocElementsToFilters(e, t) {
+    for (const [n, s] of Object.entries(t))
       for (const i in s.labels) {
-        const a = s.labels[i];
-        !n[i] || !n[i][a] || n[i][a].push(t);
+        const l = s.labels[i];
+        !e[i] || !e[i][l] || e[i][l].push(n);
       }
-    return n;
+    return e;
   }
-  getXMLElements(n) {
-    const e = {};
-    for (const [t, s] of Object.entries(n.elementNames)) {
-      const i = n.elements[s.className];
-      e[t] = {
-        ...p(i, n.elements, n.enums),
+  getXMLElements(e) {
+    const t = {};
+    for (const [n, s] of Object.entries(e.elementNames)) {
+      const i = e.elements[s.className];
+      t[n] = {
+        ...p(i, e.elements, e.enums),
         ...s,
-        name: t
+        name: n
       };
     }
-    return e;
+    return t;
   }
 }
-class k extends b {
+class D extends b {
   constructor() {
     super(...arguments), this._ffDoc = null, this._elements = null, this._filters = {};
   }
@@ -103,72 +103,77 @@ class k extends b {
   get filters() {
     return this._filters;
   }
-  async initialize(n) {
-    const e = await this.fetchJson(n);
-    this._ffDoc = e, this._filters = this.assignFrankDocElementsToFilters(
-      this.getFiltersFromLabels(e.labels),
-      e.elementNames
-    ), this._elements = this.getXMLElements(e);
+  async initialize(e) {
+    const t = await this.fetchJson(e);
+    this._ffDoc = t, this._filters = this.assignFrankDocElementsToFilters(
+      this.getFiltersFromLabels(t.labels),
+      t.elementNames
+    ), this._elements = this.getXMLElements(t);
   }
-  async fetchJson(n) {
-    return await (await fetch(n)).json();
+  async fetchJson(e) {
+    return await (await fetch(e)).json();
   }
 }
 const m = /\[([^\]]+)]\(([^)]+)\)/g, g = /<[^>]*>?/gm, o = /(?:{@link\s(.*?)})/g;
-function D(r, n, e) {
-  let t = `${r}`;
-  return t = t.replaceAll(m, '<a target="_blank" href="$2" alt="$1">$1</a>'), e ? (t = t.replaceAll(o, (s, i) => {
-    const a = u(i, n);
-    return a.href ? `\\"${JSON.stringify(a)}\\"` : a.text;
-  }), t.split(String.raw`\"`)) : (t = t.replaceAll(o, (s, i) => {
-    const a = u(i, n);
-    return a.href ? O(a) : a.text;
-  }), t = t.replaceAll(String.raw`\"`, '"'), [t]);
+function F(r, e, t) {
+  let n = r.replaceAll(m, '<a target="_blank" href="$2" alt="$1">$1</a>').replaceAll(String.raw`\"`, '"');
+  return t ? O(n, e) : (n = n.replaceAll(o, (s, i) => {
+    const l = u(i, e);
+    return l.href ? x(l) : l.text;
+  }), [n]);
 }
-function F(r, n) {
-  let e = `${r}`;
-  return e = e.replaceAll(m, "$1($2)"), e = e.replaceAll(g, ""), e = e.replaceAll(o, (t, s) => u(s, n).text), e = e.replaceAll(String.raw`\"`, '"'), [e];
+function P(r, e) {
+  return [r.replaceAll(m, "$1($2)").replaceAll(g, "").replaceAll(o, (n, s) => u(s, e).text).replaceAll(String.raw`\"`, '"')];
 }
-function O(r) {
+function x(r) {
   return `<a href="#/${r.href}">${r.text}</a>`;
 }
-function u(r, n) {
-  const e = r.indexOf("#"), t = e !== -1, s = t ? r.split("#")[0] : r;
+function u(r, e) {
+  const t = r.indexOf("#"), n = t !== -1, s = n ? r.split("#")[0] : r;
   if (s === "")
-    return { text: w(r, e) };
-  const i = s.split(" "), a = x(i, t, r), l = E(n, i[0]);
-  return l ? { href: l.name, text: a } : { text: a };
+    return { text: E(r, t) };
+  const i = s.split(" "), l = w(i, n, r), a = k(e, i[0]);
+  return a ? { href: a.className, text: l, element: a } : { text: l };
 }
-function w(r, n) {
-  const e = r.slice(n), t = e.split(" ");
-  return t.length === 2 ? t[1] : e.slice(1, e.indexOf("("));
+function O(r, e) {
+  const t = [];
+  let n = 0;
+  for (const s of r.matchAll(o)) {
+    const [i, l] = s, a = u(l, e);
+    t.push(r.slice(n, s.index), a.href ? a : a.text), n = s.index + i.length;
+  }
+  return n < r.length - 1 && t.push(r.slice(n)), t;
 }
-function x(r, n, e) {
-  const t = r.at(-1);
-  if (n) {
-    const s = e.split("#")[1], i = s.slice(s.indexOf(") ") + 1).trim();
-    return i.includes(" ") ? s.split(" ")[1] : `${t}.${i}`;
+function E(r, e) {
+  const t = r.slice(e), n = t.split(" ");
+  return n.length === 2 ? n[1] : t.slice(1, t.indexOf("("));
+}
+function w(r, e, t) {
+  const n = r.at(-1);
+  if (e) {
+    const s = t.split("#")[1], i = s.slice(s.indexOf(") ") + 1).trim();
+    return i.includes(" ") ? s.split(" ")[1] : `${n}.${i}`;
   }
-  return t;
+  return n;
 }
-function E(r, n) {
+function k(r, e) {
   if (Object.keys(r).length === 0) return null;
-  const e = r[n];
-  return e || (console.warn(`could not find element [${n}]`), null);
+  const t = r[e] ?? Object.values(r).find((n) => n.className === e);
+  return t || (console.warn(`could not find element [${e}]`), null);
 }
 export {
-  k as FFDoc,
+  D as FFDoc,
   b as FFDocBase,
   p as addInheritedPropertiesToElement,
-  O as defaultLinkTransformation,
+  x as defaultLinkTransformation,
   f as flattenInheritedParentElementProperties,
   c as getInheritedProperties,
   u as getLinkData,
-  h as groupAttributesByMandatory,
+  d as groupAttributesByMandatory,
   o as linkRegex,
   m as markdownLinkRegex,
   g as tagsRegex,
-  D as transformAsHtml,
-  F as transformAsText
+  F as transformAsHtml,
+  P as transformAsText
 };
 //# sourceMappingURL=doc-library-core.js.map

package/dist/doc-library-core.js.map

@@ -1 +1 @@
-{"version":3,"file":"doc-library-core.js","sources":["../src/frankdoc.utilities.ts","../src/ff-doc-base.ts","../src/ff-doc.ts","../src/javadoc.ts"],"sourcesContent":["import { Attribute, ElementClass, ElementProperty, EnumValue, FFDocJson } from './frankdoc.types';\n\nexport type InheritedParentElementProperties<T> = {\n  parentElementName: string;\n  properties: Record<string, T>;\n};\n\ntype InheritedPropertiesExtras = {\n  enums: Record<string, EnumValue>;\n  parentElements: string[];\n};\n\nexport type InheritedProperties = {\n  attributesRequired: InheritedParentElementProperties<Attribute>[];\n  attributesOptional: InheritedParentElementProperties<Attribute>[];\n  forwards: Record<string, ElementProperty>;\n} & InheritedPropertiesExtras;\n\nexport type ElementClassWithInheritedProperties = ElementClass & InheritedPropertiesExtras;\n\nfunction filterUsedEnums(attributes: Record<string, Attribute>, enums: FFDocJson['enums']): Record<string, EnumValue> {\n  const filteredEnums: Record<string, EnumValue> = {};\n  for (const attribute of Object.values(attributes)) {\n    if (attribute.enum) {\n      const enumType = enums[attribute.enum];\n      if (enumType && !filteredEnums[attribute.enum]) filteredEnums[attribute.enum] = enumType;\n    }\n  }\n  return filteredEnums;\n}\n\nexport function groupAttributesByMandatory(attributes: Record<string, Attribute>): {\n  required: Record<string, Attribute>;\n  optional: Record<string, Attribute>;\n} {\n  return Object.entries(attributes).reduce<{\n    required: Record<string, Attribute>;\n    optional: Record<string, Attribute>;\n  }>(\n    (collection, [name, attribute]) => {\n      collection[attribute.mandatory === true ? 'required' : 'optional'][name] = attribute;\n      return collection;\n    },\n    { required: {}, optional: {} },\n  );\n}\n\nexport function getInheritedProperties(\n  element: ElementClass,\n  elements: FFDocJson['elements'],\n  enums: FFDocJson['enums'],\n): InheritedProperties {\n  const initialInheritedProperties: InheritedProperties = {\n    attributesRequired: [],\n    attributesOptional: [],\n    forwards: {},\n    enums: {},\n    parentElements: [],\n  };\n\n  if (!element.parent) return initialInheritedProperties;\n  const parentElement = elements[element.parent];\n  if (!parentElement) return initialInheritedProperties;\n  const inheritedProperties = getInheritedProperties(parentElement, elements, enums);\n  inheritedProperties.parentElements.unshift(parentElement.name);\n\n  if (parentElement.attributes) {\n    // ES2024 has the Object.groupBy function which could make this a lot better\n    const { required: attributesRequired, optional: attributesOptional } = groupAttributesByMandatory(\n      parentElement.attributes,\n    );\n    if (Object.values(attributesRequired).length > 0) {\n      inheritedProperties.attributesRequired.unshift({\n        parentElementName: parentElement.name,\n        properties: attributesRequired,\n      });\n    }\n    if (Object.values(attributesOptional).length > 0) {\n      inheritedProperties.attributesOptional.unshift({\n        parentElementName: parentElement.name,\n        properties: attributesOptional,\n      });\n    }\n    inheritedProperties.enums = { ...inheritedProperties.enums, ...filterUsedEnums(parentElement.attributes, enums) };\n  }\n\n  if (parentElement.forwards)\n    inheritedProperties.forwards = { ...inheritedProperties.forwards, ...parentElement.forwards };\n\n  return inheritedProperties;\n}\n\nexport function addInheritedPropertiesToElement(\n  element: ElementClass,\n  elements: FFDocJson['elements'],\n  enums: FFDocJson['enums'],\n): ElementClassWithInheritedProperties {\n  const inheritedProperties = getInheritedProperties(element, elements, enums);\n  return {\n    ...element,\n    parentElements: inheritedProperties.parentElements,\n    attributes: {\n      ...flattenInheritedParentElementProperties(inheritedProperties.attributesOptional),\n      ...flattenInheritedParentElementProperties(inheritedProperties.attributesRequired),\n      ...element.attributes,\n    },\n    forwards: { ...inheritedProperties.forwards, ...element.forwards },\n    enums: inheritedProperties.enums,\n  };\n}\n\nexport function flattenInheritedParentElementProperties<T>(\n  inheritedProperties: InheritedParentElementProperties<T>[],\n): Record<string, T> {\n  let flattenedProperties: Record<string, T> = {};\n  for (const inheritedProperty of inheritedProperties) {\n    flattenedProperties = { ...inheritedProperty.properties, ...flattenedProperties };\n  }\n  return flattenedProperties;\n}\n","import { ElementInfo, FFDocJson } from './frankdoc.types';\nimport { addInheritedPropertiesToElement, ElementClassWithInheritedProperties } from './frankdoc.utilities';\n\nexport type Filters = Record<string, FilterLabels>;\nexport type FilterLabels = Record<string, string[]>;\nexport type Elements = Record<string, ElementDetails>;\nexport type ElementDetails = ElementClassWithInheritedProperties & ElementInfo;\n\nexport abstract class FFDocBase {\n  protected getFiltersFromLabels(labels: FFDocJson['labels']): Filters {\n    const filters: Filters = {};\n    for (const [filterGroup, filterLabels] of Object.entries(labels)) {\n      filters[filterGroup] = {};\n      for (const label of filterLabels) {\n        filters[filterGroup][label] = [];\n      }\n    }\n    return filters;\n  }\n\n  protected assignFrankDocElementsToFilters(filters: Filters, elements: FFDocJson['elementNames']): Filters {\n    for (const [elementName, element] of Object.entries(elements)) {\n      for (const elementFilterGroup in element.labels) {\n        const elementFilterLabel = element.labels[elementFilterGroup];\n        if (!filters[elementFilterGroup] || !filters[elementFilterGroup][elementFilterLabel]) continue;\n        filters[elementFilterGroup][elementFilterLabel].push(elementName);\n      }\n    }\n    return filters;\n  }\n\n  protected getXMLElements(json: FFDocJson): Elements {\n    const elements: Elements = {};\n\n    /* instead of looping over every xml element,\n     * maybe parent elements already processed should be used as cache in order to reduce the number of loops\n     */\n    for (const [elementName, elementValue] of Object.entries(json.elementNames)) {\n      const elementClassData = json.elements[elementValue.className];\n      elements[elementName] = {\n        ...addInheritedPropertiesToElement(elementClassData, json.elements, json.enums),\n        ...elementValue,\n        name: elementName,\n      };\n    }\n    return elements;\n  }\n}\n","import { FFDocJson } from './frankdoc.types';\nimport { Elements, FFDocBase, Filters } from './ff-doc-base';\n\nexport class FFDoc extends FFDocBase {\n  private _ffDoc: FFDocJson | null = null;\n  private _elements: Elements | null = null;\n  private _filters: Filters = {};\n\n  get ffDoc(): Readonly<FFDocJson | null> {\n    return this._ffDoc;\n  }\n\n  get elements(): Readonly<Elements | null> {\n    return this._elements;\n  }\n\n  get filters(): Readonly<Filters> {\n    return this._filters;\n  }\n\n  async initialize(jsonUrl: string): Promise<void> {\n    const ffDocJson = await this.fetchJson(jsonUrl);\n    this._ffDoc = ffDocJson;\n    this._filters = this.assignFrankDocElementsToFilters(\n      this.getFiltersFromLabels(ffDocJson.labels),\n      ffDocJson.elementNames,\n    );\n    this._elements = this.getXMLElements(ffDocJson);\n  }\n\n  private async fetchJson(url: string): Promise<FFDocJson> {\n    const response = await fetch(url);\n    return await response.json();\n  }\n}\n","import { ElementClass } from './frankdoc.types';\n\nexport type LinkData = { text: string; href?: string };\n\n// eslint-disable-next-line sonarjs/slow-regex\nexport const markdownLinkRegex = /\\[([^\\]]+)]\\(([^)]+)\\)/g; // old regex: /\\[(.*?)\\]\\((.+?)\\)/g\nexport const tagsRegex = /<[^>]*>?/gm;\nexport const linkRegex = /(?:{@link\\s(.*?)})/g;\n\nexport function transformAsHtml(\n  javadoc: string,\n  elements: Record<string, ElementClass>,\n  hasCustomLinkTransform: boolean,\n): string[] {\n  let value = `${javadoc}`;\n  value = value.replaceAll(markdownLinkRegex, '<a target=\"_blank\" href=\"$2\" alt=\"$1\">$1</a>');\n\n  if (hasCustomLinkTransform) {\n    value = value.replaceAll(linkRegex, (_, captureGroup) => {\n      const linkData = getLinkData(captureGroup, elements);\n      if (linkData.href) return `\\\\\"${JSON.stringify(linkData)}\\\\\"`;\n      return linkData.text;\n    });\n    return value.split(String.raw`\\\"`);\n  }\n  value = value.replaceAll(linkRegex, (_, captureGroup) => {\n    const linkData = getLinkData(captureGroup, elements);\n    if (linkData.href) return defaultLinkTransformation(linkData);\n    return linkData.text;\n  });\n\n  value = value.replaceAll(String.raw`\\\"`, '\"');\n  return [value];\n}\n\nexport function transformAsText(javadoc: string, elements: Record<string, ElementClass>): string[] {\n  let value = `${javadoc}`;\n  value = value.replaceAll(markdownLinkRegex, '$1($2)');\n  value = value.replaceAll(tagsRegex, '');\n  value = value.replaceAll(linkRegex, (_: string, captureGroup: string) => {\n    const linkData = getLinkData(captureGroup, elements);\n    return linkData.text;\n  });\n  value = value.replaceAll(String.raw`\\\"`, '\"');\n  return [value];\n}\n\nexport function defaultLinkTransformation(linkData: LinkData): string {\n  return `<a href=\"#/${linkData.href}\">${linkData.text}</a>`;\n}\n\n/**\n * Creates LinkData object from `@link` taglet's data\n * @param captureGroup cature group received from regex matching with the `@link` taglet,\n * e.g. 'PipeLineSession pipeLineSession' for `{@link PipeLineSession pipeLineSession}`\n * @param elements\n */\nexport function getLinkData(captureGroup: string, elements: Record<string, ElementClass>): LinkData {\n  const hashPosition = captureGroup.indexOf('#'),\n    isMethod = hashPosition !== -1,\n    elementString = isMethod ? captureGroup.split('#')[0] : captureGroup;\n\n  if (elementString === '') {\n    return { text: getInternalMethodReference(captureGroup, hashPosition) };\n  }\n\n  const elementParts = elementString.split(' '); //first part is the class name, 2nd part the written name\n  const name = parseLinkName(elementParts, isMethod, captureGroup);\n\n  const element = findElement(elements, elementParts[0]);\n  if (!element) return { text: name };\n  return { href: element.name, text: name };\n}\n\n/** Handle links to internal class methods  */\nfunction getInternalMethodReference(captureGroup: string, hashPosition: number): string {\n  const method = captureGroup.slice(hashPosition),\n    methodParts = method.split(' ');\n  return methodParts.length === 2\n    ? methodParts[1] // 'methodName label' -> 'label'\n    : method.slice(1, method.indexOf('('));\n}\n\nfunction parseLinkName(elementParts: string[], isMethod: boolean, captureGroup: string): string {\n  const elementName = elementParts.at(-1)!; // element name/label\n  if (isMethod) {\n    const method = captureGroup.split('#')[1],\n      methodNameOrLabel = method.slice(method.indexOf(') ') + 1).trim();\n    return methodNameOrLabel.includes(' ') ? method.split(' ')[1] : `${elementName}.${methodNameOrLabel}`;\n  }\n  return elementName;\n}\n\nfunction findElement(elements: Record<string, ElementClass>, simpleName: string): ElementClass | null {\n  if (Object.keys(elements).length === 0) return null;\n  const element = elements[simpleName];\n  if (element) return element;\n\n  console.warn(`could not find element [${simpleName}]`);\n  return null;\n}\n"],"names":["filterUsedEnums","attributes","enums","filteredEnums","attribute","enumType","groupAttributesByMandatory","collection","name","getInheritedProperties","element","elements","initialInheritedProperties","parentElement","inheritedProperties","attributesRequired","attributesOptional","addInheritedPropertiesToElement","flattenInheritedParentElementProperties","flattenedProperties","inheritedProperty","FFDocBase","labels","filters","filterGroup","filterLabels","label","elementName","elementFilterGroup","elementFilterLabel","json","elementValue","elementClassData","FFDoc","jsonUrl","ffDocJson","url","markdownLinkRegex","tagsRegex","linkRegex","transformAsHtml","javadoc","hasCustomLinkTransform","value","_","captureGroup","linkData","getLinkData","defaultLinkTransformation","transformAsText","hashPosition","isMethod","elementString","getInternalMethodReference","elementParts","parseLinkName","findElement","method","methodParts","methodNameOrLabel","simpleName"],"mappings":"AAoBA,SAASA,EAAgBC,GAAuCC,GAAsD;AACpH,QAAMC,IAA2C,CAAA;AACjD,aAAWC,KAAa,OAAO,OAAOH,CAAU;AAC9C,QAAIG,EAAU,MAAM;AAClB,YAAMC,IAAWH,EAAME,EAAU,IAAI;AACrC,MAAIC,KAAY,CAACF,EAAcC,EAAU,IAAI,MAAGD,EAAcC,EAAU,IAAI,IAAIC;AAAA,IAClF;AAEF,SAAOF;AACT;AAEO,SAASG,EAA2BL,GAGzC;AACA,SAAO,OAAO,QAAQA,CAAU,EAAE;AAAA,IAIhC,CAACM,GAAY,CAACC,GAAMJ,CAAS,OAC3BG,EAAWH,EAAU,cAAc,KAAO,aAAa,UAAU,EAAEI,CAAI,IAAIJ,GACpEG;AAAA,IAET,EAAE,UAAU,IAAI,UAAU,CAAA,EAAC;AAAA,EAAE;AAEjC;AAEO,SAASE,EACdC,GACAC,GACAT,GACqB;AACrB,QAAMU,IAAkD;AAAA,IACtD,oBAAoB,CAAA;AAAA,IACpB,oBAAoB,CAAA;AAAA,IACpB,UAAU,CAAA;AAAA,IACV,OAAO,CAAA;AAAA,IACP,gBAAgB,CAAA;AAAA,EAAC;AAGnB,MAAI,CAACF,EAAQ,OAAQ,QAAOE;AAC5B,QAAMC,IAAgBF,EAASD,EAAQ,MAAM;AAC7C,MAAI,CAACG,EAAe,QAAOD;AAC3B,QAAME,IAAsBL,EAAuBI,GAAeF,GAAUT,CAAK;AAGjF,MAFAY,EAAoB,eAAe,QAAQD,EAAc,IAAI,GAEzDA,EAAc,YAAY;AAE5B,UAAM,EAAE,UAAUE,GAAoB,UAAUC,MAAuBV;AAAA,MACrEO,EAAc;AAAA,IAAA;AAEhB,IAAI,OAAO,OAAOE,CAAkB,EAAE,SAAS,KAC7CD,EAAoB,mBAAmB,QAAQ;AAAA,MAC7C,mBAAmBD,EAAc;AAAA,MACjC,YAAYE;AAAA,IAAA,CACb,GAEC,OAAO,OAAOC,CAAkB,EAAE,SAAS,KAC7CF,EAAoB,mBAAmB,QAAQ;AAAA,MAC7C,mBAAmBD,EAAc;AAAA,MACjC,YAAYG;AAAA,IAAA,CACb,GAEHF,EAAoB,QAAQ,EAAE,GAAGA,EAAoB,OAAO,GAAGd,EAAgBa,EAAc,YAAYX,CAAK,EAAA;AAAA,EAChH;AAEA,SAAIW,EAAc,aAChBC,EAAoB,WAAW,EAAE,GAAGA,EAAoB,UAAU,GAAGD,EAAc,SAAA,IAE9EC;AACT;AAEO,SAASG,EACdP,GACAC,GACAT,GACqC;AACrC,QAAMY,IAAsBL,EAAuBC,GAASC,GAAUT,CAAK;AAC3E,SAAO;AAAA,IACL,GAAGQ;AAAA,IACH,gBAAgBI,EAAoB;AAAA,IACpC,YAAY;AAAA,MACV,GAAGI,EAAwCJ,EAAoB,kBAAkB;AAAA,MACjF,GAAGI,EAAwCJ,EAAoB,kBAAkB;AAAA,MACjF,GAAGJ,EAAQ;AAAA,IAAA;AAAA,IAEb,UAAU,EAAE,GAAGI,EAAoB,UAAU,GAAGJ,EAAQ,SAAA;AAAA,IACxD,OAAOI,EAAoB;AAAA,EAAA;AAE/B;AAEO,SAASI,EACdJ,GACmB;AACnB,MAAIK,IAAyC,CAAA;AAC7C,aAAWC,KAAqBN;AAC9B,IAAAK,IAAsB,EAAE,GAAGC,EAAkB,YAAY,GAAGD,EAAA;AAE9D,SAAOA;AACT;AC/GO,MAAeE,EAAU;AAAA,EACpB,qBAAqBC,GAAsC;AACnE,UAAMC,IAAmB,CAAA;AACzB,eAAW,CAACC,GAAaC,CAAY,KAAK,OAAO,QAAQH,CAAM,GAAG;AAChE,MAAAC,EAAQC,CAAW,IAAI,CAAA;AACvB,iBAAWE,KAASD;AAClB,QAAAF,EAAQC,CAAW,EAAEE,CAAK,IAAI,CAAA;AAAA,IAElC;AACA,WAAOH;AAAA,EACT;AAAA,EAEU,gCAAgCA,GAAkBZ,GAA8C;AACxG,eAAW,CAACgB,GAAajB,CAAO,KAAK,OAAO,QAAQC,CAAQ;AAC1D,iBAAWiB,KAAsBlB,EAAQ,QAAQ;AAC/C,cAAMmB,IAAqBnB,EAAQ,OAAOkB,CAAkB;AAC5D,QAAI,CAACL,EAAQK,CAAkB,KAAK,CAACL,EAAQK,CAAkB,EAAEC,CAAkB,KACnFN,EAAQK,CAAkB,EAAEC,CAAkB,EAAE,KAAKF,CAAW;AAAA,MAClE;AAEF,WAAOJ;AAAA,EACT;AAAA,EAEU,eAAeO,GAA2B;AAClD,UAAMnB,IAAqB,CAAA;AAK3B,eAAW,CAACgB,GAAaI,CAAY,KAAK,OAAO,QAAQD,EAAK,YAAY,GAAG;AAC3E,YAAME,IAAmBF,EAAK,SAASC,EAAa,SAAS;AAC7D,MAAApB,EAASgB,CAAW,IAAI;AAAA,QACtB,GAAGV,EAAgCe,GAAkBF,EAAK,UAAUA,EAAK,KAAK;AAAA,QAC9E,GAAGC;AAAA,QACH,MAAMJ;AAAA,MAAA;AAAA,IAEV;AACA,WAAOhB;AAAA,EACT;AACF;AC5CO,MAAMsB,UAAcZ,EAAU;AAAA,EAA9B,cAAA;AAAA,UAAA,GAAA,SAAA,GACL,KAAQ,SAA2B,MACnC,KAAQ,YAA6B,MACrC,KAAQ,WAAoB,CAAA;AAAA,EAAC;AAAA,EAE7B,IAAI,QAAoC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAsC;AACxC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,UAA6B;AAC/B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,WAAWa,GAAgC;AAC/C,UAAMC,IAAY,MAAM,KAAK,UAAUD,CAAO;AAC9C,SAAK,SAASC,GACd,KAAK,WAAW,KAAK;AAAA,MACnB,KAAK,qBAAqBA,EAAU,MAAM;AAAA,MAC1CA,EAAU;AAAA,IAAA,GAEZ,KAAK,YAAY,KAAK,eAAeA,CAAS;AAAA,EAChD;AAAA,EAEA,MAAc,UAAUC,GAAiC;AAEvD,WAAO,OADU,MAAM,MAAMA,CAAG,GACV,KAAA;AAAA,EACxB;AACF;AC7BO,MAAMC,IAAoB,2BACpBC,IAAY,cACZC,IAAY;AAElB,SAASC,EACdC,GACA9B,GACA+B,GACU;AACV,MAAIC,IAAQ,GAAGF,CAAO;AAGtB,SAFAE,IAAQA,EAAM,WAAWN,GAAmB,8CAA8C,GAEtFK,KACFC,IAAQA,EAAM,WAAWJ,GAAW,CAACK,GAAGC,MAAiB;AACvD,UAAMC,IAAWC,EAAYF,GAAclC,CAAQ;AACnD,WAAImC,EAAS,OAAa,MAAM,KAAK,UAAUA,CAAQ,CAAC,QACjDA,EAAS;AAAA,EAClB,CAAC,GACMH,EAAM,MAAM,OAAO,OAAO,MAEnCA,IAAQA,EAAM,WAAWJ,GAAW,CAACK,GAAGC,MAAiB;AACvD,UAAMC,IAAWC,EAAYF,GAAclC,CAAQ;AACnD,WAAImC,EAAS,OAAaE,EAA0BF,CAAQ,IACrDA,EAAS;AAAA,EAClB,CAAC,GAEDH,IAAQA,EAAM,WAAW,OAAO,SAAS,GAAG,GACrC,CAACA,CAAK;AACf;AAEO,SAASM,EAAgBR,GAAiB9B,GAAkD;AACjG,MAAIgC,IAAQ,GAAGF,CAAO;AACtB,SAAAE,IAAQA,EAAM,WAAWN,GAAmB,QAAQ,GACpDM,IAAQA,EAAM,WAAWL,GAAW,EAAE,GACtCK,IAAQA,EAAM,WAAWJ,GAAW,CAACK,GAAWC,MAC7BE,EAAYF,GAAclC,CAAQ,EACnC,IACjB,GACDgC,IAAQA,EAAM,WAAW,OAAO,SAAS,GAAG,GACrC,CAACA,CAAK;AACf;AAEO,SAASK,EAA0BF,GAA4B;AACpE,SAAO,cAAcA,EAAS,IAAI,KAAKA,EAAS,IAAI;AACtD;AAQO,SAASC,EAAYF,GAAsBlC,GAAkD;AAClG,QAAMuC,IAAeL,EAAa,QAAQ,GAAG,GAC3CM,IAAWD,MAAiB,IAC5BE,IAAgBD,IAAWN,EAAa,MAAM,GAAG,EAAE,CAAC,IAAIA;AAE1D,MAAIO,MAAkB;AACpB,WAAO,EAAE,MAAMC,EAA2BR,GAAcK,CAAY,EAAA;AAGtE,QAAMI,IAAeF,EAAc,MAAM,GAAG,GACtC5C,IAAO+C,EAAcD,GAAcH,GAAUN,CAAY,GAEzDnC,IAAU8C,EAAY7C,GAAU2C,EAAa,CAAC,CAAC;AACrD,SAAK5C,IACE,EAAE,MAAMA,EAAQ,MAAM,MAAMF,EAAA,IADd,EAAE,MAAMA,EAAA;AAE/B;AAGA,SAAS6C,EAA2BR,GAAsBK,GAA8B;AACtF,QAAMO,IAASZ,EAAa,MAAMK,CAAY,GAC5CQ,IAAcD,EAAO,MAAM,GAAG;AAChC,SAAOC,EAAY,WAAW,IAC1BA,EAAY,CAAC,IACbD,EAAO,MAAM,GAAGA,EAAO,QAAQ,GAAG,CAAC;AACzC;AAEA,SAASF,EAAcD,GAAwBH,GAAmBN,GAA8B;AAC9F,QAAMlB,IAAc2B,EAAa,GAAG,EAAE;AACtC,MAAIH,GAAU;AACZ,UAAMM,IAASZ,EAAa,MAAM,GAAG,EAAE,CAAC,GACtCc,IAAoBF,EAAO,MAAMA,EAAO,QAAQ,IAAI,IAAI,CAAC,EAAE,KAAA;AAC7D,WAAOE,EAAkB,SAAS,GAAG,IAAIF,EAAO,MAAM,GAAG,EAAE,CAAC,IAAI,GAAG9B,CAAW,IAAIgC,CAAiB;AAAA,EACrG;AACA,SAAOhC;AACT;AAEA,SAAS6B,EAAY7C,GAAwCiD,GAAyC;AACpG,MAAI,OAAO,KAAKjD,CAAQ,EAAE,WAAW,EAAG,QAAO;AAC/C,QAAMD,IAAUC,EAASiD,CAAU;AACnC,SAAIlD,MAEJ,QAAQ,KAAK,2BAA2BkD,CAAU,GAAG,GAC9C;AACT;"}
+{"version":3,"file":"doc-library-core.js","sources":["../src/frankdoc.utilities.ts","../src/ff-doc-base.ts","../src/ff-doc.ts","../src/javadoc.ts"],"sourcesContent":["import { Attribute, ElementClass, ElementProperty, EnumValue, FFDocJson } from './frankdoc.types';\n\nexport type InheritedParentElementProperties<T> = {\n  parentElementName: string;\n  properties: Record<string, T>;\n};\n\ntype InheritedPropertiesExtras = {\n  enums: Record<string, EnumValue>;\n  parentElements: string[];\n};\n\nexport type InheritedProperties = {\n  attributesRequired: InheritedParentElementProperties<Attribute>[];\n  attributesOptional: InheritedParentElementProperties<Attribute>[];\n  forwards: Record<string, ElementProperty>;\n} & InheritedPropertiesExtras;\n\nexport type ElementClassWithInheritedProperties = ElementClass & InheritedPropertiesExtras;\n\nfunction filterUsedEnums(attributes: Record<string, Attribute>, enums: FFDocJson['enums']): Record<string, EnumValue> {\n  const filteredEnums: Record<string, EnumValue> = {};\n  for (const attribute of Object.values(attributes)) {\n    if (attribute.enum) {\n      const enumType = enums[attribute.enum];\n      if (enumType && !filteredEnums[attribute.enum]) filteredEnums[attribute.enum] = enumType;\n    }\n  }\n  return filteredEnums;\n}\n\nexport function groupAttributesByMandatory(attributes: Record<string, Attribute>): {\n  required: Record<string, Attribute>;\n  optional: Record<string, Attribute>;\n} {\n  return Object.entries(attributes).reduce<{\n    required: Record<string, Attribute>;\n    optional: Record<string, Attribute>;\n  }>(\n    (collection, [name, attribute]) => {\n      collection[attribute.mandatory === true ? 'required' : 'optional'][name] = attribute;\n      return collection;\n    },\n    { required: {}, optional: {} },\n  );\n}\n\nexport function getInheritedProperties(\n  element: ElementClass,\n  elements: FFDocJson['elements'],\n  enums: FFDocJson['enums'],\n): InheritedProperties {\n  const initialInheritedProperties: InheritedProperties = {\n    attributesRequired: [],\n    attributesOptional: [],\n    forwards: {},\n    enums: {},\n    parentElements: [],\n  };\n\n  if (!element.parent) return initialInheritedProperties;\n  const parentElement = elements[element.parent];\n  if (!parentElement) return initialInheritedProperties;\n  const inheritedProperties = getInheritedProperties(parentElement, elements, enums);\n  inheritedProperties.parentElements.unshift(parentElement.name);\n\n  if (parentElement.attributes) {\n    // ES2024 has the Object.groupBy function which could make this a lot better\n    const { required: attributesRequired, optional: attributesOptional } = groupAttributesByMandatory(\n      parentElement.attributes,\n    );\n    if (Object.values(attributesRequired).length > 0) {\n      inheritedProperties.attributesRequired.unshift({\n        parentElementName: parentElement.name,\n        properties: attributesRequired,\n      });\n    }\n    if (Object.values(attributesOptional).length > 0) {\n      inheritedProperties.attributesOptional.unshift({\n        parentElementName: parentElement.name,\n        properties: attributesOptional,\n      });\n    }\n    inheritedProperties.enums = { ...inheritedProperties.enums, ...filterUsedEnums(parentElement.attributes, enums) };\n  }\n\n  if (parentElement.forwards)\n    inheritedProperties.forwards = { ...inheritedProperties.forwards, ...parentElement.forwards };\n\n  return inheritedProperties;\n}\n\nexport function addInheritedPropertiesToElement(\n  element: ElementClass,\n  elements: FFDocJson['elements'],\n  enums: FFDocJson['enums'],\n): ElementClassWithInheritedProperties {\n  const inheritedProperties = getInheritedProperties(element, elements, enums);\n  return {\n    ...element,\n    parentElements: inheritedProperties.parentElements,\n    attributes: {\n      ...flattenInheritedParentElementProperties(inheritedProperties.attributesOptional),\n      ...flattenInheritedParentElementProperties(inheritedProperties.attributesRequired),\n      ...element.attributes,\n    },\n    forwards: { ...inheritedProperties.forwards, ...element.forwards },\n    enums: inheritedProperties.enums,\n  };\n}\n\nexport function flattenInheritedParentElementProperties<T>(\n  inheritedProperties: InheritedParentElementProperties<T>[],\n): Record<string, T> {\n  let flattenedProperties: Record<string, T> = {};\n  for (const inheritedProperty of inheritedProperties) {\n    flattenedProperties = { ...inheritedProperty.properties, ...flattenedProperties };\n  }\n  return flattenedProperties;\n}\n","import { ElementInfo, FFDocJson } from './frankdoc.types';\nimport { addInheritedPropertiesToElement, ElementClassWithInheritedProperties } from './frankdoc.utilities';\n\nexport type Filters = Record<string, FilterLabels>;\nexport type FilterLabels = Record<string, string[]>;\nexport type Elements = Record<string, ElementDetails>;\nexport type ElementDetails = ElementClassWithInheritedProperties & ElementInfo;\n\nexport abstract class FFDocBase {\n  protected getFiltersFromLabels(labels: FFDocJson['labels']): Filters {\n    const filters: Filters = {};\n    for (const [filterGroup, filterLabels] of Object.entries(labels)) {\n      filters[filterGroup] = {};\n      for (const label of filterLabels) {\n        filters[filterGroup][label] = [];\n      }\n    }\n    return filters;\n  }\n\n  protected assignFrankDocElementsToFilters(filters: Filters, elements: FFDocJson['elementNames']): Filters {\n    for (const [elementName, element] of Object.entries(elements)) {\n      for (const elementFilterGroup in element.labels) {\n        const elementFilterLabel = element.labels[elementFilterGroup];\n        if (!filters[elementFilterGroup] || !filters[elementFilterGroup][elementFilterLabel]) continue;\n        filters[elementFilterGroup][elementFilterLabel].push(elementName);\n      }\n    }\n    return filters;\n  }\n\n  protected getXMLElements(json: FFDocJson): Elements {\n    const elements: Elements = {};\n\n    /* instead of looping over every xml element,\n     * maybe parent elements already processed should be used as cache in order to reduce the number of loops\n     */\n    for (const [elementName, elementValue] of Object.entries(json.elementNames)) {\n      const elementClassData = json.elements[elementValue.className];\n      elements[elementName] = {\n        ...addInheritedPropertiesToElement(elementClassData, json.elements, json.enums),\n        ...elementValue,\n        name: elementName,\n      };\n    }\n    return elements;\n  }\n}\n","import { FFDocJson } from './frankdoc.types';\nimport { Elements, FFDocBase, Filters } from './ff-doc-base';\n\nexport class FFDoc extends FFDocBase {\n  private _ffDoc: FFDocJson | null = null;\n  private _elements: Elements | null = null;\n  private _filters: Filters = {};\n\n  get ffDoc(): Readonly<FFDocJson | null> {\n    return this._ffDoc;\n  }\n\n  get elements(): Readonly<Elements | null> {\n    return this._elements;\n  }\n\n  get filters(): Readonly<Filters> {\n    return this._filters;\n  }\n\n  async initialize(jsonUrl: string): Promise<void> {\n    const ffDocJson = await this.fetchJson(jsonUrl);\n    this._ffDoc = ffDocJson;\n    this._filters = this.assignFrankDocElementsToFilters(\n      this.getFiltersFromLabels(ffDocJson.labels),\n      ffDocJson.elementNames,\n    );\n    this._elements = this.getXMLElements(ffDocJson);\n  }\n\n  private async fetchJson(url: string): Promise<FFDocJson> {\n    const response = await fetch(url);\n    return await response.json();\n  }\n}\n","import { ElementClass, ElementInfo } from './frankdoc.types';\n\nexport type ElementsWithInfo = ElementClass & ElementInfo;\nexport type LinkData = {\n  text: string;\n  href?: string;\n  element?: ElementsWithInfo;\n};\ntype TransformedJavadocPart = string | LinkData;\nexport type TransformedJavadoc = TransformedJavadocPart[];\n\n// eslint-disable-next-line sonarjs/slow-regex\nexport const markdownLinkRegex = /\\[([^\\]]+)]\\(([^)]+)\\)/g; // old regex: /\\[(.*?)\\]\\((.+?)\\)/g\nexport const tagsRegex = /<[^>]*>?/gm;\nexport const linkRegex = /(?:{@link\\s(.*?)})/g;\n\nexport function transformAsHtml(\n  javadoc: string,\n  elements: Record<string, ElementsWithInfo>,\n  hasCustomLinkTransform: boolean,\n): TransformedJavadoc {\n  let transformed = javadoc\n    .replaceAll(markdownLinkRegex, '<a target=\"_blank\" href=\"$2\" alt=\"$1\">$1</a>')\n    .replaceAll(String.raw`\\\"`, '\"');\n\n  if (hasCustomLinkTransform) {\n    return transformAsCustomHtml(transformed, elements);\n  }\n\n  transformed = transformed.replaceAll(linkRegex, (_, captureGroup) => {\n    const linkData = getLinkData(captureGroup, elements);\n    if (linkData.href) return defaultLinkTransformation(linkData);\n    return linkData.text;\n  });\n  return [transformed];\n}\n\nexport function transformAsText(javadoc: string, elements: Record<string, ElementsWithInfo>): TransformedJavadoc {\n  const text = javadoc\n    .replaceAll(markdownLinkRegex, '$1($2)')\n    .replaceAll(tagsRegex, '')\n    .replaceAll(linkRegex, (_: string, captureGroup: string) => {\n      const linkData = getLinkData(captureGroup, elements);\n      return linkData.text;\n    })\n    .replaceAll(String.raw`\\\"`, '\"');\n  return [text];\n}\n\nexport function defaultLinkTransformation(linkData: LinkData): string {\n  return `<a href=\"#/${linkData.href}\">${linkData.text}</a>`;\n}\n\n/**\n * Creates LinkData object from `@link` taglet's data\n * @param captureGroup cature group received from regex matching with the `@link` taglet,\n * e.g. 'PipeLineSession pipeLineSession' for `{@link PipeLineSession pipeLineSession}`\n * @param elements\n */\nexport function getLinkData(captureGroup: string, elements: Record<string, ElementsWithInfo>): LinkData {\n  const hashPosition = captureGroup.indexOf('#'),\n    isMethod = hashPosition !== -1,\n    elementString = isMethod ? captureGroup.split('#')[0] : captureGroup;\n\n  if (elementString === '') {\n    return { text: getInternalMethodReference(captureGroup, hashPosition) };\n  }\n\n  const elementParts = elementString.split(' '); //first part is the class name, 2nd part the written name\n  const name = parseLinkName(elementParts, isMethod, captureGroup);\n\n  const element = findElement(elements, elementParts[0]);\n  if (!element) return { text: name };\n  return { href: element.className, text: name, element };\n}\n\nfunction transformAsCustomHtml(javadoc: string, elements: Record<string, ElementsWithInfo>): TransformedJavadoc {\n  const transformedParts: TransformedJavadocPart[] = [];\n  let lastIndex = 0;\n  for (const match of javadoc.matchAll(linkRegex)) {\n    const [string, captureGroup] = match;\n    const linkData = getLinkData(captureGroup, elements);\n    transformedParts.push(javadoc.slice(lastIndex, match.index), linkData.href ? linkData : linkData.text);\n    lastIndex = match.index + string.length;\n  }\n  if (lastIndex < javadoc.length - 1) transformedParts.push(javadoc.slice(lastIndex));\n  return transformedParts;\n}\n\n/** Handle links to internal class methods  */\nfunction getInternalMethodReference(captureGroup: string, hashPosition: number): string {\n  const method = captureGroup.slice(hashPosition),\n    methodParts = method.split(' ');\n  return methodParts.length === 2\n    ? methodParts[1] // 'methodName label' -> 'label'\n    : method.slice(1, method.indexOf('('));\n}\n\nfunction parseLinkName(elementParts: string[], isMethod: boolean, captureGroup: string): string {\n  const elementName = elementParts.at(-1)!; // element name/label\n  if (isMethod) {\n    const method = captureGroup.split('#')[1],\n      methodNameOrLabel = method.slice(method.indexOf(') ') + 1).trim();\n    return methodNameOrLabel.includes(' ') ? method.split(' ')[1] : `${elementName}.${methodNameOrLabel}`;\n  }\n  return elementName;\n}\n\nfunction findElement(elements: Record<string, ElementsWithInfo>, name: string): ElementsWithInfo | null {\n  if (Object.keys(elements).length === 0) return null;\n  const element = elements[name] ?? Object.values(elements).find((element) => element.className === name);\n  if (element) return element;\n\n  console.warn(`could not find element [${name}]`);\n  return null;\n}\n"],"names":["filterUsedEnums","attributes","enums","filteredEnums","attribute","enumType","groupAttributesByMandatory","collection","name","getInheritedProperties","element","elements","initialInheritedProperties","parentElement","inheritedProperties","attributesRequired","attributesOptional","addInheritedPropertiesToElement","flattenInheritedParentElementProperties","flattenedProperties","inheritedProperty","FFDocBase","labels","filters","filterGroup","filterLabels","label","elementName","elementFilterGroup","elementFilterLabel","json","elementValue","elementClassData","FFDoc","jsonUrl","ffDocJson","url","markdownLinkRegex","tagsRegex","linkRegex","transformAsHtml","javadoc","hasCustomLinkTransform","transformed","transformAsCustomHtml","_","captureGroup","linkData","getLinkData","defaultLinkTransformation","transformAsText","hashPosition","isMethod","elementString","getInternalMethodReference","elementParts","parseLinkName","findElement","transformedParts","lastIndex","match","string","method","methodParts","methodNameOrLabel"],"mappings":"AAoBA,SAASA,EAAgBC,GAAuCC,GAAsD;AACpH,QAAMC,IAA2C,CAAA;AACjD,aAAWC,KAAa,OAAO,OAAOH,CAAU;AAC9C,QAAIG,EAAU,MAAM;AAClB,YAAMC,IAAWH,EAAME,EAAU,IAAI;AACrC,MAAIC,KAAY,CAACF,EAAcC,EAAU,IAAI,MAAGD,EAAcC,EAAU,IAAI,IAAIC;AAAA,IAClF;AAEF,SAAOF;AACT;AAEO,SAASG,EAA2BL,GAGzC;AACA,SAAO,OAAO,QAAQA,CAAU,EAAE;AAAA,IAIhC,CAACM,GAAY,CAACC,GAAMJ,CAAS,OAC3BG,EAAWH,EAAU,cAAc,KAAO,aAAa,UAAU,EAAEI,CAAI,IAAIJ,GACpEG;AAAA,IAET,EAAE,UAAU,IAAI,UAAU,CAAA,EAAC;AAAA,EAAE;AAEjC;AAEO,SAASE,EACdC,GACAC,GACAT,GACqB;AACrB,QAAMU,IAAkD;AAAA,IACtD,oBAAoB,CAAA;AAAA,IACpB,oBAAoB,CAAA;AAAA,IACpB,UAAU,CAAA;AAAA,IACV,OAAO,CAAA;AAAA,IACP,gBAAgB,CAAA;AAAA,EAAC;AAGnB,MAAI,CAACF,EAAQ,OAAQ,QAAOE;AAC5B,QAAMC,IAAgBF,EAASD,EAAQ,MAAM;AAC7C,MAAI,CAACG,EAAe,QAAOD;AAC3B,QAAME,IAAsBL,EAAuBI,GAAeF,GAAUT,CAAK;AAGjF,MAFAY,EAAoB,eAAe,QAAQD,EAAc,IAAI,GAEzDA,EAAc,YAAY;AAE5B,UAAM,EAAE,UAAUE,GAAoB,UAAUC,MAAuBV;AAAA,MACrEO,EAAc;AAAA,IAAA;AAEhB,IAAI,OAAO,OAAOE,CAAkB,EAAE,SAAS,KAC7CD,EAAoB,mBAAmB,QAAQ;AAAA,MAC7C,mBAAmBD,EAAc;AAAA,MACjC,YAAYE;AAAA,IAAA,CACb,GAEC,OAAO,OAAOC,CAAkB,EAAE,SAAS,KAC7CF,EAAoB,mBAAmB,QAAQ;AAAA,MAC7C,mBAAmBD,EAAc;AAAA,MACjC,YAAYG;AAAA,IAAA,CACb,GAEHF,EAAoB,QAAQ,EAAE,GAAGA,EAAoB,OAAO,GAAGd,EAAgBa,EAAc,YAAYX,CAAK,EAAA;AAAA,EAChH;AAEA,SAAIW,EAAc,aAChBC,EAAoB,WAAW,EAAE,GAAGA,EAAoB,UAAU,GAAGD,EAAc,SAAA,IAE9EC;AACT;AAEO,SAASG,EACdP,GACAC,GACAT,GACqC;AACrC,QAAMY,IAAsBL,EAAuBC,GAASC,GAAUT,CAAK;AAC3E,SAAO;AAAA,IACL,GAAGQ;AAAA,IACH,gBAAgBI,EAAoB;AAAA,IACpC,YAAY;AAAA,MACV,GAAGI,EAAwCJ,EAAoB,kBAAkB;AAAA,MACjF,GAAGI,EAAwCJ,EAAoB,kBAAkB;AAAA,MACjF,GAAGJ,EAAQ;AAAA,IAAA;AAAA,IAEb,UAAU,EAAE,GAAGI,EAAoB,UAAU,GAAGJ,EAAQ,SAAA;AAAA,IACxD,OAAOI,EAAoB;AAAA,EAAA;AAE/B;AAEO,SAASI,EACdJ,GACmB;AACnB,MAAIK,IAAyC,CAAA;AAC7C,aAAWC,KAAqBN;AAC9B,IAAAK,IAAsB,EAAE,GAAGC,EAAkB,YAAY,GAAGD,EAAA;AAE9D,SAAOA;AACT;AC/GO,MAAeE,EAAU;AAAA,EACpB,qBAAqBC,GAAsC;AACnE,UAAMC,IAAmB,CAAA;AACzB,eAAW,CAACC,GAAaC,CAAY,KAAK,OAAO,QAAQH,CAAM,GAAG;AAChE,MAAAC,EAAQC,CAAW,IAAI,CAAA;AACvB,iBAAWE,KAASD;AAClB,QAAAF,EAAQC,CAAW,EAAEE,CAAK,IAAI,CAAA;AAAA,IAElC;AACA,WAAOH;AAAA,EACT;AAAA,EAEU,gCAAgCA,GAAkBZ,GAA8C;AACxG,eAAW,CAACgB,GAAajB,CAAO,KAAK,OAAO,QAAQC,CAAQ;AAC1D,iBAAWiB,KAAsBlB,EAAQ,QAAQ;AAC/C,cAAMmB,IAAqBnB,EAAQ,OAAOkB,CAAkB;AAC5D,QAAI,CAACL,EAAQK,CAAkB,KAAK,CAACL,EAAQK,CAAkB,EAAEC,CAAkB,KACnFN,EAAQK,CAAkB,EAAEC,CAAkB,EAAE,KAAKF,CAAW;AAAA,MAClE;AAEF,WAAOJ;AAAA,EACT;AAAA,EAEU,eAAeO,GAA2B;AAClD,UAAMnB,IAAqB,CAAA;AAK3B,eAAW,CAACgB,GAAaI,CAAY,KAAK,OAAO,QAAQD,EAAK,YAAY,GAAG;AAC3E,YAAME,IAAmBF,EAAK,SAASC,EAAa,SAAS;AAC7D,MAAApB,EAASgB,CAAW,IAAI;AAAA,QACtB,GAAGV,EAAgCe,GAAkBF,EAAK,UAAUA,EAAK,KAAK;AAAA,QAC9E,GAAGC;AAAA,QACH,MAAMJ;AAAA,MAAA;AAAA,IAEV;AACA,WAAOhB;AAAA,EACT;AACF;AC5CO,MAAMsB,UAAcZ,EAAU;AAAA,EAA9B,cAAA;AAAA,UAAA,GAAA,SAAA,GACL,KAAQ,SAA2B,MACnC,KAAQ,YAA6B,MACrC,KAAQ,WAAoB,CAAA;AAAA,EAAC;AAAA,EAE7B,IAAI,QAAoC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAsC;AACxC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,UAA6B;AAC/B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,WAAWa,GAAgC;AAC/C,UAAMC,IAAY,MAAM,KAAK,UAAUD,CAAO;AAC9C,SAAK,SAASC,GACd,KAAK,WAAW,KAAK;AAAA,MACnB,KAAK,qBAAqBA,EAAU,MAAM;AAAA,MAC1CA,EAAU;AAAA,IAAA,GAEZ,KAAK,YAAY,KAAK,eAAeA,CAAS;AAAA,EAChD;AAAA,EAEA,MAAc,UAAUC,GAAiC;AAEvD,WAAO,OADU,MAAM,MAAMA,CAAG,GACV,KAAA;AAAA,EACxB;AACF;ACtBO,MAAMC,IAAoB,2BACpBC,IAAY,cACZC,IAAY;AAElB,SAASC,EACdC,GACA9B,GACA+B,GACoB;AACpB,MAAIC,IAAcF,EACf,WAAWJ,GAAmB,8CAA8C,EAC5E,WAAW,OAAO,SAAS,GAAG;AAEjC,SAAIK,IACKE,EAAsBD,GAAahC,CAAQ,KAGpDgC,IAAcA,EAAY,WAAWJ,GAAW,CAACM,GAAGC,MAAiB;AACnE,UAAMC,IAAWC,EAAYF,GAAcnC,CAAQ;AACnD,WAAIoC,EAAS,OAAaE,EAA0BF,CAAQ,IACrDA,EAAS;AAAA,EAClB,CAAC,GACM,CAACJ,CAAW;AACrB;AAEO,SAASO,EAAgBT,GAAiB9B,GAAgE;AAS/G,SAAO,CARM8B,EACV,WAAWJ,GAAmB,QAAQ,EACtC,WAAWC,GAAW,EAAE,EACxB,WAAWC,GAAW,CAACM,GAAWC,MAChBE,EAAYF,GAAcnC,CAAQ,EACnC,IACjB,EACA,WAAW,OAAO,SAAS,GAAG,CACrB;AACd;AAEO,SAASsC,EAA0BF,GAA4B;AACpE,SAAO,cAAcA,EAAS,IAAI,KAAKA,EAAS,IAAI;AACtD;AAQO,SAASC,EAAYF,GAAsBnC,GAAsD;AACtG,QAAMwC,IAAeL,EAAa,QAAQ,GAAG,GAC3CM,IAAWD,MAAiB,IAC5BE,IAAgBD,IAAWN,EAAa,MAAM,GAAG,EAAE,CAAC,IAAIA;AAE1D,MAAIO,MAAkB;AACpB,WAAO,EAAE,MAAMC,EAA2BR,GAAcK,CAAY,EAAA;AAGtE,QAAMI,IAAeF,EAAc,MAAM,GAAG,GACtC7C,IAAOgD,EAAcD,GAAcH,GAAUN,CAAY,GAEzDpC,IAAU+C,EAAY9C,GAAU4C,EAAa,CAAC,CAAC;AACrD,SAAK7C,IACE,EAAE,MAAMA,EAAQ,WAAW,MAAMF,GAAM,SAAAE,EAAA,IADzB,EAAE,MAAMF,EAAA;AAE/B;AAEA,SAASoC,EAAsBH,GAAiB9B,GAAgE;AAC9G,QAAM+C,IAA6C,CAAA;AACnD,MAAIC,IAAY;AAChB,aAAWC,KAASnB,EAAQ,SAASF,CAAS,GAAG;AAC/C,UAAM,CAACsB,GAAQf,CAAY,IAAIc,GACzBb,IAAWC,EAAYF,GAAcnC,CAAQ;AACnD,IAAA+C,EAAiB,KAAKjB,EAAQ,MAAMkB,GAAWC,EAAM,KAAK,GAAGb,EAAS,OAAOA,IAAWA,EAAS,IAAI,GACrGY,IAAYC,EAAM,QAAQC,EAAO;AAAA,EACnC;AACA,SAAIF,IAAYlB,EAAQ,SAAS,OAAoB,KAAKA,EAAQ,MAAMkB,CAAS,CAAC,GAC3ED;AACT;AAGA,SAASJ,EAA2BR,GAAsBK,GAA8B;AACtF,QAAMW,IAAShB,EAAa,MAAMK,CAAY,GAC5CY,IAAcD,EAAO,MAAM,GAAG;AAChC,SAAOC,EAAY,WAAW,IAC1BA,EAAY,CAAC,IACbD,EAAO,MAAM,GAAGA,EAAO,QAAQ,GAAG,CAAC;AACzC;AAEA,SAASN,EAAcD,GAAwBH,GAAmBN,GAA8B;AAC9F,QAAMnB,IAAc4B,EAAa,GAAG,EAAE;AACtC,MAAIH,GAAU;AACZ,UAAMU,IAAShB,EAAa,MAAM,GAAG,EAAE,CAAC,GACtCkB,IAAoBF,EAAO,MAAMA,EAAO,QAAQ,IAAI,IAAI,CAAC,EAAE,KAAA;AAC7D,WAAOE,EAAkB,SAAS,GAAG,IAAIF,EAAO,MAAM,GAAG,EAAE,CAAC,IAAI,GAAGnC,CAAW,IAAIqC,CAAiB;AAAA,EACrG;AACA,SAAOrC;AACT;AAEA,SAAS8B,EAAY9C,GAA4CH,GAAuC;AACtG,MAAI,OAAO,KAAKG,CAAQ,EAAE,WAAW,EAAG,QAAO;AAC/C,QAAMD,IAAUC,EAASH,CAAI,KAAK,OAAO,OAAOG,CAAQ,EAAE,KAAK,CAACD,MAAYA,EAAQ,cAAcF,CAAI;AACtG,SAAIE,MAEJ,QAAQ,KAAK,2BAA2BF,CAAI,GAAG,GACxC;AACT;"}

package/dist/javadoc.d.ts

@@ -1,13 +1,17 @@
-import { ElementClass } from './frankdoc.types';
+import { ElementClass, ElementInfo } from './frankdoc.types';
+export type ElementsWithInfo = ElementClass & ElementInfo;
 export type LinkData = {
     text: string;
     href?: string;
+    element?: ElementsWithInfo;
 };
+type TransformedJavadocPart = string | LinkData;
+export type TransformedJavadoc = TransformedJavadocPart[];
 export declare const markdownLinkRegex: RegExp;
 export declare const tagsRegex: RegExp;
 export declare const linkRegex: RegExp;
-export declare function transformAsHtml(javadoc: string, elements: Record<string, ElementClass>, hasCustomLinkTransform: boolean): string[];
-export declare function transformAsText(javadoc: string, elements: Record<string, ElementClass>): string[];
+export declare function transformAsHtml(javadoc: string, elements: Record<string, ElementsWithInfo>, hasCustomLinkTransform: boolean): TransformedJavadoc;
+export declare function transformAsText(javadoc: string, elements: Record<string, ElementsWithInfo>): TransformedJavadoc;
 export declare function defaultLinkTransformation(linkData: LinkData): string;
 /**
  * Creates LinkData object from `@link` taglet's data
@@ -15,4 +19,5 @@ export declare function defaultLinkTransformation(linkData: LinkData): string;
  * e.g. 'PipeLineSession pipeLineSession' for `{@link PipeLineSession pipeLineSession}`
  * @param elements
  */
-export declare function getLinkData(captureGroup: string, elements: Record<string, ElementClass>): LinkData;
+export declare function getLinkData(captureGroup: string, elements: Record<string, ElementsWithInfo>): LinkData;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frankframework/doc-library-core",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "type": "module",
   "description": "A powerful and easy-to-use library, designed to extract and process information from the FF! Doc JSON.",
   "module": "dist/doc-library-core.js",
@@ -17,9 +17,9 @@
     "directory": "packages/core"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.55.0",
+    "@microsoft/api-extractor": "^7.55.2",
     "unplugin-dts": "1.0.0-beta.6",
-    "vite": "^7.2.2"
+    "vite": "^7.3.1"
   },
   "scripts": {
     "build": "vite build"