@depup/typedoc 0.28.17-depup.0

package/dist/lib/utils-common/i18n.js

@@ -0,0 +1,39 @@
+let translations = {};
+/**
+ * Set the available translations to be used by TypeDoc.
+ */
+export function setTranslations(t) {
+    translations = { ...t };
+}
+/**
+ * Add the specified translations to the current translations object
+ * Any keys already specified will overwrite current keys
+ */
+export function addTranslations(t) {
+    Object.assign(translations, t);
+}
+export const i18n = new Proxy({}, {
+    get(_, key) {
+        return (...args) => {
+            const template = String(translations[key] || key);
+            return template.replace(/\{(\d+)\}/g, (_, index) => {
+                return args[+index] ?? "(no placeholder)";
+            });
+        };
+    },
+    has(_, key) {
+        return Object.prototype.hasOwnProperty.call(translations, key);
+    },
+});
+export function translateTagName(tag) {
+    const tagName = tag.substring(1);
+    if (Object.prototype.hasOwnProperty.call(translations, `tag_${tagName}`)) {
+        return translations[`tag_${tagName}`];
+    }
+    // In English, the tag names are the translated names, once turned
+    // into title case.
+    return (tagName.substring(0, 1).toUpperCase() +
+        tagName
+            .substring(1)
+            .replace(/[a-z][A-Z]/g, (x) => `${x[0]} ${x[1]}`));
+}

package/dist/lib/utils-common/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./array.js";
+export * from "./declarationReference.js";
+export * from "./enum.js";
+export * from "./events.js";
+export * from "./general.js";
+export * from "./hooks.js";
+export * from "./i18n.js";
+export * as JSX from "./jsx.js";
+export * from "./logger.js";
+export * from "./map.js";
+export * from "./minimalSourceFile.js";
+export * from "./path.js";
+export * from "./set.js";
+export * from "./string.js";
+export * as Validation from "./validation.js";
+export type { TagString } from "./validation.js";

package/dist/lib/utils-common/index.js

@@ -0,0 +1,17 @@
+// utils-common includes utilities which don't depend on anything, and thus can be used
+// within the browser-utils export which is suitable for bundling.
+export * from "./array.js";
+export * from "./declarationReference.js";
+export * from "./enum.js";
+export * from "./events.js";
+export * from "./general.js";
+export * from "./hooks.js";
+export * from "./i18n.js";
+export * as JSX from "./jsx.js";
+export * from "./logger.js";
+export * from "./map.js";
+export * from "./minimalSourceFile.js";
+export * from "./path.js";
+export * from "./set.js";
+export * from "./string.js";
+export * as Validation from "./validation.js";

package/dist/lib/utils-common/jsx.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Custom JSX module designed specifically for TypeDoc's needs.
+ * When overriding a default TypeDoc theme output, your implementation must create valid {@link Element}
+ * instances, which can be most easily done by using TypeDoc's JSX implementation. To use it, set up
+ * your tsconfig with the following compiler options:
+ * ```json
+ * {
+ *     "jsx": "react",
+ *     "jsxFactory": "JSX.createElement",
+ *     "jsxFragmentFactory": "JSX.Fragment"
+ * }
+ * ```
+ * @summary Custom JSX module designed specifically for TypeDoc's needs.
+ * @module
+ */
+import type { IntrinsicElements, JsxChildren, JsxComponent, JsxElement, JsxHtmlGlobalProps } from "./jsx.elements.js";
+export type { JsxChildren as Children, JsxComponent, JsxElement as Element } from "./jsx.elements.js";
+export { JsxFragment as Fragment } from "./jsx.elements.js";
+/**
+ * Used to inject HTML directly into the document.
+ */
+export declare function Raw(_props: {
+    html: string;
+}): null;
+/**
+ * TypeScript's rules for looking up the JSX.IntrinsicElements and JSX.Element
+ * interfaces are incredibly strange. It will find them if they are included as
+ * a namespace under the createElement function, or globally, or, apparently, if
+ * a JSX namespace is declared at the same scope as the factory function.
+ * Hide this in the docs, hopefully someday TypeScript improves this and allows
+ * looking adjacent to the factory function and we can get rid of this phantom namespace.
+ * @hidden
+ */
+export declare namespace JSX {
+    export { IntrinsicElements, JsxElement as Element, JsxHtmlGlobalProps as IntrinsicAttributes };
+}
+/**
+ * JSX factory function to create an "element" that can later be rendered with {@link renderElement}
+ * @param tag
+ * @param props
+ * @param children
+ */
+export declare function createElement(tag: string | JsxComponent<any>, props: object | null, ...children: JsxChildren[]): JsxElement;
+export declare function setRenderSettings(options: {
+    pretty: boolean;
+}): void;
+export declare function renderElement(element: JsxElement | null | undefined): string;
+/**
+ * Render an element to text, stripping out any HTML tags.
+ * This is roughly equivalent to getting `innerText` on a rendered element.
+ * @internal
+ */
+export declare function renderElementToText(element: JsxElement | null | undefined): string;