typedoc 0.26.0-beta.2 → 0.26.0-beta.4

package/dist/lib/models/reflections/abstract.js

@@ -59,23 +59,19 @@ var ReflectionFlag;
     ReflectionFlag[ReflectionFlag["Protected"] = 2] = "Protected";
     ReflectionFlag[ReflectionFlag["Public"] = 4] = "Public";
     ReflectionFlag[ReflectionFlag["Static"] = 8] = "Static";
-    ReflectionFlag[ReflectionFlag["ExportAssignment"] = 16] = "ExportAssignment";
-    ReflectionFlag[ReflectionFlag["External"] = 32] = "External";
-    ReflectionFlag[ReflectionFlag["Optional"] = 64] = "Optional";
-    ReflectionFlag[ReflectionFlag["DefaultValue"] = 128] = "DefaultValue";
-    ReflectionFlag[ReflectionFlag["Rest"] = 256] = "Rest";
-    ReflectionFlag[ReflectionFlag["Abstract"] = 512] = "Abstract";
-    ReflectionFlag[ReflectionFlag["Const"] = 1024] = "Const";
-    ReflectionFlag[ReflectionFlag["Let"] = 2048] = "Let";
-    ReflectionFlag[ReflectionFlag["Readonly"] = 4096] = "Readonly";
+    ReflectionFlag[ReflectionFlag["External"] = 16] = "External";
+    ReflectionFlag[ReflectionFlag["Optional"] = 32] = "Optional";
+    ReflectionFlag[ReflectionFlag["Rest"] = 64] = "Rest";
+    ReflectionFlag[ReflectionFlag["Abstract"] = 128] = "Abstract";
+    ReflectionFlag[ReflectionFlag["Const"] = 256] = "Const";
+    ReflectionFlag[ReflectionFlag["Readonly"] = 512] = "Readonly";
+    ReflectionFlag[ReflectionFlag["Inherited"] = 1024] = "Inherited";
 })(ReflectionFlag || (exports.ReflectionFlag = ReflectionFlag = {}));
 const relevantFlags = [
     ReflectionFlag.Private,
     ReflectionFlag.Protected,
     ReflectionFlag.Static,
-    ReflectionFlag.ExportAssignment,
     ReflectionFlag.Optional,
-    ReflectionFlag.DefaultValue,
     ReflectionFlag.Rest,
     ReflectionFlag.Abstract,
     ReflectionFlag.Const,
@@ -84,9 +80,8 @@ const relevantFlags = [
 /**
  * This must extend Array in order to work with Handlebar's each helper.
  */
-class ReflectionFlags extends Array {
+class ReflectionFlags {
     constructor() {
-        super(...arguments);
         this.flags = ReflectionFlag.None;
     }
     hasFlag(flag) {
@@ -136,9 +131,6 @@ class ReflectionFlags extends Array {
     get isRest() {
         return this.hasFlag(ReflectionFlag.Rest);
     }
-    get hasExportAssignment() {
-        return this.hasFlag(ReflectionFlag.ExportAssignment);
-    }
     get isAbstract() {
         return this.hasFlag(ReflectionFlag.Abstract);
     }
@@ -148,6 +140,9 @@ class ReflectionFlags extends Array {
     get isReadonly() {
         return this.hasFlag(ReflectionFlag.Readonly);
     }
+    get isInherited() {
+        return this.hasFlag(ReflectionFlag.Inherited);
+    }
     setFlag(flag, set) {
         switch (flag) {
             case ReflectionFlag.Private:
@@ -175,18 +170,20 @@ class ReflectionFlags extends Array {
                 this.setSingleFlag(flag, set);
         }
     }
+    getFlagStrings(i18n) {
+        const strings = [];
+        for (const flag of relevantFlags) {
+            if (this.hasFlag(flag)) {
+                strings.push(i18n.flagString(flag));
+            }
+        }
+        return strings;
+    }
     setSingleFlag(flag, set) {
-        const name = ReflectionFlag[flag].replace(/(.)([A-Z])/g, (_m, a, b) => a + " " + b.toLowerCase());
         if (!set && this.hasFlag(flag)) {
-            if (relevantFlags.includes(flag)) {
-                this.splice(this.indexOf(name), 1);
-            }
             this.flags ^= flag;
         }
         else if (set && !this.hasFlag(flag)) {
-            if (relevantFlags.includes(flag)) {
-                this.push(name);
-            }
             this.flags |= flag;
         }
     }
@@ -213,10 +210,10 @@ ReflectionFlags.serializedFlags = [
     "isExternal",
     "isOptional",
     "isRest",
-    "hasExportAssignment",
     "isAbstract",
     "isConst",
     "isReadonly",
+    "isInherited",
 ];
 var TraverseProperty;
 (function (TraverseProperty) {
@@ -326,33 +323,33 @@ let Reflection = (() => {
              * Return an url safe alias for this reflection.
              */
             getAlias() {
-                if (!this._alias) {
-                    let alias = this.name.replace(/\W/g, "_");
-                    if (alias === "") {
-                        alias = `reflection-${this.id}`;
-                    }
-                    // NTFS/ExFAT use uppercase, so we will too. It probably won't matter
-                    // in this case since names will generally be valid identifiers, but to be safe...
-                    const upperAlias = alias.toUpperCase();
-                    let target = this;
-                    while (target.parent && !target.hasOwnDocument) {
-                        target = target.parent;
-                    }
-                    target._aliases ||= new Map();
-                    let suffix = "";
-                    if (!target._aliases.has(upperAlias)) {
-                        target._aliases.set(upperAlias, 1);
-                    }
-                    else {
-                        const count = target._aliases.get(upperAlias);
-                        suffix = "-" + count.toString();
-                        target._aliases.set(upperAlias, count + 1);
-                    }
-                    alias += suffix;
-                    this._alias = alias;
-                }
+                this._alias ||= this.getUniqueAliasInPage(this.name.replace(/\W/g, "_") || `reflection-${this.id}`);
                 return this._alias;
             }
+            // This really ought not live here, it ought to live in the html renderer, but moving that
+            // is more work than I want right now, it can wait for 0.27 when trying to split models into
+            // a bundleable structure.
+            getUniqueAliasInPage(heading) {
+                // NTFS/ExFAT use uppercase, so we will too. It probably won't matter
+                // in this case since names will generally be valid identifiers, but to be safe...
+                const upperAlias = heading.toUpperCase();
+                let target = this;
+                while (target.parent && !target.hasOwnDocument) {
+                    target = target.parent;
+                }
+                target._aliases ||= new Map();
+                let suffix = "";
+                if (!target._aliases.has(upperAlias)) {
+                    target._aliases.set(upperAlias, 1);
+                }
+                else {
+                    const count = target._aliases.get(upperAlias);
+                    suffix = "-" + count.toString();
+                    target._aliases.set(upperAlias, count + 1);
+                }
+                heading += suffix;
+                return heading;
+            }
             /**
              * Has this reflection a visible comment?
              *

package/dist/lib/models/reflections/document.d.ts

@@ -19,9 +19,14 @@ export declare class DocumentReflection extends Reflection {
      * boosting search relevance scores at runtime. May be modified by plugins.
      */
     relevanceBoost?: number;
+    /**
+     * Child documents, if any are present.
+     */
+    children?: DocumentReflection[];
     constructor(name: string, parent: Reflection, content: CommentDisplayPart[], frontmatter: Record<string, unknown>);
+    addChild(child: DocumentReflection): void;
     isDocument(): this is DocumentReflection;
-    traverse(_callback: TraverseCallback): void;
+    traverse(callback: TraverseCallback): void;
     toObject(serializer: Serializer): JSONOutput.DocumentReflection;
     fromObject(de: Deserializer, obj: JSONOutput.DocumentReflection): void;
 }

package/dist/lib/models/reflections/document.js

@@ -18,11 +18,19 @@ class DocumentReflection extends abstract_1.Reflection {
             delete frontmatter["title"];
         }
     }
+    addChild(child) {
+        this.children ||= [];
+        this.children.push(child);
+    }
     isDocument() {
         return true;
     }
-    traverse(_callback) {
-        // Nothing to do here, we have no children.
+    traverse(callback) {
+        for (const child of this.children || []) {
+            if (callback(child, abstract_1.TraverseProperty.Documents) === false) {
+                return;
+            }
+        }
     }
     toObject(serializer) {
         return {
@@ -31,6 +39,7 @@ class DocumentReflection extends abstract_1.Reflection {
             content: comments_1.Comment.serializeDisplayParts(serializer, this.content),
             frontmatter: this.frontmatter,
             relevanceBoost: this.relevanceBoost,
+            children: serializer.toObjectsOptional(this.children),
         };
     }
     fromObject(de, obj) {
@@ -38,6 +47,7 @@ class DocumentReflection extends abstract_1.Reflection {
         this.content = comments_1.Comment.deserializeDisplayParts(de, obj.content);
         this.frontmatter = obj.frontmatter;
         this.relevanceBoost = obj.relevanceBoost;
+        this.children = de.reviveMany(obj.children, (obj) => de.reflectionBuilders.document(this, obj));
     }
 }
 exports.DocumentReflection = DocumentReflection;

package/dist/lib/models/reflections/kind.d.ts

@@ -35,6 +35,7 @@ export declare enum ReflectionKind {
 /** @category Reflections */
 export declare namespace ReflectionKind {
     type KindString = EnumKeys<typeof ReflectionKind>;
+    /** @internal */
     const All: number;
     /** @internal */
     const ClassOrInterface: number;
@@ -56,6 +57,7 @@ export declare namespace ReflectionKind {
     const SomeMember: number;
     /** @internal */
     const SomeExport: number;
+    /** @internal */
     const MayContainDocuments: number;
     /** @internal */
     const ExportContainer: number;

package/dist/lib/models/reflections/kind.js

@@ -37,6 +37,7 @@ var ReflectionKind;
 })(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 /** @category Reflections */
 (function (ReflectionKind) {
+    /** @internal */
     ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
     /** @internal */
     ReflectionKind.ClassOrInterface = ReflectionKind.Class | ReflectionKind.Interface;
@@ -79,7 +80,8 @@ var ReflectionKind;
         ReflectionKind.Interface |
         ReflectionKind.TypeAlias |
         ReflectionKind.Reference;
-    ReflectionKind.MayContainDocuments = ReflectionKind.SomeExport | ReflectionKind.Project;
+    /** @internal */
+    ReflectionKind.MayContainDocuments = ReflectionKind.SomeExport | ReflectionKind.Project | ReflectionKind.Document;
     /** @internal */
     ReflectionKind.ExportContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
     /** @internal */

package/dist/lib/models/reflections/project.js

@@ -298,6 +298,7 @@ class ProjectReflection extends container_1.ContainerReflection {
         }
         this.files.fromObject(de, obj.files);
         de.defer(() => {
+            // Unnecessary conditional in release
             for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
                 const refl = this.getReflectionById(de.oldIdToNewId[+id] ?? -1);
                 if (refl) {

package/dist/lib/models/reflections/signature.js

@@ -50,7 +50,7 @@ class SignatureReflection extends abstract_1.Reflection {
             ...super.toObject(serializer),
             variant: this.variant,
             sources: serializer.toObjectsOptional(this.sources),
-            typeParameter: serializer.toObjectsOptional(this.typeParameters),
+            typeParameters: serializer.toObjectsOptional(this.typeParameters),
             parameters: serializer.toObjectsOptional(this.parameters),
             type: serializer.toObject(this.type),
             overwrites: serializer.toObject(this.overwrites),
@@ -61,7 +61,12 @@ class SignatureReflection extends abstract_1.Reflection {
     fromObject(de, obj) {
         super.fromObject(de, obj);
         this.sources = de.reviveMany(obj.sources, (t) => new file_1.SourceReference(t.fileName, t.line, t.character));
-        this.typeParameters = de.reviveMany(obj.typeParameter, (t) => de.constructReflection(t));
+        if (obj.typeParameter) {
+            this.typeParameters = de.reviveMany(obj.typeParameter, (t) => de.constructReflection(t));
+        }
+        else {
+            this.typeParameters = de.reviveMany(obj.typeParameters, (t) => de.constructReflection(t));
+        }
         this.parameters = de.reviveMany(obj.parameters, (t) => de.constructReflection(t));
         this.type = de.reviveType(obj.type);
         this.overwrites = de.reviveType(obj.overwrites);

package/dist/lib/models/types.d.ts

@@ -6,6 +6,7 @@ import type { ProjectReflection } from "./reflections/project";
 import type { Serializer, JSONOutput, Deserializer } from "../serialization";
 import { ReflectionSymbolId } from "./reflections/ReflectionSymbolId";
 import type { DeclarationReference } from "../converter/comments/declarationReference";
+import { type CommentDisplayPart } from "./comments";
 /**
  * Base class of all type definitions.
  * @category Types
@@ -507,10 +508,17 @@ export declare class TypeOperatorType extends Type {
 export declare class UnionType extends Type {
     types: SomeType[];
     readonly type = "union";
+    /**
+     * If present, there should be as many items in this array as there are items in the {@link types} array.
+     *
+     * This member is only valid on unions which are on {@link DeclarationReflection.type | DeclarationReflection.type} with a
+     * {@link ReflectionKind} `kind` of `TypeAlias`. Specifying it on any other union is undefined behavior.
+     */
+    elementSummaries?: CommentDisplayPart[][];
     constructor(types: SomeType[]);
     protected getTypeString(): string;
     needsParenthesis(context: TypeContext): boolean;
-    private normalize;
+    fromObject(de: Deserializer, obj: JSONOutput.UnionType): void;
     toObject(serializer: Serializer): JSONOutput.UnionType;
 }
 /**

package/dist/lib/models/types.js

@@ -30,6 +30,7 @@ const tsutils_1 = require("../utils/tsutils");
 const ReflectionSymbolId_1 = require("./reflections/ReflectionSymbolId");
 const fs_1 = require("../utils/fs");
 const kind_1 = require("./reflections/kind");
+const comments_1 = require("./comments");
 /**
  * Base class of all type definitions.
  * @category Types
@@ -1092,7 +1093,6 @@ class UnionType extends Type {
         super();
         this.types = types;
         this.type = "union";
-        this.normalize();
     }
     getTypeString() {
         return this.types
@@ -1127,29 +1127,16 @@ class UnionType extends Type {
         };
         return map[context];
     }
-    normalize() {
-        let trueIndex = -1;
-        let falseIndex = -1;
-        for (let i = 0; i < this.types.length && (trueIndex === -1 || falseIndex === -1); i++) {
-            const t = this.types[i];
-            if (t instanceof LiteralType) {
-                if (t.value === true) {
-                    trueIndex = i;
-                }
-                if (t.value === false) {
-                    falseIndex = i;
-                }
-            }
-        }
-        if (trueIndex !== -1 && falseIndex !== -1) {
-            this.types.splice(Math.max(trueIndex, falseIndex), 1);
-            this.types.splice(Math.min(trueIndex, falseIndex), 1, new IntrinsicType("boolean"));
+    fromObject(de, obj) {
+        if (obj.elementSummaries) {
+            this.elementSummaries = obj.elementSummaries.map((parts) => comments_1.Comment.deserializeDisplayParts(de, parts));
         }
     }
     toObject(serializer) {
         return {
             type: this.type,
             types: this.types.map((t) => serializer.toObject(t)),
+            elementSummaries: this.elementSummaries?.map((parts) => comments_1.Comment.serializeDisplayParts(serializer, parts)),
         };
     }
 }

package/dist/lib/output/components.d.ts

@@ -28,6 +28,8 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
      * Regular expression to test if a string looks like an external url.
      */
     protected urlPrefix: RegExp;
+    private get hostedBaseUrl();
+    private accessor useHostedBaseUrlForAbsoluteLinks;
     /**
      * Create a new ContextAwareRendererPlugin instance.
      *

package/dist/lib/output/components.js

@@ -15,6 +15,40 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
@@ -22,82 +56,121 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextAwareRendererComponent = exports.RendererComponent = exports.Component = void 0;
 const Path = __importStar(require("path"));
 const component_1 = require("../utils/component");
 Object.defineProperty(exports, "Component", { enumerable: true, get: function () { return component_1.Component; } });
 const events_1 = require("./events");
+const utils_1 = require("../utils");
 class RendererComponent extends component_1.AbstractComponent {
 }
 exports.RendererComponent = RendererComponent;
 /**
  * A plugin for the renderer that reads the current render context.
  */
-class ContextAwareRendererComponent extends RendererComponent {
-    constructor() {
-        super(...arguments);
-        /**
-         * The url of the document that is being currently generated.
-         * Set when a page begins rendering.
-         *
-         * Defaulted to '.' so that tests don't have to set up events.
-         */
-        this.location = ".";
-        /**
-         * Regular expression to test if a string looks like an external url.
-         */
-        this.urlPrefix = /^(http|ftp)s?:\/\//;
-        this.absoluteToRelativePathMap = new Map();
-    }
-    /**
-     * Create a new ContextAwareRendererPlugin instance.
-     *
-     * @param renderer  The renderer this plugin should be attached to.
-     */
-    initialize() {
-        this.listenTo(this.owner, {
-            [events_1.RendererEvent.BEGIN]: this.onBeginRenderer,
-            [events_1.PageEvent.BEGIN]: this.onBeginPage,
-            [events_1.RendererEvent.END]: () => this.absoluteToRelativePathMap.clear(),
-        });
-    }
-    /**
-     * Transform the given absolute path into a relative path.
-     *
-     * @param absolute  The absolute path to transform.
-     * @returns A path relative to the document currently processed.
-     */
-    getRelativeUrl(absolute) {
-        if (this.urlPrefix.test(absolute)) {
-            return absolute;
-        }
-        else {
-            const key = `${this.location}:${absolute}`;
-            let path = this.absoluteToRelativePathMap.get(key);
-            if (path)
-                return path;
-            path = Path.posix.relative(this.location, absolute) || ".";
-            this.absoluteToRelativePathMap.set(key, path);
-            return path;
-        }
-    }
-    /**
-     * Triggered before the renderer starts rendering a project.
-     *
-     * @param event  An event object describing the current render operation.
-     */
-    onBeginRenderer(event) {
-        this.project = event.project;
-    }
-    /**
-     * Triggered before a document will be rendered.
-     *
-     * @param page  An event object describing the current render operation.
-     */
-    onBeginPage(page) {
-        this.location = Path.posix.dirname(page.url);
-        this.page = page;
-    }
-}
+let ContextAwareRendererComponent = (() => {
+    var _a, _ContextAwareRendererComponent_useHostedBaseUrlForAbsoluteLinks_accessor_storage;
+    let _classSuper = RendererComponent;
+    let _useHostedBaseUrlForAbsoluteLinks_decorators;
+    let _useHostedBaseUrlForAbsoluteLinks_initializers = [];
+    let _useHostedBaseUrlForAbsoluteLinks_extraInitializers = [];
+    return _a = class ContextAwareRendererComponent extends _classSuper {
+            constructor() {
+                super(...arguments);
+                /**
+                 * The url of the document that is being currently generated.
+                 * Set when a page begins rendering.
+                 *
+                 * Defaulted to '.' so that tests don't have to set up events.
+                 */
+                this.location = ".";
+                /**
+                 * Regular expression to test if a string looks like an external url.
+                 */
+                this.urlPrefix = /^(http|ftp)s?:\/\//;
+                _ContextAwareRendererComponent_useHostedBaseUrlForAbsoluteLinks_accessor_storage.set(this, __runInitializers(this, _useHostedBaseUrlForAbsoluteLinks_initializers, void 0));
+                this.absoluteToRelativePathMap = (__runInitializers(this, _useHostedBaseUrlForAbsoluteLinks_extraInitializers), new Map());
+            }
+            get hostedBaseUrl() {
+                const url = this.application.options.getValue("hostedBaseUrl");
+                return !url || url.endsWith("/") ? url : url + "/";
+            }
+            get useHostedBaseUrlForAbsoluteLinks() { return __classPrivateFieldGet(this, _ContextAwareRendererComponent_useHostedBaseUrlForAbsoluteLinks_accessor_storage, "f"); }
+            set useHostedBaseUrlForAbsoluteLinks(value) { __classPrivateFieldSet(this, _ContextAwareRendererComponent_useHostedBaseUrlForAbsoluteLinks_accessor_storage, value, "f"); }
+            /**
+             * Create a new ContextAwareRendererPlugin instance.
+             *
+             * @param renderer  The renderer this plugin should be attached to.
+             */
+            initialize() {
+                this.listenTo(this.owner, {
+                    [events_1.RendererEvent.BEGIN]: this.onBeginRenderer,
+                    [events_1.PageEvent.BEGIN]: this.onBeginPage,
+                    [events_1.RendererEvent.END]: () => this.absoluteToRelativePathMap.clear(),
+                });
+            }
+            /**
+             * Transform the given absolute path into a relative path.
+             *
+             * @param absolute  The absolute path to transform.
+             * @returns A path relative to the document currently processed.
+             */
+            getRelativeUrl(absolute) {
+                if (this.urlPrefix.test(absolute)) {
+                    return absolute;
+                }
+                else {
+                    const key = `${this.location}:${absolute}`;
+                    let path = this.absoluteToRelativePathMap.get(key);
+                    if (path)
+                        return path;
+                    if (this.useHostedBaseUrlForAbsoluteLinks) {
+                        path = new URL(absolute, this.hostedBaseUrl).toString();
+                    }
+                    else {
+                        path = Path.posix.relative(this.location, absolute) || ".";
+                    }
+                    this.absoluteToRelativePathMap.set(key, path);
+                    return path;
+                }
+            }
+            /**
+             * Triggered before the renderer starts rendering a project.
+             *
+             * @param event  An event object describing the current render operation.
+             */
+            onBeginRenderer(event) {
+                this.project = event.project;
+            }
+            /**
+             * Triggered before a document will be rendered.
+             *
+             * @param page  An event object describing the current render operation.
+             */
+            onBeginPage(page) {
+                this.location = Path.posix.dirname(page.url);
+                this.page = page;
+            }
+        },
+        _ContextAwareRendererComponent_useHostedBaseUrlForAbsoluteLinks_accessor_storage = new WeakMap(),
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _useHostedBaseUrlForAbsoluteLinks_decorators = [(0, utils_1.Option)("useHostedBaseUrlForAbsoluteLinks")];
+            __esDecorate(_a, null, _useHostedBaseUrlForAbsoluteLinks_decorators, { kind: "accessor", name: "useHostedBaseUrlForAbsoluteLinks", static: false, private: false, access: { has: obj => "useHostedBaseUrlForAbsoluteLinks" in obj, get: obj => obj.useHostedBaseUrlForAbsoluteLinks, set: (obj, value) => { obj.useHostedBaseUrlForAbsoluteLinks = value; } }, metadata: _metadata }, _useHostedBaseUrlForAbsoluteLinks_initializers, _useHostedBaseUrlForAbsoluteLinks_extraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
 exports.ContextAwareRendererComponent = ContextAwareRendererComponent;

package/dist/lib/output/models/UrlMapping.d.ts

@@ -6,4 +6,8 @@ export declare class UrlMapping<Model = any> {
     template: RenderTemplate<PageEvent<Model>>;
     constructor(url: string, model: Model, template: RenderTemplate<PageEvent<Model>>);
 }
+/**
+ * @param data the reflection to render
+ * @returns either a string to be written to the file, or an element to be serialized and then written.
+ */
 export type RenderTemplate<T> = (data: T) => JSX.Element | string;