@xyd-js/content 0.1.0-xyd.13 → 0.1.0-xyd.16

package/dist/md.d.ts

@@ -1,14 +1,69 @@
+import * as hast from 'hast';
+import * as vfile from 'vfile';
+import { VFile } from 'vfile';
+import * as unist from 'unist';
 import * as remark_gfm from 'remark-gfm';
+import * as unified from 'unified';
 import * as mdast from 'mdast';
 import * as remark_mdx_frontmatter from 'remark-mdx-frontmatter';
 import * as remark_frontmatter from 'remark-frontmatter';
-import * as unified from 'unified';
-import * as unist from 'unist';
-import { R as RemarkMdxTocOptions } from './mdToc-CYxzibVZ.js';
+import { Settings } from '@xyd-js/core';
+import { R as RemarkMdxTocOptions } from './mdToc-NBBxMJ4l.js';
+
+type OutputVars<T extends Record<string, any>> = {
+    [K in keyof T]: T[K];
+};
+interface SymbolxVfile<T extends Record<string, any>> extends VFile {
+    data: {
+        outputVars?: OutputVars<T>;
+        [key: string]: any;
+    };
+}
+
+/**
+ * Common options for all function plugins
+ */
+interface FunctionOptions {
+    resolveFrom?: string;
+}
+
+interface DocSectionSchema {
+    /**
+     * Id of the page e.g. "getting-started"
+     */
+    pageId: string;
+    /**
+     * URL of the page e.g. "/getting-started"
+     */
+    pageUrl: string;
+    /**
+     * Title of the page e.g. "Getting Started"
+     */
+    pageTitle: string;
+    /**
+     * Level of the heading e.g. 1, 2
+     */
+    headingLevel: number;
+    /**
+     * Title of the heading e.g. "Making a new project"
+     */
+    headingTitle: string;
+    /**
+     * Summary of the page e.g. "This is the summary of the page"
+     */
+    summary: string;
+    /**
+     * Content of the section
+     */
+    content: string;
+}
+
+declare function mapSettingsToDocSections(xydSettings: Settings): Promise<DocSectionSchema[]>;
 
-declare function mdOptions(toc: RemarkMdxTocOptions): {
-    remarkPlugins: (unified.Plugin<[], unist.Node, unist.Node> | typeof remark_frontmatter.default | unified.Plugin<[(remark_mdx_frontmatter.RemarkMdxFrontmatterOptions | undefined)?], mdast.Root, mdast.Root> | typeof remark_gfm.default)[];
-    rehypePlugins: never[];
+declare function markdownPlugins(toc: RemarkMdxTocOptions, // TODO: unify this cuz it should come from core -global settings and toc options?
+settings?: Settings): {
+    remarkPlugins: (typeof remark_frontmatter.default | unified.Plugin<[(remark_mdx_frontmatter.RemarkMdxFrontmatterOptions | undefined)?], mdast.Root, mdast.Root> | typeof remark_gfm.default | unified.Plugin<[], unist.Node, unist.Node> | ((options?: FunctionOptions) => (tree: any, file: vfile.VFile) => Promise<void>) | (() => (tree: mdast.Root, file: SymbolxVfile<any>) => Promise<void>))[];
+    rehypePlugins: unified.Plugin<[], hast.Root, hast.Root>[];
 };
 
-export { RemarkMdxTocOptions, mdOptions };
+export { type DocSectionSchema, RemarkMdxTocOptions, mapSettingsToDocSections, markdownPlugins };