@geenius/docs 0.4.1 → 0.8.10

package/packages/shared/dist/index.d.ts

@@ -1,274 +1,7 @@
+import { D as DocsConfig, a as DocSection, B as BreadcrumbItem, b as DocPage, S as SearchResult, T as TocItem } from './types-n-Ryn258.js';
+export { c as DocAccess, d as DocAuthor, e as DocNavigationLink, f as DocRevision, g as DocStatus, h as DocsPage, i as DocsProvider, j as DocsSearchResult, k as DocsSidebar, l as DocsSidebarItem, m as DocsSidebarPage } from './types-n-Ryn258.js';
 import { GeeniusError, GeeniusErrorOptions, ErrorCode } from '@geenius/tools/errors';
 
-/**
- * @module docsTypes
- * @package @geenius/docs-shared
- * @description Declares the shared docs domain model used by the framework
- * variants, Convex integration, and provider adapters. These types form the
- * public contract exported from `@geenius/docs`.
- */
-/**
- * Access levels supported by docs content.
- */
-type DocAccess = 'public' | 'team' | 'admin';
-/**
- * Publishing states supported by docs pages.
- */
-type DocStatus = 'draft' | 'published' | 'archived';
-/**
- * Author metadata attached to a docs page.
- *
- * @property name - Human-readable author display name.
- * @property avatar - Optional avatar URL for UI surfaces that show authorship.
- */
-interface DocAuthor {
-    name: string;
-    avatar?: string;
-}
-/**
- * Last-editor metadata attached to a docs page revision.
- *
- * @property name - Human-readable editor display name.
- * @property editedAt - ISO timestamp describing the edit event.
- */
-interface DocRevision {
-    name: string;
-    editedAt: string;
-}
-/**
- * Minimal navigation link used for previous and next page affordances.
- *
- * @property title - Label shown in the navigation UI.
- * @property slug - Page slug used to resolve the target.
- */
-interface DocNavigationLink {
-    title: string;
-    slug: string;
-}
-/**
- * Core page record shared across all docs variants.
- *
- * @property id - Stable page identifier.
- * @property title - Human-readable page title.
- * @property slug - Route slug relative to the docs base path.
- * @property content - Markdown or MDX body content.
- * @property excerpt - Optional preview excerpt used by search and listings.
- * @property sectionId - Stable section identifier used for grouping.
- * @property order - Sort order inside the containing section.
- * @property author - Primary author metadata for the page.
- * @property lastEditedBy - Optional revision metadata for the last editor.
- * @property version - Optional semantic version label for versioned docs.
- * @property access - Access control level for the page.
- * @property tags - Searchable tags attached to the page.
- * @property status - Publishing status for the page.
- * @property createdAt - ISO timestamp describing when the page was created.
- * @property updatedAt - ISO timestamp describing the most recent update.
- * @property wordCount - Approximate rendered word count.
- * @property readingTime - Reading time in minutes.
- * @property viewCount - Recorded page view count.
- */
-interface DocPage {
-    id: string;
-    title: string;
-    slug: string;
-    content: string;
-    excerpt?: string;
-    sectionId: string;
-    order: number;
-    author: DocAuthor;
-    lastEditedBy?: DocRevision;
-    version?: string;
-    access: DocAccess;
-    tags: string[];
-    status: DocStatus;
-    createdAt: string;
-    updatedAt: string;
-    wordCount: number;
-    readingTime: number;
-    viewCount: number;
-}
-/**
- * Section record used by listings, navigation trees, and admin tooling.
- *
- * @property id - Stable section identifier.
- * @property title - Human-readable section title.
- * @property slug - Route slug for the section landing page.
- * @property parentId - Optional parent section identifier for nested trees.
- * @property order - Sort order among sibling sections.
- * @property icon - Optional decorative icon token or emoji.
- * @property description - Optional descriptive copy used in dashboards and cards.
- * @property access - Access control level inherited by the section.
- * @property pageCount - Optional precomputed number of pages in the section.
- */
-interface DocSection {
-    id: string;
-    title: string;
-    slug: string;
-    parentId?: string;
-    order: number;
-    icon?: string;
-    description?: string;
-    access: DocAccess;
-    pageCount?: number;
-}
-/**
- * Search result returned by the shared search helpers.
- *
- * @property pageId - Stable page identifier.
- * @property pageTitle - Human-readable page title.
- * @property sectionTitle - Human-readable section title.
- * @property sectionSlug - Route slug for the containing section.
- * @property slug - Route slug for the page.
- * @property highlight - Excerpt or match snippet shown in results.
- * @property score - Rank score used to sort results.
- * @property tags - Searchable tags attached to the matching page.
- */
-interface SearchResult {
-    pageId: string;
-    pageTitle: string;
-    sectionTitle: string;
-    sectionSlug: string;
-    slug: string;
-    highlight: string;
-    score: number;
-    tags: string[];
-}
-/**
- * Table-of-contents node extracted from a page body.
- *
- * @property id - Heading anchor identifier.
- * @property text - Visible heading label.
- * @property level - Heading depth supported by the docs renderer.
- * @property children - Nested headings beneath this item.
- */
-interface TocItem {
-    id: string;
-    text: string;
-    level: 2 | 3 | 4;
-    children: TocItem[];
-}
-/**
- * Breadcrumb node used by page-level navigation chrome.
- *
- * @property title - Visible breadcrumb label.
- * @property href - Target route for the breadcrumb item.
- */
-interface BreadcrumbItem {
-    title: string;
-    href: string;
-}
-/**
- * Shared configuration options consumed by the docs variants.
- *
- * @property siteName - Optional site label for layouts and metadata.
- * @property baseUrl - Optional docs base path.
- * @property defaultAccess - Default access level for new content.
- * @property versionsEnabled - Enables version selection UI when true.
- * @property cmdKEnabled - Enables keyboard search affordances when true.
- * @property editPageUrl - Optional base URL used by "Edit this page" actions.
- * @property showReadingTime - Controls reading-time metadata visibility.
- * @property showLastEdited - Controls last-edited metadata visibility.
- * @property showViewCount - Controls view-count metadata visibility.
- * @property printModeEnabled - Enables print-focused layout affordances.
- */
-interface DocsConfig {
-    siteName?: string;
-    baseUrl?: string;
-    defaultAccess?: DocAccess;
-    versionsEnabled?: boolean;
-    cmdKEnabled?: boolean;
-    editPageUrl?: string;
-    showReadingTime?: boolean;
-    showLastEdited?: boolean;
-    showViewCount?: boolean;
-    printModeEnabled?: boolean;
-}
-/**
- * Provider-backed page record with derived navigation and heading data.
- */
-interface DocsPage extends DocPage {
-    prev?: DocNavigationLink | null;
-    next?: DocNavigationLink | null;
-    toc?: TocItem[];
-    breadcrumbs?: BreadcrumbItem[];
-}
-/**
- * Page summary entry displayed inside a sidebar section.
- *
- * @property slug - Route slug used by the nav item.
- * @property title - Human-readable nav label.
- */
-interface DocsSidebarPage {
-    slug: string;
-    title: string;
-}
-/**
- * Section node displayed by docs navigation components.
- *
- * @property id - Stable section identifier.
- * @property title - Human-readable section label.
- * @property slug - Route slug for the section.
- * @property icon - Optional decorative icon token or emoji.
- * @property pages - Flattened page entries belonging to the section.
- * @property children - Optional nested section tree beneath this item.
- */
-interface DocsSidebarItem {
-    id: string;
-    title: string;
-    slug: string;
-    icon?: string;
-    pages: DocsSidebarPage[];
-    children?: DocsSidebarItem[];
-}
-/**
- * Full sidebar structure returned by docs providers.
- */
-type DocsSidebar = DocsSidebarItem[];
-/**
- * Search result returned by provider-backed docs integrations.
- *
- * @property pageId - Stable page identifier.
- * @property pageTitle - Human-readable page title.
- * @property sectionTitle - Human-readable containing section label.
- * @property slug - Page route slug.
- * @property highlight - Preview snippet used in search results.
- * @property score - Rank score used to sort results.
- */
-interface DocsSearchResult {
-    pageId: string;
-    pageTitle: string;
-    sectionTitle: string;
-    slug: string;
-    highlight: string;
-    score: number;
-}
-/**
- * Provider contract implemented by pluggable docs backends such as internal
- * arrays, Astro content directories, and Fumadocs sources.
- */
-interface DocsProvider {
-    /**
-     * Load the sidebar navigation structure for the docs source.
-     *
-     * @returns The full sidebar tree for the provider.
-     */
-    getSidebar(): Promise<DocsSidebar>;
-    /**
-     * Resolve a single docs page by slug.
-     *
-     * @param slug - Route slug for the requested page.
-     * @returns The resolved page record or `null` when not found.
-     */
-    getPage(slug: string): Promise<DocsPage | null>;
-    /**
-     * Search the provider-backed content source.
-     *
-     * @param query - User-entered search query.
-     * @returns Ranked provider search results for the query.
-     */
-    search(query: string): Promise<DocsSearchResult[]>;
-}
-
 /**
  * @module docsConfig
  * @package @geenius/docs-shared
@@ -379,237 +112,6 @@ declare class DocsProviderError extends DocsError {
     });
 }
 
-/**
- * @module astroDocsProvider
- * @package @geenius/docs-shared
- * @description Implements the Astro-oriented provider used to normalise Markdown
- * and MDX files discovered from Astro content collections into the shared docs
- * contract consumed by the framework variants.
- */
-
-/**
- * Normalises Astro Markdown and MDX files into the shared docs contract.
- */
-declare class AstroDocsProvider implements DocsProvider {
-    private pages;
-    /**
-     * Loads docs from an Astro-style `import.meta.glob()` result.
-     *
-     * @param globResult - Lazy or eager Astro content loaders keyed by path.
-     * @returns Nothing. The provider page set is replaced in memory.
-     */
-    loadFromGlob(globResult: Record<string, (() => Promise<string>) | string>): Promise<void>;
-    /**
-     * Loads docs from already-read file contents.
-     *
-     * @param files - File path and content pairs to normalise.
-     * @returns Nothing. The provider page set is replaced in memory.
-     */
-    loadFromFiles(files: Array<{
-        path: string;
-        content: string;
-    }>): Promise<void>;
-    private parseDoc;
-    private linkPages;
-    /**
-     * Loads the sidebar structure derived from the parsed Astro pages.
-     *
-     * @returns Sidebar navigation entries derived from the published pages.
-     */
-    getSidebar(): Promise<DocsSidebar>;
-    /**
-     * Resolves a linked docs page by slug.
-     *
-     * @param slug - Target page slug.
-     * @returns The linked page or `null` when no page matches the slug.
-     */
-    getPage(slug: string): Promise<DocsPage | null>;
-    /**
-     * Returns all published pages managed by the provider.
-     *
-     * @returns Published pages in their linked navigation order.
-     */
-    getAllPages(): Promise<DocsPage[]>;
-    /**
-     * Searches the parsed Astro page set.
-     *
-     * @param query - User-entered search query.
-     * @returns Ranked search results derived from the published pages.
-     */
-    search(query: string): Promise<DocsSearchResult[]>;
-    /**
-     * Resolves previous and next pages for a slug.
-     *
-     * @param slug - Target page slug.
-     * @returns Linked previous and next page records when available.
-     */
-    getNavigation(slug: string): Promise<{
-        prev: DocsPage | null;
-        next: DocsPage | null;
-    }>;
-}
-
-/**
- * @module fumadocsProvider
- * @package @geenius/docs-shared
- * @description Implements the Fumadocs-backed provider used to normalise
- * source pages and page-tree metadata from Fumadocs into the shared docs
- * contract consumed by the framework variants.
- */
-
-/**
- * Fumadocs source-page shape accepted by the provider.
- */
-interface FumadocsSourcePage {
-    slug?: string;
-    slugs?: string[];
-    url?: string;
-    data: {
-        title?: string;
-        description?: string;
-        body?: string;
-        icon?: string;
-        order?: number;
-        toc?: TocItem[];
-        draft?: boolean;
-        status?: DocStatus;
-        access?: DocAccess;
-        author?: string;
-        avatar?: string;
-        tags?: string[] | string;
-        version?: string;
-        lastModified?: string;
-        lastUpdated?: string;
-        [key: string]: unknown;
-    };
-}
-/**
- * Fumadocs tree-node shape accepted by the provider.
- */
-interface FumadocsTreeNode {
-    type: 'page' | 'folder' | 'separator';
-    name?: string;
-    slug?: string;
-    icon?: string;
-    children?: FumadocsTreeNode[];
-}
-/**
- * Fumadocs provider that bridges source pages and trees into the shared docs contract.
- */
-declare class FumadocsDocsProvider implements DocsProvider {
-    private pages;
-    private tree;
-    /**
-     * Loads pages and an optional page tree from Fumadocs.
-     *
-     * @param pages - Source pages supplied by Fumadocs.
-     * @param tree - Optional source page tree for nested sidebar rendering.
-     * @returns Nothing. The provider page set is replaced in memory.
-     */
-    loadFromSource(pages: FumadocsSourcePage[], tree?: FumadocsTreeNode[]): void;
-    private normalizePage;
-    private linkPages;
-    private treeToSidebar;
-    /**
-     * Loads the sidebar structure derived from the Fumadocs tree or grouped pages.
-     *
-     * @returns Sidebar navigation entries derived from the published pages.
-     */
-    getSidebar(): Promise<DocsSidebar>;
-    /**
-     * Resolves a linked docs page by slug.
-     *
-     * @param slug - Target page slug.
-     * @returns The linked page or `null` when no page matches the slug.
-     */
-    getPage(slug: string): Promise<DocsPage | null>;
-    /**
-     * Returns all published pages managed by the provider.
-     *
-     * @returns Published pages in their linked navigation order.
-     */
-    getAllPages(): Promise<DocsPage[]>;
-    /**
-     * Searches the provider-backed page set.
-     *
-     * @param query - User-entered search query.
-     * @returns Ranked search results derived from the published pages.
-     */
-    search(query: string): Promise<DocsSearchResult[]>;
-    /**
-     * Resolves previous and next pages for a slug.
-     *
-     * @param slug - Target page slug.
-     * @returns Linked previous and next page records when available.
-     */
-    getNavigation(slug: string): Promise<{
-        prev: DocsPage | null;
-        next: DocsPage | null;
-    }>;
-}
-
-/**
- * @module internalDocsProvider
- * @package @geenius/docs-shared
- * @description Implements the in-memory docs provider used by local fixtures,
- * tests, and apps that already have page records loaded in process memory.
- */
-
-/**
- * In-memory provider for already-hydrated docs pages.
- */
-declare class InternalDocsProvider implements DocsProvider {
-    private pages;
-    /**
-     * @param pages - Optional initial page records to seed the provider with.
-     */
-    constructor(pages?: DocPage[]);
-    /**
-     * Replaces the provider's page set.
-     *
-     * @param pages - Fresh page records to seed into the provider.
-     * @returns Nothing. The provider page set is replaced in memory.
-     */
-    setPages(pages: DocPage[]): void;
-    private linkPages;
-    /**
-     * Loads the sidebar structure derived from the current page set.
-     *
-     * @returns Sidebar navigation entries derived from the published pages.
-     */
-    getSidebar(): Promise<DocsSidebar>;
-    /**
-     * Resolves a linked docs page by slug.
-     *
-     * @param slug - Target page slug.
-     * @returns The linked page or `null` when no page matches the slug.
-     */
-    getPage(slug: string): Promise<DocsPage | null>;
-    /**
-     * Returns all published pages managed by the provider.
-     *
-     * @returns Published pages in their linked navigation order.
-     */
-    getAllPages(): Promise<DocsPage[]>;
-    /**
-     * Searches the provider-backed page set.
-     *
-     * @param query - User-entered search query.
-     * @returns Ranked search results derived from the published pages.
-     */
-    search(query: string): Promise<DocsSearchResult[]>;
-    /**
-     * Resolves previous and next pages for a slug.
-     *
-     * @param slug - Target page slug.
-     * @returns Linked previous and next page records when available.
-     */
-    getNavigation(slug: string): Promise<{
-        prev: DocsPage | null;
-        next: DocsPage | null;
-    }>;
-}
-
 /**
  * @module docsUtilities
  * @package @geenius/docs-shared
@@ -681,4 +183,4 @@ declare function highlightMatch(text: string, query: string, maxLen?: number): s
  */
 declare const defaultDocsConfig: DocsConfig;
 
-export { AstroDocsProvider, type BreadcrumbItem, type DocAccess, type DocAuthor, type DocNavigationLink, type DocPage, type DocRevision, type DocSection, type DocStatus, type DocsConfig, DocsConfigurationError, DocsError, type DocsErrorCode, type DocsErrorOptions, type DocsPage, type DocsProvider, DocsProviderError, type DocsSearchResult, type DocsSidebar, type DocsSidebarItem, type DocsSidebarPage, FumadocsDocsProvider, InternalDocsProvider, type SearchResult, type TocItem, buildBreadcrumbs, buildDocsIndex, calcWordCount, configureDocs, defaultDocsConfig, defineDocsConfig, extractToc, getDocsConfig, highlightMatch, isDocsConfigured, mergeDocsConfig, resetDocsConfig, searchDocs, slugify };
+export { BreadcrumbItem, DocPage, DocSection, DocsConfig, DocsConfigurationError, DocsError, type DocsErrorCode, type DocsErrorOptions, DocsProviderError, SearchResult, TocItem, buildBreadcrumbs, buildDocsIndex, calcWordCount, configureDocs, defaultDocsConfig, defineDocsConfig, extractToc, getDocsConfig, highlightMatch, isDocsConfigured, mergeDocsConfig, resetDocsConfig, searchDocs, slugify };