docusaurus-plugin-llms-builder/dist/index.d.ts

A Docusaurus plugin for generating standardized LLM configuration files (llms.txt, llms-full.txt)

import { Hookable } from "hookable";
import { LoadContext, Plugin } from "@docusaurus/types";

//#region src/types.d.ts
// External link configuration
type ExternalLink = {
  title: string;
  link: string;
  description?: string;
};
// Document information

/*
* Optional: A custom sort function to order files.
* This function takes two absolute file paths (strings) as input and should return a number.
* - Return a negative value if `fileA` should come before `fileB`.
* - Return a positive value if `fileA` should come after `fileB`.
* - Return zero if their order doesn't matter relative to each other.
* If provided, this function takes precedence over `orderByPatterns`.
* @param fileA The first absolute file path for comparison.
* @param fileB The second absolute file path for comparison.
* @returns A number indicating the sort order.
* @example
* ```ts
* // Sort files by filename length (shortest first)
* sortFunction: (fileA, fileB) => require('path').basename(fileA).length - require('path').basename(fileB).length
* ```
*/
type SortFunction = (fileA: string, fileB: string) => number;
// File pattern configuration
type FilePatternConfiguration = {
  /**
  * Optional: Patterns to ignore when processing files (e.g. ['test/**'])
  */
  ignorePatterns?: string[];
  /**
  * Optional: Patterns to include when processing files (e.g. ['docs/**'])
  * Only process .md and .mdx files
  */
  includePatterns?: string[];
  /**
  * Optional: Patterns to order when processing files
  */
  orderPatterns?: string[] | SortFunction;
};
// Header configuration
type HeaderConfiguration = {
  /**
  * Optional: Header title
  */
  title?: string;
  /**
  * Optional: Header description
  */
  description?: string;
  /**
  * Optional: Header summary
  */
  summary?: string;
};
/**
* HTML parser result
*/

/**
* Content session configuration, supports sidebar and pattern-based content retrieval
*/
type ContentSession = {
  type: "docs";
  sessionName?: string;
  docsDir: string;
  /**
  * Optional: Configuration for file patterns and traversal method
  */
  patterns?: FilePatternConfiguration;
  /**
  * Optional: Whether to use sitemap for file discovery instead of recursive traversal
  * @default false
  */
  sitemap?: string;
} | {
  type: "blog";
  sessionName?: string;
  docsDir: string;
  /**
  * Optional: Configuration for file patterns and traversal method
  */
  patterns?: FilePatternConfiguration;
  /**
  * Optional: Whether to use sitemap for file discovery instead of recursive traversal
  * @default false
  */
  rss?: string;
};
// Document configuration
type DocumentConfiguration = HeaderConfiguration & {
  sessions: ContentSession[];
};
// Session files

// Additional session
type AdditionalSession = {
  sessionName: string;
  extraLinks: ExternalLink[];
};
// Common configuration
type CommonConfiguration = {
  infixName?: string;
  /**
  * Whether to generate llms.txt file (default: true)
  */
  generateLLMsTxt?: boolean;
  /**
  * Whether to generate llms-full.txt file (default: true)
  */
  generateLLMsFullTxt?: boolean;
  /**
  * Optional: Additional external links or references to include
  */
  extraSession?: AdditionalSession;
  /**
  * Optional: Hooks for customizing the build process
  */
  hooks?: Partial<LLMsHooks> | ((hooks: Hookable<LLMsHooks>) => Awaitable<void>);
};
// Content configuration
type ContentConfiguration = DocumentConfiguration & CommonConfiguration;
// Interface for a single LLM session item containing title, link and optional description
type LLMSessionItem = {
  title: string;
  link: string;
  description?: string;
};
// Interface for an LLM session containing session name and array of items
type LLMSession = {
  sessionName: string;
  source: "sitemap" | "rss" | "normal";
  items: LLMSessionItem[];
};
// Interface for standard LLM configuration with metadata and sessions
type LLMStdConfig = {
  title: string;
  description: string;
  summary?: string;
  sessions: LLMSession[];
};
// Interface for a full LLM session item containing title and content
type LLMFullSessionItem = {
  title?: string;
  link: string;
  content: string;
};
// Interface for full LLM configuration with metadata and full content sessions
type LLMFullStdConfig = {
  title: string;
  description: string;
  summary?: string;
  // Set of URLs from previously processed sessions for filtering
  processedUrls: Set<string>;
  sessions: LLMFullSessionItem[];
};
// Combined output configuration type containing both standard and full configs
type LLMOutputConfig = {
  llmStdConfig: LLMStdConfig;
  llmFullStdConfig: LLMFullStdConfig;
};
type Awaitable<T> = T | Promise<T>;
type BuildContext = {
  llmConfig: LLMOutputConfig;
  hooks: Hookable<LLMsHooks>;
};
type LLMsHooks = {
  "generate:prepare": (ctx: BuildContext) => void | Promise<void>;
};
/**
* Plugin options for configuring LLM builder functionality
* Defines settings for generating LLM files, directory traversal, and metadata processing
*/
type PluginOptions = {
  version: string;
  llmConfigs: ContentConfiguration[];
}; //#endregion
//#region src/index.d.ts
declare function defineDocusaurusPlugins(context: LoadContext, options: PluginOptions): Plugin<void>;

//#endregion
export { PluginOptions, defineDocusaurusPlugins as default };