typedoc 0.28.19 → 0.28.20

package/dist/lib/models/ReflectionSymbolId.js

@@ -1,85 +0,0 @@
-import {} from "#utils";
-import { splitUnquotedString } from "./utils.js";
-/**
- * This exists so that TypeDoc can store a unique identifier for a `ts.Symbol` without
- * keeping a reference to the `ts.Symbol` itself. This identifier should be stable across
- * runs so long as the symbol is exported from the same file.
- */
-export class ReflectionSymbolId {
-    /**
-     * This will only be used if we somehow cannot find a package.json file for
-     * source code. This is very unlikely, but if it occurs then the {@link packageName}
-     * will be set to this string, and {@link packagePath} will have the absolute path
-     * to the source file.
-     */
-    static UNKNOWN_PACKAGE = "<unknown>";
-    /**
-     * The name of the package which this symbol ID resides within.
-     */
-    packageName;
-    /**
-     * Path to the source file containing this symbol.
-     * Note that this is NOT an absolute path, but a package-relative path according
-     * to the directory containing package.json for the package name.
-     */
-    packagePath;
-    /**
-     * Qualified name of this symbol within the source file.
-     */
-    qualifiedName;
-    /**
-     * Note: This is **not** serialized. It exists for sorting by declaration order, but
-     * should not be needed when deserializing from JSON.
-     * Will be set to `Infinity` if the ID was deserialized from JSON.
-     */
-    pos = Infinity;
-    /**
-     * Note: This is **not** serialized. It exists to support detection of the differences between
-     * symbols which share declarations, but are instantiated with different type parameters.
-     * This will be `NaN` if the symbol reference is not transient.
-     * Note: This can only be non-NaN if {@link pos} is finite.
-     */
-    transientId = NaN;
-    /**
-     * Note: This is **not** serialized, only {@link packageName} and {@link packagePath} path
-     * information is preserved when serializing. This is set so that it is available to plugins
-     * when initially converting a project.
-     *
-     * @privateRemarks
-     * This is used by typedoc-plugin-dt-links to determine the path to read to get the source
-     * code of a definitely typed package.
-     */
-    fileName;
-    constructor(json) {
-        this.packageName = json.packageName;
-        this.packagePath = json.packagePath;
-        this.qualifiedName = json.qualifiedName;
-    }
-    getStableKey() {
-        if (Number.isFinite(this.pos)) {
-            return `${this.packageName}\0${this.packagePath}\0${this.qualifiedName}\0${this.pos}\0${this.transientId}`;
-        }
-        else {
-            return `${this.packageName}\0${this.packagePath}\0${this.qualifiedName}`;
-        }
-    }
-    toDeclarationReference() {
-        return {
-            resolutionStart: "global",
-            moduleSource: this.packageName,
-            symbolReference: {
-                path: splitUnquotedString(this.qualifiedName, ".").map((path) => ({
-                    navigation: ".",
-                    path,
-                })),
-            },
-        };
-    }
-    toObject() {
-        return {
-            packageName: this.packageName,
-            packagePath: this.packagePath,
-            qualifiedName: this.qualifiedName,
-        };
-    }
-}

package/dist/lib/models/SignatureReflection.js

@@ -1,96 +0,0 @@
-import { ReflectionType } from "./types.js";
-import { Reflection, TraverseProperty } from "./Reflection.js";
-import { SourceReference } from "./SourceReference.js";
-/**
- * @category Reflections
- */
-export class SignatureReflection extends Reflection {
-    variant = "signature";
-    // ESLint is wrong, we're restricting types to be more narrow.
-    // eslint-disable-next-line @typescript-eslint/no-useless-constructor
-    constructor(name, kind, parent) {
-        super(name, kind, parent);
-    }
-    /**
-     * A list of all source files that contributed to this reflection.
-     */
-    sources;
-    parameters;
-    typeParameters;
-    type;
-    /**
-     * 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;
-    traverse(callback) {
-        if (this.type instanceof ReflectionType) {
-            if (callback(this.type.declaration, TraverseProperty.TypeLiteral) === false) {
-                return;
-            }
-        }
-        for (const parameter of this.typeParameters?.slice() || []) {
-            if (callback(parameter, TraverseProperty.TypeParameter) === false) {
-                return;
-            }
-        }
-        for (const parameter of this.parameters?.slice() || []) {
-            if (callback(parameter, TraverseProperty.Parameters) === false) {
-                return;
-            }
-        }
-    }
-    isSignature() {
-        return true;
-    }
-    /**
-     * 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,
-            sources: serializer.toObjectsOptional(this.sources),
-            typeParameters: serializer.toObjectsOptional(this.typeParameters),
-            parameters: serializer.toObjectsOptional(this.parameters),
-            type: serializer.toObject(this.type),
-            overwrites: serializer.toObject(this.overwrites),
-            inheritedFrom: serializer.toObject(this.inheritedFrom),
-            implementationOf: serializer.toObject(this.implementationOf),
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        this.sources = de.reviveMany(obj.sources, (t) => new SourceReference(t.fileName, t.line, t.character));
-        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);
-        this.inheritedFrom = de.reviveType(obj.inheritedFrom);
-        this.implementationOf = de.reviveType(obj.implementationOf);
-    }
-}

package/dist/lib/models/SourceReference.js

@@ -1,50 +0,0 @@
-/**
- * Represents references of reflections to their defining source files.
- *
- * @see {@link DeclarationReflection.sources}
- */
-export class SourceReference {
-    /**
-     * The filename of the source file.
-     */
-    fileName;
-    /**
-     * The absolute filename of the source file.
-     * @internal
-     */
-    fullFileName;
-    /**
-     * The one based number of the line that emitted the declaration.
-     */
-    line;
-    /**
-     * The index of the character that emitted the declaration.
-     */
-    character;
-    /**
-     * URL for displaying the source file.
-     */
-    url;
-    constructor(fileName, line, character) {
-        this.fileName = fileName;
-        this.fullFileName = fileName;
-        this.line = line;
-        this.character = character;
-    }
-    equals(other) {
-        return (this.fullFileName == other.fullFileName &&
-            this.line === other.line &&
-            this.character === other.character);
-    }
-    toObject() {
-        return {
-            fileName: this.fileName,
-            line: this.line,
-            character: this.character,
-            url: this.url,
-        };
-    }
-    fromObject(_de, obj) {
-        this.url = obj.url;
-    }
-}

package/dist/lib/models/TypeParameterReflection.js

@@ -1,45 +0,0 @@
-import { Reflection } from "./Reflection.js";
-import { ReflectionKind } from "./kind.js";
-/**
- * Modifier flags for type parameters, added in TS 4.7
- * @enum
- */
-export const VarianceModifier = {
-    in: "in",
-    out: "out",
-    inOut: "in out",
-};
-/**
- * @category Reflections
- */
-export class TypeParameterReflection extends Reflection {
-    variant = "typeParam";
-    type;
-    default;
-    varianceModifier;
-    constructor(name, parent, varianceModifier) {
-        super(name, ReflectionKind.TypeParameter, parent);
-        this.varianceModifier = varianceModifier;
-    }
-    isTypeParameter() {
-        return true;
-    }
-    toObject(serializer) {
-        return {
-            ...super.toObject(serializer),
-            variant: this.variant,
-            type: serializer.toObject(this.type),
-            default: serializer.toObject(this.default),
-            varianceModifier: this.varianceModifier,
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        this.type = de.reviveType(obj.type);
-        this.default = de.reviveType(obj.default);
-        this.varianceModifier = obj.varianceModifier;
-    }
-    traverse(_callback) {
-        // do nothing, no child reflections.
-    }
-}

package/dist/lib/models/index.js

@@ -1,19 +0,0 @@
-export * from "./Comment.js";
-export * from "./ContainerReflection.js";
-export * from "./DeclarationReflection.js";
-export * from "./DocumentReflection.js";
-export * from "./FileRegistry.js";
-export * from "./kind.js";
-export * from "./ParameterReflection.js";
-export { ProjectReflection } from "./ProjectReflection.js";
-export * from "./ReferenceReflection.js";
-export * from "./Reflection.js";
-export * from "./ReflectionCategory.js";
-export * from "./ReflectionGroup.js";
-export * from "./ReflectionSymbolId.js";
-export * from "./SignatureReflection.js";
-export * from "./SourceReference.js";
-export * from "./TypeParameterReflection.js";
-export * from "./types.js";
-export * from "./utils.js";
-export * from "./variant.js";

package/dist/lib/models/kind.js

@@ -1,231 +0,0 @@
-import { i18n } from "#utils";
-/**
- * Defines the available reflection kinds.
- * @category Reflections
- */
-export var ReflectionKind;
-(function (ReflectionKind) {
-    ReflectionKind[ReflectionKind["Project"] = 1] = "Project";
-    ReflectionKind[ReflectionKind["Module"] = 2] = "Module";
-    ReflectionKind[ReflectionKind["Namespace"] = 4] = "Namespace";
-    ReflectionKind[ReflectionKind["Enum"] = 8] = "Enum";
-    ReflectionKind[ReflectionKind["EnumMember"] = 16] = "EnumMember";
-    ReflectionKind[ReflectionKind["Variable"] = 32] = "Variable";
-    ReflectionKind[ReflectionKind["Function"] = 64] = "Function";
-    ReflectionKind[ReflectionKind["Class"] = 128] = "Class";
-    ReflectionKind[ReflectionKind["Interface"] = 256] = "Interface";
-    ReflectionKind[ReflectionKind["Constructor"] = 512] = "Constructor";
-    ReflectionKind[ReflectionKind["Property"] = 1024] = "Property";
-    ReflectionKind[ReflectionKind["Method"] = 2048] = "Method";
-    ReflectionKind[ReflectionKind["CallSignature"] = 4096] = "CallSignature";
-    ReflectionKind[ReflectionKind["IndexSignature"] = 8192] = "IndexSignature";
-    ReflectionKind[ReflectionKind["ConstructorSignature"] = 16384] = "ConstructorSignature";
-    ReflectionKind[ReflectionKind["Parameter"] = 32768] = "Parameter";
-    ReflectionKind[ReflectionKind["TypeLiteral"] = 65536] = "TypeLiteral";
-    ReflectionKind[ReflectionKind["TypeParameter"] = 131072] = "TypeParameter";
-    ReflectionKind[ReflectionKind["Accessor"] = 262144] = "Accessor";
-    ReflectionKind[ReflectionKind["GetSignature"] = 524288] = "GetSignature";
-    ReflectionKind[ReflectionKind["SetSignature"] = 1048576] = "SetSignature";
-    ReflectionKind[ReflectionKind["TypeAlias"] = 2097152] = "TypeAlias";
-    ReflectionKind[ReflectionKind["Reference"] = 4194304] = "Reference";
-    /**
-     * Generic non-ts content to be included in the generated docs as its own page.
-     */
-    ReflectionKind[ReflectionKind["Document"] = 8388608] = "Document";
-})(ReflectionKind || (ReflectionKind = {}));
-/** @category Reflections */
-(function (ReflectionKind) {
-    /** @internal */
-    ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
-    /** @internal */
-    ReflectionKind.ClassOrInterface = ReflectionKind.Class | ReflectionKind.Interface;
-    /** @internal */
-    ReflectionKind.VariableOrProperty = ReflectionKind.Variable | ReflectionKind.Property;
-    /** @internal */
-    ReflectionKind.FunctionOrMethod = ReflectionKind.Function | ReflectionKind.Method;
-    /** @internal */
-    ReflectionKind.ClassMember = ReflectionKind.Accessor |
-        ReflectionKind.Constructor |
-        ReflectionKind.Method |
-        ReflectionKind.Property;
-    /** @internal */
-    ReflectionKind.SomeSignature = ReflectionKind.CallSignature |
-        ReflectionKind.IndexSignature |
-        ReflectionKind.ConstructorSignature |
-        ReflectionKind.GetSignature |
-        ReflectionKind.SetSignature;
-    /** @internal */
-    ReflectionKind.SomeModule = ReflectionKind.Namespace | ReflectionKind.Module;
-    /** @internal */
-    ReflectionKind.SomeType = ReflectionKind.Interface |
-        ReflectionKind.TypeLiteral |
-        ReflectionKind.TypeParameter |
-        ReflectionKind.TypeAlias;
-    /** @internal */
-    ReflectionKind.SomeValue = ReflectionKind.Variable | ReflectionKind.Function;
-    /** @internal */
-    ReflectionKind.SomeMember = ReflectionKind.EnumMember |
-        ReflectionKind.Property |
-        ReflectionKind.Method |
-        ReflectionKind.Accessor;
-    /** @internal */
-    ReflectionKind.SomeExport = ReflectionKind.Module |
-        ReflectionKind.Namespace |
-        ReflectionKind.Enum |
-        ReflectionKind.Variable |
-        ReflectionKind.Function |
-        ReflectionKind.Class |
-        ReflectionKind.Interface |
-        ReflectionKind.TypeAlias |
-        ReflectionKind.Reference;
-    /** @internal */
-    ReflectionKind.MayContainDocuments = ReflectionKind.SomeExport | ReflectionKind.Project | ReflectionKind.Document;
-    /** @internal */
-    ReflectionKind.ExportContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
-    /** @internal */
-    ReflectionKind.Inheritable = ReflectionKind.Accessor |
-        ReflectionKind.IndexSignature |
-        ReflectionKind.Property |
-        ReflectionKind.Method |
-        ReflectionKind.Constructor;
-    /** @internal */
-    ReflectionKind.ContainsCallSignatures = ReflectionKind.Constructor |
-        ReflectionKind.Function |
-        ReflectionKind.Method;
-    // The differences between Type/Value here only really matter for
-    // possibly merged declarations where we have multiple reflections.
-    /** @internal */
-    ReflectionKind.TypeReferenceTarget = ReflectionKind.Interface |
-        ReflectionKind.TypeAlias |
-        ReflectionKind.Class |
-        ReflectionKind.Enum;
-    /** @internal */
-    ReflectionKind.ValueReferenceTarget = ReflectionKind.Module |
-        ReflectionKind.Namespace |
-        ReflectionKind.Variable |
-        ReflectionKind.Function;
-    /**
-     * Note: This does not include Class/Interface, even though they technically could contain index signatures
-     * @internal
-     */
-    ReflectionKind.SignatureContainer = ReflectionKind.ContainsCallSignatures | ReflectionKind.Accessor;
-    /** @internal */
-    ReflectionKind.VariableContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
-    /** @internal */
-    ReflectionKind.MethodContainer = ReflectionKind.ClassOrInterface |
-        ReflectionKind.VariableOrProperty |
-        ReflectionKind.FunctionOrMethod |
-        ReflectionKind.TypeLiteral;
-    function singularString(kind) {
-        switch (kind) {
-            case ReflectionKind.Project:
-                return i18n.kind_project();
-            case ReflectionKind.Module:
-                return i18n.kind_module();
-            case ReflectionKind.Namespace:
-                return i18n.kind_namespace();
-            case ReflectionKind.Enum:
-                return i18n.kind_enum();
-            case ReflectionKind.EnumMember:
-                return i18n.kind_enum_member();
-            case ReflectionKind.Variable:
-                return i18n.kind_variable();
-            case ReflectionKind.Function:
-                return i18n.kind_function();
-            case ReflectionKind.Class:
-                return i18n.kind_class();
-            case ReflectionKind.Interface:
-                return i18n.kind_interface();
-            case ReflectionKind.Constructor:
-                return i18n.kind_constructor();
-            case ReflectionKind.Property:
-                return i18n.kind_property();
-            case ReflectionKind.Method:
-                return i18n.kind_method();
-            case ReflectionKind.CallSignature:
-                return i18n.kind_call_signature();
-            case ReflectionKind.IndexSignature:
-                return i18n.kind_index_signature();
-            case ReflectionKind.ConstructorSignature:
-                return i18n.kind_constructor_signature();
-            case ReflectionKind.Parameter:
-                return i18n.kind_parameter();
-            case ReflectionKind.TypeLiteral:
-                return i18n.kind_type_literal();
-            case ReflectionKind.TypeParameter:
-                return i18n.kind_type_parameter();
-            case ReflectionKind.Accessor:
-                return i18n.kind_accessor();
-            case ReflectionKind.GetSignature:
-                return i18n.kind_get_signature();
-            case ReflectionKind.SetSignature:
-                return i18n.kind_set_signature();
-            case ReflectionKind.TypeAlias:
-                return i18n.kind_type_alias();
-            case ReflectionKind.Reference:
-                return i18n.kind_reference();
-            case ReflectionKind.Document:
-                return i18n.kind_document();
-        }
-    }
-    ReflectionKind.singularString = singularString;
-    function pluralString(kind) {
-        switch (kind) {
-            case ReflectionKind.Project:
-                return i18n.kind_plural_project();
-            case ReflectionKind.Module:
-                return i18n.kind_plural_module();
-            case ReflectionKind.Namespace:
-                return i18n.kind_plural_namespace();
-            case ReflectionKind.Enum:
-                return i18n.kind_plural_enum();
-            case ReflectionKind.EnumMember:
-                return i18n.kind_plural_enum_member();
-            case ReflectionKind.Variable:
-                return i18n.kind_plural_variable();
-            case ReflectionKind.Function:
-                return i18n.kind_plural_function();
-            case ReflectionKind.Class:
-                return i18n.kind_plural_class();
-            case ReflectionKind.Interface:
-                return i18n.kind_plural_interface();
-            case ReflectionKind.Constructor:
-                return i18n.kind_plural_constructor();
-            case ReflectionKind.Property:
-                return i18n.kind_plural_property();
-            case ReflectionKind.Method:
-                return i18n.kind_plural_method();
-            case ReflectionKind.CallSignature:
-                return i18n.kind_plural_call_signature();
-            case ReflectionKind.IndexSignature:
-                return i18n.kind_plural_index_signature();
-            case ReflectionKind.ConstructorSignature:
-                return i18n.kind_plural_constructor_signature();
-            case ReflectionKind.Parameter:
-                return i18n.kind_plural_parameter();
-            case ReflectionKind.TypeLiteral:
-                return i18n.kind_plural_type_literal();
-            case ReflectionKind.TypeParameter:
-                return i18n.kind_plural_type_parameter();
-            case ReflectionKind.Accessor:
-                return i18n.kind_plural_accessor();
-            case ReflectionKind.GetSignature:
-                return i18n.kind_plural_get_signature();
-            case ReflectionKind.SetSignature:
-                return i18n.kind_plural_set_signature();
-            case ReflectionKind.TypeAlias:
-                return i18n.kind_plural_type_alias();
-            case ReflectionKind.Reference:
-                return i18n.kind_plural_reference();
-            case ReflectionKind.Document:
-                return i18n.kind_plural_document();
-        }
-    }
-    ReflectionKind.pluralString = pluralString;
-    function classString(kind) {
-        return `tsd-kind-${ReflectionKind[kind]
-            .replace(/(.)([A-Z])/g, (_m, a, b) => `${a}-${b}`)
-            .toLowerCase()}`;
-    }
-    ReflectionKind.classString = classString;
-})(ReflectionKind || (ReflectionKind = {}));