@reapi/docs-compile 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,70 @@
+import { Root } from 'mdast';
+
+interface CompileIssue {
+    message: string;
+    line?: number;
+    column?: number;
+}
+interface TocEntry {
+    depth: number;
+    text: string;
+    id: string;
+}
+interface CompiledPage {
+    /** YAML frontmatter (title, description, openapi…), already parsed. */
+    frontmatter: Record<string, unknown>;
+    /** Sanitized mdast as plain JSON (positions stripped). */
+    ast: Root;
+    /** h2/h3 entries; heading ids are also stamped onto the ast nodes. */
+    toc: TocEntry[];
+    /** API slugs referenced by ApiOperation/ApiSchema embeds (+ frontmatter). */
+    embeds: string[];
+    errors: CompileIssue[];
+}
+interface OpenapiRef {
+    api: string;
+    method: string;
+    path: string;
+}
+/** `"<api-slug> <METHOD> <path>"` → parts, or null when malformed. */
+declare function parseOpenapiRef(value: unknown): OpenapiRef | null;
+declare function compileMdx(source: string): CompiledPage;
+
+/**
+ * The preset component whitelist (portal.md §5). Anything else in JSX
+ * position is a publish-time error — the dialect has no user components,
+ * no expressions, no imports, so nothing the author writes ever executes.
+ */
+declare const PRESET_COMPONENTS: ReadonlySet<string>;
+
+/**
+ * `docs.json` at the docs root configures the site (Mintlify-style):
+ *
+ *   {
+ *     "name": "Acme Docs",
+ *     "nav": [
+ *       { "group": "Getting started", "pages": ["index", "quickstart"] },
+ *       { "group": "Guides", "pages": ["guides/auth"] }
+ *     ]
+ *   }
+ *
+ * Page entries are repo-relative paths without extension; `index` is the
+ * site home. Theme keys are accepted but unused for now (Pro customization).
+ */
+interface DocsNavGroup {
+    group: string;
+    pages: string[];
+}
+interface DocsConfig {
+    name: string;
+    description?: string;
+    nav: DocsNavGroup[];
+}
+/** Normalize a page path: strip ./, leading /, extension; index.* → index. */
+declare function normalizePagePath(raw: string): string;
+declare function parseDocsConfig(jsonText: string): {
+    config: DocsConfig | null;
+    errors: CompileIssue[];
+};
+
+export { type CompileIssue, type CompiledPage, type DocsConfig, type DocsNavGroup, type OpenapiRef, PRESET_COMPONENTS, type TocEntry, compileMdx, normalizePagePath, parseDocsConfig, parseOpenapiRef };

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import { Root } from 'mdast';
+
+interface CompileIssue {
+    message: string;
+    line?: number;
+    column?: number;
+}
+interface TocEntry {
+    depth: number;
+    text: string;
+    id: string;
+}
+interface CompiledPage {
+    /** YAML frontmatter (title, description, openapi…), already parsed. */
+    frontmatter: Record<string, unknown>;
+    /** Sanitized mdast as plain JSON (positions stripped). */
+    ast: Root;
+    /** h2/h3 entries; heading ids are also stamped onto the ast nodes. */
+    toc: TocEntry[];
+    /** API slugs referenced by ApiOperation/ApiSchema embeds (+ frontmatter). */
+    embeds: string[];
+    errors: CompileIssue[];
+}
+interface OpenapiRef {
+    api: string;
+    method: string;
+    path: string;
+}
+/** `"<api-slug> <METHOD> <path>"` → parts, or null when malformed. */
+declare function parseOpenapiRef(value: unknown): OpenapiRef | null;
+declare function compileMdx(source: string): CompiledPage;
+
+/**
+ * The preset component whitelist (portal.md §5). Anything else in JSX
+ * position is a publish-time error — the dialect has no user components,
+ * no expressions, no imports, so nothing the author writes ever executes.
+ */
+declare const PRESET_COMPONENTS: ReadonlySet<string>;
+
+/**
+ * `docs.json` at the docs root configures the site (Mintlify-style):
+ *
+ *   {
+ *     "name": "Acme Docs",
+ *     "nav": [
+ *       { "group": "Getting started", "pages": ["index", "quickstart"] },
+ *       { "group": "Guides", "pages": ["guides/auth"] }
+ *     ]
+ *   }
+ *
+ * Page entries are repo-relative paths without extension; `index` is the
+ * site home. Theme keys are accepted but unused for now (Pro customization).
+ */
+interface DocsNavGroup {
+    group: string;
+    pages: string[];
+}
+interface DocsConfig {
+    name: string;
+    description?: string;
+    nav: DocsNavGroup[];
+}
+/** Normalize a page path: strip ./, leading /, extension; index.* → index. */
+declare function normalizePagePath(raw: string): string;
+declare function parseDocsConfig(jsonText: string): {
+    config: DocsConfig | null;
+    errors: CompileIssue[];
+};
+
+export { type CompileIssue, type CompiledPage, type DocsConfig, type DocsNavGroup, type OpenapiRef, PRESET_COMPONENTS, type TocEntry, compileMdx, normalizePagePath, parseDocsConfig, parseOpenapiRef };