@talonic/docs 0.17.1 → 0.19.0

package/dist/content.d.ts

@@ -0,0 +1,134 @@
+/** HTTP method for API endpoint blocks. */
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/** A single parameter row in a param-table block. */
+interface Param {
+    name: string;
+    type: string;
+    required?: boolean;
+    description: string;
+    default?: string;
+}
+/**
+ * A single content block. The union discriminates on `type`.
+ *
+ * Text fields use lightweight inline markup:
+ * - `**bold**` for strong emphasis
+ * - `` `code` `` for inline code
+ * - `[text](url)` for links
+ * - HTML entities like `→` are passed through
+ */
+type DocBlock = {
+    type: 'heading';
+    level: 2 | 3;
+    id: string;
+    text: string;
+} | {
+    type: 'paragraph';
+    text: string;
+} | {
+    type: 'code';
+    language?: string;
+    title?: string;
+    code: string;
+} | {
+    type: 'callout';
+    variant?: 'info' | 'warning';
+    text: string;
+} | {
+    type: 'param-table';
+    title?: string;
+    params: Param[];
+} | {
+    type: 'endpoint';
+    method: HttpMethod;
+    path: string;
+    summary: string;
+    description?: string;
+    blocks: DocBlock[];
+} | {
+    type: 'list';
+    ordered?: boolean;
+    items: string[];
+} | {
+    type: 'ui-excerpt';
+    title: string;
+    caption?: string;
+    id: string;
+};
+/**
+ * A fully-resolved documentation section ready for SEO page rendering.
+ * Every leaf-level section ID from the nav structure maps to one DocSection.
+ */
+interface DocSection {
+    /** Leaf section ID / URL slug, e.g. "introduction" or "post-extract". */
+    slug: string;
+    /** Parent group ID, e.g. "overview" or "extract". */
+    parentSlug: string;
+    /** Display title (from nav label). */
+    title: string;
+    /** SEO page title, 50-60 chars, includes "Talonic". */
+    seoTitle: string;
+    /** Meta description, 150-160 chars, unique per page. */
+    description: string;
+    /** Breadcrumb chain from root to this section. */
+    breadcrumbs: {
+        label: string;
+        slug: string;
+    }[];
+    /** The content body as an ordered list of blocks. */
+    content: DocBlock[];
+    /** Related sections for cross-linking. */
+    related: {
+        label: string;
+        slug: string;
+    }[];
+    /** FAQ entries for FAQPage JSON-LD. */
+    faq: {
+        question: string;
+        answer: string;
+    }[];
+    /** Technical terms for JSON-LD TechArticle mentions. */
+    mentions: string[];
+    /** Previous section in reading order, or null. */
+    prev: {
+        slug: string;
+        label: string;
+    } | null;
+    /** Next section in reading order, or null. */
+    next: {
+        slug: string;
+        label: string;
+    } | null;
+}
+/**
+ * Raw section data before prev/next and breadcrumbs are derived.
+ * Content files export arrays of these; the index module enriches them.
+ */
+interface RawSection {
+    slug: string;
+    parentSlug: string;
+    title: string;
+    seoTitle: string;
+    description: string;
+    content: DocBlock[];
+    related: {
+        label: string;
+        slug: string;
+    }[];
+    faq: {
+        question: string;
+        answer: string;
+    }[];
+    mentions: string[];
+}
+
+/** Get a single platform section by slug, or null if not found. */
+declare function getPlatformSection(slug: string): DocSection | null;
+/** Get all platform sections in reading order. */
+declare function getAllPlatformSections(): DocSection[];
+/** Get a single API section by slug, or null if not found. */
+declare function getApiSection(slug: string): DocSection | null;
+/** Get all API sections in reading order. */
+declare function getAllApiSections(): DocSection[];
+
+export { type DocBlock, type DocSection, type HttpMethod, type Param, type RawSection, getAllApiSections, getAllPlatformSections, getApiSection, getPlatformSection };