ardo 3.0.5 → 3.2.0

package/dist/typedoc/index.d.ts

@@ -1,315 +1,46 @@
-import { Plugin } from 'vite';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-
-interface TypeDocConfig {
-    /**
-     * Enable TypeDoc API documentation generation
-     * @default false
-     */
-    enabled?: boolean;
-    /**
-     * Entry points for TypeDoc (source files or directories)
-     */
-    entryPoints: string[];
-    /**
-     * Path to tsconfig.json
-     */
-    tsconfig?: string;
-    /**
-     * Output directory for generated markdown files (relative to srcDir)
-     * @default 'api'
-     */
-    out?: string;
-    /**
-     * Include README in the API docs
-     * @default false
-     */
-    readme?: string | "none";
-    /**
-     * Plugin options passed to TypeDoc
-     */
-    plugin?: string[];
-    /**
-     * Exclude patterns
-     */
-    exclude?: string[];
-    /**
-     * Exclude external modules
-     * @default true
-     */
-    excludeExternals?: boolean;
-    /**
-     * Exclude private members
-     * @default true
-     */
-    excludePrivate?: boolean;
-    /**
-     * Exclude protected members
-     * @default false
-     */
-    excludeProtected?: boolean;
-    /**
-     * Exclude internal members (marked with @internal)
-     * @default true
-     */
-    excludeInternal?: boolean;
-    /**
-     * Sort order for members
-     * @default ['source-order']
-     */
-    sort?: Array<"source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "required-first" | "visibility">;
-    /**
-     * Category order for organizing API docs
-     */
-    categoryOrder?: string[];
-    /**
-     * Group order for organizing API docs
-     */
-    groupOrder?: string[];
-    /**
-     * Watch mode for development
-     * @default false
-     */
-    watch?: boolean;
-    /**
-     * Custom sidebar configuration for API docs
-     */
-    sidebar?: {
-        /**
-         * Title for the API section in sidebar
-         * @default 'API Reference'
-         */
-        title?: string;
-        /**
-         * Position in sidebar (lower = higher in list)
-         * @default 100
-         */
-        position?: number;
-        /**
-         * Whether the API section should be collapsed by default
-         * @default false
-         */
-        collapsed?: boolean;
-    };
-    /**
-     * Transform options for generated markdown
-     */
-    markdown?: {
-        /**
-         * Include breadcrumbs in generated pages
-         * @default true
-         */
-        breadcrumbs?: boolean;
-        /**
-         * Include type hierarchy for classes/interfaces
-         * @default true
-         */
-        hierarchy?: boolean;
-        /**
-         * Include source links to GitHub/GitLab
-         * @default true
-         */
-        sourceLinks?: boolean;
-        /**
-         * Base URL for source links
-         */
-        sourceBaseUrl?: string;
-        /**
-         * Use code blocks for type signatures
-         * @default true
-         */
-        codeBlocks?: boolean;
-    };
-}
-interface ApiDocItem {
-    id: string;
-    name: string;
-    kind: ApiDocKind;
-    description?: string;
-    signature?: string;
-    parameters?: ApiDocParameter[];
-    returns?: ApiDocReturn;
-    examples?: string[];
-    tags?: ApiDocTag[];
-    children?: ApiDocItem[];
-    source?: ApiDocSource;
-    typeParameters?: ApiDocTypeParameter[];
-    hierarchy?: ApiDocHierarchy;
-}
-type ApiDocKind = "module" | "namespace" | "class" | "interface" | "type" | "enum" | "function" | "variable" | "property" | "method" | "accessor" | "constructor" | "parameter" | "typeParameter" | "enumMember";
-interface ApiDocParameter {
-    name: string;
-    type: string;
-    description?: string;
-    optional?: boolean;
-    defaultValue?: string;
-}
-interface ApiDocReturn {
-    type: string;
-    description?: string;
-}
-interface ApiDocTag {
-    name: string;
-    value?: string;
-}
-interface ApiDocSource {
-    file: string;
-    line: number;
-    url?: string;
-}
-interface ApiDocTypeParameter {
-    name: string;
-    constraint?: string;
-    default?: string;
-    description?: string;
-}
-interface ApiDocHierarchy {
-    extends?: string[];
-    implements?: string[];
-    extendedBy?: string[];
-    implementedBy?: string[];
-}
-interface GeneratedApiDoc {
-    path: string;
-    content: string;
-    frontmatter: {
-        title: string;
-        description?: string;
-        sidebar_position?: number;
-        sidebar?: boolean;
-    };
-}
+import { a as ApiDocReturn, c as ApiDocTypeParameter, i as ApiDocParameter, l as GeneratedApiDoc, n as ApiDocItem, o as ApiDocSource, r as ApiDocKind, s as ApiDocTag, t as ApiDocHierarchy, u as TypeDocConfig } from "../types-DAZHcySL.js";
+import { Plugin } from "vite";
 
+//#region src/typedoc/generator.d.ts
 declare class TypeDocGenerator {
-    private config;
-    private app;
-    private project;
-    private basePath;
-    private packageNameCache;
-    constructor(config: TypeDocConfig);
-    generate(outputDir: string): Promise<GeneratedApiDoc[]>;
-    private generateMarkdownDocs;
-    private generateCategoryIndexPages;
-    private generateGroupedFunctionsPage;
-    private generateGroupedTypesPage;
-    private resolvePackageName;
-    private getModuleNameFromPath;
-    private generateIndexPage;
-    private getKindGroupName;
-    private generateReflectionDocs;
-    private generateReflectionPage;
-    private renderSignature;
-    private renderProperty;
-    private renderMethod;
-    private renderTypeParameters;
-    private renderHierarchy;
-    private renderComment;
-    private renderCommentShort;
-    private generateBreadcrumbs;
-    private getKindName;
-    private getGroupUrlPrefix;
-    private getSlug;
-    /**
-     * Build a route-compatible link path for a category/slug pair.
-     * React Router maps "category/index.md" to the "/category" route,
-     * so links must not include a trailing "/index".
-     */
-    private buildLink;
-    private getSourceUrl;
-    /**
-     * Check if a function name looks like a React component (PascalCase)
-     */
-    private isReactComponent;
-    /**
-     * Generate a page for a React component
-     */
-    private generateComponentPage;
-    /**
-     * Get the name of a TypeDoc type (handles reference types, etc.)
-     */
-    private getTypeName;
-    /**
-     * Get props from a component's parameter type
-     */
-    private getPropsFromType;
-    /**
-     * Render a component signature in a more readable format
-     */
-    private renderComponentSignature;
+  private readonly basePath;
+  private readonly config;
+  private readonly packageNameCache;
+  constructor(config: TypeDocConfig);
+  generate(outputDir: string): Promise<GeneratedApiDoc[]>;
+  private populatePackageNameCache;
+  private resolvePackageName;
+  private writeDocs;
+  private writeSingleDoc;
 }
 declare function generateApiDocs(config: TypeDocConfig, outputDir: string): Promise<GeneratedApiDoc[]>;
-
+//#endregion
+//#region src/typedoc/vite-plugin.d.ts
 interface TypeDocPluginOptions extends Partial<TypeDocConfig> {
-    /**
-     * Content directory where markdown files are stored
-     * @default './content'
-     */
-    contentDir?: string;
-    /**
-     * Run TypeDoc on every build
-     * @default false in dev, true in build
-     */
-    runOnBuild?: boolean;
-    /**
-     * Run TypeDoc on startup
-     * @default true
-     */
-    runOnStart?: boolean;
+  /**
+   * Content directory where markdown files are stored
+   * @default './content'
+   */
+  contentDir?: string;
+  /**
+   * Run TypeDoc on every build
+   * @default false in dev, true in build
+   */
+  runOnBuild?: boolean;
+  /**
+   * Run TypeDoc on startup
+   * @default true
+   */
+  runOnStart?: boolean;
 }
 /**
  * Vite plugin for generating API documentation with TypeDoc.
- *
- * @example
- * ```ts
- * // Minimal config (uses ./src/index.ts as entry point)
- * typedocPlugin()
- *
- * // Custom entry point
- * typedocPlugin({ entryPoints: ['./lib/index.ts'] })
- *
- * // Full config
- * typedocPlugin({
- *   entryPoints: ['./src/index.ts'],
- *   out: 'api-reference',
- *   excludePrivate: true,
- * })
- * ```
  */
 declare function typedocPlugin(options?: TypeDocPluginOptions): Plugin;
 declare function createTypedocWatcher(config: TypeDocConfig, contentDir: string, onChange?: () => void): {
-    start: () => Promise<void>;
-    stop: () => void;
+  start: () => void;
+  stop: () => void;
 };
-
-interface ApiSignatureProps {
-    name: string;
-    typeParameters?: ApiDocTypeParameter[];
-    parameters?: ApiDocParameter[];
-    returns?: ApiDocReturn;
-    className?: string;
-}
-declare function ApiSignature({ name, typeParameters, parameters, returns, className, }: ApiSignatureProps): react_jsx_runtime.JSX.Element;
-interface ApiParametersTableProps {
-    parameters: ApiDocParameter[];
-}
-declare function ApiParametersTable({ parameters }: ApiParametersTableProps): react_jsx_runtime.JSX.Element | null;
-interface ApiReturnsProps {
-    returns: ApiDocReturn;
-}
-declare function ApiReturns({ returns }: ApiReturnsProps): react_jsx_runtime.JSX.Element;
-
-interface ApiItemProps {
-    item: ApiDocItem;
-    level?: number;
-}
-declare function ApiItem({ item, level }: ApiItemProps): react_jsx_runtime.JSX.Element;
-interface ApiKindBadgeProps {
-    kind: ApiDocKind;
-}
-declare function ApiKindBadge({ kind }: ApiKindBadgeProps): react_jsx_runtime.JSX.Element;
-interface ApiHierarchyProps {
-    hierarchy: ApiDocItem["hierarchy"];
-}
-declare function ApiHierarchy({ hierarchy }: ApiHierarchyProps): react_jsx_runtime.JSX.Element | null;
-
-export { type ApiDocHierarchy, type ApiDocItem, type ApiDocKind, type ApiDocParameter, type ApiDocReturn, type ApiDocSource, type ApiDocTag, type ApiDocTypeParameter, ApiHierarchy, ApiItem, ApiKindBadge, ApiParametersTable, ApiReturns, ApiSignature, type GeneratedApiDoc, type TypeDocConfig, TypeDocGenerator, type TypeDocPluginOptions, createTypedocWatcher, generateApiDocs, typedocPlugin };
+//#endregion
+export { type ApiDocHierarchy, type ApiDocItem, type ApiDocKind, type ApiDocParameter, type ApiDocReturn, type ApiDocSource, type ApiDocTag, type ApiDocTypeParameter, type GeneratedApiDoc, type TypeDocConfig, TypeDocGenerator, type TypeDocPluginOptions, createTypedocWatcher, generateApiDocs, typedocPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/typedoc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/typedoc/generator.ts","../../src/typedoc/vite-plugin.ts"],"mappings":";;;;cAea,gBAAA;EAAA,iBACM,QAAA;EAAA,iBACA,MAAA;EAAA,iBACA,gBAAA;cAEL,MAAA,EAAQ,aAAA;EAKd,QAAA,CAAS,SAAA,WAAoB,OAAA,CAAQ,eAAA;EAAA,QAyB7B,wBAAA;EAAA,QAMA,kBAAA;EAAA,QAkBA,SAAA;EAAA,QAUA,cAAA;AAAA;AAAA,iBA4BM,eAAA,CACpB,MAAA,EAAQ,aAAA,EACR,SAAA,WACC,OAAA,CAAQ,eAAA;;;UC1GM,oBAAA,SAA6B,OAAA,CAAQ,aAAA;;ADMtD;;;ECDE,UAAA;EDW2C;;;;ECL3C,UAAA;EDHiB;;;;ECSjB,UAAA;AAAA;;;;iBAMc,aAAA,CAAc,OAAA,GAAS,oBAAA,GAA4B,MAAA;AAAA,iBAiGnD,oBAAA,CACd,MAAA,EAAQ,aAAA,EACR,UAAA,UACA,QAAA;EACG,KAAA;EAAmB,IAAA;AAAA"}