typedoc 0.28.19 → 0.28.20

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

@@ -1,90 +0,0 @@
-import { insertOrderSorted } from "./array.js";
-const momentos = new WeakMap();
-/**
- * Event emitter which allows listeners to return a value.
- *
- * This is beneficial for the themes since it allows plugins to modify the HTML output
- * without doing unsafe text replacement.
- *
- * Very simple event emitter class which collects the return values of its listeners.
- *
- * @example
- * ```ts
- * const x = new EventHooks<{ a: [string] }, string>()
- * x.on('a', a => a.repeat(123)) // ok, returns a string
- * x.on('b', console.log) // error, 'b' is not assignable to 'a'
- * x.on('a' a => 1) // error, returns a number but expected a string
- * ```
- */
-export class EventHooks {
-    // Function is *usually* not a good type to use, but here it lets us specify stricter
-    // contracts in the methods while not casting everywhere this is used.
-    _listeners = new Map();
-    /**
-     * Starts listening to an event.
-     * @param event the event to listen to.
-     * @param listener function to be called when an this event is emitted.
-     * @param order optional order to insert this hook with.
-     */
-    on(event, listener, order = 0) {
-        const list = (this._listeners.get(event) || []).slice();
-        insertOrderSorted(list, { listener, order });
-        this._listeners.set(event, list);
-    }
-    /**
-     * Listens to a single occurrence of an event.
-     * @param event the event to listen to.
-     * @param listener function to be called when an this event is emitted.
-     * @param order optional order to insert this hook with.
-     */
-    once(event, listener, order = 0) {
-        const list = (this._listeners.get(event) || []).slice();
-        insertOrderSorted(list, { listener, once: true, order });
-        this._listeners.set(event, list);
-    }
-    /**
-     * Stops listening to an event.
-     * @param event the event to stop listening to.
-     * @param listener the function to remove from the listener array.
-     */
-    off(event, listener) {
-        const listeners = this._listeners.get(event);
-        if (listeners) {
-            const index = listeners.findIndex((lo) => lo.listener === listener);
-            if (index > -1) {
-                listeners.splice(index, 1);
-            }
-        }
-    }
-    /**
-     * Emits an event to all currently subscribed listeners.
-     * @param event the event to emit.
-     * @param args any arguments required for the event.
-     */
-    emit(event, ...args) {
-        const listeners = this._listeners.get(event)?.slice() || [];
-        this._listeners.set(event, listeners.filter(({ once }) => !once));
-        return listeners.map(({ listener }) => listener(...args));
-    }
-    saveMomento() {
-        const momento = {};
-        const save = new Map();
-        for (const [key, val] of this._listeners) {
-            save.set(key, [...val]);
-        }
-        momentos.set(momento, save);
-        return momento;
-    }
-    restoreMomento(momento) {
-        const saved = momentos.get(momento);
-        if (saved) {
-            this._listeners.clear();
-            for (const [key, val] of saved) {
-                this._listeners.set(key, [...val]);
-            }
-        }
-        else {
-            throw new Error("Momento not found.");
-        }
-    }
-}

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

@@ -1,39 +0,0 @@
-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.js

@@ -1,17 +0,0 @@
-// 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.elements.js

@@ -1,3 +0,0 @@
-export function JsxFragment() {
-    throw new Error("Should never be called");
-}

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

@@ -1,187 +0,0 @@
-/**
- * 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 { JsxFragment } from "./jsx.elements.js";
-import { escapeHtml } from "./string.js";
-export { JsxFragment as Fragment } from "./jsx.elements.js";
-/**
- * Used to inject HTML directly into the document.
- */
-export function Raw(_props) {
-    // This is handled specially by the renderElement function. Instead of being
-    // called, the tag is compared to this function and the `html` prop will be
-    // returned directly.
-    return null;
-}
-const voidElements = new Set([
-    "area",
-    "base",
-    "br",
-    "col",
-    "embed",
-    "hr",
-    "img",
-    "input",
-    "link",
-    "meta",
-    "param",
-    "source",
-    "track",
-    "wbr",
-]);
-const blockElements = new Set([
-    "h1",
-    "h2",
-    "h3",
-    "h4",
-    "h5",
-    "h6",
-    "div",
-    "section",
-    "nav",
-    "details",
-    "p",
-    "ul",
-    "ol",
-    "li",
-]);
-/**
- * JSX factory function to create an "element" that can later be rendered with {@link renderElement}
- * @param tag
- * @param props
- * @param children
- */
-export function createElement(tag, props, ...children) {
-    return { tag, props, children };
-}
-let renderPretty = true;
-export function setRenderSettings(options) {
-    renderPretty = options.pretty;
-}
-export function renderElement(element) {
-    if (!element) {
-        return "";
-    }
-    const { tag, props, children } = element;
-    let html = "";
-    if (typeof tag === "function") {
-        if (tag === Raw) {
-            return String(props.html);
-        }
-        if (tag === JsxFragment) {
-            renderChildren(children);
-            return html;
-        }
-        return renderElement(tag(Object.assign({ children }, props)));
-    }
-    if (blockElements.has(tag) && renderPretty && html) {
-        html += "\n";
-    }
-    html += "<";
-    html += tag;
-    for (const [key, val] of Object.entries(props ?? {})) {
-        if (val == null)
-            continue;
-        if (typeof val == "boolean") {
-            if (val) {
-                html += " ";
-                html += key;
-            }
-        }
-        else {
-            html += " ";
-            html += key;
-            html += '="';
-            html += (typeof val === "string" ? val : JSON.stringify(val)).replaceAll('"', "&quot;");
-            html += '"';
-        }
-    }
-    if (children.length) {
-        html += ">";
-        renderChildren(children);
-        html += "</";
-        html += tag;
-        html += ">";
-    }
-    else {
-        if (voidElements.has(tag)) {
-            html += "/>";
-        }
-        else {
-            html += "></";
-            html += tag;
-            html += ">";
-        }
-    }
-    return html;
-    function renderChildren(children) {
-        for (const child of children) {
-            if (typeof child === "boolean")
-                continue;
-            if (Array.isArray(child)) {
-                renderChildren(child);
-            }
-            else if (typeof child === "string" || typeof child === "number" || typeof child === "bigint") {
-                html += escapeHtml(child.toString());
-            }
-            else {
-                html += renderElement(child);
-            }
-        }
-    }
-}
-/**
- * Render an element to text, stripping out any HTML tags.
- * This is roughly equivalent to getting `innerText` on a rendered element.
- * @internal
- */
-export function renderElementToText(element) {
-    if (!element) {
-        return "";
-    }
-    const { tag, props, children } = element;
-    let html = "";
-    if (typeof tag === "function") {
-        if (tag === Raw) {
-            return String(props.html);
-        }
-        if (tag === JsxFragment) {
-            renderChildren(children);
-            return html;
-        }
-        return renderElementToText(tag(Object.assign({ children }, props)));
-    }
-    else if (tag === "br") {
-        return "\n";
-    }
-    renderChildren(children);
-    return html;
-    function renderChildren(children) {
-        for (const child of children) {
-            if (typeof child === "boolean")
-                continue;
-            if (Array.isArray(child)) {
-                renderChildren(child);
-            }
-            else if (typeof child === "string" || typeof child === "number" || typeof child === "bigint") {
-                // Turn non-breaking spaces into regular spaces
-                html += child.toString().replaceAll("\u00A0", " ");
-            }
-            else {
-                html += renderElementToText(child);
-            }
-        }
-    }
-}

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

@@ -1,129 +0,0 @@
-/**
- * List of known log levels. Used to specify the urgency of a log message.
- */
-export var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["Verbose"] = 0] = "Verbose";
-    LogLevel[LogLevel["Info"] = 1] = "Info";
-    LogLevel[LogLevel["Warn"] = 2] = "Warn";
-    LogLevel[LogLevel["Error"] = 3] = "Error";
-    LogLevel[LogLevel["None"] = 4] = "None";
-})(LogLevel || (LogLevel = {}));
-const messagePrefixes = {
-    [LogLevel.Error]: "[error]",
-    [LogLevel.Warn]: "[warning]",
-    [LogLevel.Info]: "[info]",
-    [LogLevel.Verbose]: "[debug]",
-};
-/**
- * A logger that will not produce any output.
- *
- * This logger also serves as the base class of other loggers as it implements
- * all the required utility functions.
- */
-export class Logger {
-    /**
-     * How many error messages have been logged?
-     */
-    errorCount = 0;
-    /**
-     * How many warning messages have been logged?
-     */
-    warningCount = 0;
-    /**
-     * How many validation warning messages have been logged?
-     */
-    validationWarningCount = 0;
-    /**
-     * The minimum logging level to print.
-     */
-    level = LogLevel.Info;
-    /**
-     * Has an error been raised through the log method?
-     */
-    hasErrors() {
-        return this.errorCount > 0;
-    }
-    /**
-     * Has a warning been raised through the log method?
-     */
-    hasWarnings() {
-        return this.warningCount > 0;
-    }
-    /**
-     * Reset the error counter.
-     */
-    resetErrors() {
-        this.errorCount = 0;
-    }
-    /**
-     * Reset the warning counter.
-     */
-    resetWarnings() {
-        this.warningCount = 0;
-        this.validationWarningCount = 0;
-    }
-    /**
-     * Log the given verbose message.
-     *
-     * @param text  The message that should be logged.
-     */
-    verbose(text) {
-        this.log(this.addContext(text, LogLevel.Verbose), LogLevel.Verbose);
-    }
-    /** Log the given info message. */
-    info(text) {
-        this.log(this.addContext(text, LogLevel.Info), LogLevel.Info);
-    }
-    warn(text, ...args) {
-        const text2 = this.addContext(text, LogLevel.Warn, ...args);
-        this.log(text2, LogLevel.Warn);
-    }
-    validationWarning(...args) {
-        this.validationWarningCount += 1;
-        this.warn(...args);
-    }
-    error(text, ...args) {
-        const text2 = this.addContext(text, LogLevel.Error, ...args);
-        this.log(text2, LogLevel.Error);
-    }
-    /**
-     * Print a log message.
-     *
-     * @param _message The message itself.
-     * @param level The urgency of the log message.
-     */
-    log(_message, level) {
-        if (level === LogLevel.Error) {
-            this.errorCount += 1;
-        }
-        if (level === LogLevel.Warn) {
-            this.warningCount += 1;
-        }
-    }
-    addContext(message, _level, ..._args) {
-        return message;
-    }
-}
-/**
- * Logger implementation which logs to the console
- */
-export class ConsoleLogger extends Logger {
-    log(message, level) {
-        super.log(message, level);
-        if (level < this.level) {
-            return;
-        }
-        const method = {
-            [LogLevel.Error]: "error",
-            [LogLevel.Warn]: "warn",
-            [LogLevel.Info]: "info",
-            [LogLevel.Verbose]: "log",
-        }[level];
-        // eslint-disable-next-line no-console
-        console[method](message);
-    }
-    addContext(message, level, ..._args) {
-        return `${messagePrefixes[level]} ${message}`;
-    }
-}

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

@@ -1,63 +0,0 @@
-export class DefaultMap extends Map {
-    creator;
-    constructor(creator) {
-        super();
-        this.creator = creator;
-    }
-    get(key) {
-        const saved = super.get(key);
-        if (saved != null) {
-            return saved;
-        }
-        const created = this.creator(key);
-        this.set(key, created);
-        return created;
-    }
-    getNoInsert(key) {
-        return super.get(key);
-    }
-}
-export class StableKeyMap {
-    [Symbol.toStringTag] = "StableKeyMap";
-    impl = new Map();
-    get size() {
-        return this.impl.size;
-    }
-    set(key, value) {
-        this.impl.set(key.getStableKey(), [key, value]);
-        return this;
-    }
-    get(key) {
-        return this.impl.get(key.getStableKey())?.[1];
-    }
-    has(key) {
-        return this.get(key) != null;
-    }
-    clear() {
-        this.impl.clear();
-    }
-    delete(key) {
-        return this.impl.delete(key.getStableKey());
-    }
-    forEach(callbackfn, thisArg) {
-        for (const [k, v] of this.entries()) {
-            callbackfn.apply(thisArg, [v, k, this]);
-        }
-    }
-    entries() {
-        return this.impl.values();
-    }
-    *keys() {
-        for (const [k] of this.entries()) {
-            yield k;
-        }
-    }
-    *values() {
-        for (const [, v] of this.entries()) {
-            yield v;
-        }
-    }
-    [Symbol.iterator]() {
-        return this.entries();
-    }
-}

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

@@ -1,43 +0,0 @@
-import { binaryFindPartition } from "./array.js";
-// I don't like this, but it's necessary so that the lineStarts property isn't
-// visible in the `MinimalSourceFile` type. Even when private it causes compilation
-// errors downstream.
-const lineStarts = new WeakMap();
-export class MinimalSourceFile {
-    text;
-    // This type is just string to ensure assignability from SourceFile
-    fileName;
-    constructor(text, fileName) {
-        // This is unfortunate, but the yaml library we use relies on the source
-        // text using LF line endings https://github.com/eemeli/yaml/issues/127.
-        // If we don't do this, in a simple document which includes a single key
-        // like:
-        // ---<CR><LF>
-        // title: Windows line endings<CR><LF>
-        // ---<CR><LF>
-        // we'll end up with a parsed title of "Windows line endings\r"
-        this.text = text.replaceAll("\r\n", "\n");
-        lineStarts.set(this, [0]);
-        this.fileName = fileName;
-    }
-    getLineAndCharacterOfPosition(pos) {
-        if (pos < 0 || pos >= this.text.length) {
-            throw new Error("pos must be within the range of the file.");
-        }
-        const starts = lineStarts.get(this);
-        while (pos >= starts[starts.length - 1]) {
-            const nextStart = this.text.indexOf("\n", starts[starts.length - 1]);
-            if (nextStart === -1) {
-                starts.push(Infinity);
-            }
-            else {
-                starts.push(nextStart + 1);
-            }
-        }
-        const line = binaryFindPartition(starts, (x) => x > pos) - 1;
-        return {
-            character: pos - starts[line],
-            line,
-        };
-    }
-}