@apify/docusaurus-plugin-typedoc-api 3.0.0

package/lib/plugin/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sources":["../../src/plugin/version.ts"],"sourcesContent":null,"names":["path","DEFAULT_PLUGIN_ID","VERSIONED_DOCS_DIR","CURRENT_VERSION_NAME","normalizeUrl","getDefaultVersionBanner","readVersionNames","filterVersions"],"mappings":";;;;;;;;;;AAAA;AAKO,SAAS,uBAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE;AAC3D,EAAE,OAAOA,qBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,KAAKC,uBAAiB,GAAGC,yBAAkB,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAEA,yBAAkB,CAAC,CAAC,CAAC,CAAC;AACvH,CAAC;AACD,SAAS,yBAAyB,CAAC,YAAY,EAAE;AACjD,EAAE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;AACjC,IAAI,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;AAC3B,GAAG;AACH,EAAE,OAAO,YAAY,CAAC,IAAI,CAAC,WAAW,IAAI,WAAW,KAAKC,2BAAoB,CAAC,IAAI,EAAE,CAAC;AACtF,CAAC;AACD,SAAS,qBAAqB,CAAC;AAC/B,EAAE,WAAW;AACb,EAAE,YAAY;AACd,EAAE,eAAe;AACjB,EAAE,OAAO;AACT,EAAE,OAAO;AACT,CAAC,EAAE;AACH,EAAE,MAAM,MAAM,GAAG,WAAW,KAAK,eAAe,CAAC;AACjD,EAAE,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;AAC7D,EAAE,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,IAAI,WAAW,KAAKA,2BAAoB,GAAG,MAAM,GAAG,WAAW,CAAC;AAC3G,EAAE,IAAI,eAAe,GAAG,cAAc,CAAC,IAAI,IAAI,WAAW,KAAKA,2BAAoB,GAAG,MAAM,GAAG,WAAW,CAAC;AAC3G,EAAE,IAAI,MAAM,EAAE;AACd,IAAI,eAAe,GAAG,EAAE,CAAC;AACzB,GAAG;AACH,EAAE,MAAM,WAAW,GAAGC,kBAAY,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,IAAI,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC;AAClH,EAAE,OAAO;AACT,IAAI,MAAM,EAAE,WAAW,KAAK,eAAe;AAC3C,IAAI,aAAa,EAAE,eAAe,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS;AAC1D,IAAI,YAAY,EAAE,cAAc,EAAE,KAAK,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;AACpE,IAAI,aAAa,EAAEC,8BAAuB,CAAC;AAC3C,MAAM,OAAO;AACb,MAAM,eAAe;AACrB;AACA,MAAM,OAAO;AACb,MAAM,WAAW;AACjB,MAAM,YAAY;AAClB,KAAK,CAAC;AACN,IAAI,gBAAgB,EAAE,cAAc,EAAE,SAAS,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAC/E,IAAI,YAAY;AAChB,IAAI,WAAW;AACf,IAAI,WAAW;AACf,GAAG,CAAC;AACJ,CAAC;AACM,eAAe,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE;AAC7D;AACA;AACA;AACA,EAAE,MAAM,cAAc,GAAG,OAAO,CAAC;AACjC,EAAE,MAAM,sBAAsB,GAAG,MAAMC,uBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;AACzE,IAAI,GAAG,cAAc;AACrB,IAAI,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,IAAI,KAAK;AACzD,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,SAAS;AAC/B,IAAI,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,IAAI,IAAI;AAChE,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,YAAY,GAAGC,qBAAc,CAAC,sBAAsB,EAAE;AAC9D,IAAI,GAAG,cAAc;AACrB,IAAI,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS;AACxI,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAC;AAC9G,EAAE,OAAO,YAAY,CAAC,GAAG,CAAC,WAAW,IAAI,qBAAqB,CAAC;AAC/D,IAAI,OAAO;AACX,IAAI,eAAe;AACnB,IAAI,OAAO;AACX,IAAI,WAAW;AACf,IAAI,YAAY;AAChB,GAAG,CAAC,CAAC,CAAC;AACN;;;;;"}

package/lib/types.js

@@ -0,0 +1,2 @@
+'use strict';
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":[],"sourcesContent":null,"names":[],"mappings":";;"}

package/lib/utils/hierarchy.js

@@ -0,0 +1,35 @@
+'use strict';
+
+// The JSON output does not include hierarchy information, so we need to duplicate the logic!
+// https://github.com/TypeStrong/typedoc/blob/master/src/lib/converter/plugins/TypePlugin.ts#L98
+function createHierarchy(reflection) {
+  let root;
+  let hierarchy;
+  function push(types) {
+    const level = {
+      types
+    };
+    if (hierarchy) {
+      hierarchy.next = level;
+      hierarchy = level;
+    } else {
+      root = level;
+      hierarchy = level;
+    }
+  }
+  if (reflection.extendedTypes) {
+    push(reflection.extendedTypes);
+  }
+  push([{
+    id: reflection.id,
+    name: reflection.name,
+    type: 'reference'
+  }]);
+  hierarchy.isTarget = true;
+  if (reflection.extendedBy) {
+    push(reflection.extendedBy);
+  }
+  return root;
+}
+exports.createHierarchy = createHierarchy;
+//# sourceMappingURL=hierarchy.js.map

package/lib/utils/hierarchy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hierarchy.js","sources":["../../src/utils/hierarchy.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACA;AACO,SAAS,eAAe,CAAC,UAAU,EAAE;AAC5C,EAAE,IAAI,IAAI,CAAC;AACX,EAAE,IAAI,SAAS,CAAC;AAChB,EAAE,SAAS,IAAI,CAAC,KAAK,EAAE;AACvB,IAAI,MAAM,KAAK,GAAG;AAClB,MAAM,KAAK;AACX,KAAK,CAAC;AACN,IAAI,IAAI,SAAS,EAAE;AACnB,MAAM,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC;AAC7B,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,KAAK,MAAM;AACX,MAAM,IAAI,GAAG,KAAK,CAAC;AACnB,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,KAAK;AACL,GAAG;AACH,EAAE,IAAI,UAAU,CAAC,aAAa,EAAE;AAChC,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACnC,GAAG;AACH,EAAE,IAAI,CAAC,CAAC;AACR,IAAI,EAAE,EAAE,UAAU,CAAC,EAAE;AACrB,IAAI,IAAI,EAAE,UAAU,CAAC,IAAI;AACzB,IAAI,IAAI,EAAE,WAAW;AACrB,GAAG,CAAC,CAAC,CAAC;AACN,EAAE,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;AAC5B,EAAE,IAAI,UAAU,CAAC,UAAU,EAAE;AAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAChC,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd;;;;"}

package/lib/utils/icons.js

@@ -0,0 +1,124 @@
+'use strict';
+
+/* eslint-disable no-fallthrough */
+
+// We have to map these manually instead of using the `ReflectionKind` enum,
+// otherwise the `typedoc` package ends up in the bundle and crashes.
+const KIND_ICONS = {
+  1: 'project',
+  // Project
+  2: 'package',
+  // Module
+  4: 'symbol-namespace',
+  // Namespace
+  8: 'symbol-enum',
+  // Enum
+  16: 'symbol-enum-member',
+  // EnumMember
+  32: 'symbol-variable',
+  // Variable
+  64: 'symbol-function',
+  // Function
+  128: 'symbol-class',
+  // Class
+  256: 'symbol-interface',
+  // Interface
+  512: 'symbol-constructor',
+  // Constructor
+  1024: 'symbol-property',
+  // Property
+  2048: 'symbol-method',
+  // Method
+  4096: 'symbol-method',
+  // CallSignature
+  8192: 'bracket-dot',
+  // IndexSignature
+  16_384: 'symbol-method',
+  // ConstructorSignature
+  32_768: 'symbol-property',
+  // Parameter
+  65_536: 'symbol-key',
+  // TypeLiteral
+  131_072: 'symbol-type-parameter',
+  // TypeParameter
+  262_144: 'symbol-field',
+  // Accessor
+  524_288: 'symbol-field',
+  // GetSignature
+  1_048_576: 'symbol-field',
+  // SetSignature
+  2_097_152: 'bracket',
+  // ObjectLiteral
+  4_194_304: 'symbol-parameter',
+  // TypeAlias
+  8_388_608: 'references' // Reference
+};
+
+function getKindIcon(kind, name) {
+  let icon = KIND_ICONS[kind];
+
+  // Use event icon when property starts with "on"
+  if (kind === 1024 && name.match(/^on[A-Z]/)) {
+    icon = 'symbol-event';
+  }
+  return icon;
+}
+
+// eslint-disable-next-line complexity
+function getKindIconColor(kind) {
+  switch (kind) {
+    // Function
+    case 64:
+    // Constructor
+    case 512:
+    // Method
+    case 2048:
+    // CallSignature
+    case 4096:
+    // ConstructorSignature
+    case 16_384:
+    // Accessor
+    case 262_144:
+      return 'var(--ifm-color-info)';
+
+    // EnumMember
+    case 16:
+    // Variable
+    case 32:
+    // Property
+    case 1024:
+    // GetSignature
+    case 524_288:
+    // SetSignature
+    case 1_048_576:
+      return 'var(--ifm-color-success)';
+
+    // Namespace
+    case 4:
+    // Class
+    case 128:
+      return 'var(--ifm-color-warning)';
+
+    // Enum
+    case 8:
+    // Interface
+    case 256:
+    // TypeAlias
+    case 4_194_304:
+      return 'var(--ifm-color-danger)';
+    default:
+      return 'inherit';
+  }
+}
+function getKindIconHtml(kind, name) {
+  const icon = getKindIcon(kind, name);
+  if (!icon) {
+    return '';
+  }
+  const color = getKindIconColor(kind);
+  return `<i class="codicon codicon-${icon}" style="color:${color};"></i>`;
+}
+exports.getKindIcon = getKindIcon;
+exports.getKindIconColor = getKindIconColor;
+exports.getKindIconHtml = getKindIconHtml;
+//# sourceMappingURL=icons.js.map

package/lib/utils/icons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons.js","sources":["../../src/utils/icons.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAG;AACnB,EAAE,CAAC,EAAE,SAAS;AACd;AACA,EAAE,CAAC,EAAE,SAAS;AACd;AACA,EAAE,CAAC,EAAE,kBAAkB;AACvB;AACA,EAAE,CAAC,EAAE,aAAa;AAClB;AACA,EAAE,EAAE,EAAE,oBAAoB;AAC1B;AACA,EAAE,EAAE,EAAE,iBAAiB;AACvB;AACA,EAAE,EAAE,EAAE,iBAAiB;AACvB;AACA,EAAE,GAAG,EAAE,cAAc;AACrB;AACA,EAAE,GAAG,EAAE,kBAAkB;AACzB;AACA,EAAE,GAAG,EAAE,oBAAoB;AAC3B;AACA,EAAE,IAAI,EAAE,iBAAiB;AACzB;AACA,EAAE,IAAI,EAAE,eAAe;AACvB;AACA,EAAE,IAAI,EAAE,eAAe;AACvB;AACA,EAAE,IAAI,EAAE,aAAa;AACrB;AACA,EAAE,MAAM,EAAE,eAAe;AACzB;AACA,EAAE,MAAM,EAAE,iBAAiB;AAC3B;AACA,EAAE,MAAM,EAAE,YAAY;AACtB;AACA,EAAE,OAAO,EAAE,uBAAuB;AAClC;AACA,EAAE,OAAO,EAAE,cAAc;AACzB;AACA,EAAE,OAAO,EAAE,cAAc;AACzB;AACA,EAAE,SAAS,EAAE,cAAc;AAC3B;AACA,EAAE,SAAS,EAAE,SAAS;AACtB;AACA,EAAE,SAAS,EAAE,kBAAkB;AAC/B;AACA,EAAE,SAAS,EAAE,YAAY;AACzB,CAAC,CAAC;AACF;AACO,SAAS,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE;AACxC,EAAE,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;AAC9B;AACA;AACA,EAAE,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;AAC/C,IAAI,IAAI,GAAG,cAAc,CAAC;AAC1B,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd,CAAC;AACD;AACA;AACO,SAAS,gBAAgB,CAAC,IAAI,EAAE;AACvC,EAAE,QAAQ,IAAI;AACd;AACA,IAAI,KAAK,EAAE,CAAC;AACZ;AACA,IAAI,KAAK,GAAG,CAAC;AACb;AACA,IAAI,KAAK,IAAI,CAAC;AACd;AACA,IAAI,KAAK,IAAI,CAAC;AACd;AACA,IAAI,KAAK,MAAM,CAAC;AAChB;AACA,IAAI,KAAK,OAAO;AAChB,MAAM,OAAO,uBAAuB,CAAC;AACrC;AACA;AACA,IAAI,KAAK,EAAE,CAAC;AACZ;AACA,IAAI,KAAK,EAAE,CAAC;AACZ;AACA,IAAI,KAAK,IAAI,CAAC;AACd;AACA,IAAI,KAAK,OAAO,CAAC;AACjB;AACA,IAAI,KAAK,SAAS;AAClB,MAAM,OAAO,0BAA0B,CAAC;AACxC;AACA;AACA,IAAI,KAAK,CAAC,CAAC;AACX;AACA,IAAI,KAAK,GAAG;AACZ,MAAM,OAAO,0BAA0B,CAAC;AACxC;AACA;AACA,IAAI,KAAK,CAAC,CAAC;AACX;AACA,IAAI,KAAK,GAAG,CAAC;AACb;AACA,IAAI,KAAK,SAAS;AAClB,MAAM,OAAO,yBAAyB,CAAC;AACvC,IAAI;AACJ,MAAM,OAAO,SAAS,CAAC;AACvB,GAAG;AACH,CAAC;AACM,SAAS,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE;AAC5C,EAAE,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACvC,EAAE,IAAI,CAAC,IAAI,EAAE;AACb,IAAI,OAAO,EAAE,CAAC;AACd,GAAG;AACH,EAAE,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACvC,EAAE,OAAO,CAAC,0BAA0B,EAAE,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3E;;;;;;"}

package/lib/utils/links.js

@@ -0,0 +1,10 @@
+'use strict';
+
+function removeScopes(text, scopes) {
+  if (scopes.length === 0) {
+    return text;
+  }
+  return scopes.reduce((value, scope) => value.replace(new RegExp(`^(${scope}-|@${scope}/)`), ''), text);
+}
+exports.removeScopes = removeScopes;
+//# sourceMappingURL=links.js.map

package/lib/utils/links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sources":["../../src/utils/links.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAO,SAAS,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE;AAC3C,EAAE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;AACzG;;;;"}

package/lib/utils/markdown.js

@@ -0,0 +1,69 @@
+'use strict';
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function splitLinkText(text) {
+  let splitIndex = text.indexOf('|');
+  if (splitIndex === -1) {
+    splitIndex = text.search(/\s/);
+  }
+  if (splitIndex !== -1) {
+    return {
+      caption: text.slice(splitIndex + 1).replace(/\n+/, ' ').trim(),
+      target: text.slice(0, Math.max(0, splitIndex)).trim()
+    };
+  }
+  return {
+    caption: text,
+    target: text
+  };
+}
+function findReflectionWithMatchingTarget(reflections, symbol, member) {
+  return Object.values(reflections).find(ref => {
+    if (ref.name !== symbol) {
+      return false;
+    }
+    return member ? ref.children?.some(child => child.name === member) : true;
+  });
+}
+function replaceApiLinks(reflections) {
+  return (match, tagName, content) => {
+    const _splitLinkText = splitLinkText(content),
+      caption = _splitLinkText.caption,
+      target = _splitLinkText.target;
+    const _target$split = target.split('.'),
+      _target$split2 = _slicedToArray(_target$split, 2),
+      symbol = _target$split2[0],
+      member = _target$split2[1];
+    const reflection = findReflectionWithMatchingTarget(reflections, symbol, member);
+    const label = tagName === 'linkcode' ? `\`${caption}\`` : caption;
+    if (!reflection?.permalink) {
+      return label;
+    }
+    return `[${label}](${reflection.permalink}${member ? `#${member}` : ''})`;
+  };
+}
+function replaceDocLinks(currentVersion) {
+  return (match, content) => {
+    const _splitLinkText2 = splitLinkText(content),
+      caption = _splitLinkText2.caption,
+      target = _splitLinkText2.target;
+    const version = currentVersion.version === 'current' ? 'next' : currentVersion.version;
+
+    // TODO: Handle `routeBasePath`? Something else besides "docs"?
+    const url = currentVersion.isLast ? `/docs/${target}` : `/docs/${version}/${target}`;
+    return `[${caption}](${url})`;
+  };
+}
+
+// TypeDoc JSON output does not replace links, so we need to do this manually.
+// @see https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/plugins/MarkedLinksPlugin.ts
+function replaceLinkTokens(markdown, reflections, currentVersion) {
+  return markdown.replace(/{@(link|linkcode|linkplain|apilink)\s+([^}]+?)}/gi, replaceApiLinks(reflections)).replace(/{@doclink\s+([^}]+?)}/gi, replaceDocLinks(currentVersion));
+}
+exports.replaceLinkTokens = replaceLinkTokens;
+//# sourceMappingURL=markdown.js.map

package/lib/utils/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sources":["../../src/utils/markdown.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA,SAAS,aAAa,CAAC,IAAI,EAAE;AAC7B,EAAE,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACrC,EAAE,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;AACzB,IAAI,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACnC,GAAG;AACH,EAAE,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;AACzB,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE;AACpE,MAAM,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE;AAC3D,KAAK,CAAC;AACN,GAAG;AACH,EAAE,OAAO;AACT,IAAI,OAAO,EAAE,IAAI;AACjB,IAAI,MAAM,EAAE,IAAI;AAChB,GAAG,CAAC;AACJ,CAAC;AACD,SAAS,gCAAgC,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE;AACvE,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI;AAChD,IAAI,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE;AAC7B,MAAM,OAAO,KAAK,CAAC;AACnB,KAAK;AACL,IAAI,OAAO,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;AAC9E,GAAG,CAAC,CAAC;AACL,CAAC;AACD,SAAS,eAAe,CAAC,WAAW,EAAE;AACtC,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,KAAK;AACtC,IAAI,MAAM;AACV,MAAM,OAAO;AACb,MAAM,MAAM;AACZ,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/B,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC/C,IAAI,MAAM,UAAU,GAAG,gCAAgC,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AACrF,IAAI,MAAM,KAAK,GAAG,OAAO,KAAK,UAAU,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;AACtE,IAAI,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE;AAChC,MAAM,OAAO,KAAK,CAAC;AACnB,KAAK;AACL,IAAI,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9E,GAAG,CAAC;AACJ,CAAC;AACD,SAAS,eAAe,CAAC,cAAc,EAAE;AACzC,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,KAAK;AAC7B,IAAI,MAAM;AACV,MAAM,OAAO;AACb,MAAM,MAAM;AACZ,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/B,IAAI,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,KAAK,SAAS,GAAG,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC;AAC3F;AACA;AACA,IAAI,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AACzF,IAAI,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAClC,GAAG,CAAC;AACJ,CAAC;AACD;AACA;AACA;AACO,SAAS,iBAAiB,CAAC,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE;AACzE,EAAE,OAAO,QAAQ,CAAC,OAAO,CAAC,mDAAmD,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,yBAAyB,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;AACjL;;;;"}

package/lib/utils/visibility.js

@@ -0,0 +1,25 @@
+'use strict';
+
+// https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/themes/DefaultTheme.ts#L264
+function hasOwnDocument(id, reflections) {
+  const reflection = reflections[id];
+  return Boolean(reflection?.permalink && !reflection.permalink.includes('#'));
+}
+
+// https://github.com/TypeStrong/typedoc/blob/2103f347c9cba40fcaa1f67e36f7cea0bdea2f0f/src/lib/models/ReflectionCategory.ts#L44
+function allCategoryChildrenHaveOwnDocument(category, reflections) {
+  let onlyOwnDocuments = true;
+  category.children?.forEach(child => {
+    onlyOwnDocuments &&= hasOwnDocument(child, reflections);
+  });
+  return onlyOwnDocuments;
+}
+
+// https://github.com/TypeStrong/typedoc/blob/2103f347c9cba40fcaa1f67e36f7cea0bdea2f0f/src/lib/models/ReflectionGroup.ts#L81
+function allGroupChildrenHaveOwnDocument(group, reflections) {
+  return Boolean(group.children?.every(child => hasOwnDocument(child, reflections)));
+}
+exports.allCategoryChildrenHaveOwnDocument = allCategoryChildrenHaveOwnDocument;
+exports.allGroupChildrenHaveOwnDocument = allGroupChildrenHaveOwnDocument;
+exports.hasOwnDocument = hasOwnDocument;
+//# sourceMappingURL=visibility.js.map

package/lib/utils/visibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility.js","sources":["../../src/utils/visibility.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACO,SAAS,cAAc,CAAC,EAAE,EAAE,WAAW,EAAE;AAChD,EAAE,MAAM,UAAU,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;AACrC,EAAE,OAAO,OAAO,CAAC,UAAU,EAAE,SAAS,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/E,CAAC;AACD;AACA;AACO,SAAS,kCAAkC,CAAC,QAAQ,EAAE,WAAW,EAAE;AAC1E,EAAE,IAAI,gBAAgB,GAAG,IAAI,CAAC;AAC9B,EAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,IAAI;AACtC,IAAI,gBAAgB,KAAK,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAC5D,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AACD;AACA;AACO,SAAS,+BAA+B,CAAC,KAAK,EAAE,WAAW,EAAE;AACpE,EAAE,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,IAAI,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AACrF;;;;;;"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@apify/docusaurus-plugin-typedoc-api",
+  "version": "3.0.0",
+  "description": "Docusaurus plugin that provides source code API documentation powered by TypeDoc. ",
+  "keywords": [
+    "docusaurus",
+    "plugin",
+    "typedoc",
+    "api"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:apify/docusaurus-plugin-typedoc-api.git"
+  },
+  "author": "Miles Johnson, Apify Technologies",
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "assets/**/*",
+    "lib/**/*",
+    "src/**/*",
+    "styles.css"
+  ],
+  "engines": {
+    "node": ">=16.12.0"
+  },
+  "packemon": {
+    "format": "lib",
+    "platform": "node",
+    "externals": [
+      "@theme/*",
+      "@docusaurus/*",
+      "@vscode/*",
+      "css$"
+    ]
+  },
+  "peerDependencies": {
+    "@docusaurus/core": "^2.0.0",
+    "react": ">=16.0.0",
+    "typescript": "^4.0.0 || ^5.0.0"
+  },
+  "dependencies": {
+    "@docusaurus/plugin-content-docs": "^2.4.0",
+    "@docusaurus/types": "^2.4.0",
+    "@docusaurus/utils": "^2.4.0",
+    "@vscode/codicons": "^0.0.32",
+    "marked": "^4.3.0",
+    "typedoc": "^0.23.28"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "^2.4.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "typescript": "^5.0.2"
+  }
+}

package/src/components/AnchorLink.tsx

@@ -0,0 +1,14 @@
+import React from 'react';
+
+export interface AnchorLinkProps {
+	id: string;
+}
+
+export function AnchorLink({ id }: AnchorLinkProps) {
+	return (
+		<a className="tsd-anchor" href={`#${id}`}>
+			<span className="tsd-anchor-id" id={id} />
+			<i className="codicon codicon-symbol-numeric" />
+		</a>
+	);
+}

package/src/components/ApiChangelog.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import { PageMetadata } from '@docusaurus/theme-common';
+import type { Props as DocItemProps } from '@theme/DocItem';
+import type { TOCItem } from '../types';
+import ApiItemLayout from './ApiItemLayout';
+
+export interface ApiChangelogProps extends Pick<DocItemProps, 'route'> {
+	changelog: DocItemProps['content'];
+}
+
+const emptyToc: TOCItem[] = [];
+
+export default function ApiChangelog({ changelog: Changelog, route }: ApiChangelogProps) {
+	return (
+		<ApiItemLayout
+			heading="Changelog"
+			pageMetadata={<PageMetadata description={Changelog.contentTitle} title="Changelog | API" />}
+			route={route}
+			toc={Changelog.toc ?? emptyToc}
+		>
+			<section className="tsd-readme">
+				<Changelog />
+			</section>
+		</ApiItemLayout>
+	);
+}

package/src/components/ApiDataContext.ts

@@ -0,0 +1,17 @@
+import { createContext } from 'react';
+import type { ApiOptions, DeclarationReflectionMap } from '../types';
+
+export const ApiDataContext = createContext<{
+	options: ApiOptions;
+	reflections: DeclarationReflectionMap;
+}>({
+	options: {
+		banner: '',
+		breadcrumbs: true,
+		gitRefName: 'master',
+		minimal: false,
+		pluginId: 'default',
+		scopes: [],
+	},
+	reflections: {},
+});

package/src/components/ApiIndex.tsx

@@ -0,0 +1,109 @@
+import React, { useEffect } from 'react';
+import Link from '@docusaurus/Link';
+import type { PropVersionMetadata } from '@docusaurus/plugin-content-docs';
+import type { GlobalVersion } from '@docusaurus/plugin-content-docs/client';
+import { useDocsPreferredVersion } from '@docusaurus/theme-common';
+import { useDocsVersion } from '@docusaurus/theme-common/internal';
+import type { Props as DocItemProps } from '@theme/DocItem';
+import Heading from '@theme/Heading';
+import type { ApiOptions, PackageReflectionGroup } from '../types';
+import { removeScopes } from '../utils/links';
+import { VersionBanner } from './VersionBanner';
+
+export interface ApiIndexProps extends Pick<DocItemProps, 'route'> {
+	history: {
+		location: { pathname: string };
+		replace: (path: string) => void;
+	};
+	options: ApiOptions;
+	packages: PackageReflectionGroup[];
+}
+
+function addVersionToUrl(
+	url: string,
+	latestVersion: PropVersionMetadata,
+	preferredVersion: GlobalVersion | null | undefined,
+) {
+	if (
+		!url.match(/api\/([\d.]+)/) &&
+		!url.includes('api/next') &&
+		preferredVersion &&
+		preferredVersion.name !== latestVersion.version
+	) {
+		const version = preferredVersion.name === 'current' ? 'next' : preferredVersion.name;
+
+		if (url.endsWith('/api')) {
+			return `${url}/${version}`;
+		}
+
+		return url.replace('/api/', `/api/${version}/`);
+	}
+
+	return url;
+}
+
+export default function ApiIndex({ options, packages, history }: ApiIndexProps) {
+	const latestVersion = useDocsVersion();
+	const { preferredVersion } = useDocsPreferredVersion(latestVersion.pluginId);
+
+	useEffect(() => {
+		// Redirect to package when only 1
+		if (packages.length === 1) {
+			history.replace(
+				addVersionToUrl(
+					packages[0].entryPoints[0].reflection.permalink,
+					latestVersion,
+					preferredVersion,
+				),
+			);
+
+			// Redirect to preferred version
+		} else if (preferredVersion) {
+			history.replace(addVersionToUrl(history.location.pathname, latestVersion, preferredVersion));
+		}
+	}, [packages, history, latestVersion, preferredVersion]);
+
+	return (
+		<div className="row">
+			<div className="col apiItemCol">
+				{options.banner && (
+					<div className="alert alert--info margin-bottom--md" role="alert">
+						{/* eslint-disable-next-line react/no-danger, react-perf/jsx-no-new-object-as-prop */}
+						<div dangerouslySetInnerHTML={{ __html: options.banner }} />
+					</div>
+				)}
+
+				<VersionBanner />
+
+				<div className="apiItemContainer">
+					<article>
+						<div className="markdown">
+							<header>
+								<Heading as="h1">API</Heading>
+							</header>
+
+							<section className="tsd-panel">
+								<h3 className="tsd-panel-header">Packages</h3>
+								<div className="tsd-panel-content">
+									<ul className="tsd-index-list">
+										{packages.map((pkg) => (
+											<li key={pkg.packageName} className="tsd-truncate">
+												<Link
+													className="tsd-kind-icon"
+													to={pkg.entryPoints[0].reflection.permalink}
+												>
+													<span className="tsd-signature-symbol">v{pkg.packageVersion}</span>{' '}
+													<span>{removeScopes(pkg.packageName, options.scopes)}</span>
+												</Link>
+											</li>
+										))}
+									</ul>
+								</div>
+							</section>
+						</div>
+					</article>
+				</div>
+			</div>
+		</div>
+	);
+}

package/src/components/ApiItem.tsx

@@ -0,0 +1,110 @@
+import React, { useMemo } from 'react';
+import type { JSONOutput } from 'typedoc';
+import { PageMetadata } from '@docusaurus/theme-common';
+import type { Props as DocItemProps } from '@theme/DocItem';
+import { useReflection } from '../hooks/useReflection';
+import { useReflectionMap } from '../hooks/useReflectionMap';
+import type { DeclarationReflectionMap, TOCItem } from '../types';
+import { getKindIconHtml } from '../utils/icons';
+import ApiItemLayout from './ApiItemLayout';
+import { displayPartsToMarkdown } from './Comment';
+import { Flags } from './Flags';
+import { Reflection } from './Reflection';
+import { TypeParametersGeneric } from './TypeParametersGeneric';
+
+function extractTOC(
+	item: JSONOutput.DeclarationReflection,
+	map: DeclarationReflectionMap,
+): TOCItem[] {
+	const toc: TOCItem[] = [];
+	const mapped = new Set<string>();
+
+	item.groups?.forEach((group) => {
+		group.children?.forEach((childId) => {
+			const child = map[childId]!;
+
+			if (mapped.has(child.name)) {
+				return;
+			}
+
+			const iconHtml = getKindIconHtml(child.kind, child.name);
+
+			if (!child.permalink || child.permalink.includes('#')) {
+				toc.push({
+					// @ts-expect-error Not typed upstream
+					children: [],
+					id: child.name,
+					value: iconHtml ? `${iconHtml} ${child.name}` : child.name,
+					level: 1,
+				});
+
+				mapped.add(child.name);
+			}
+		});
+	});
+
+	return toc;
+}
+
+export interface ApiItemProps extends Pick<DocItemProps, 'route'> {
+	readme?: React.ComponentType;
+}
+
+export default function ApiItem({ readme: Readme, route }: ApiItemProps) {
+	const item = useReflection((route as unknown as { id: number }).id)!;
+	const reflections = useReflectionMap();
+	const toc = useMemo(() => extractTOC(item, reflections), [item, reflections]);
+
+	// Pagination
+	const prevItem = useReflection(item.previousId);
+	const nextItem = useReflection(item.nextId);
+	const pagingMetadata = useMemo(
+		() => ({
+			next: nextItem
+				? {
+						permalink: nextItem.permalink,
+						title: nextItem.name,
+				  }
+				: undefined,
+			previous: prevItem
+				? {
+						permalink: prevItem.permalink,
+						title: prevItem.name,
+				  }
+				: undefined,
+		}),
+		[nextItem, prevItem],
+	);
+
+	return (
+		<ApiItemLayout
+			heading={
+				<>
+					<span className="tsd-header-flags">
+						<Flags flags={item.flags} />
+					</span>
+					{item.name} <TypeParametersGeneric params={item.typeParameters} />
+				</>
+			}
+			module={(item as unknown as { module: string }).module}
+			name={item.name}
+			pageMetadata={
+				<PageMetadata
+					description={item.comment?.summary ? displayPartsToMarkdown(item.comment.summary) : ''}
+					title={`${item.name} | API`}
+				/>
+			}
+			pagingMetadata={pagingMetadata}
+			route={route}
+			toc={toc}
+		>
+			{Readme && (
+				<section className="tsd-readme">
+					<Readme />
+				</section>
+			)}
+
+			<Reflection reflection={item} />
+		</ApiItemLayout>
+	);
+}