@geenius/docs 0.8.10 → 0.11.0

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

@@ -1,16 +1,17 @@
-import { BreadcrumbItem, DocPage as DocPage$1, SearchResult, DocSection, TocItem, DocsConfig } from '@geenius/docs-shared';
-export { BreadcrumbItem, DocAccess, DocPage as DocPageType, DocSection, DocStatus, DocsConfig, SearchResult, TocItem } from '@geenius/docs-shared';
+import { BreadcrumbItem, DocPage as DocPage$1, SearchResult, DocSection, TocItem, DocsConfig } from '@geenius/docs/shared';
+export { BreadcrumbItem, DocAccess, DocPage as DocPageType, DocSection, DocStatus, DocsConfig, SearchResult, TocItem } from '@geenius/docs/shared';
 import { JSX, Accessor } from 'solid-js';
 
 /**
  * @module solidjsBreadcrumbs
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the SolidJS docs breadcrumb trail using shared route
  * metadata and the Tailwind-styled docs presentation contract.
  */
 
 interface BreadcrumbsProps {
     items: BreadcrumbItem[];
+    class?: string;
 }
 /**
  * Renders the current docs breadcrumb hierarchy.
@@ -22,7 +23,7 @@ declare function Breadcrumbs(props: BreadcrumbsProps): JSX.Element | null;
 
 /**
  * @module solidDocPage
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders a docs page body with safe Markdown semantics, heading
  * anchors, and package-consistent typography. The component deliberately avoids
  * raw HTML injection so authored docs content stays within the Markdown runtime.
@@ -30,6 +31,7 @@ declare function Breadcrumbs(props: BreadcrumbsProps): JSX.Element | null;
 
 interface DocPageProps {
     page: DocPage$1;
+    class?: string;
 }
 /**
  * Renders a docs page body using safe Markdown rendering.
@@ -41,7 +43,7 @@ declare function DocPage(props: DocPageProps): JSX.Element;
 
 /**
  * @module solidjsDocSearch
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Provides the SolidJS command-palette style docs search modal
  * with keyboard navigation, animated presentation, and highlighted matches.
  */
@@ -53,6 +55,7 @@ interface DocSearchProps {
     onSelect: (result: SearchResult) => void;
     isOpen: boolean;
     onClose: () => void;
+    class?: string;
 }
 /**
  * Renders the SolidJS docs search modal and result list.
@@ -62,20 +65,40 @@ interface DocSearchProps {
  */
 declare function DocSearch(props: DocSearchProps): JSX.Element | null;
 
+/**
+ * @module docsSolidTypes
+ * @package @geenius/docs/solidjs
+ * @description Declares the SolidJS-specific supporting types that keep the
+ * exported docs components aligned on shared section/page shapes and a common
+ * optional `class` extension point.
+ */
+
+/**
+ * Optional `class` contract shared by SolidJS docs exports.
+ */
+interface WithClassName {
+    class?: string;
+}
+/**
+ * Shared docs section shape used by layout, navigation, and page components.
+ */
+type DocsSectionWithPages = DocSection & {
+    pages?: DocPage$1[];
+    pageCount?: number;
+};
+
 /**
  * @module solidjsDocSidebar
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the hierarchical SolidJS docs sidebar with expandable
  * sections, nested pages, and the active-page highlight state.
  */
 
 interface DocSidebarProps {
-    sections: (DocSection & {
-        pages?: DocPage$1[];
-        pageCount?: number;
-    })[];
+    sections: DocsSectionWithPages[];
     currentPageId?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
+    class?: string;
 }
 /**
  * Renders the docs section tree for sidebar navigation.
@@ -87,15 +110,13 @@ declare function DocSidebar(props: DocSidebarProps): JSX.Element;
 
 /**
  * @module solidjsDocsLayout
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Composes the SolidJS docs chrome, including sidebar,
  * breadcrumbs, main content region, and table of contents rail.
  */
 
 interface DocsLayoutProps {
-    sections: (DocSection & {
-        pages?: DocPage$1[];
-    })[];
+    sections: DocsSectionWithPages[];
     currentPage?: DocPage$1;
     toc?: TocItem[];
     activeHeadingId?: string;
@@ -103,6 +124,7 @@ interface DocsLayoutProps {
     currentPageId?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
     children: JSX.Element;
+    class?: string;
 }
 /**
  * Renders the shared SolidJS docs page shell.
@@ -114,7 +136,7 @@ declare function DocsLayout(props: DocsLayoutProps): JSX.Element;
 
 /**
  * @module solidjsEditButton
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the external edit-source affordance for the SolidJS
  * docs variant when an upstream repository edit URL is configured.
  */
@@ -122,6 +144,7 @@ declare function DocsLayout(props: DocsLayoutProps): JSX.Element;
 interface EditButtonProps {
     pageSlug: string;
     editUrl?: string;
+    class?: string;
 }
 /**
  * Renders an external link for editing the current docs page source.
@@ -133,7 +156,7 @@ declare function EditButton(props: EditButtonProps): JSX.Element | null;
 
 /**
  * @module solidjsPageNavigation
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders previous and next page affordances for the SolidJS
  * docs variant so readers can move linearly through the content graph.
  */
@@ -147,6 +170,7 @@ interface PageNavigationProps {
         title: string;
         href: string;
     };
+    class?: string;
 }
 /**
  * Renders previous and next page links for the current docs page.
@@ -158,7 +182,7 @@ declare function PageNavigation(props: PageNavigationProps): JSX.Element | null;
 
 /**
  * @module solidjsTableOfContents
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the SolidJS docs table of contents with nested anchor
  * links and animated active-heading highlighting.
  */
@@ -166,6 +190,7 @@ declare function PageNavigation(props: PageNavigationProps): JSX.Element | null;
 interface TableOfContentsProps {
     toc: TocItem[];
     activeId?: string;
+    class?: string;
 }
 /**
  * Renders the page-local table of contents rail.
@@ -177,7 +202,7 @@ declare function TableOfContents(props: TableOfContentsProps): JSX.Element | nul
 
 /**
  * @module solidjsVersionSelector
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Presents the SolidJS docs version switcher for packages that
  * expose multiple documentation versions in the same surface.
  */
@@ -186,6 +211,7 @@ interface VersionSelectorProps {
     versions: string[];
     current: string;
     onSelect: (version: string) => void;
+    class?: string;
 }
 /**
  * Renders a version picker when more than one docs version is available.
@@ -197,7 +223,7 @@ declare function VersionSelector(props: VersionSelectorProps): JSX.Element | nul
 
 /**
  * @module solidjsDocSearchPage
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the dedicated SolidJS docs search page, including
  * query input, derived search results, and empty or loading states.
  */
@@ -208,6 +234,7 @@ interface DocSearchPageProps {
         pageCount: number;
     })[] | undefined>;
     onSelectPage?: (page: DocPage$1, section: DocSection) => void;
+    class?: string;
 }
 /**
  * Renders a full-page docs search experience for SolidJS consumers.
@@ -219,7 +246,7 @@ declare function DocSearchPage(props: DocSearchPageProps): JSX.Element;
 
 /**
  * @module solidjsCreateDocsAdmin
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Adapts caller-provided section and page mutations into a
  * stable SolidJS admin controller with normalized method signatures.
  */
@@ -281,7 +308,7 @@ declare function createDocsAdmin(mutations: {
 
 /**
  * @module solidjsDocsAdminPage
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the SolidJS docs administration surface for creating,
  * selecting, publishing, archiving, and deleting sections and pages.
  */
@@ -293,6 +320,7 @@ interface DocsAdminPageProps {
     })[] | undefined>;
     allPages?: DocPage$1[];
     admin: DocsAdminActions;
+    class?: string;
 }
 /**
  * Renders the docs administration dashboard for SolidJS consumers.
@@ -304,7 +332,7 @@ declare function DocsAdminPage(props: DocsAdminPageProps): JSX.Element;
 
 /**
  * @module solidjsDocsIndexPage
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the SolidJS docs landing page with section cards,
  * keyboard-accessible search launch, and empty or loading states.
  */
@@ -315,6 +343,7 @@ interface DocsIndexPageProps {
         pageCount: number;
     })[] | undefined>;
     onSelectPage?: (page: DocPage$1, section: DocSection) => void;
+    class?: string;
 }
 /**
  * Renders the root docs landing page for the SolidJS variant.
@@ -326,7 +355,7 @@ declare function DocsIndexPage(props: DocsIndexPageProps): JSX.Element;
 
 /**
  * @module solidjsDocViewPage
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Renders the main SolidJS docs reading experience, including
  * layout chrome, MDX content, table of contents, and sibling navigation.
  */
@@ -340,6 +369,7 @@ interface DocViewPageProps {
     editPageUrl?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
     onIncrementView?: (pageId: string) => void;
+    class?: string;
 }
 /**
  * Renders the docs reader view for a selected SolidJS page.
@@ -351,7 +381,7 @@ declare function DocViewPage(props: DocViewPageProps): JSX.Element;
 
 /**
  * @module solidjsCreateDocSearch
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Creates the SolidJS docs search state machine, including the
  * query signal, debounced execution, and normalized result lifecycle.
  */
@@ -383,7 +413,7 @@ declare function createDocSearch(searchFn: (query: string) => SearchResult[] | P
 
 /**
  * @module solidjsCreateDocs
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Creates the canonical SolidJS docs state container that merges
  * config, flattens pages, and tracks section, page, and search selection state.
  */
@@ -431,7 +461,7 @@ declare function createDocs(tree: Accessor<(DocSection & {
 
 /**
  * @module solidjsCreateTableOfContents
- * @package @geenius/docs-solidjs
+ * @package @geenius/docs/solidjs
  * @description Derives the SolidJS docs table of contents from MDX content
  * and tracks the active heading via intersection observer updates.
  */
@@ -456,4 +486,4 @@ interface TableOfContentsState {
  */
 declare function createTableOfContents(mdxContent: Accessor<string | undefined>): TableOfContentsState;
 
-export { Breadcrumbs, DocPage, DocSearch, DocSearchPage, DocSidebar, DocViewPage, DocsAdminPage, DocsIndexPage, DocsLayout, EditButton, PageNavigation, TableOfContents, VersionSelector, createDocSearch, createDocs, createDocsAdmin, createTableOfContents };
+export { Breadcrumbs, DocPage, DocSearch, DocSearchPage, type DocSearchState, DocSidebar, DocViewPage, type DocsAdminActions, DocsAdminPage, DocsIndexPage, DocsLayout, type DocsSectionWithPages, type DocsState, EditButton, PageNavigation, TableOfContents, type TableOfContentsState, VersionSelector, type WithClassName, createDocSearch, createDocs, createDocsAdmin, createTableOfContents };