docula 1.1.0 → 1.5.0

package/dist/docula.d.ts

@@ -52,6 +52,27 @@ type ApiGroup = {
     id: string;
     operations: ApiOperation[];
 };
+type ApiOAuth2Flow = {
+    authorizationUrl?: string;
+    tokenUrl?: string;
+    refreshUrl?: string;
+    scopes: Record<string, string>;
+};
+type ApiSecurityScheme = {
+    key: string;
+    type: string;
+    scheme?: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: string;
+    description: string;
+    flows?: {
+        authorizationCode?: ApiOAuth2Flow;
+        implicit?: ApiOAuth2Flow;
+        clientCredentials?: ApiOAuth2Flow;
+        password?: ApiOAuth2Flow;
+    };
+};
 type ApiSpecData = {
     info: {
         title: string;
@@ -63,6 +84,41 @@ type ApiSpecData = {
         description: string;
     }>;
     groups: ApiGroup[];
+    securitySchemes: ApiSecurityScheme[];
+};
+
+declare class DoculaConsole {
+    log(message: string): void;
+    error(message: string): void;
+    warn(message: string): void;
+    success(message: string): void;
+    info(message: string): void;
+    step(message: string): void;
+    fileBuilt(filePath: string): void;
+    fileCopied(filePath: string): void;
+    serverLog(method: string, url: string, statusCode: number, durationMs?: number): void;
+    banner(message: string): void;
+    printHelp(): void;
+    parseProcessArgv(argv: string[]): DoculaConsoleProcess;
+    getCommand(argv: string[]): string | undefined;
+    getArguments(argv: string[]): DoculaConsoleArguments;
+}
+type DoculaConsoleProcess = {
+    argv: string[];
+    command: string | undefined;
+    args: DoculaConsoleArguments;
+};
+type DoculaConsoleArguments = {
+    sitePath: string | undefined;
+    templatePath: string | undefined;
+    template: string | undefined;
+    output: string | undefined;
+    watch: boolean;
+    clean: boolean;
+    build: boolean;
+    port: number | undefined;
+    typescript: boolean;
+    javascript: boolean;
 };
 
 type GithubData = {
@@ -72,8 +128,10 @@ type GithubData = {
 
 type DoculaCookieAuth = {
     loginUrl: string;
-    cookieName?: string;
     logoutUrl?: string;
+    authCheckUrl?: string;
+    authCheckMethod?: string;
+    authCheckUserPath?: string;
 };
 type DoculaHeaderLink = {
     label: string;
@@ -138,10 +196,9 @@ declare class DoculaOptions {
      */
     enableReleaseChangelog: boolean;
     /**
-     * When false, the first document becomes the home page (index.html)
-     * and the home.hbs template is not rendered.
+     * Number of changelog entries to display per page on the changelog index.
      */
-    homePage: boolean;
+    changelogPerPage: number;
     /**
      * When true, generates llms.txt and llms-full.txt files for the built site.
      */
@@ -198,7 +255,10 @@ type DoculaChangelogEntry = {
     slug: string;
     content: string;
     generatedHtml: string;
+    preview: string;
+    previewImage?: string;
     urlPath: string;
+    lastModified: string;
 };
 type DoculaData = {
     siteUrl: string;
@@ -220,18 +280,23 @@ type DoculaData = {
     hasApi?: boolean;
     apiSpec?: ApiSpecData;
     changelogEntries?: DoculaChangelogEntry[];
-    homePage?: boolean;
+    hasReadme?: boolean;
     themeMode?: string;
     cookieAuth?: {
         loginUrl: string;
-        cookieName?: string;
         logoutUrl?: string;
+        authCheckUrl?: string;
+        authCheckMethod?: string;
+        authCheckUserPath?: string;
     };
     headerLinks?: Array<{
         label: string;
         url: string;
         icon?: string;
     }>;
+    enableLlmsTxt?: boolean;
+    hasFeed?: boolean;
+    lastModified?: string;
 };
 type DoculaTemplates = {
     home: string;
@@ -259,11 +324,14 @@ type DoculaDocument = {
     documentPath: string;
     urlPath: string;
     isRoot: boolean;
+    lastModified: string;
 };
 declare class DoculaBuilder {
     private readonly _options;
     private readonly _ecto;
     private readonly _console;
+    private readonly _hash;
+    onReleaseChangelog?: (entries: DoculaChangelogEntry[], console: DoculaConsole) => Promise<DoculaChangelogEntry[]> | DoculaChangelogEntry[];
     constructor(options?: DoculaOptions, engineOptions?: any);
     get options(): DoculaOptions;
     build(): Promise<void>;
@@ -273,11 +341,14 @@ declare class DoculaBuilder {
     getTemplateFile(path: string, name: string): Promise<string | undefined>;
     buildRobotsPage(options: DoculaOptions): Promise<void>;
     buildSiteMapPage(data: DoculaData): Promise<void>;
+    buildFeedPage(data: DoculaData): Promise<void>;
     buildLlmsFiles(data: DoculaData): Promise<void>;
     private generateLlmsIndexContent;
     private generateLlmsFullContent;
     private buildAbsoluteSiteUrl;
     private normalizePathForUrl;
+    private escapeXml;
+    private summarizeMarkdown;
     private isRemoteUrl;
     private resolveOpenApiSpecUrl;
     private resolveLocalOpenApiPath;
@@ -290,16 +361,19 @@ declare class DoculaBuilder {
     buildReadmeSection(data: DoculaData): Promise<string>;
     buildAnnouncementSection(data: DoculaData): Promise<string | undefined>;
     buildDocsPages(data: DoculaData): Promise<void>;
+    renderApiContent(data: DoculaData): Promise<string>;
     buildApiPage(data: DoculaData): Promise<void>;
-    getChangelogEntries(changelogPath: string): DoculaChangelogEntry[];
+    buildApiHomePage(data: DoculaData): Promise<void>;
+    getChangelogEntries(changelogPath: string, cachedEntries?: Map<string, DoculaChangelogEntry>, previousHashes?: Record<string, string>, currentHashes?: Record<string, string>): DoculaChangelogEntry[];
     parseChangelogEntry(filePath: string): DoculaChangelogEntry;
+    generateChangelogPreview(markdown: string, maxLength?: number, mdx?: boolean): string;
     convertReleaseToChangelogEntry(release: Record<string, any>): DoculaChangelogEntry;
     getReleasesAsChangelogEntries(releases: any[]): DoculaChangelogEntry[];
     buildChangelogPage(data: DoculaData): Promise<void>;
     buildChangelogEntryPages(data: DoculaData): Promise<void>;
     generateSidebarItems(data: DoculaData): DoculaSection[];
-    getDocuments(sitePath: string, doculaData: DoculaData): DoculaDocument[];
-    getDocumentInDirectory(sitePath: string): DoculaDocument[];
+    getDocuments(sitePath: string, doculaData: DoculaData, cachedDocs?: Map<string, DoculaDocument>, previousDocHashes?: Record<string, string>, currentDocHashes?: Record<string, string>): DoculaDocument[];
+    getDocumentInDirectory(sitePath: string, docsRootPath: string, cachedDocs?: Map<string, DoculaDocument>, previousDocHashes?: Record<string, string>, currentDocHashes?: Record<string, string>): DoculaDocument[];
     getSections(sitePath: string, doculaOptions: DoculaOptions): DoculaSection[];
     mergeSectionWithOptions(section: DoculaSection, options: DoculaOptions): DoculaSection;
     parseDocumentData(documentPath: string): DoculaDocument;
@@ -307,13 +381,31 @@ declare class DoculaBuilder {
     private directoryContainsMarkdown;
     private mergeTemplateOverrides;
     private ensureCacheInGitignore;
-    private isCacheFresh;
+    private getChangedOverrides;
+    private hashFile;
     private listFilesRecursive;
     private copyDirectory;
     private copyPublicFolder;
     private copyPublicDirectory;
     private copyDocumentSiblingAssets;
     private listContentAssets;
+    private loadBuildManifest;
+    private saveBuildManifest;
+    private hashOptions;
+    private hashTemplateDirectory;
+    private loadCachedDocuments;
+    private saveCachedDocuments;
+    private loadCachedChangelog;
+    private saveCachedChangelog;
+    private hashSourceFiles;
+    private recordsEqual;
+    private hasAssetsChanged;
+    /**
+     * Hashes the source file, records it in currentAssets, and returns
+     * whether the copy can be skipped (unchanged from previous build).
+     */
+    private hashAssetAndCheckSkip;
+    private copyDirectoryWithHashing;
     private copyContentAssets;
 }
 
@@ -373,6 +465,12 @@ declare class Docula {
      * @returns {Promise<void>}
      */
     execute(process: NodeJS.Process): Promise<void>;
+    private runBuild;
+    /**
+     * Detect if the current project uses TypeScript by checking for tsconfig.json
+     * @returns {boolean}
+     */
+    detectTypeScript(): boolean;
     /**
      * Generate the init files
      * @param {string} sitePath
@@ -407,4 +505,4 @@ declare class Docula {
     serve(options: DoculaOptions): Promise<http.Server>;
 }
 
-export { type DoculaCacheOptions, type DoculaCookieAuth, type DoculaHeaderLink, DoculaOptions, Docula as default };
+export { type DoculaCacheOptions, type DoculaChangelogEntry, DoculaConsole, type DoculaCookieAuth, type DoculaHeaderLink, DoculaOptions, Docula as default };