typedoc 0.26.11 → 0.27.0-beta.1

package/dist/lib/models/comments/index.d.ts

@@ -1,2 +1,2 @@
-export { Comment, CommentTag } from "./comment";
-export type { CommentDisplayPart, InlineTagDisplayPart, RelativeLinkDisplayPart, } from "./comment";
+export { Comment, CommentTag } from "./comment.js";
+export type { CommentDisplayPart, InlineTagDisplayPart, RelativeLinkDisplayPart, } from "./comment.js";

package/dist/lib/models/comments/index.js

@@ -1,6 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommentTag = exports.Comment = void 0;
-var comment_1 = require("./comment");
-Object.defineProperty(exports, "Comment", { enumerable: true, get: function () { return comment_1.Comment; } });
-Object.defineProperty(exports, "CommentTag", { enumerable: true, get: function () { return comment_1.CommentTag; } });
+export { Comment, CommentTag } from "./comment.js";

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

@@ -1,7 +1,7 @@
-export * from "./reflections/index";
-export * from "./types";
-export * from "./comments/index";
-export * from "./sources/index";
-export * from "./ReflectionGroup";
-export * from "./ReflectionCategory";
-export * from "./FileRegistry";
+export * from "./reflections/index.js";
+export * from "./types.js";
+export * from "./comments/index.js";
+export * from "./sources/index.js";
+export * from "./ReflectionGroup.js";
+export * from "./ReflectionCategory.js";
+export * from "./FileRegistry.js";

package/dist/lib/models/index.js

@@ -1,23 +1,7 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./reflections/index"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./comments/index"), exports);
-__exportStar(require("./sources/index"), exports);
-__exportStar(require("./ReflectionGroup"), exports);
-__exportStar(require("./ReflectionCategory"), exports);
-__exportStar(require("./FileRegistry"), exports);
+export * from "./reflections/index.js";
+export * from "./types.js";
+export * from "./comments/index.js";
+export * from "./sources/index.js";
+export * from "./ReflectionGroup.js";
+export * from "./ReflectionCategory.js";
+export * from "./FileRegistry.js";

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

@@ -1,6 +1,6 @@
 import ts from "typescript";
-import type { JSONOutput, Serializer } from "../../serialization/index";
-import type { DeclarationReference } from "../../converter/comments/declarationReference";
+import type { JSONOutput, Serializer } from "../../serialization/index.js";
+import type { DeclarationReference } from "../../converter/index.js";
 /**
  * See {@link ReflectionSymbolId}
  */

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

@@ -1,18 +1,11 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReflectionSymbolId = void 0;
-exports.addInferredDeclarationMapPaths = addInferredDeclarationMapPaths;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const typescript_1 = __importDefault(require("typescript"));
-const fs_2 = require("../../utils/fs");
-const paths_1 = require("../../utils/paths");
-const tsutils_1 = require("../../utils/tsutils");
-const validation_1 = require("../../utils/validation");
-const utils_1 = require("./utils");
+import { existsSync } from "fs";
+import { isAbsolute, join, relative, resolve } from "path";
+import ts from "typescript";
+import { findPackageForPath, getCommonDirectory, readFile, } from "../../utils/fs.js";
+import { normalizePath } from "../../utils/paths.js";
+import { getQualifiedName } from "../../utils/tsutils.js";
+import { optional, validate } from "../../utils/validation.js";
+import { splitUnquotedString } from "./utils.js";
 let transientCount = 0;
 const transientIds = new WeakMap();
 /**
@@ -20,19 +13,34 @@ const transientIds = new WeakMap();
  * 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.
  */
-class ReflectionSymbolId {
+export class ReflectionSymbolId {
+    fileName;
+    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;
+    /**
+     * 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;
     constructor(symbol, declaration) {
         if ("name" in symbol) {
             declaration ??= symbol.declarations?.[0];
-            this.fileName = (0, paths_1.normalizePath)(declaration?.getSourceFile().fileName ?? "");
-            if (symbol.declarations?.some(typescript_1.default.isSourceFile)) {
+            this.fileName = normalizePath(declaration?.getSourceFile().fileName ?? "");
+            if (symbol.declarations?.some(ts.isSourceFile)) {
                 this.qualifiedName = "";
             }
             else {
-                this.qualifiedName = (0, tsutils_1.getQualifiedName)(symbol, symbol.name);
+                this.qualifiedName = getQualifiedName(symbol, symbol.name);
             }
             this.pos = declaration?.getStart() ?? Infinity;
-            if (symbol.flags & typescript_1.default.SymbolFlags.Transient) {
+            if (symbol.flags & ts.SymbolFlags.Transient) {
                 this.transientId = transientIds.get(symbol) ?? ++transientCount;
                 transientIds.set(symbol, this.transientId);
             }
@@ -58,9 +66,9 @@ class ReflectionSymbolId {
     toDeclarationReference() {
         return {
             resolutionStart: "global",
-            moduleSource: (0, fs_2.findPackageForPath)(this.fileName),
+            moduleSource: findPackageForPath(this.fileName),
             symbolReference: {
-                path: (0, utils_1.splitUnquotedString)(this.qualifiedName, ".").map((path) => ({
+                path: splitUnquotedString(this.qualifiedName, ".").map((path) => ({
                     navigation: ".",
                     path,
                 })),
@@ -68,8 +76,8 @@ class ReflectionSymbolId {
         };
     }
     toObject(serializer) {
-        const sourceFileName = (0, path_1.isAbsolute)(this.fileName)
-            ? (0, paths_1.normalizePath)((0, path_1.relative)(serializer.projectRoot, resolveDeclarationMaps(this.fileName)))
+        const sourceFileName = isAbsolute(this.fileName)
+            ? normalizePath(relative(serializer.projectRoot, resolveDeclarationMaps(this.fileName)))
             : this.fileName;
         return {
             sourceFileName,
@@ -77,7 +85,6 @@ class ReflectionSymbolId {
         };
     }
 }
-exports.ReflectionSymbolId = ReflectionSymbolId;
 const declarationMapCache = new Map();
 function resolveDeclarationMaps(file) {
     if (!/\.d\.[cm]?ts$/.test(file))
@@ -85,18 +92,18 @@ function resolveDeclarationMaps(file) {
     if (declarationMapCache.has(file))
         return declarationMapCache.get(file);
     const mapFile = file + ".map";
-    if (!(0, fs_1.existsSync)(mapFile))
+    if (!existsSync(mapFile))
         return file;
     let sourceMap;
     try {
-        sourceMap = JSON.parse((0, fs_2.readFile)(mapFile));
+        sourceMap = JSON.parse(readFile(mapFile));
     }
     catch {
         return file;
     }
-    if ((0, validation_1.validate)({
+    if (validate({
         file: String,
-        sourceRoot: (0, validation_1.optional)(String),
+        sourceRoot: optional(String),
         sources: [Array, String],
     }, sourceMap)) {
         // There's a pretty large assumption in here that we only have
@@ -107,19 +114,20 @@ function resolveDeclarationMaps(file) {
         // Similar to how it's done at https://github.com/mozilla/source-map/blob/58819f09018d56ef84dc41ba9c93f554e0645169/lib/util.js#L412
         if (sourceMap.sourceRoot !== undefined) {
             source = source.replace(/^\//, "");
-            source = (0, path_1.join)(sourceMap.sourceRoot, source);
+            source = join(sourceMap.sourceRoot, source);
         }
-        const result = (0, path_1.resolve)(mapFile, "..", source);
+        const result = resolve(mapFile, "..", source);
         declarationMapCache.set(file, result);
         return result;
     }
     return file;
 }
-function addInferredDeclarationMapPaths(opts, files) {
-    const rootDir = opts.rootDir || (0, fs_2.getCommonDirectory)(files);
+// See also: inferEntryPoints in entry-point.ts
+export function addInferredDeclarationMapPaths(opts, files) {
+    const rootDir = opts.rootDir || getCommonDirectory(files);
     const declDir = opts.declarationDir || opts.outDir || rootDir;
     for (const file of files) {
-        const mapFile = (0, paths_1.normalizePath)((0, path_1.resolve)(declDir, (0, path_1.relative)(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1"));
+        const mapFile = normalizePath(resolve(declDir, relative(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1"));
         declarationMapCache.set(mapFile, file);
     }
 }

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

@@ -1,12 +1,14 @@
-import { Comment } from "../comments/comment";
-import type { ProjectReflection } from "./project";
-import type { NeverIfInternal } from "../../utils";
-import { ReflectionKind } from "./kind";
-import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
-import type { ReflectionVariant } from "./variant";
-import type { DeclarationReflection } from "./declaration";
-import type { DocumentReflection } from "./document";
-import type { Internationalization, TranslatedString } from "../../internationalization";
+import { Comment } from "../comments/comment.js";
+import type { ProjectReflection } from "./project.js";
+import type { NeverIfInternal } from "../../utils/index.js";
+import { ReflectionKind } from "./kind.js";
+import type { Serializer, Deserializer, JSONOutput } from "../../serialization/index.js";
+import type { ReflectionVariant } from "./variant.js";
+import type { DeclarationReflection } from "./declaration.js";
+import type { DocumentReflection } from "./document.js";
+import type { Internationalization, TranslatedString } from "../../internationalization/index.js";
+import type { ParameterReflection } from "./parameter.js";
+import type { ReferenceReflection } from "./reference.js";
 /**
  * Reset the reflection id.
  *
@@ -95,6 +97,9 @@ export interface TraverseCallback {
 export type ReflectionVisitor = {
     [K in keyof ReflectionVariant]?: (refl: ReflectionVariant[K]) => void;
 };
+export type ReflectionId = number & {
+    __reflectionIdBrand: never;
+};
 /**
  * Base class for all reflection classes.
  *
@@ -115,7 +120,7 @@ export declare abstract class Reflection {
     /**
      * Unique id of this reflection.
      */
-    id: number;
+    id: ReflectionId;
     /**
      * The symbol name of this reflection.
      */
@@ -151,11 +156,6 @@ export declare abstract class Reflection {
      * TODO: Reflections shouldn't know how they are rendered. Move this to the correct serializer.
      */
     hasOwnDocument?: boolean;
-    /**
-     * Url safe alias for this reflection.
-     */
-    private _alias?;
-    private _aliases?;
     constructor(name: string, kind: ReflectionKind, parent?: Reflection);
     /**
      * Test whether this reflection is of the given kind.
@@ -180,11 +180,6 @@ export declare abstract class Reflection {
      * Set a flag on this reflection.
      */
     setFlag(flag: ReflectionFlag, value?: boolean): void;
-    /**
-     * Return an url safe alias for this reflection.
-     */
-    getAlias(): string;
-    getUniqueAliasInPage(heading: string): string;
     /**
      * Has this reflection a visible comment?
      *
@@ -204,7 +199,9 @@ export declare abstract class Reflection {
      */
     isProject(): this is ProjectReflection;
     isDeclaration(): this is DeclarationReflection;
+    isParameter(): this is ParameterReflection;
     isDocument(): this is DocumentReflection;
+    isReference(): this is ReferenceReflection;
     /**
      * Check if this reflection or any of its parents have been marked with the `@deprecated` tag.
      */