typedoc 0.28.18 → 0.28.20

package/dist/lib/models/DeclarationReflection.js

@@ -1,287 +0,0 @@
-import { ReflectionType } from "./types.js";
-import { TraverseProperty } from "./Reflection.js";
-import { ContainerReflection } from "./ContainerReflection.js";
-import { Comment } from "./Comment.js";
-import { SourceReference } from "./SourceReference.js";
-import { ReflectionSymbolId } from "./ReflectionSymbolId.js";
-import { ReflectionKind } from "./kind.js";
-import { i18n } from "#utils";
-/**
- * A reflection that represents a single declaration emitted by the TypeScript compiler.
- *
- * All parts of a project are represented by DeclarationReflection instances. The actual
- * kind of a reflection is stored in its `kind` member.
- * @category Reflections
- */
-export class DeclarationReflection extends ContainerReflection {
-    variant = "declaration";
-    /**
-     * A list of all source files that contributed to this reflection.
-     */
-    sources;
-    /**
-     * Precomputed boost for search results, may be less than 1 to de-emphasize this member in search results.
-     * Does NOT include group/category values as they are computed when building the JS index.
-     *
-     * This is exposed purely for plugin use, see #3036 for details.
-     */
-    relevanceBoost;
-    /**
-     * The escaped name of this declaration assigned by the TS compiler if there is an associated symbol.
-     * This is used to retrieve properties for analyzing inherited members.
-     *
-     * Not serialized, only useful during conversion. This is a `ts.__String`.
-     * @internal
-     */
-    escapedName;
-    /**
-     * The type of the reflection.
-     *
-     * If the reflection represents a variable or a property, this is the value type.<br />
-     * If the reflection represents a signature, this is the return type.
-     */
-    type;
-    typeParameters;
-    /**
-     * A list of call signatures attached to this declaration.
-     *
-     * TypeDoc creates one declaration per function that may contain one or more
-     * signature reflections.
-     */
-    signatures;
-    /**
-     * The index signature of this declaration.
-     */
-    indexSignatures;
-    /**
-     * The get signature of this declaration.
-     */
-    getSignature;
-    /**
-     * The set signature of this declaration.
-     */
-    setSignature;
-    /**
-     * The default value of this reflection.
-     *
-     * Applies to function parameters, variables, and properties.
-     */
-    defaultValue;
-    /**
-     * A type that points to the reflection that has been overwritten by this reflection.
-     *
-     * Applies to interface and class members.
-     */
-    overwrites;
-    /**
-     * A type that points to the reflection this reflection has been inherited from.
-     *
-     * Applies to interface and class members.
-     */
-    inheritedFrom;
-    /**
-     * A type that points to the reflection this reflection is the implementation of.
-     *
-     * Applies to class members.
-     */
-    implementationOf;
-    /**
-     * A list of all types this reflection extends (e.g. the parent classes).
-     */
-    extendedTypes;
-    /**
-     * A list of all types that extend this reflection (e.g. the subclasses).
-     */
-    extendedBy;
-    /**
-     * A list of all types this reflection implements.
-     */
-    implementedTypes;
-    /**
-     * A list of all types that implement this reflection.
-     */
-    implementedBy;
-    /**
-     * Contains a simplified representation of the type hierarchy suitable for being
-     * rendered in templates.
-     */
-    typeHierarchy;
-    /**
-     * The contents of the readme file of the module when found.
-     */
-    readme;
-    /**
-     * The version of the module when found.
-     */
-    packageVersion;
-    isDeclaration() {
-        return true;
-    }
-    hasGetterOrSetter() {
-        return !!this.getSignature || !!this.setSignature;
-    }
-    getAllSignatures() {
-        let result = [];
-        if (this.signatures) {
-            result = result.concat(this.signatures);
-        }
-        if (this.indexSignatures) {
-            result = result.concat(this.indexSignatures);
-        }
-        if (this.getSignature) {
-            result.push(this.getSignature);
-        }
-        if (this.setSignature) {
-            result.push(this.setSignature);
-        }
-        return result;
-    }
-    getNonIndexSignatures() {
-        return [].concat(this.signatures ?? [], this.setSignature ?? [], this.getSignature ?? []);
-    }
-    getProperties() {
-        if (this.children?.length) {
-            return this.children;
-        }
-        if (this.type?.type === "reflection") {
-            return this.type.declaration.children ?? [];
-        }
-        return [];
-    }
-    getChildOrTypePropertyByName(path) {
-        if (this.type?.type === "reflection") {
-            for (const child of this.type.declaration.children || []) {
-                if (path[0] === child.name) {
-                    if (path.length === 1) {
-                        return child;
-                    }
-                    return child.getChildOrTypePropertyByName(path.slice(1));
-                }
-            }
-        }
-        for (const child of this.children || []) {
-            if (path[0] === child.name) {
-                if (path.length === 1) {
-                    return child;
-                }
-                return child.getChildOrTypePropertyByName(path.slice(1));
-            }
-        }
-        return undefined;
-    }
-    traverse(callback) {
-        for (const parameter of this.typeParameters?.slice() || []) {
-            if (callback(parameter, TraverseProperty.TypeParameter) === false) {
-                return;
-            }
-        }
-        if (this.type instanceof ReflectionType) {
-            if (callback(this.type.declaration, TraverseProperty.TypeLiteral) === false) {
-                return;
-            }
-        }
-        for (const signature of this.signatures?.slice() || []) {
-            if (callback(signature, TraverseProperty.Signatures) === false) {
-                return;
-            }
-        }
-        for (const signature of this.indexSignatures?.slice() || []) {
-            if (callback(signature, TraverseProperty.IndexSignature) === false) {
-                return;
-            }
-        }
-        if (this.getSignature) {
-            if (callback(this.getSignature, TraverseProperty.GetSignature) ===
-                false) {
-                return;
-            }
-        }
-        if (this.setSignature) {
-            if (callback(this.setSignature, TraverseProperty.SetSignature) ===
-                false) {
-                return;
-            }
-        }
-        super.traverse(callback);
-    }
-    /**
-     * Return a string representation of this reflection.
-     */
-    toString() {
-        let result = super.toString();
-        if (this.typeParameters) {
-            const parameters = this.typeParameters.map((parameter) => parameter.name);
-            result += "<" + parameters.join(", ") + ">";
-        }
-        if (this.type) {
-            result += ": " + this.type.toString();
-        }
-        return result;
-    }
-    toObject(serializer) {
-        return {
-            ...super.toObject(serializer),
-            variant: this.variant,
-            packageVersion: this.packageVersion,
-            sources: serializer.toObjectsOptional(this.sources),
-            relevanceBoost: this.relevanceBoost === 1 ? undefined : this.relevanceBoost,
-            typeParameters: serializer.toObjectsOptional(this.typeParameters),
-            type: serializer.toObject(this.type),
-            signatures: serializer.toObjectsOptional(this.signatures),
-            indexSignatures: serializer.toObjectsOptional(this.indexSignatures),
-            getSignature: serializer.toObject(this.getSignature),
-            setSignature: serializer.toObject(this.setSignature),
-            defaultValue: this.defaultValue,
-            overwrites: serializer.toObject(this.overwrites),
-            inheritedFrom: serializer.toObject(this.inheritedFrom),
-            implementationOf: serializer.toObject(this.implementationOf),
-            extendedTypes: serializer.toObjectsOptional(this.extendedTypes),
-            extendedBy: serializer.toObjectsOptional(this.extendedBy),
-            implementedTypes: serializer.toObjectsOptional(this.implementedTypes),
-            implementedBy: serializer.toObjectsOptional(this.implementedBy),
-            readme: Comment.serializeDisplayParts(this.readme),
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        if (obj.readme) {
-            this.readme = Comment.deserializeDisplayParts(de, obj.readme);
-        }
-        // This happens when merging multiple projects together.
-        // If updating this, also check ProjectReflection.fromObject.
-        if (obj.variant === "project") {
-            this.kind = ReflectionKind.Module;
-            this.packageVersion = obj.packageVersion;
-            this.project.files.fromObject(de, obj.files || {});
-            de.defer(() => {
-                for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
-                    const refl = this.project.getReflectionById(de.oldIdToNewId[+id] ?? -1);
-                    if (refl) {
-                        this.project.registerSymbolId(refl, new ReflectionSymbolId(sid));
-                    }
-                    else {
-                        de.logger.warn(i18n.serialized_project_referenced_0_not_part_of_project(id));
-                    }
-                }
-            });
-            return;
-        }
-        this.packageVersion = obj.packageVersion;
-        this.sources = de.reviveMany(obj.sources, (src) => new SourceReference(src.fileName, src.line, src.character));
-        this.relevanceBoost = obj.relevanceBoost;
-        this.typeParameters = de.reviveMany(obj.typeParameters, (tp) => de.constructReflection(tp));
-        this.type = de.revive(obj.type, (t) => de.constructType(t));
-        this.signatures = de.reviveMany(obj.signatures, (r) => de.constructReflection(r));
-        this.indexSignatures = de.reviveMany(obj.indexSignatures, (r) => de.constructReflection(r));
-        this.getSignature = de.revive(obj.getSignature, (r) => de.constructReflection(r));
-        this.setSignature = de.revive(obj.setSignature, (r) => de.constructReflection(r));
-        this.defaultValue = obj.defaultValue;
-        this.overwrites = de.reviveType(obj.overwrites);
-        this.inheritedFrom = de.reviveType(obj.inheritedFrom);
-        this.implementationOf = de.reviveType(obj.implementationOf);
-        this.extendedTypes = de.reviveMany(obj.extendedTypes, (t) => de.reviveType(t));
-        this.extendedBy = de.reviveMany(obj.extendedBy, (t) => de.reviveType(t));
-        this.implementedTypes = de.reviveMany(obj.implementedTypes, (t) => de.reviveType(t));
-        this.implementedBy = de.reviveMany(obj.implementedBy, (t) => de.reviveType(t));
-    }
-}

package/dist/lib/models/DocumentReflection.js

@@ -1,66 +0,0 @@
-import { Comment } from "./Comment.js";
-import { Reflection, TraverseProperty } from "./Reflection.js";
-import { ReflectionKind } from "./kind.js";
-/**
- * Non-TS reflection type which is used to represent markdown documents included in the docs.
- */
-export class DocumentReflection extends Reflection {
-    variant = "document";
-    /**
-     * The content to be displayed on the page for this reflection.
-     */
-    content;
-    /**
-     * Frontmatter included in document
-     */
-    frontmatter;
-    /**
-     * A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when
-     * boosting search relevance scores at runtime. May be modified by plugins.
-     */
-    relevanceBoost;
-    /**
-     * Child documents, if any are present.
-     */
-    children;
-    constructor(name, parent, content, frontmatter) {
-        super(name, ReflectionKind.Document, parent);
-        this.content = content;
-        this.frontmatter = frontmatter;
-        if (typeof frontmatter["title"] === "string") {
-            this.name = frontmatter["title"];
-            delete frontmatter["title"];
-        }
-    }
-    addChild(child) {
-        this.children ||= [];
-        this.children.push(child);
-    }
-    isDocument() {
-        return true;
-    }
-    traverse(callback) {
-        for (const child of this.children || []) {
-            if (callback(child, TraverseProperty.Documents) === false) {
-                return;
-            }
-        }
-    }
-    toObject(serializer) {
-        return {
-            ...super.toObject(serializer),
-            variant: this.variant,
-            content: Comment.serializeDisplayParts(this.content),
-            frontmatter: this.frontmatter,
-            relevanceBoost: this.relevanceBoost,
-            children: serializer.toObjectsOptional(this.children),
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        this.content = Comment.deserializeDisplayParts(de, obj.content);
-        this.frontmatter = obj.frontmatter;
-        this.relevanceBoost = obj.relevanceBoost;
-        this.children = de.reviveMany(obj.children, (obj) => de.constructReflection(obj));
-    }
-}

package/dist/lib/models/FileRegistry.js

@@ -1,133 +0,0 @@
-import { NormalizedPathUtils } from "#utils";
-export class FileRegistry {
-    nextId = 1;
-    // The combination of these two make up the registry
-    mediaToReflection = new Map();
-    mediaToPath = new Map();
-    reflectionToPath = new Map();
-    pathToMedia = new Map();
-    // Lazily created as we get names for rendering
-    names = new Map();
-    nameUsage = new Map();
-    registerAbsolute(absolute) {
-        const anchorIndex = absolute.indexOf("#");
-        let anchor = undefined;
-        if (anchorIndex !== -1) {
-            anchor = absolute.substring(anchorIndex + 1);
-            absolute = absolute.substring(0, anchorIndex);
-        }
-        const existing = this.pathToMedia.get(absolute);
-        if (existing) {
-            return { target: existing, anchor };
-        }
-        this.mediaToPath.set(this.nextId, absolute);
-        this.pathToMedia.set(absolute, this.nextId);
-        return { target: this.nextId++, anchor };
-    }
-    /**
-     * Registers the specified path as the canonical file for this reflection
-     */
-    registerReflection(absolute, reflection) {
-        const { target } = this.registerAbsolute(absolute);
-        this.reflectionToPath.set(reflection.id, absolute);
-        this.mediaToReflection.set(target, reflection.id);
-    }
-    /**
-     * Registers the specified path as a path which should be resolved to the specified
-     * reflection. A reflection *may* be associated with multiple paths.
-     */
-    registerReflectionPath(absolute, reflection) {
-        const { target } = this.registerAbsolute(absolute);
-        this.mediaToReflection.set(target, reflection.id);
-    }
-    getReflectionPath(reflection) {
-        return this.reflectionToPath.get(reflection.id);
-    }
-    register(sourcePath, relativePath) {
-        return this.registerAbsolute(NormalizedPathUtils.resolve(NormalizedPathUtils.dirname(sourcePath), relativePath));
-    }
-    removeReflection(reflection) {
-        const absolute = this.reflectionToPath.get(reflection.id);
-        if (absolute) {
-            const media = this.pathToMedia.get(absolute);
-            this.mediaToReflection.delete(media);
-        }
-    }
-    resolve(id, project) {
-        const reflId = this.mediaToReflection.get(id);
-        if (typeof reflId === "number") {
-            return project.getReflectionById(reflId);
-        }
-        return this.mediaToPath.get(id);
-    }
-    resolvePath(id) {
-        return this.mediaToPath.get(id);
-    }
-    getName(id) {
-        const absolute = this.mediaToPath.get(id);
-        if (!absolute)
-            return;
-        if (this.names.has(id)) {
-            return this.names.get(id);
-        }
-        const file = NormalizedPathUtils.basename(absolute);
-        if (!this.nameUsage.has(file)) {
-            this.nameUsage.set(file, 1);
-            this.names.set(id, file);
-        }
-        else {
-            const { name, ext } = NormalizedPathUtils.splitFilename(file);
-            let counter = this.nameUsage.get(file);
-            while (this.nameUsage.has(`${name}-${counter}${ext}`)) {
-                ++counter;
-            }
-            this.nameUsage.set(file, counter + 1);
-            this.nameUsage.set(`${name}-${counter}${ext}`, counter + 1);
-            this.names.set(id, `${name}-${counter}${ext}`);
-        }
-        return this.names.get(id);
-    }
-    getNameToAbsoluteMap() {
-        const result = new Map();
-        for (const [id, name] of this.names.entries()) {
-            result.set(name, this.mediaToPath.get(id));
-        }
-        return result;
-    }
-    toObject(ser) {
-        const result = {
-            entries: {},
-            reflections: {},
-        };
-        for (const [key, val] of this.mediaToPath.entries()) {
-            result.entries[key] = NormalizedPathUtils.relative(ser.projectRoot, val);
-        }
-        for (const [key, val] of this.mediaToReflection.entries()) {
-            // A registry may be shared by multiple projects. When serializing,
-            // only save reflection mapping for reflections in the serialized project.
-            if (ser.project.getReflectionById(val)) {
-                result.reflections[key] = val;
-            }
-        }
-        return result;
-    }
-    /**
-     * Revive a file registry from disc.
-     * Note that in the packages context this may be called multiple times on
-     * a single object, and should merge in files from the other registries.
-     */
-    fromObject(de, obj) {
-        for (const [fileId, path] of Object.entries(obj.entries)) {
-            const absolute = NormalizedPathUtils.resolve(de.projectRoot, path);
-            de.oldFileIdToNewFileId[+fileId] = this.registerAbsolute(absolute).target;
-        }
-        de.defer((project) => {
-            for (const [fileId, reflId] of Object.entries(obj.reflections)) {
-                const refl = project.getReflectionById(de.oldIdToNewId[reflId]);
-                if (refl) {
-                    this.mediaToReflection.set(de.oldFileIdToNewFileId[+fileId], refl.id);
-                }
-            }
-        });
-    }
-}

package/dist/lib/models/ParameterReflection.js

@@ -1,39 +0,0 @@
-import { ReflectionType } from "./types.js";
-import { Reflection, TraverseProperty } from "./Reflection.js";
-/**
- * @category Reflections
- */
-export class ParameterReflection extends Reflection {
-    variant = "param";
-    defaultValue;
-    type;
-    traverse(callback) {
-        if (this.type instanceof ReflectionType) {
-            if (callback(this.type.declaration, TraverseProperty.TypeLiteral) === false) {
-                return;
-            }
-        }
-    }
-    isParameter() {
-        return true;
-    }
-    /**
-     * Return a string representation of this reflection.
-     */
-    toString() {
-        return (super.toString() + (this.type ? ": " + this.type.toString() : ""));
-    }
-    toObject(serializer) {
-        return {
-            ...super.toObject(serializer),
-            variant: this.variant,
-            type: serializer.toObject(this.type),
-            defaultValue: this.defaultValue,
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        this.type = de.reviveType(obj.type);
-        this.defaultValue = obj.defaultValue;
-    }
-}