typedoc 0.26.0-beta.5 → 0.26.0

package/dist/lib/utils/events.js

@@ -1,395 +1,54 @@
 "use strict";
-// Backbone.js 1.2.3
-// (c) 2010-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
-// Backbone may be freely distributed under the MIT license.
-// For all details and documentation:
-// https://backbonejs.org
-//
-// The Events object is a typesafe conversion of Backbones Events object:
-// https://github.com/jashkenas/backbone/blob/05fde9e201f7e2137796663081105cd6dad12a98/backbone.js#L119-L374
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventDispatcher = exports.Event = void 0;
-// Priority: Higher number makes the listener be called earlier.
-const uniqueId = (function () {
-    const prefixes = Object.create(null);
-    return function (prefix) {
-        const unique = prefixes[prefix] || 1;
-        prefixes[prefix] = unique + 1;
-        return `${prefix}${unique}`;
-    };
-})();
-function once(cb) {
-    let hasRun = false;
-    let result;
-    return function (...args) {
-        if (hasRun === false) {
-            hasRun = true;
-            result = cb.apply(this, args);
-        }
-        return result;
-    };
-}
-// Regular expression used to split event strings.
-const eventSplitter = /\s+/;
-/**
- * Iterates over the standard `event, callback` (as well as the fancy multiple
- * space-separated events `"change blur", callback` and jQuery-style event
- * maps `{event: callback}`).
- */
-function eventsApi(iteratee, events, name, callback, options) {
-    let i = 0, names;
-    const anyOptions = options;
-    if (name && typeof name === "object") {
-        // Handle event maps.
-        if (callback !== void 0 &&
-            "context" in options &&
-            anyOptions["context"] === void 0) {
-            anyOptions["context"] = callback;
-        }
-        for (names = Object.keys(name); i < names.length; i++) {
-            events = eventsApi(iteratee, events, names[i], name[names[i]], options);
-        }
-    }
-    else if (name && typeof name === "string" && eventSplitter.test(name)) {
-        // Handle space separated event names by delegating them individually.
-        for (names = name.split(eventSplitter); i < names.length; i++) {
-            events = iteratee(events, names[i], callback, options);
-        }
-    }
-    else {
-        // Finally, standard events.
-        events = iteratee(events, name, callback, options);
-    }
-    return events;
-}
-/**
- * The reducing API that adds a callback to the `events` object.
- */
-function onApi(events, name, callback, options) {
-    if (callback) {
-        const handlers = (events[name] ||= []);
-        const context = options.context, ctx = options.ctx, listening = options.listening, priority = options.priority;
-        if (listening) {
-            listening.count++;
-        }
-        handlers.push({
-            callback: callback,
-            context: context,
-            ctx: context || ctx,
-            listening: listening,
-            priority: priority,
-        });
-        handlers.sort((a, b) => b.priority - a.priority);
-    }
-    return events;
-}
-/**
- * The reducing API that removes a callback from the `events` object.
- */
-function offApi(events, name, callback, options) {
-    if (!events) {
-        return;
-    }
-    let i = 0, listening;
-    const context = options.context, listeners = options.listeners;
-    // Delete all events listeners and "drop" events.
-    if (!name && !callback && !context) {
-        const ids = Object.keys(listeners || {});
-        for (; i < ids.length; i++) {
-            listening = listeners[ids[i]];
-            delete listeners[listening.id];
-            delete listening.listeningTo[listening.objId];
-        }
-        return;
-    }
-    const names = name ? [name] : Object.keys(events || {});
-    for (; i < names.length; i++) {
-        name = names[i];
-        const handlers = events[name];
-        // Bail out if there are no events stored.
-        if (!handlers) {
-            break;
-        }
-        // Replace events if there are any remaining.  Otherwise, clean up.
-        const remaining = [];
-        for (let j = 0; j < handlers.length; j++) {
-            const handler = handlers[j];
-            if ((callback &&
-                callback !== handler.callback &&
-                callback !== handler.callback._callback) ||
-                (context && context !== handler.context)) {
-                remaining.push(handler);
-            }
-            else {
-                listening = handler.listening;
-                if (listening && --listening.count === 0) {
-                    delete listeners[listening.id];
-                    delete listening.listeningTo[listening.objId];
-                }
-            }
-        }
-        // Update tail event if the list has any events.  Otherwise, clean up.
-        if (remaining.length) {
-            events[name] = remaining;
-        }
-        else {
-            delete events[name];
-        }
-    }
-    if (Object.keys(events || {}).length !== 0) {
-        return events;
-    }
-}
-/**
- * Reduces the event callbacks into a map of `{event: onceWrapper`.}
- * `offer` unbinds the `onceWrapper` after it has been called.
- */
-function onceMap(map, name, callback, offer) {
-    if (callback) {
-        const listener = (map[name] = once(function (...args) {
-            offer(name, listener);
-            callback.apply(this, args);
-        }));
-        listener._callback = callback;
-    }
-    return map;
-}
-/**
- * Handles triggering the appropriate event callbacks.
- */
-function triggerApi(objEvents, name, _callback, args, triggerer = triggerEvents) {
-    if (objEvents) {
-        const events = objEvents[name];
-        let allEvents = objEvents["all"];
-        if (events && allEvents) {
-            allEvents = allEvents.slice();
-        }
-        if (events) {
-            triggerer(events, args);
-        }
-        if (allEvents) {
-            triggerer(allEvents, [name].concat(args));
-        }
-    }
-    return objEvents;
-}
-/**
- * A difficult-to-believe, but optimized internal dispatch function for
- * triggering events. Tries to keep the usual cases speedy (most internal
- * Backbone events have 3 arguments).
- */
-function triggerEvents(events, args) {
-    let ev, i = -1;
-    const l = events.length, a1 = args[0], a2 = args[1], a3 = args[2];
-    switch (args.length) {
-        case 0:
-            while (++i < l) {
-                (ev = events[i]).callback.call(ev.ctx);
-            }
-            return;
-        case 1:
-            while (++i < l) {
-                (ev = events[i]).callback.call(ev.ctx, a1);
-            }
-            return;
-        case 2:
-            while (++i < l) {
-                (ev = events[i]).callback.call(ev.ctx, a1, a2);
-            }
-            return;
-        case 3:
-            while (++i < l) {
-                (ev = events[i]).callback.call(ev.ctx, a1, a2, a3);
-            }
-            return;
-        default:
-            while (++i < l) {
-                (ev = events[i]).callback.apply(ev.ctx, args);
-            }
-            return;
-    }
-}
-/**
- * An event object.
- */
-class Event {
-    /**
-     * Create a new Event instance.
-     */
-    constructor(name) {
-        /**
-         * Has {@link Event.stopPropagation} been called?
-         */
-        this._isPropagationStopped = false;
-        /**
-         * Has {@link Event.preventDefault} been called?
-         */
-        this._isDefaultPrevented = false;
-        this._name = name;
-    }
-    /**
-     * Stop the propagation of this event. Remaining event handlers will not be executed.
-     */
-    stopPropagation() {
-        this._isPropagationStopped = true;
-    }
-    /**
-     * Prevent the default action associated with this event from being executed.
-     */
-    preventDefault() {
-        this._isDefaultPrevented = true;
-    }
-    /**
-     * Return the event name.
-     */
-    get name() {
-        return this._name;
-    }
-    /**
-     * Has {@link Event.stopPropagation} been called?
-     */
-    get isPropagationStopped() {
-        return this._isPropagationStopped;
-    }
-    /**
-     * Has {@link Event.preventDefault} been called?
-     */
-    isDefaultPrevented() {
-        return this._isDefaultPrevented;
-    }
-}
-exports.Event = Event;
+exports.EventDispatcher = void 0;
+const array_1 = require("./array");
 /**
- * A class that provides a custom event channel.
+ * Intentionally very simple event emitter.
  *
- * You may bind a callback to an event with `on` or remove with `off`;
- * `trigger`-ing an event fires all callbacks in succession.
+ * @privateRemarks
+ * This is essentially a stripped down copy of EventHooks in hooks.ts.
  */
 class EventDispatcher {
-    /**
-     * A unique id that identifies this instance.
-     */
-    get _listenId() {
-        return this._savedListenId || (this._savedListenId = uniqueId("l"));
-    }
-    on(nameOrMap, callback, context, priority) {
-        this.internalOn(nameOrMap, callback, context, priority);
-        return this;
-    }
-    /**
-     * Guard the `listening` argument from the public API.
-     */
-    internalOn(name, callback, context, priority = 0, listening) {
-        this._events = eventsApi(onApi, this._events || {}, name, callback, {
-            context: context,
-            ctx: this,
-            listening: listening,
-            priority: priority,
-        });
-        if (listening) {
-            const listeners = this._listeners || (this._listeners = {});
-            listeners[listening.id] = listening;
-        }
-    }
-    once(name, callback, context, priority) {
-        // Map the event into a `{event: once}` object.
-        const events = eventsApi(onceMap, {}, name, callback, this.off.bind(this));
-        return this.on(events, void 0, context, priority);
-    }
-    off(name, callback, context) {
-        if (!this._events) {
-            return this;
-        }
-        this._events = eventsApi(offApi, this._events, name, callback, {
-            context: context,
-            listeners: this._listeners,
-        });
-        return this;
+    constructor() {
+        // 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.
+        this._listeners = new Map();
     }
     /**
-     * Inversion-of-control versions of `on`. Tell *this* object to listen to
-     * an event in another object... keeping track of what it's listening to
-     * for easier unbinding later.
+     * 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 priority optional priority to insert this hook with.
      */
-    listenTo(obj, name, callback, priority) {
-        if (!obj) {
-            return this;
-        }
-        const id = obj._listenId;
-        const listeningTo = this._listeningTo || (this._listeningTo = {});
-        let listening = listeningTo[id];
-        // This object is not listening to any other events on `obj` yet.
-        // Setup the necessary references to track the listening callbacks.
-        if (!listening) {
-            const thisId = this._listenId;
-            listening = listeningTo[id] = {
-                obj: obj,
-                objId: id,
-                id: thisId,
-                listeningTo: listeningTo,
-                count: 0,
-            };
-        }
-        // Bind callbacks on obj, and keep track of them on listening.
-        obj.internalOn(name, callback, this, priority, listening);
-        return this;
-    }
-    listenToOnce(obj, name, callback, priority) {
-        // Map the event into a `{event: once}` object.
-        const events = eventsApi(onceMap, {}, name, callback, this.stopListening.bind(this, obj));
-        return this.listenTo(obj, events, void 0, priority);
+    on(event, listener, priority = 0) {
+        const list = (this._listeners.get(event) || []).slice();
+        (0, array_1.insertPrioritySorted)(list, { listener, priority });
+        this._listeners.set(event, list);
     }
     /**
-     * Tell this object to stop listening to either specific events ... or
-     * to every object it's currently listening to.
+     * Stops listening to an event.
+     * @param event the event to stop listening to.
+     * @param listener the function to remove from the listener array.
      */
-    stopListening(obj, name, callback) {
-        const listeningTo = this._listeningTo;
-        if (!listeningTo) {
-            return this;
-        }
-        const ids = obj ? [obj._listenId] : Object.keys(listeningTo);
-        for (let i = 0; i < ids.length; i++) {
-            const listening = listeningTo[ids[i]];
-            // If listening doesn't exist, this object is not currently
-            // listening to obj. Break out early.
-            if (!listening) {
-                break;
+    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);
             }
-            listening.obj.off(name, callback, this);
-        }
-        if (Object.keys(listeningTo).length === 0) {
-            this._listeningTo = void 0;
         }
-        return this;
     }
     /**
-     * Trigger one or many events, firing all bound callbacks. Callbacks are
-     * passed the same arguments as `trigger` is, apart from the event name
-     * (unless you're listening on `"all"`, which will cause your callback to
-     * receive the true name of the event as the first argument).
+     * Emits an event to all currently subscribed listeners.
+     * @param event the event to emit.
+     * @param args any arguments required for the event.
      */
-    trigger(name, ...args) {
-        if (!this._events) {
-            return this;
-        }
-        if (name instanceof Event) {
-            triggerApi(this._events, name.name, void 0, [name], (events, args) => {
-                let ev, i = -1;
-                const l = events.length;
-                while (++i < l) {
-                    if (name.isPropagationStopped) {
-                        return;
-                    }
-                    ev = events[i];
-                    ev.callback.apply(ev.ctx, args);
-                }
-            });
-        }
-        else {
-            eventsApi(triggerApi, this._events, name, void 0, args);
+    trigger(event, ...args) {
+        const listeners = this._listeners.get(event)?.slice() || [];
+        for (const { listener } of listeners) {
+            listener(...args);
         }
-        return this;
     }
 }
 exports.EventDispatcher = EventDispatcher;

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

@@ -1,7 +1,7 @@
 export { filterMap, insertPrioritySorted, partition, removeIf, removeIfPresent, unique, } from "./array";
 export { AbstractComponent, ChildableComponent, Component } from "./component";
 export * from "./enum";
-export { Event, EventDispatcher } from "./events";
+export { EventDispatcher } from "./events";
 export { isFile, copy, copySync, getCommonDirectory, readFile, writeFile, writeFileSync, discoverInParentDir, discoverPackageJson, } from "./fs";
 export { normalizePath } from "./paths";
 export type { IfInternal, NeverIfInternal, Chars } from "./general";

package/dist/lib/utils/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Event = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
+exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
 var array_1 = require("./array");
 Object.defineProperty(exports, "filterMap", { enumerable: true, get: function () { return array_1.filterMap; } });
 Object.defineProperty(exports, "insertPrioritySorted", { enumerable: true, get: function () { return array_1.insertPrioritySorted; } });
@@ -40,7 +40,6 @@ Object.defineProperty(exports, "ChildableComponent", { enumerable: true, get: fu
 Object.defineProperty(exports, "Component", { enumerable: true, get: function () { return component_1.Component; } });
 __exportStar(require("./enum"), exports);
 var events_1 = require("./events");
-Object.defineProperty(exports, "Event", { enumerable: true, get: function () { return events_1.Event; } });
 Object.defineProperty(exports, "EventDispatcher", { enumerable: true, get: function () { return events_1.EventDispatcher; } });
 var fs_1 = require("./fs");
 Object.defineProperty(exports, "isFile", { enumerable: true, get: function () { return fs_1.isFile; } });

package/dist/lib/utils/options/declaration.d.ts

@@ -126,7 +126,6 @@ export interface TypeDocOptionMap {
     hostedBaseUrl: string;
     useHostedBaseUrlForAbsoluteLinks: boolean;
     cacheBust: boolean;
-    gaID: string;
     hideGenerator: boolean;
     customFooterHtml: string;
     customFooterHtmlDisableWrapper: boolean;

package/dist/lib/utils/options/sources/typedoc.js

@@ -335,6 +335,7 @@ function addTypeDocOptions(options) {
         type: declaration_1.ParameterType.Mixed,
         configFileOnly: true,
         defaultValue: {
+            html: true,
             linkify: true,
         },
         validate(value, i18n) {
@@ -449,10 +450,6 @@ function addTypeDocOptions(options) {
         help: (i18n) => i18n.help_useHostedBaseUrlForAbsoluteLinks(),
         type: declaration_1.ParameterType.Boolean,
     });
-    options.addDeclaration({
-        name: "gaID",
-        help: (i18n) => i18n.help_gaID(),
-    });
     options.addDeclaration({
         name: "hideGenerator",
         help: (i18n) => i18n.help_hideGenerator(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.0-beta.5",
+  "version": "0.26.0",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -77,7 +77,8 @@
     "build:prod:tsc": "tsc --project . --sourceMap false --declarationMap false",
     "lint": "eslint . && npm run prettier -- --check .",
     "prettier": "prettier --config .config/.prettierrc.json --ignore-path .config/.prettierignore",
-    "prepublishOnly": "node scripts/set_strict.js false && npm run build:prod && npm test",
+    "prepack": "node scripts/set_strict.js false && npm run build:prod",
+    "prepare": "node scripts/prepare.mjs",
     "postpublish": "node scripts/set_strict.js true"
   },
   "keywords": [

package/dist/lib/output/themes/default/partials/analytics.d.ts

@@ -1,3 +0,0 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-export declare function analytics(context: DefaultThemeRenderContext): JSX.Element | undefined;

package/dist/lib/output/themes/default/partials/analytics.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.analytics = analytics;
-const utils_1 = require("../../../../utils");
-function analytics(context) {
-    const gaID = context.options.getValue("gaID");
-    if (!gaID)
-        return;
-    const script = `
-window.dataLayer = window.dataLayer || [];
-function gtag(){dataLayer.push(arguments);}
-gtag('js', new Date());
-gtag('config', '${gaID}');
-`.trim();
-    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("script", { async: true, src: "https://www.googletagmanager.com/gtag/js?id=" + gaID }),
-        utils_1.JSX.createElement("script", null,
-            utils_1.JSX.createElement(utils_1.JSX.Raw, { html: script }))));
-}