typedoc 0.27.9 → 0.28.0-beta.1

package/tsdoc.json

@@ -116,6 +116,10 @@
             "tagName": "@inline",
             "syntaxKind": "modifier"
         },
+        {
+            "tagName": "@primaryExport",
+            "syntaxKind": "modifier"
+        },
         {
             "tagName": "@template",
             "syntaxKind": "block",
@@ -177,6 +181,10 @@
             "tagName": "@interface",
             "syntaxKind": "modifier"
         },
+        {
+            "tagName": "@function",
+            "syntaxKind": "modifier"
+        },
         {
             "tagName": "@showCategories",
             "syntaxKind": "modifier"

package/dist/lib/debug/debugRendererUrls.js

@@ -1,59 +0,0 @@
-/* eslint-disable no-console */
-import { join } from "node:path";
-import { Reflection, ReflectionKind, } from "../models/index.js";
-const serializer = {
-    priority: 0,
-    supports(x) {
-        return x instanceof Reflection;
-    },
-    toObject(item, obj) {
-        obj.url = item.url;
-        obj.hasOwnDocument = item.hasOwnDocument;
-        // obj.anchor = item.anchor;
-        delete obj.sources;
-        delete obj.groups;
-        delete obj.categories;
-        delete obj.readme;
-        delete obj.content;
-        obj.kind = ReflectionKind[obj.kind];
-        delete obj.flags;
-        delete obj.defaultValue;
-        delete obj.symbolIdMap;
-        delete obj.files;
-        delete obj.packageName;
-        delete obj.variant;
-        delete obj.extendedTypes;
-        delete obj.inheritedFrom;
-        if (!["reflection", "reference"].includes(obj.type?.type)) {
-            delete obj.type;
-        }
-        if (obj.comment) {
-            obj.comment.summary = obj.comment.summary.filter((part) => part.kind === "inline-tag");
-            obj.comment.blockTags = obj.comment.blockTags?.filter((tag) => {
-                tag.content = tag.content.filter((part) => part.kind === "inline-tag");
-                return tag.content.length;
-            });
-            if (!obj.comment.summary.length &&
-                !obj.comment.blockTags?.length &&
-                !obj.comment.modifierTags) {
-                delete obj.comment;
-            }
-        }
-        return obj;
-    },
-};
-export function debugRendererUrls(app, { json = false, logs = false } = { logs: true }) {
-    app.renderer.postRenderAsyncJobs.push(async (evt) => {
-        if (json) {
-            app.serializer.addSerializer(serializer);
-            await app.generateJson(evt.project, join(evt.outputDirectory, "url_debug.json"));
-            app.serializer.removeSerializer(serializer);
-        }
-        if (logs) {
-            for (const id in evt.project.reflections) {
-                const refl = evt.project.reflections[id];
-                console.log(refl.id, refl.getFullName(), refl.url, refl.hasOwnDocument);
-            }
-        }
-    });
-}

package/dist/lib/internationalization/locales/jp.cjs

@@ -1,3 +0,0 @@
-"use strict";
-const ja = require("./ja.cjs");
-module.exports = ja;

package/dist/lib/internationalization/locales/jp.d.cts

@@ -1,2 +0,0 @@
-import ja = require("./ja.cjs");
-export = ja;

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

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

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

@@ -1 +0,0 @@
-export { Comment, CommentTag } from "./comment.js";

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

@@ -1,133 +0,0 @@
-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();
-/**
- * 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 {
-    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 = normalizePath(declaration?.getSourceFile().fileName ?? "");
-            if (symbol.declarations?.some(ts.isSourceFile)) {
-                this.qualifiedName = "";
-            }
-            else {
-                this.qualifiedName = getQualifiedName(symbol, symbol.name);
-            }
-            this.pos = declaration?.getStart() ?? Infinity;
-            if (symbol.flags & ts.SymbolFlags.Transient) {
-                this.transientId = transientIds.get(symbol) ?? ++transientCount;
-                transientIds.set(symbol, this.transientId);
-            }
-            else {
-                this.transientId = NaN;
-            }
-        }
-        else {
-            this.fileName = symbol.sourceFileName;
-            this.qualifiedName = symbol.qualifiedName;
-            this.pos = Infinity;
-            this.transientId = NaN;
-        }
-    }
-    getStableKey() {
-        if (Number.isFinite(this.pos)) {
-            return `${this.fileName}\0${this.qualifiedName}\0${this.pos}\0${this.transientId}`;
-        }
-        else {
-            return `${this.fileName}\0${this.qualifiedName}`;
-        }
-    }
-    toDeclarationReference() {
-        return {
-            resolutionStart: "global",
-            moduleSource: findPackageForPath(this.fileName),
-            symbolReference: {
-                path: splitUnquotedString(this.qualifiedName, ".").map((path) => ({
-                    navigation: ".",
-                    path,
-                })),
-            },
-        };
-    }
-    toObject(serializer) {
-        const sourceFileName = isAbsolute(this.fileName)
-            ? normalizePath(relative(serializer.projectRoot, resolveDeclarationMaps(this.fileName)))
-            : this.fileName;
-        return {
-            sourceFileName,
-            qualifiedName: this.qualifiedName,
-        };
-    }
-}
-const declarationMapCache = new Map();
-function resolveDeclarationMaps(file) {
-    if (!/\.d\.[cm]?ts$/.test(file))
-        return file;
-    if (declarationMapCache.has(file))
-        return declarationMapCache.get(file);
-    const mapFile = file + ".map";
-    if (!existsSync(mapFile))
-        return file;
-    let sourceMap;
-    try {
-        sourceMap = JSON.parse(readFile(mapFile));
-    }
-    catch {
-        return file;
-    }
-    if (validate({
-        file: String,
-        sourceRoot: optional(String),
-        sources: [Array, String],
-    }, sourceMap)) {
-        // There's a pretty large assumption in here that we only have
-        // 1 source file per js file. This is a pretty standard typescript approach,
-        // but people might do interesting things with transpilation that could break this.
-        let source = sourceMap.sources[0];
-        // If we have a sourceRoot, trim any leading slash from the source, and join them
-        // 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 = join(sourceMap.sourceRoot, source);
-        }
-        const result = resolve(mapFile, "..", source);
-        declarationMapCache.set(file, result);
-        return result;
-    }
-    return file;
-}
-// 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 = normalizePath(resolve(declDir, relative(rootDir, file)).replace(/\.([cm]?[tj]s)x?$/, ".d.$1"));
-        declarationMapCache.set(mapFile, file);
-    }
-}

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

@@ -1,15 +0,0 @@
-export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract.js";
-export type { ReflectionVisitor, TraverseCallback, ReflectionId, } from "./abstract.js";
-export { ContainerReflection } from "./container.js";
-export { DeclarationReflection } from "./declaration.js";
-export type { DeclarationHierarchy } from "./declaration.js";
-export { DocumentReflection } from "./document.js";
-export { ReflectionKind } from "./kind.js";
-export { ParameterReflection } from "./parameter.js";
-export { ProjectReflection } from "./project.js";
-export { ReferenceReflection } from "./reference.js";
-export { ReflectionSymbolId, type ReflectionSymbolIdString, } from "./ReflectionSymbolId.js";
-export { SignatureReflection } from "./signature.js";
-export { TypeParameterReflection, VarianceModifier } from "./type-parameter.js";
-export { splitUnquotedString } from "./utils.js";
-export type { ReflectionVariant, SomeReflection } from "./variant.js";

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

@@ -1,12 +0,0 @@
-export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract.js";
-export { ContainerReflection } from "./container.js";
-export { DeclarationReflection } from "./declaration.js";
-export { DocumentReflection } from "./document.js";
-export { ReflectionKind } from "./kind.js";
-export { ParameterReflection } from "./parameter.js";
-export { ProjectReflection } from "./project.js";
-export { ReferenceReflection } from "./reference.js";
-export { ReflectionSymbolId, } from "./ReflectionSymbolId.js";
-export { SignatureReflection } from "./signature.js";
-export { TypeParameterReflection, VarianceModifier } from "./type-parameter.js";
-export { splitUnquotedString } from "./utils.js";

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

@@ -1 +0,0 @@
-export { SourceReference } from "./file.js";

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

@@ -1 +0,0 @@
-export { SourceReference } from "./file.js";

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

@@ -1,13 +0,0 @@
-import type { JSX } from "../../utils/index.js";
-import type { PageEvent } from "../events.js";
-export declare class UrlMapping<Model = any> {
-    url: string;
-    model: Model;
-    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;

package/dist/lib/output/models/UrlMapping.js

@@ -1,10 +0,0 @@
-export class UrlMapping {
-    url;
-    model;
-    template;
-    constructor(url, model, template) {
-        this.url = url;
-        this.model = model;
-        this.template = template;
-    }
-}