@xyd-js/uniform 0.1.0-xyd.3 → 0.1.0-xyd.5

package/content.ts

@@ -1 +1 @@
-export * from "./src/content"
+export * from "./src/content/index"

package/dist/content.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../content.ts","../src/content/index.ts"],"sourcesContent":["export * from \"./src/content\"","import path from \"path\";\nimport {promises as fs} from \"fs\";\n\nimport React from \"react\";\nimport {parse} from \"codehike\";\nimport {visit} from \"unist-util-visit\";\nimport {recmaCodeHike, remarkCodeHike} from \"codehike/mdx\";\nimport {compile as mdxCompile} from \"@mdx-js/mdx\";\n\nconst codeHikeOptions = {\n    lineNumbers: true,\n    showCopyButton: true,\n    autoImport: true,\n    components: {code: \"Code\"},\n    // syntaxHighlighting: { // TODO: !!! FROM SETTINGS !!! wait for rr7 rsc ??\n    //     theme: \"github-dark\",\n    // },\n};\n//\n// // since unist does not support heading level > 6, we need to normalize them\nfunction normalizeCustomHeadings() {\n    return (tree: any) => {\n        visit(tree, 'paragraph', (node, index, parent) => {\n            const match = node.children[0] && node.children[0].value.match(/^(#+)\\s+(.*)/);\n            if (match) {\n                const level = match[1].length;\n                const text = match[2];\n                if (level > 6) {\n                    // Create a new heading node with depth 6\n                    const headingNode = {\n                        type: 'heading',\n                        depth: level,\n                        children: [{type: 'text', value: text}]\n                    };\n                    // Replace the paragraph node with the new heading node\n                    //@ts-ignore\n                    parent.children[index] = headingNode;\n                }\n            }\n        });\n    };\n}\n\n//\nasync function compile(content: string): Promise<string> {\n    const compiled = await mdxCompile(content, {\n        remarkPlugins: [normalizeCustomHeadings, [remarkCodeHike, codeHikeOptions]],\n        recmaPlugins: [\n            [recmaCodeHike, codeHikeOptions]\n        ],\n        outputFormat: 'function-body',\n        development: false,\n    });\n\n    return String(compiled)\n}\n\nasync function compileBySlug(slug: string) {\n    // TODO: cwd ?\n    const filePath = path.join(process.cwd(), `${slug}.md`)\n\n    try {\n        await fs.access(filePath)\n    } catch (e) {\n        console.error(e)\n        return \"\"\n    }\n\n    const content = await fs.readFile(filePath, \"utf-8\");\n\n    return await compile(content)\n}\n\nfunction getMDXComponent(code: string) {\n    const mdxExport = getMDXExport(code)\n    return mdxExport.default\n}\n\nfunction getMDXExport(code: string) {\n    const scope = {\n        Fragment: React.Fragment,\n        jsxs: React.createElement,\n        jsx: React.createElement,\n        jsxDEV: React.createElement,\n    }\n    const fn = new Function(...Object.keys(scope), code)\n    return fn(scope)\n}\n\n//\n// function MDXContent(code: string) {\n//     return React.useMemo(\n//         () => code ? getMDXComponent(code) : null,\n//         [code]\n//     )\n// }\n\n// TODO: mod ts\nasync function lazyReferences(mod: any) {\n    const references: any[] = []\n\n    if (Array.isArray(mod.default)) {\n        for (const chunk of mod.default) {\n            try {\n                const code = await compile(chunk) // TODO: do we need real path?\n                const Content = getMDXComponent(code)\n                const content = Content ? parse(Content) : null\n\n                references.push(...content.references as [])\n            } catch (e) {\n                console.error(e)\n            }\n        }\n    } else {\n        console.warn(`mod.default is not an array, current type is: ${typeof mod.default}`)\n    }\n\n    return references\n}\n\nexport {\n    compileBySlug,\n    lazyReferences\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAAiB;AACjB,gBAA6B;AAE7B,mBAAkB;AAClB,sBAAoB;AACpB,8BAAoB;AACpB,iBAA4C;AAC5C,IAAAA,cAAoC;AAEpC,IAAM,kBAAkB;AAAA,EACpB,aAAa;AAAA,EACb,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,YAAY,EAAC,MAAM,OAAM;AAAA;AAAA;AAAA;AAI7B;AAGA,SAAS,0BAA0B;AAC/B,SAAO,CAAC,SAAc;AAClB,uCAAM,MAAM,aAAa,CAAC,MAAM,OAAO,WAAW;AAC9C,YAAM,QAAQ,KAAK,SAAS,CAAC,KAAK,KAAK,SAAS,CAAC,EAAE,MAAM,MAAM,cAAc;AAC7E,UAAI,OAAO;AACP,cAAM,QAAQ,MAAM,CAAC,EAAE;AACvB,cAAM,OAAO,MAAM,CAAC;AACpB,YAAI,QAAQ,GAAG;AAEX,gBAAM,cAAc;AAAA,YAChB,MAAM;AAAA,YACN,OAAO;AAAA,YACP,UAAU,CAAC,EAAC,MAAM,QAAQ,OAAO,KAAI,CAAC;AAAA,UAC1C;AAGA,iBAAO,SAAS,KAAK,IAAI;AAAA,QAC7B;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAGA,eAAe,QAAQ,SAAkC;AACrD,QAAM,WAAW,UAAM,YAAAC,SAAW,SAAS;AAAA,IACvC,eAAe,CAAC,yBAAyB,CAAC,2BAAgB,eAAe,CAAC;AAAA,IAC1E,cAAc;AAAA,MACV,CAAC,0BAAe,eAAe;AAAA,IACnC;AAAA,IACA,cAAc;AAAA,IACd,aAAa;AAAA,EACjB,CAAC;AAED,SAAO,OAAO,QAAQ;AAC1B;AAEA,eAAe,cAAc,MAAc;AAEvC,QAAM,WAAW,YAAAC,QAAK,KAAK,QAAQ,IAAI,GAAG,GAAG,IAAI,KAAK;AAEtD,MAAI;AACA,UAAM,UAAAC,SAAG,OAAO,QAAQ;AAAA,EAC5B,SAAS,GAAG;AACR,YAAQ,MAAM,CAAC;AACf,WAAO;AAAA,EACX;AAEA,QAAM,UAAU,MAAM,UAAAA,SAAG,SAAS,UAAU,OAAO;AAEnD,SAAO,MAAM,QAAQ,OAAO;AAChC;AAEA,SAAS,gBAAgB,MAAc;AACnC,QAAM,YAAY,aAAa,IAAI;AACnC,SAAO,UAAU;AACrB;AAEA,SAAS,aAAa,MAAc;AAChC,QAAM,QAAQ;AAAA,IACV,UAAU,aAAAC,QAAM;AAAA,IAChB,MAAM,aAAAA,QAAM;AAAA,IACZ,KAAK,aAAAA,QAAM;AAAA,IACX,QAAQ,aAAAA,QAAM;AAAA,EAClB;AACA,QAAM,KAAK,IAAI,SAAS,GAAG,OAAO,KAAK,KAAK,GAAG,IAAI;AACnD,SAAO,GAAG,KAAK;AACnB;AAWA,eAAe,eAAe,KAAU;AACpC,QAAM,aAAoB,CAAC;AAE3B,MAAI,MAAM,QAAQ,IAAI,OAAO,GAAG;AAC5B,eAAW,SAAS,IAAI,SAAS;AAC7B,UAAI;AACA,cAAM,OAAO,MAAM,QAAQ,KAAK;AAChC,cAAM,UAAU,gBAAgB,IAAI;AACpC,cAAM,UAAU,cAAU,uBAAM,OAAO,IAAI;AAE3C,mBAAW,KAAK,GAAG,QAAQ,UAAgB;AAAA,MAC/C,SAAS,GAAG;AACR,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ;AAAA,EACJ,OAAO;AACH,YAAQ,KAAK,iDAAiD,OAAO,IAAI,OAAO,EAAE;AAAA,EACtF;AAEA,SAAO;AACX;","names":["import_mdx","mdxCompile","path","fs","React"]}
+{"version":3,"sources":["../content.ts","../src/content/index.ts"],"sourcesContent":["export * from \"./src/content/index\"","import path from \"path\";\nimport {promises as fs} from \"fs\";\n\nimport React from \"react\";\nimport {parse} from \"codehike\";\nimport {visit} from \"unist-util-visit\";\nimport {recmaCodeHike, remarkCodeHike} from \"codehike/mdx\";\nimport {compile as mdxCompile} from \"@mdx-js/mdx\";\n\nconst codeHikeOptions = {\n    lineNumbers: true,\n    showCopyButton: true,\n    autoImport: true,\n    components: {code: \"Code\"},\n    // syntaxHighlighting: { // TODO: !!! FROM SETTINGS !!! wait for rr7 rsc ??\n    //     theme: \"github-dark\",\n    // },\n};\n//\n// // since unist does not support heading level > 6, we need to normalize them\nfunction normalizeCustomHeadings() {\n    return (tree: any) => {\n        visit(tree, 'paragraph', (node, index, parent) => {\n            const match = node.children[0] && node.children[0].value.match(/^(#+)\\s+(.*)/);\n            if (match) {\n                const level = match[1].length;\n                const text = match[2];\n                if (level > 6) {\n                    // Create a new heading node with depth 6\n                    const headingNode = {\n                        type: 'heading',\n                        depth: level,\n                        children: [{type: 'text', value: text}]\n                    };\n                    // Replace the paragraph node with the new heading node\n                    //@ts-ignore\n                    parent.children[index] = headingNode;\n                }\n            }\n        });\n    };\n}\n\n//\nasync function compile(content: string): Promise<string> {\n    const compiled = await mdxCompile(content, {\n        remarkPlugins: [normalizeCustomHeadings, [remarkCodeHike, codeHikeOptions]],\n        recmaPlugins: [\n            [recmaCodeHike, codeHikeOptions]\n        ],\n        outputFormat: 'function-body',\n        development: false,\n    });\n\n    return String(compiled)\n}\n\nasync function compileBySlug(slug: string) {\n    // TODO: cwd ?\n    const filePath = path.join(process.cwd(), `${slug}.md`)\n\n    try {\n        await fs.access(filePath)\n    } catch (e) {\n        console.error(e)\n        return \"\"\n    }\n\n    const content = await fs.readFile(filePath, \"utf-8\");\n\n    return await compile(content)\n}\n\nfunction getMDXComponent(code: string) {\n    const mdxExport = getMDXExport(code)\n    return mdxExport.default\n}\n\nfunction getMDXExport(code: string) {\n    const scope = {\n        Fragment: React.Fragment,\n        jsxs: React.createElement,\n        jsx: React.createElement,\n        jsxDEV: React.createElement,\n    }\n    const fn = new Function(...Object.keys(scope), code)\n    return fn(scope)\n}\n\n//\n// function MDXContent(code: string) {\n//     return React.useMemo(\n//         () => code ? getMDXComponent(code) : null,\n//         [code]\n//     )\n// }\n\n// TODO: mod ts\nasync function lazyReferences(mod: any) {\n    const references: any[] = []\n\n    if (Array.isArray(mod.default)) {\n        for (const chunk of mod.default) {\n            try {\n                const code = await compile(chunk) // TODO: do we need real path?\n                const Content = getMDXComponent(code)\n                const content = Content ? parse(Content) : null\n\n                references.push(...content.references as [])\n            } catch (e) {\n                console.error(e)\n            }\n        }\n    } else {\n        console.warn(`mod.default is not an array, current type is: ${typeof mod.default}`)\n    }\n\n    return references\n}\n\nexport {\n    compileBySlug,\n    lazyReferences\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAAiB;AACjB,gBAA6B;AAE7B,mBAAkB;AAClB,sBAAoB;AACpB,8BAAoB;AACpB,iBAA4C;AAC5C,IAAAA,cAAoC;AAEpC,IAAM,kBAAkB;AAAA,EACpB,aAAa;AAAA,EACb,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,YAAY,EAAC,MAAM,OAAM;AAAA;AAAA;AAAA;AAI7B;AAGA,SAAS,0BAA0B;AAC/B,SAAO,CAAC,SAAc;AAClB,uCAAM,MAAM,aAAa,CAAC,MAAM,OAAO,WAAW;AAC9C,YAAM,QAAQ,KAAK,SAAS,CAAC,KAAK,KAAK,SAAS,CAAC,EAAE,MAAM,MAAM,cAAc;AAC7E,UAAI,OAAO;AACP,cAAM,QAAQ,MAAM,CAAC,EAAE;AACvB,cAAM,OAAO,MAAM,CAAC;AACpB,YAAI,QAAQ,GAAG;AAEX,gBAAM,cAAc;AAAA,YAChB,MAAM;AAAA,YACN,OAAO;AAAA,YACP,UAAU,CAAC,EAAC,MAAM,QAAQ,OAAO,KAAI,CAAC;AAAA,UAC1C;AAGA,iBAAO,SAAS,KAAK,IAAI;AAAA,QAC7B;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAGA,eAAe,QAAQ,SAAkC;AACrD,QAAM,WAAW,UAAM,YAAAC,SAAW,SAAS;AAAA,IACvC,eAAe,CAAC,yBAAyB,CAAC,2BAAgB,eAAe,CAAC;AAAA,IAC1E,cAAc;AAAA,MACV,CAAC,0BAAe,eAAe;AAAA,IACnC;AAAA,IACA,cAAc;AAAA,IACd,aAAa;AAAA,EACjB,CAAC;AAED,SAAO,OAAO,QAAQ;AAC1B;AAEA,eAAe,cAAc,MAAc;AAEvC,QAAM,WAAW,YAAAC,QAAK,KAAK,QAAQ,IAAI,GAAG,GAAG,IAAI,KAAK;AAEtD,MAAI;AACA,UAAM,UAAAC,SAAG,OAAO,QAAQ;AAAA,EAC5B,SAAS,GAAG;AACR,YAAQ,MAAM,CAAC;AACf,WAAO;AAAA,EACX;AAEA,QAAM,UAAU,MAAM,UAAAA,SAAG,SAAS,UAAU,OAAO;AAEnD,SAAO,MAAM,QAAQ,OAAO;AAChC;AAEA,SAAS,gBAAgB,MAAc;AACnC,QAAM,YAAY,aAAa,IAAI;AACnC,SAAO,UAAU;AACrB;AAEA,SAAS,aAAa,MAAc;AAChC,QAAM,QAAQ;AAAA,IACV,UAAU,aAAAC,QAAM;AAAA,IAChB,MAAM,aAAAA,QAAM;AAAA,IACZ,KAAK,aAAAA,QAAM;AAAA,IACX,QAAQ,aAAAA,QAAM;AAAA,EAClB;AACA,QAAM,KAAK,IAAI,SAAS,GAAG,OAAO,KAAK,KAAK,GAAG,IAAI;AACnD,SAAO,GAAG,KAAK;AACnB;AAWA,eAAe,eAAe,KAAU;AACpC,QAAM,aAAoB,CAAC;AAE3B,MAAI,MAAM,QAAQ,IAAI,OAAO,GAAG;AAC5B,eAAW,SAAS,IAAI,SAAS;AAC7B,UAAI;AACA,cAAM,OAAO,MAAM,QAAQ,KAAK;AAChC,cAAM,UAAU,gBAAgB,IAAI;AACpC,cAAM,UAAU,cAAU,uBAAM,OAAO,IAAI;AAE3C,mBAAW,KAAK,GAAG,QAAQ,UAAgB;AAAA,MAC/C,SAAS,GAAG;AACR,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ;AAAA,EACJ,OAAO;AACH,YAAQ,KAAK,iDAAiD,OAAO,IAAI,OAAO,EAAE;AAAA,EACtF;AAEA,SAAO;AACX;","names":["import_mdx","mdxCompile","path","fs","React"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../index.ts","../src/index.ts","../src/utils.ts","../src/types.ts"],"sourcesContent":["export {default} from \"./src/index\"\n\nexport {\n    pluginNavigation\n} from \"./src/utils\"\n\nexport * from \"./src/types\"\n\n","// Define the new PluginV type with a callback function that returns another function\nimport {Reference} from \"./types\";\n\n// Define the new PluginV type with a callback function that returns another function\nexport type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;\n\n// Utility type to infer if a type is an array and avoid wrapping it into an array twice\ntype NormalizeArray<T> = T extends Array<infer U> ? U[] : T;\n\n// Infer the return type of the plugin callback properly and normalize array types\ntype PluginResult<T extends UniformPlugin<any>> = T extends UniformPlugin<infer R> ? R : never;\n\n// Merge all plugin return types into a single object and normalize arrays\ntype MergePluginResults<T extends UniformPlugin<any>[]> = {\n    [K in keyof UnionToIntersection<PluginResult<T[number]>>]: NormalizeArray<UnionToIntersection<PluginResult<T[number]>>[K]>\n};\n\n// Utility type to handle intersection to an object type\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n// Implement the uniform function\nexport default function uniform<T extends UniformPlugin<any>[]>(\n    references: Reference[],\n    config: { plugins: T }\n) {\n    // Infer the merged result type from all plugins\n    type ResultType = MergePluginResults<T>;\n\n    // Initialize the response with a type-safe out object\n    const response: {\n        references: Reference[]\n        out: { [K in keyof ResultType]: ResultType[K] }\n    } = {\n        references,\n        out: {} as { [K in keyof ResultType]: ResultType[K] }\n    };\n\n\n    const finishCallbacks = new Set();\n\n    config.plugins.forEach((plugin) => {\n        const call = plugin(cb => {\n            finishCallbacks.add(cb);\n        })\n\n        references.forEach((ref) => {\n            call(ref)\n        });\n    })\n\n    finishCallbacks.forEach(cb => {\n        if (typeof cb === \"function\") {\n            const resp = cb()\n            if (typeof resp !== \"object\") {\n                throw new Error(`Invalid callback return type: ${typeof resp}`)\n            }\n\n            response.out = {\n                ...response.out,\n                ...resp\n            }\n        } else {\n            throw new Error(`Invalid callback type: ${typeof cb}`)\n        }\n    });\n\n    return response;\n}\n\n// Example usage\n// const examplePlugin: UniformPlugin<{ value: boolean }> = (cb) => {\n//     return (ref: Reference) => {\n//     };\n// };\n// function examplePlugin(cb: (cb: () => { value: boolean }) => void) {\n//     cb(() => ({\n//         value: true,\n//     }));\n//\n//     return (ref: Reference) => {\n//\n//     };\n// }\n// const response = uniform([/* references */], {\n//     plugins: [examplePlugin],\n// });\n// response.out\n","import path from 'path';\nimport matter from 'gray-matter';\nimport {Sidebar, FrontMatter, PageFrontMatter} from \"@xyd-js/core\";\n\nimport {Reference} from \"./types\";\nimport uniform from \"./index\";\n\n// interface UniformFrontMatter extends FrontMatter { // TODO: it's concept only\n//     scopes?: string\n// }\n\ntype GroupMap = {\n    [key: string]: {\n        __groups: GroupMap\n        pages: Set<string>\n    }\n}\n\nexport interface pluginNavigationOptions {\n    urlPrefix: string\n}\n\nexport function pluginNavigation(options: pluginNavigationOptions) {\n    if (!options.urlPrefix) {\n        throw new Error(\"urlPrefix is required\")\n    }\n\n    return function pluginNavigationInner(cb: (cb: () => {\n        pageFrontMatter: PageFrontMatter\n        sidebar: Sidebar[]\n    }) => void) {\n        const pageFrontMatter: PageFrontMatter = {}\n        const groupMaps: GroupMap = {}\n\n        cb(() => {\n            return {\n                pageFrontMatter: pageFrontMatter,\n                sidebar: convertGroupMapsToNavigations(groupMaps) as Sidebar[]\n            }\n        })\n\n        return (ref: Reference) => {\n            const content = matter(ref.description || \"\") // TODO: pluginMatter before?\n\n            if (content.data) {\n                const data = content.data as FrontMatter\n\n                const pagePath = path.join(options.urlPrefix, ref.canonical)\n\n                if (data.title) {\n                    pageFrontMatter[pagePath] = {\n                        title: data.title,\n                    }\n                }\n\n                if (data.group) {\n                    if (typeof content?.data?.group === \"string\") {\n                        // TODO: seek nested group (it's not always from 0)\n                        throw new Error(\"group as string is not supported yet\")\n                    }\n\n                    content.data.group.reduce((groups: GroupMap, group: string, i: number) => {\n                        if (!groups[group]) {\n                            groups[group] = {\n                                __groups: {},\n                                pages: new Set()\n                            }\n                        }\n\n                        if (i === content.data.group.length - 1) {\n                            groups[group].pages.add(pagePath)\n                        }\n\n                        return groups[group].__groups\n                    }, groupMaps)\n                }\n\n                // back description to original without frontmatter\n                ref.description = content.content\n            }\n        }\n    }\n}\n\n\nfunction convertGroupMapsToNavigations(groupMaps: GroupMap): Sidebar[] {\n    const nav: Sidebar[] = []\n\n    Object.keys(groupMaps).map((groupName) => {\n        const current = groupMaps[groupName]\n\n        const pages: string[] | Sidebar[] = []\n\n        current.pages.forEach((page: string) => {\n            pages.push(page)\n        })\n\n        if (Object.keys(current.__groups).length) {\n            const subNav: Sidebar = {\n                group: groupName,\n                pages: convertGroupMapsToNavigations(current.__groups)\n            }\n\n            nav.push(subNav)\n        } else {\n            nav.push({\n                group: groupName,\n                pages,\n            })\n        }\n    })\n\n    return nav\n}\n\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginNavigation({\n//         urlPrefix: \"/docs\"\n//     })],\n// });\n\n\n","// TODO: concept only\nexport enum ReferenceCategory {\n    // for React\n    COMPONENTS = \"components\",\n    HOOKS = \"hooks\",\n    // end for React\n\n    // for API\n    REST = \"rest\",\n    GRAPHQL = \"graphql\",\n    // end for API\n\n    // for code\n    FUNCTIONS = \"functions\",\n    //\n}\n\n// TODO: concept only\nexport enum ReferenceType {\n    // for React\n    COMPONENT = \"component\",\n    HOOK = \"hook\",\n    // end for React\n\n    // for API\n    REST_HTTP_GET = \"rest_get\",\n    REST_HTTP_POST = \"rest_post\",\n    REST_HTTP_PUT = \"rest_put\",\n    REST_HTTP_PATCH = \"rest_patch\",\n    REST_HTTP_DELETE = \"rest_delete\",\n    // ---\n    GRAPHQL_QUERY = \"graphql_query\",\n    GRAPHQL_MUTATION = \"graphql_mutation\",\n    // end for API\n\n    // for code\n    FUNCTION_JS = \"function_js\",\n    // end for code\n}\n\nexport interface GraphQLReferenceContext {\n}\n\n// TODO: custom value?\nexport interface OpenAPIReferenceContext {\n    method: string;\n\n    path: string;\n}\n\nexport type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;\n\nexport interface ExampleRoot {\n    groups: ExampleGroup[];\n}\n\nexport interface ExampleGroup {\n    description?: string;\n\n    examples: Example[];\n}\n\nexport interface Example {\n    description?: string; // TODO: replace with title ?\n\n    codeblock: CodeBlock;\n}\n\nexport interface CodeBlock {\n    title?: string;\n\n    tabs: CodeBlockTab[];\n}\n\nexport interface GraphQLExampleContext {\n    schema?: any; // TODO:\n}\n\nexport interface OpenAPIExampleContext {\n    status?: number;\n\n    content?: string;\n}\n\nexport type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;\n\nexport interface CodeBlockTab {\n    // title of the tab e.g \"JavaScript\"\n    title: string;\n\n    // code in the tab e.g \"console.log('Hello World')\"\n    code: string\n    \n    // language of the code e.g \"js\"\n    language: string;\n\n    // context of the generation method e.g openapi or graphql\n    context?: ExampleContext;\n}\n\nexport interface Reference {\n    title: string;\n    description: string;\n    canonical: string;\n\n    definitions: Definition[]\n    examples: ExampleRoot\n\n    category?: ReferenceCategory; // TODO: do we need that?\n    type?: ReferenceType; // TODO: do we need that?\n    context?: ReferenceContext;\n}\n\nexport interface Definition {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n    type?: string;\n\n    id?: string;\n\n    description?: string;\n}\n\nexport interface DefinitionProperty {\n    name: string;\n\n    type: string;\n\n    description: string;\n\n    properties?: DefinitionProperty[];\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqBe,SAAR,QACH,YACA,QACF;AAKE,QAAM,WAGF;AAAA,IACA;AAAA,IACA,KAAK,CAAC;AAAA,EACV;AAGA,QAAM,kBAAkB,oBAAI,IAAI;AAEhC,SAAO,QAAQ,QAAQ,CAAC,WAAW;AAC/B,UAAM,OAAO,OAAO,QAAM;AACtB,sBAAgB,IAAI,EAAE;AAAA,IAC1B,CAAC;AAED,eAAW,QAAQ,CAAC,QAAQ;AACxB,WAAK,GAAG;AAAA,IACZ,CAAC;AAAA,EACL,CAAC;AAED,kBAAgB,QAAQ,QAAM;AAC1B,QAAI,OAAO,OAAO,YAAY;AAC1B,YAAM,OAAO,GAAG;AAChB,UAAI,OAAO,SAAS,UAAU;AAC1B,cAAM,IAAI,MAAM,iCAAiC,OAAO,IAAI,EAAE;AAAA,MAClE;AAEA,eAAS,MAAM;AAAA,QACX,GAAG,SAAS;AAAA,QACZ,GAAG;AAAA,MACP;AAAA,IACJ,OAAO;AACH,YAAM,IAAI,MAAM,0BAA0B,OAAO,EAAE,EAAE;AAAA,IACzD;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;ACnEA,kBAAiB;AACjB,yBAAmB;AAqBZ,SAAS,iBAAiB,SAAkC;AAC/D,MAAI,CAAC,QAAQ,WAAW;AACpB,UAAM,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AAEA,SAAO,SAAS,sBAAsB,IAG1B;AACR,UAAM,kBAAmC,CAAC;AAC1C,UAAM,YAAsB,CAAC;AAE7B,OAAG,MAAM;AACL,aAAO;AAAA,QACH;AAAA,QACA,SAAS,8BAA8B,SAAS;AAAA,MACpD;AAAA,IACJ,CAAC;AAED,WAAO,CAAC,QAAmB;AAzCnC;AA0CY,YAAM,cAAU,mBAAAA,SAAO,IAAI,eAAe,EAAE;AAE5C,UAAI,QAAQ,MAAM;AACd,cAAM,OAAO,QAAQ;AAErB,cAAM,WAAW,YAAAC,QAAK,KAAK,QAAQ,WAAW,IAAI,SAAS;AAE3D,YAAI,KAAK,OAAO;AACZ,0BAAgB,QAAQ,IAAI;AAAA,YACxB,OAAO,KAAK;AAAA,UAChB;AAAA,QACJ;AAEA,YAAI,KAAK,OAAO;AACZ,cAAI,SAAO,wCAAS,SAAT,mBAAe,WAAU,UAAU;AAE1C,kBAAM,IAAI,MAAM,sCAAsC;AAAA,UAC1D;AAEA,kBAAQ,KAAK,MAAM,OAAO,CAAC,QAAkB,OAAe,MAAc;AACtE,gBAAI,CAAC,OAAO,KAAK,GAAG;AAChB,qBAAO,KAAK,IAAI;AAAA,gBACZ,UAAU,CAAC;AAAA,gBACX,OAAO,oBAAI,IAAI;AAAA,cACnB;AAAA,YACJ;AAEA,gBAAI,MAAM,QAAQ,KAAK,MAAM,SAAS,GAAG;AACrC,qBAAO,KAAK,EAAE,MAAM,IAAI,QAAQ;AAAA,YACpC;AAEA,mBAAO,OAAO,KAAK,EAAE;AAAA,UACzB,GAAG,SAAS;AAAA,QAChB;AAGA,YAAI,cAAc,QAAQ;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,8BAA8B,WAAgC;AACnE,QAAM,MAAiB,CAAC;AAExB,SAAO,KAAK,SAAS,EAAE,IAAI,CAAC,cAAc;AACtC,UAAM,UAAU,UAAU,SAAS;AAEnC,UAAM,QAA8B,CAAC;AAErC,YAAQ,MAAM,QAAQ,CAAC,SAAiB;AACpC,YAAM,KAAK,IAAI;AAAA,IACnB,CAAC;AAED,QAAI,OAAO,KAAK,QAAQ,QAAQ,EAAE,QAAQ;AACtC,YAAM,SAAkB;AAAA,QACpB,OAAO;AAAA,QACP,OAAO,8BAA8B,QAAQ,QAAQ;AAAA,MACzD;AAEA,UAAI,KAAK,MAAM;AAAA,IACnB,OAAO;AACH,UAAI,KAAK;AAAA,QACL,OAAO;AAAA,QACP;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;AChHO,IAAK,oBAAL,kBAAKC,uBAAL;AAEH,EAAAA,mBAAA,gBAAa;AACb,EAAAA,mBAAA,WAAQ;AAIR,EAAAA,mBAAA,UAAO;AACP,EAAAA,mBAAA,aAAU;AAIV,EAAAA,mBAAA,eAAY;AAZJ,SAAAA;AAAA,GAAA;AAiBL,IAAK,gBAAL,kBAAKC,mBAAL;AAEH,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AAIP,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,sBAAmB;AAInB,EAAAA,eAAA,iBAAc;AAlBN,SAAAA;AAAA,GAAA;","names":["matter","path","ReferenceCategory","ReferenceType"]}
+{"version":3,"sources":["../index.ts","../src/index.ts","../src/utils.ts","../src/types.ts"],"sourcesContent":["export {default} from \"./src/index\"\n\nexport {\n    pluginNavigation\n} from \"./src/utils\"\n\nexport * from \"./src/types\"\n\n","// Define the new PluginV type with a callback function that returns another function\nimport {Reference} from \"./types\";\n\n// Define the new PluginV type with a callback function that returns another function\nexport type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;\n\n// Utility type to infer if a type is an array and avoid wrapping it into an array twice\ntype NormalizeArray<T> = T extends Array<infer U> ? U[] : T;\n\n// Infer the return type of the plugin callback properly and normalize array types\ntype PluginResult<T extends UniformPlugin<any>> = T extends UniformPlugin<infer R> ? R : never;\n\n// Merge all plugin return types into a single object and normalize arrays\ntype MergePluginResults<T extends UniformPlugin<any>[]> = {\n    [K in keyof UnionToIntersection<PluginResult<T[number]>>]: NormalizeArray<UnionToIntersection<PluginResult<T[number]>>[K]>\n};\n\n// Utility type to handle intersection to an object type\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n// Implement the uniform function\nexport default function uniform<T extends UniformPlugin<any>[]>(\n    references: Reference[],\n    config: { plugins: T }\n) {\n    // Infer the merged result type from all plugins\n    type ResultType = MergePluginResults<T>;\n\n    // Initialize the response with a type-safe out object\n    const response: {\n        references: Reference[]\n        out: { [K in keyof ResultType]: ResultType[K] }\n    } = {\n        references,\n        out: {} as { [K in keyof ResultType]: ResultType[K] }\n    };\n\n\n    const finishCallbacks = new Set();\n\n    config.plugins.forEach((plugin) => {\n        const call = plugin(cb => {\n            finishCallbacks.add(cb);\n        })\n\n        references.forEach((ref) => {\n            call(ref)\n        });\n    })\n\n    finishCallbacks.forEach(cb => {\n        if (typeof cb === \"function\") {\n            const resp = cb()\n            if (typeof resp !== \"object\") {\n                throw new Error(`Invalid callback return type: ${typeof resp}`)\n            }\n\n            response.out = {\n                ...response.out,\n                ...resp\n            }\n        } else {\n            throw new Error(`Invalid callback type: ${typeof cb}`)\n        }\n    });\n\n    return response;\n}\n\n// Example usage\n// const examplePlugin: UniformPlugin<{ value: boolean }> = (cb) => {\n//     return (ref: Reference) => {\n//     };\n// };\n// function examplePlugin(cb: (cb: () => { value: boolean }) => void) {\n//     cb(() => ({\n//         value: true,\n//     }));\n//\n//     return (ref: Reference) => {\n//\n//     };\n// }\n// const response = uniform([/* references */], {\n//     plugins: [examplePlugin],\n// });\n// response.out\n","import path from 'path';\nimport matter from 'gray-matter';\nimport {Sidebar, FrontMatter, PageFrontMatter} from \"@xyd-js/core\";\n\nimport {Reference} from \"./types\";\nimport uniform from \"./index\";\n\n// interface UniformFrontMatter extends FrontMatter { // TODO: it's concept only\n//     scopes?: string\n// }\n\ntype GroupMap = {\n    [key: string]: {\n        __groups: GroupMap\n        pages: Set<string>\n    }\n}\n\nexport interface pluginNavigationOptions {\n    urlPrefix: string\n}\n\nexport function pluginNavigation(options: pluginNavigationOptions) {\n    if (!options.urlPrefix) {\n        throw new Error(\"urlPrefix is required\")\n    }\n\n    return function pluginNavigationInner(cb: (cb: () => {\n        pageFrontMatter: PageFrontMatter\n        sidebar: Sidebar[]\n    }) => void) {\n        const pageFrontMatter: PageFrontMatter = {}\n        const groupMaps: GroupMap = {}\n\n        cb(() => {\n            return {\n                pageFrontMatter: pageFrontMatter,\n                sidebar: convertGroupMapsToNavigations(groupMaps) as Sidebar[]\n            }\n        })\n\n        return (ref: Reference) => {\n            const content = matter(ref.description || \"\") // TODO: pluginMatter before?\n\n            if (content.data) {\n                const data = content.data as FrontMatter\n\n                const pagePath = path.join(options.urlPrefix, ref.canonical)\n\n                if (data.title) {\n                    pageFrontMatter[pagePath] = {\n                        title: data.title,\n                    }\n                }\n\n                if (data.group) {\n                    if (typeof content?.data?.group === \"string\") {\n                        // TODO: seek nested group (it's not always from 0)\n                        throw new Error(\"group as string is not supported yet\")\n                    }\n\n                    content.data.group.reduce((groups: GroupMap, group: string, i: number) => {\n                        if (!groups[group]) {\n                            groups[group] = {\n                                __groups: {},\n                                pages: new Set()\n                            }\n                        }\n\n                        if (i === content.data.group.length - 1) {\n                            groups[group].pages.add(pagePath)\n                        }\n\n                        return groups[group].__groups\n                    }, groupMaps)\n                }\n\n                // back description to original without frontmatter\n                ref.description = content.content\n            }\n        }\n    }\n}\n\n\nfunction convertGroupMapsToNavigations(groupMaps: GroupMap): Sidebar[] {\n    const nav: Sidebar[] = []\n\n    Object.keys(groupMaps).map((groupName) => {\n        const current = groupMaps[groupName]\n\n        const pages: string[] | Sidebar[] = []\n\n        current.pages.forEach((page: string) => {\n            pages.push(page)\n        })\n\n        if (Object.keys(current.__groups).length) {\n            const subNav: Sidebar = {\n                group: groupName,\n                pages: convertGroupMapsToNavigations(current.__groups)\n            }\n\n            nav.push(subNav)\n        } else {\n            nav.push({\n                group: groupName,\n                pages,\n            })\n        }\n    })\n\n    return nav\n}\n\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginNavigation({\n//         urlPrefix: \"/docs\"\n//     })],\n// });\n\n\n","// TODO: concept only\nexport enum ReferenceCategory {\n    // for React\n    COMPONENTS = \"components\",\n    HOOKS = \"hooks\",\n    // end for React\n\n    // for API\n    REST = \"rest\",\n    GRAPHQL = \"graphql\",\n    // end for API\n\n    // for code\n    FUNCTIONS = \"functions\",\n    //\n}\n\n// TODO: concept only\nexport enum ReferenceType {\n    // for React\n    COMPONENT = \"component\",\n    HOOK = \"hook\",\n    // end for React\n\n    // for API\n    REST_HTTP_GET = \"rest_get\",\n    REST_HTTP_POST = \"rest_post\",\n    REST_HTTP_PUT = \"rest_put\",\n    REST_HTTP_PATCH = \"rest_patch\",\n    REST_HTTP_DELETE = \"rest_delete\",\n    // ---\n    GRAPHQL_QUERY = \"graphql_query\",\n    GRAPHQL_MUTATION = \"graphql_mutation\",\n    // end for API\n\n    // for code\n    FUNCTION_JS = \"function_js\",\n    // end for code\n}\n\nexport interface GraphQLReferenceContext {\n}\n\n// TODO: custom value?\nexport interface OpenAPIReferenceContext {\n    method: string;\n\n    path: string;\n}\n\nexport type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;\n\nexport interface ExampleRoot {\n    groups: ExampleGroup[];\n}\n\nexport interface ExampleGroup {\n    description?: string;\n\n    examples: Example[];\n}\n\nexport interface Example {\n    description?: string; // TODO: replace with title ?\n\n    codeblock: CodeBlock;\n}\n\nexport interface CodeBlock {\n    title?: string;\n\n    tabs: CodeBlockTab[];\n}\n\nexport interface GraphQLExampleContext {\n    schema?: any; // TODO:\n}\n\nexport interface OpenAPIExampleContext {\n    status?: number;\n\n    content?: string;\n}\n\nexport type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;\n\nexport interface CodeBlockTab {\n    // title of the tab e.g \"JavaScript\"\n    title: string;\n\n    // code in the tab e.g \"console.log('Hello World')\"\n    code: string\n    \n    // language of the code e.g \"js\"\n    language: string;\n\n    // context of the generation method e.g openapi or graphql\n    context?: ExampleContext;\n}\n\nexport interface Reference {\n    title: string;\n    description: string;\n    canonical: string;\n\n    definitions: Definition[]\n    examples: ExampleRoot\n\n    category?: ReferenceCategory; // TODO: do we need that?\n    type?: ReferenceType; // TODO: do we need that?\n    context?: ReferenceContext;\n}\n\nexport interface Definition {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n\n    type?: string;\n\n    id?: string;\n\n    description?: string;\n}\n\nexport interface DefinitionProperty {\n    name: string;\n\n    type: string;\n\n    description: string;\n\n    context?: any // TODO: better type\n\n    properties?: DefinitionProperty[];\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqBe,SAAR,QACH,YACA,QACF;AAKE,QAAM,WAGF;AAAA,IACA;AAAA,IACA,KAAK,CAAC;AAAA,EACV;AAGA,QAAM,kBAAkB,oBAAI,IAAI;AAEhC,SAAO,QAAQ,QAAQ,CAAC,WAAW;AAC/B,UAAM,OAAO,OAAO,QAAM;AACtB,sBAAgB,IAAI,EAAE;AAAA,IAC1B,CAAC;AAED,eAAW,QAAQ,CAAC,QAAQ;AACxB,WAAK,GAAG;AAAA,IACZ,CAAC;AAAA,EACL,CAAC;AAED,kBAAgB,QAAQ,QAAM;AAC1B,QAAI,OAAO,OAAO,YAAY;AAC1B,YAAM,OAAO,GAAG;AAChB,UAAI,OAAO,SAAS,UAAU;AAC1B,cAAM,IAAI,MAAM,iCAAiC,OAAO,IAAI,EAAE;AAAA,MAClE;AAEA,eAAS,MAAM;AAAA,QACX,GAAG,SAAS;AAAA,QACZ,GAAG;AAAA,MACP;AAAA,IACJ,OAAO;AACH,YAAM,IAAI,MAAM,0BAA0B,OAAO,EAAE,EAAE;AAAA,IACzD;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;ACnEA,kBAAiB;AACjB,yBAAmB;AAqBZ,SAAS,iBAAiB,SAAkC;AAC/D,MAAI,CAAC,QAAQ,WAAW;AACpB,UAAM,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AAEA,SAAO,SAAS,sBAAsB,IAG1B;AACR,UAAM,kBAAmC,CAAC;AAC1C,UAAM,YAAsB,CAAC;AAE7B,OAAG,MAAM;AACL,aAAO;AAAA,QACH;AAAA,QACA,SAAS,8BAA8B,SAAS;AAAA,MACpD;AAAA,IACJ,CAAC;AAED,WAAO,CAAC,QAAmB;AAzCnC;AA0CY,YAAM,cAAU,mBAAAA,SAAO,IAAI,eAAe,EAAE;AAE5C,UAAI,QAAQ,MAAM;AACd,cAAM,OAAO,QAAQ;AAErB,cAAM,WAAW,YAAAC,QAAK,KAAK,QAAQ,WAAW,IAAI,SAAS;AAE3D,YAAI,KAAK,OAAO;AACZ,0BAAgB,QAAQ,IAAI;AAAA,YACxB,OAAO,KAAK;AAAA,UAChB;AAAA,QACJ;AAEA,YAAI,KAAK,OAAO;AACZ,cAAI,SAAO,wCAAS,SAAT,mBAAe,WAAU,UAAU;AAE1C,kBAAM,IAAI,MAAM,sCAAsC;AAAA,UAC1D;AAEA,kBAAQ,KAAK,MAAM,OAAO,CAAC,QAAkB,OAAe,MAAc;AACtE,gBAAI,CAAC,OAAO,KAAK,GAAG;AAChB,qBAAO,KAAK,IAAI;AAAA,gBACZ,UAAU,CAAC;AAAA,gBACX,OAAO,oBAAI,IAAI;AAAA,cACnB;AAAA,YACJ;AAEA,gBAAI,MAAM,QAAQ,KAAK,MAAM,SAAS,GAAG;AACrC,qBAAO,KAAK,EAAE,MAAM,IAAI,QAAQ;AAAA,YACpC;AAEA,mBAAO,OAAO,KAAK,EAAE;AAAA,UACzB,GAAG,SAAS;AAAA,QAChB;AAGA,YAAI,cAAc,QAAQ;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,8BAA8B,WAAgC;AACnE,QAAM,MAAiB,CAAC;AAExB,SAAO,KAAK,SAAS,EAAE,IAAI,CAAC,cAAc;AACtC,UAAM,UAAU,UAAU,SAAS;AAEnC,UAAM,QAA8B,CAAC;AAErC,YAAQ,MAAM,QAAQ,CAAC,SAAiB;AACpC,YAAM,KAAK,IAAI;AAAA,IACnB,CAAC;AAED,QAAI,OAAO,KAAK,QAAQ,QAAQ,EAAE,QAAQ;AACtC,YAAM,SAAkB;AAAA,QACpB,OAAO;AAAA,QACP,OAAO,8BAA8B,QAAQ,QAAQ;AAAA,MACzD;AAEA,UAAI,KAAK,MAAM;AAAA,IACnB,OAAO;AACH,UAAI,KAAK;AAAA,QACL,OAAO;AAAA,QACP;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;AChHO,IAAK,oBAAL,kBAAKC,uBAAL;AAEH,EAAAA,mBAAA,gBAAa;AACb,EAAAA,mBAAA,WAAQ;AAIR,EAAAA,mBAAA,UAAO;AACP,EAAAA,mBAAA,aAAU;AAIV,EAAAA,mBAAA,eAAY;AAZJ,SAAAA;AAAA,GAAA;AAiBL,IAAK,gBAAL,kBAAKC,mBAAL;AAEH,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AAIP,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,sBAAmB;AAInB,EAAAA,eAAA,iBAAc;AAlBN,SAAAA;AAAA,GAAA;","names":["matter","path","ReferenceCategory","ReferenceType"]}

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { R as Reference } from './types-C8Pm_zQH.cjs';
-export { C as CodeBlock, i as CodeBlockTab, D as Definition, j as DefinitionProperty, e as Example, h as ExampleContext, d as ExampleGroup, E as ExampleRoot, f as GraphQLExampleContext, G as GraphQLReferenceContext, g as OpenAPIExampleContext, O as OpenAPIReferenceContext, a as ReferenceCategory, c as ReferenceContext, b as ReferenceType } from './types-C8Pm_zQH.cjs';
+import { R as Reference } from './types-CbDJSEtC.cjs';
+export { C as CodeBlock, i as CodeBlockTab, D as Definition, j as DefinitionProperty, e as Example, h as ExampleContext, d as ExampleGroup, E as ExampleRoot, f as GraphQLExampleContext, G as GraphQLReferenceContext, g as OpenAPIExampleContext, O as OpenAPIReferenceContext, a as ReferenceCategory, c as ReferenceContext, b as ReferenceType } from './types-CbDJSEtC.cjs';
 import { PageFrontMatter, Sidebar } from '@xyd-js/core';
 
 type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;
@@ -13,7 +13,7 @@ declare function uniform<T extends UniformPlugin<any>[]>(references: Reference[]
     plugins: T;
 }): {
     references: Reference[];
-    out: { [K in keyof UnionToIntersection<PluginResult<T[number]>>]: MergePluginResults<T>[K]; };
+    out: MergePluginResults<T> extends infer T_1 ? { [K in keyof T_1]: MergePluginResults<T>[K]; } : never;
 };
 
 interface pluginNavigationOptions {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { R as Reference } from './types-C8Pm_zQH.js';
-export { C as CodeBlock, i as CodeBlockTab, D as Definition, j as DefinitionProperty, e as Example, h as ExampleContext, d as ExampleGroup, E as ExampleRoot, f as GraphQLExampleContext, G as GraphQLReferenceContext, g as OpenAPIExampleContext, O as OpenAPIReferenceContext, a as ReferenceCategory, c as ReferenceContext, b as ReferenceType } from './types-C8Pm_zQH.js';
+import { R as Reference } from './types-CbDJSEtC.js';
+export { C as CodeBlock, i as CodeBlockTab, D as Definition, j as DefinitionProperty, e as Example, h as ExampleContext, d as ExampleGroup, E as ExampleRoot, f as GraphQLExampleContext, G as GraphQLReferenceContext, g as OpenAPIExampleContext, O as OpenAPIReferenceContext, a as ReferenceCategory, c as ReferenceContext, b as ReferenceType } from './types-CbDJSEtC.js';
 import { PageFrontMatter, Sidebar } from '@xyd-js/core';
 
 type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;
@@ -13,7 +13,7 @@ declare function uniform<T extends UniformPlugin<any>[]>(references: Reference[]
     plugins: T;
 }): {
     references: Reference[];
-    out: { [K in keyof UnionToIntersection<PluginResult<T[number]>>]: MergePluginResults<T>[K]; };
+    out: MergePluginResults<T> extends infer T_1 ? { [K in keyof T_1]: MergePluginResults<T>[K]; } : never;
 };
 
 interface pluginNavigationOptions {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/utils.ts","../src/types.ts"],"sourcesContent":["// Define the new PluginV type with a callback function that returns another function\nimport {Reference} from \"./types\";\n\n// Define the new PluginV type with a callback function that returns another function\nexport type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;\n\n// Utility type to infer if a type is an array and avoid wrapping it into an array twice\ntype NormalizeArray<T> = T extends Array<infer U> ? U[] : T;\n\n// Infer the return type of the plugin callback properly and normalize array types\ntype PluginResult<T extends UniformPlugin<any>> = T extends UniformPlugin<infer R> ? R : never;\n\n// Merge all plugin return types into a single object and normalize arrays\ntype MergePluginResults<T extends UniformPlugin<any>[]> = {\n    [K in keyof UnionToIntersection<PluginResult<T[number]>>]: NormalizeArray<UnionToIntersection<PluginResult<T[number]>>[K]>\n};\n\n// Utility type to handle intersection to an object type\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n// Implement the uniform function\nexport default function uniform<T extends UniformPlugin<any>[]>(\n    references: Reference[],\n    config: { plugins: T }\n) {\n    // Infer the merged result type from all plugins\n    type ResultType = MergePluginResults<T>;\n\n    // Initialize the response with a type-safe out object\n    const response: {\n        references: Reference[]\n        out: { [K in keyof ResultType]: ResultType[K] }\n    } = {\n        references,\n        out: {} as { [K in keyof ResultType]: ResultType[K] }\n    };\n\n\n    const finishCallbacks = new Set();\n\n    config.plugins.forEach((plugin) => {\n        const call = plugin(cb => {\n            finishCallbacks.add(cb);\n        })\n\n        references.forEach((ref) => {\n            call(ref)\n        });\n    })\n\n    finishCallbacks.forEach(cb => {\n        if (typeof cb === \"function\") {\n            const resp = cb()\n            if (typeof resp !== \"object\") {\n                throw new Error(`Invalid callback return type: ${typeof resp}`)\n            }\n\n            response.out = {\n                ...response.out,\n                ...resp\n            }\n        } else {\n            throw new Error(`Invalid callback type: ${typeof cb}`)\n        }\n    });\n\n    return response;\n}\n\n// Example usage\n// const examplePlugin: UniformPlugin<{ value: boolean }> = (cb) => {\n//     return (ref: Reference) => {\n//     };\n// };\n// function examplePlugin(cb: (cb: () => { value: boolean }) => void) {\n//     cb(() => ({\n//         value: true,\n//     }));\n//\n//     return (ref: Reference) => {\n//\n//     };\n// }\n// const response = uniform([/* references */], {\n//     plugins: [examplePlugin],\n// });\n// response.out\n","import path from 'path';\nimport matter from 'gray-matter';\nimport {Sidebar, FrontMatter, PageFrontMatter} from \"@xyd-js/core\";\n\nimport {Reference} from \"./types\";\nimport uniform from \"./index\";\n\n// interface UniformFrontMatter extends FrontMatter { // TODO: it's concept only\n//     scopes?: string\n// }\n\ntype GroupMap = {\n    [key: string]: {\n        __groups: GroupMap\n        pages: Set<string>\n    }\n}\n\nexport interface pluginNavigationOptions {\n    urlPrefix: string\n}\n\nexport function pluginNavigation(options: pluginNavigationOptions) {\n    if (!options.urlPrefix) {\n        throw new Error(\"urlPrefix is required\")\n    }\n\n    return function pluginNavigationInner(cb: (cb: () => {\n        pageFrontMatter: PageFrontMatter\n        sidebar: Sidebar[]\n    }) => void) {\n        const pageFrontMatter: PageFrontMatter = {}\n        const groupMaps: GroupMap = {}\n\n        cb(() => {\n            return {\n                pageFrontMatter: pageFrontMatter,\n                sidebar: convertGroupMapsToNavigations(groupMaps) as Sidebar[]\n            }\n        })\n\n        return (ref: Reference) => {\n            const content = matter(ref.description || \"\") // TODO: pluginMatter before?\n\n            if (content.data) {\n                const data = content.data as FrontMatter\n\n                const pagePath = path.join(options.urlPrefix, ref.canonical)\n\n                if (data.title) {\n                    pageFrontMatter[pagePath] = {\n                        title: data.title,\n                    }\n                }\n\n                if (data.group) {\n                    if (typeof content?.data?.group === \"string\") {\n                        // TODO: seek nested group (it's not always from 0)\n                        throw new Error(\"group as string is not supported yet\")\n                    }\n\n                    content.data.group.reduce((groups: GroupMap, group: string, i: number) => {\n                        if (!groups[group]) {\n                            groups[group] = {\n                                __groups: {},\n                                pages: new Set()\n                            }\n                        }\n\n                        if (i === content.data.group.length - 1) {\n                            groups[group].pages.add(pagePath)\n                        }\n\n                        return groups[group].__groups\n                    }, groupMaps)\n                }\n\n                // back description to original without frontmatter\n                ref.description = content.content\n            }\n        }\n    }\n}\n\n\nfunction convertGroupMapsToNavigations(groupMaps: GroupMap): Sidebar[] {\n    const nav: Sidebar[] = []\n\n    Object.keys(groupMaps).map((groupName) => {\n        const current = groupMaps[groupName]\n\n        const pages: string[] | Sidebar[] = []\n\n        current.pages.forEach((page: string) => {\n            pages.push(page)\n        })\n\n        if (Object.keys(current.__groups).length) {\n            const subNav: Sidebar = {\n                group: groupName,\n                pages: convertGroupMapsToNavigations(current.__groups)\n            }\n\n            nav.push(subNav)\n        } else {\n            nav.push({\n                group: groupName,\n                pages,\n            })\n        }\n    })\n\n    return nav\n}\n\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginNavigation({\n//         urlPrefix: \"/docs\"\n//     })],\n// });\n\n\n","// TODO: concept only\nexport enum ReferenceCategory {\n    // for React\n    COMPONENTS = \"components\",\n    HOOKS = \"hooks\",\n    // end for React\n\n    // for API\n    REST = \"rest\",\n    GRAPHQL = \"graphql\",\n    // end for API\n\n    // for code\n    FUNCTIONS = \"functions\",\n    //\n}\n\n// TODO: concept only\nexport enum ReferenceType {\n    // for React\n    COMPONENT = \"component\",\n    HOOK = \"hook\",\n    // end for React\n\n    // for API\n    REST_HTTP_GET = \"rest_get\",\n    REST_HTTP_POST = \"rest_post\",\n    REST_HTTP_PUT = \"rest_put\",\n    REST_HTTP_PATCH = \"rest_patch\",\n    REST_HTTP_DELETE = \"rest_delete\",\n    // ---\n    GRAPHQL_QUERY = \"graphql_query\",\n    GRAPHQL_MUTATION = \"graphql_mutation\",\n    // end for API\n\n    // for code\n    FUNCTION_JS = \"function_js\",\n    // end for code\n}\n\nexport interface GraphQLReferenceContext {\n}\n\n// TODO: custom value?\nexport interface OpenAPIReferenceContext {\n    method: string;\n\n    path: string;\n}\n\nexport type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;\n\nexport interface ExampleRoot {\n    groups: ExampleGroup[];\n}\n\nexport interface ExampleGroup {\n    description?: string;\n\n    examples: Example[];\n}\n\nexport interface Example {\n    description?: string; // TODO: replace with title ?\n\n    codeblock: CodeBlock;\n}\n\nexport interface CodeBlock {\n    title?: string;\n\n    tabs: CodeBlockTab[];\n}\n\nexport interface GraphQLExampleContext {\n    schema?: any; // TODO:\n}\n\nexport interface OpenAPIExampleContext {\n    status?: number;\n\n    content?: string;\n}\n\nexport type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;\n\nexport interface CodeBlockTab {\n    // title of the tab e.g \"JavaScript\"\n    title: string;\n\n    // code in the tab e.g \"console.log('Hello World')\"\n    code: string\n    \n    // language of the code e.g \"js\"\n    language: string;\n\n    // context of the generation method e.g openapi or graphql\n    context?: ExampleContext;\n}\n\nexport interface Reference {\n    title: string;\n    description: string;\n    canonical: string;\n\n    definitions: Definition[]\n    examples: ExampleRoot\n\n    category?: ReferenceCategory; // TODO: do we need that?\n    type?: ReferenceType; // TODO: do we need that?\n    context?: ReferenceContext;\n}\n\nexport interface Definition {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n    type?: string;\n\n    id?: string;\n\n    description?: string;\n}\n\nexport interface DefinitionProperty {\n    name: string;\n\n    type: string;\n\n    description: string;\n\n    properties?: DefinitionProperty[];\n}"],"mappings":";AAqBe,SAAR,QACH,YACA,QACF;AAKE,QAAM,WAGF;AAAA,IACA;AAAA,IACA,KAAK,CAAC;AAAA,EACV;AAGA,QAAM,kBAAkB,oBAAI,IAAI;AAEhC,SAAO,QAAQ,QAAQ,CAAC,WAAW;AAC/B,UAAM,OAAO,OAAO,QAAM;AACtB,sBAAgB,IAAI,EAAE;AAAA,IAC1B,CAAC;AAED,eAAW,QAAQ,CAAC,QAAQ;AACxB,WAAK,GAAG;AAAA,IACZ,CAAC;AAAA,EACL,CAAC;AAED,kBAAgB,QAAQ,QAAM;AAC1B,QAAI,OAAO,OAAO,YAAY;AAC1B,YAAM,OAAO,GAAG;AAChB,UAAI,OAAO,SAAS,UAAU;AAC1B,cAAM,IAAI,MAAM,iCAAiC,OAAO,IAAI,EAAE;AAAA,MAClE;AAEA,eAAS,MAAM;AAAA,QACX,GAAG,SAAS;AAAA,QACZ,GAAG;AAAA,MACP;AAAA,IACJ,OAAO;AACH,YAAM,IAAI,MAAM,0BAA0B,OAAO,EAAE,EAAE;AAAA,IACzD;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;ACnEA,OAAO,UAAU;AACjB,OAAO,YAAY;AAqBZ,SAAS,iBAAiB,SAAkC;AAC/D,MAAI,CAAC,QAAQ,WAAW;AACpB,UAAM,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AAEA,SAAO,SAAS,sBAAsB,IAG1B;AACR,UAAM,kBAAmC,CAAC;AAC1C,UAAM,YAAsB,CAAC;AAE7B,OAAG,MAAM;AACL,aAAO;AAAA,QACH;AAAA,QACA,SAAS,8BAA8B,SAAS;AAAA,MACpD;AAAA,IACJ,CAAC;AAED,WAAO,CAAC,QAAmB;AAzCnC;AA0CY,YAAM,UAAU,OAAO,IAAI,eAAe,EAAE;AAE5C,UAAI,QAAQ,MAAM;AACd,cAAM,OAAO,QAAQ;AAErB,cAAM,WAAW,KAAK,KAAK,QAAQ,WAAW,IAAI,SAAS;AAE3D,YAAI,KAAK,OAAO;AACZ,0BAAgB,QAAQ,IAAI;AAAA,YACxB,OAAO,KAAK;AAAA,UAChB;AAAA,QACJ;AAEA,YAAI,KAAK,OAAO;AACZ,cAAI,SAAO,wCAAS,SAAT,mBAAe,WAAU,UAAU;AAE1C,kBAAM,IAAI,MAAM,sCAAsC;AAAA,UAC1D;AAEA,kBAAQ,KAAK,MAAM,OAAO,CAAC,QAAkB,OAAe,MAAc;AACtE,gBAAI,CAAC,OAAO,KAAK,GAAG;AAChB,qBAAO,KAAK,IAAI;AAAA,gBACZ,UAAU,CAAC;AAAA,gBACX,OAAO,oBAAI,IAAI;AAAA,cACnB;AAAA,YACJ;AAEA,gBAAI,MAAM,QAAQ,KAAK,MAAM,SAAS,GAAG;AACrC,qBAAO,KAAK,EAAE,MAAM,IAAI,QAAQ;AAAA,YACpC;AAEA,mBAAO,OAAO,KAAK,EAAE;AAAA,UACzB,GAAG,SAAS;AAAA,QAChB;AAGA,YAAI,cAAc,QAAQ;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,8BAA8B,WAAgC;AACnE,QAAM,MAAiB,CAAC;AAExB,SAAO,KAAK,SAAS,EAAE,IAAI,CAAC,cAAc;AACtC,UAAM,UAAU,UAAU,SAAS;AAEnC,UAAM,QAA8B,CAAC;AAErC,YAAQ,MAAM,QAAQ,CAAC,SAAiB;AACpC,YAAM,KAAK,IAAI;AAAA,IACnB,CAAC;AAED,QAAI,OAAO,KAAK,QAAQ,QAAQ,EAAE,QAAQ;AACtC,YAAM,SAAkB;AAAA,QACpB,OAAO;AAAA,QACP,OAAO,8BAA8B,QAAQ,QAAQ;AAAA,MACzD;AAEA,UAAI,KAAK,MAAM;AAAA,IACnB,OAAO;AACH,UAAI,KAAK;AAAA,QACL,OAAO;AAAA,QACP;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;AChHO,IAAK,oBAAL,kBAAKA,uBAAL;AAEH,EAAAA,mBAAA,gBAAa;AACb,EAAAA,mBAAA,WAAQ;AAIR,EAAAA,mBAAA,UAAO;AACP,EAAAA,mBAAA,aAAU;AAIV,EAAAA,mBAAA,eAAY;AAZJ,SAAAA;AAAA,GAAA;AAiBL,IAAK,gBAAL,kBAAKC,mBAAL;AAEH,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AAIP,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,sBAAmB;AAInB,EAAAA,eAAA,iBAAc;AAlBN,SAAAA;AAAA,GAAA;","names":["ReferenceCategory","ReferenceType"]}
+{"version":3,"sources":["../src/index.ts","../src/utils.ts","../src/types.ts"],"sourcesContent":["// Define the new PluginV type with a callback function that returns another function\nimport {Reference} from \"./types\";\n\n// Define the new PluginV type with a callback function that returns another function\nexport type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;\n\n// Utility type to infer if a type is an array and avoid wrapping it into an array twice\ntype NormalizeArray<T> = T extends Array<infer U> ? U[] : T;\n\n// Infer the return type of the plugin callback properly and normalize array types\ntype PluginResult<T extends UniformPlugin<any>> = T extends UniformPlugin<infer R> ? R : never;\n\n// Merge all plugin return types into a single object and normalize arrays\ntype MergePluginResults<T extends UniformPlugin<any>[]> = {\n    [K in keyof UnionToIntersection<PluginResult<T[number]>>]: NormalizeArray<UnionToIntersection<PluginResult<T[number]>>[K]>\n};\n\n// Utility type to handle intersection to an object type\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n// Implement the uniform function\nexport default function uniform<T extends UniformPlugin<any>[]>(\n    references: Reference[],\n    config: { plugins: T }\n) {\n    // Infer the merged result type from all plugins\n    type ResultType = MergePluginResults<T>;\n\n    // Initialize the response with a type-safe out object\n    const response: {\n        references: Reference[]\n        out: { [K in keyof ResultType]: ResultType[K] }\n    } = {\n        references,\n        out: {} as { [K in keyof ResultType]: ResultType[K] }\n    };\n\n\n    const finishCallbacks = new Set();\n\n    config.plugins.forEach((plugin) => {\n        const call = plugin(cb => {\n            finishCallbacks.add(cb);\n        })\n\n        references.forEach((ref) => {\n            call(ref)\n        });\n    })\n\n    finishCallbacks.forEach(cb => {\n        if (typeof cb === \"function\") {\n            const resp = cb()\n            if (typeof resp !== \"object\") {\n                throw new Error(`Invalid callback return type: ${typeof resp}`)\n            }\n\n            response.out = {\n                ...response.out,\n                ...resp\n            }\n        } else {\n            throw new Error(`Invalid callback type: ${typeof cb}`)\n        }\n    });\n\n    return response;\n}\n\n// Example usage\n// const examplePlugin: UniformPlugin<{ value: boolean }> = (cb) => {\n//     return (ref: Reference) => {\n//     };\n// };\n// function examplePlugin(cb: (cb: () => { value: boolean }) => void) {\n//     cb(() => ({\n//         value: true,\n//     }));\n//\n//     return (ref: Reference) => {\n//\n//     };\n// }\n// const response = uniform([/* references */], {\n//     plugins: [examplePlugin],\n// });\n// response.out\n","import path from 'path';\nimport matter from 'gray-matter';\nimport {Sidebar, FrontMatter, PageFrontMatter} from \"@xyd-js/core\";\n\nimport {Reference} from \"./types\";\nimport uniform from \"./index\";\n\n// interface UniformFrontMatter extends FrontMatter { // TODO: it's concept only\n//     scopes?: string\n// }\n\ntype GroupMap = {\n    [key: string]: {\n        __groups: GroupMap\n        pages: Set<string>\n    }\n}\n\nexport interface pluginNavigationOptions {\n    urlPrefix: string\n}\n\nexport function pluginNavigation(options: pluginNavigationOptions) {\n    if (!options.urlPrefix) {\n        throw new Error(\"urlPrefix is required\")\n    }\n\n    return function pluginNavigationInner(cb: (cb: () => {\n        pageFrontMatter: PageFrontMatter\n        sidebar: Sidebar[]\n    }) => void) {\n        const pageFrontMatter: PageFrontMatter = {}\n        const groupMaps: GroupMap = {}\n\n        cb(() => {\n            return {\n                pageFrontMatter: pageFrontMatter,\n                sidebar: convertGroupMapsToNavigations(groupMaps) as Sidebar[]\n            }\n        })\n\n        return (ref: Reference) => {\n            const content = matter(ref.description || \"\") // TODO: pluginMatter before?\n\n            if (content.data) {\n                const data = content.data as FrontMatter\n\n                const pagePath = path.join(options.urlPrefix, ref.canonical)\n\n                if (data.title) {\n                    pageFrontMatter[pagePath] = {\n                        title: data.title,\n                    }\n                }\n\n                if (data.group) {\n                    if (typeof content?.data?.group === \"string\") {\n                        // TODO: seek nested group (it's not always from 0)\n                        throw new Error(\"group as string is not supported yet\")\n                    }\n\n                    content.data.group.reduce((groups: GroupMap, group: string, i: number) => {\n                        if (!groups[group]) {\n                            groups[group] = {\n                                __groups: {},\n                                pages: new Set()\n                            }\n                        }\n\n                        if (i === content.data.group.length - 1) {\n                            groups[group].pages.add(pagePath)\n                        }\n\n                        return groups[group].__groups\n                    }, groupMaps)\n                }\n\n                // back description to original without frontmatter\n                ref.description = content.content\n            }\n        }\n    }\n}\n\n\nfunction convertGroupMapsToNavigations(groupMaps: GroupMap): Sidebar[] {\n    const nav: Sidebar[] = []\n\n    Object.keys(groupMaps).map((groupName) => {\n        const current = groupMaps[groupName]\n\n        const pages: string[] | Sidebar[] = []\n\n        current.pages.forEach((page: string) => {\n            pages.push(page)\n        })\n\n        if (Object.keys(current.__groups).length) {\n            const subNav: Sidebar = {\n                group: groupName,\n                pages: convertGroupMapsToNavigations(current.__groups)\n            }\n\n            nav.push(subNav)\n        } else {\n            nav.push({\n                group: groupName,\n                pages,\n            })\n        }\n    })\n\n    return nav\n}\n\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginNavigation({\n//         urlPrefix: \"/docs\"\n//     })],\n// });\n\n\n","// TODO: concept only\nexport enum ReferenceCategory {\n    // for React\n    COMPONENTS = \"components\",\n    HOOKS = \"hooks\",\n    // end for React\n\n    // for API\n    REST = \"rest\",\n    GRAPHQL = \"graphql\",\n    // end for API\n\n    // for code\n    FUNCTIONS = \"functions\",\n    //\n}\n\n// TODO: concept only\nexport enum ReferenceType {\n    // for React\n    COMPONENT = \"component\",\n    HOOK = \"hook\",\n    // end for React\n\n    // for API\n    REST_HTTP_GET = \"rest_get\",\n    REST_HTTP_POST = \"rest_post\",\n    REST_HTTP_PUT = \"rest_put\",\n    REST_HTTP_PATCH = \"rest_patch\",\n    REST_HTTP_DELETE = \"rest_delete\",\n    // ---\n    GRAPHQL_QUERY = \"graphql_query\",\n    GRAPHQL_MUTATION = \"graphql_mutation\",\n    // end for API\n\n    // for code\n    FUNCTION_JS = \"function_js\",\n    // end for code\n}\n\nexport interface GraphQLReferenceContext {\n}\n\n// TODO: custom value?\nexport interface OpenAPIReferenceContext {\n    method: string;\n\n    path: string;\n}\n\nexport type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;\n\nexport interface ExampleRoot {\n    groups: ExampleGroup[];\n}\n\nexport interface ExampleGroup {\n    description?: string;\n\n    examples: Example[];\n}\n\nexport interface Example {\n    description?: string; // TODO: replace with title ?\n\n    codeblock: CodeBlock;\n}\n\nexport interface CodeBlock {\n    title?: string;\n\n    tabs: CodeBlockTab[];\n}\n\nexport interface GraphQLExampleContext {\n    schema?: any; // TODO:\n}\n\nexport interface OpenAPIExampleContext {\n    status?: number;\n\n    content?: string;\n}\n\nexport type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;\n\nexport interface CodeBlockTab {\n    // title of the tab e.g \"JavaScript\"\n    title: string;\n\n    // code in the tab e.g \"console.log('Hello World')\"\n    code: string\n    \n    // language of the code e.g \"js\"\n    language: string;\n\n    // context of the generation method e.g openapi or graphql\n    context?: ExampleContext;\n}\n\nexport interface Reference {\n    title: string;\n    description: string;\n    canonical: string;\n\n    definitions: Definition[]\n    examples: ExampleRoot\n\n    category?: ReferenceCategory; // TODO: do we need that?\n    type?: ReferenceType; // TODO: do we need that?\n    context?: ReferenceContext;\n}\n\nexport interface Definition {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n\n    type?: string;\n\n    id?: string;\n\n    description?: string;\n}\n\nexport interface DefinitionProperty {\n    name: string;\n\n    type: string;\n\n    description: string;\n\n    context?: any // TODO: better type\n\n    properties?: DefinitionProperty[];\n}"],"mappings":";AAqBe,SAAR,QACH,YACA,QACF;AAKE,QAAM,WAGF;AAAA,IACA;AAAA,IACA,KAAK,CAAC;AAAA,EACV;AAGA,QAAM,kBAAkB,oBAAI,IAAI;AAEhC,SAAO,QAAQ,QAAQ,CAAC,WAAW;AAC/B,UAAM,OAAO,OAAO,QAAM;AACtB,sBAAgB,IAAI,EAAE;AAAA,IAC1B,CAAC;AAED,eAAW,QAAQ,CAAC,QAAQ;AACxB,WAAK,GAAG;AAAA,IACZ,CAAC;AAAA,EACL,CAAC;AAED,kBAAgB,QAAQ,QAAM;AAC1B,QAAI,OAAO,OAAO,YAAY;AAC1B,YAAM,OAAO,GAAG;AAChB,UAAI,OAAO,SAAS,UAAU;AAC1B,cAAM,IAAI,MAAM,iCAAiC,OAAO,IAAI,EAAE;AAAA,MAClE;AAEA,eAAS,MAAM;AAAA,QACX,GAAG,SAAS;AAAA,QACZ,GAAG;AAAA,MACP;AAAA,IACJ,OAAO;AACH,YAAM,IAAI,MAAM,0BAA0B,OAAO,EAAE,EAAE;AAAA,IACzD;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;ACnEA,OAAO,UAAU;AACjB,OAAO,YAAY;AAqBZ,SAAS,iBAAiB,SAAkC;AAC/D,MAAI,CAAC,QAAQ,WAAW;AACpB,UAAM,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AAEA,SAAO,SAAS,sBAAsB,IAG1B;AACR,UAAM,kBAAmC,CAAC;AAC1C,UAAM,YAAsB,CAAC;AAE7B,OAAG,MAAM;AACL,aAAO;AAAA,QACH;AAAA,QACA,SAAS,8BAA8B,SAAS;AAAA,MACpD;AAAA,IACJ,CAAC;AAED,WAAO,CAAC,QAAmB;AAzCnC;AA0CY,YAAM,UAAU,OAAO,IAAI,eAAe,EAAE;AAE5C,UAAI,QAAQ,MAAM;AACd,cAAM,OAAO,QAAQ;AAErB,cAAM,WAAW,KAAK,KAAK,QAAQ,WAAW,IAAI,SAAS;AAE3D,YAAI,KAAK,OAAO;AACZ,0BAAgB,QAAQ,IAAI;AAAA,YACxB,OAAO,KAAK;AAAA,UAChB;AAAA,QACJ;AAEA,YAAI,KAAK,OAAO;AACZ,cAAI,SAAO,wCAAS,SAAT,mBAAe,WAAU,UAAU;AAE1C,kBAAM,IAAI,MAAM,sCAAsC;AAAA,UAC1D;AAEA,kBAAQ,KAAK,MAAM,OAAO,CAAC,QAAkB,OAAe,MAAc;AACtE,gBAAI,CAAC,OAAO,KAAK,GAAG;AAChB,qBAAO,KAAK,IAAI;AAAA,gBACZ,UAAU,CAAC;AAAA,gBACX,OAAO,oBAAI,IAAI;AAAA,cACnB;AAAA,YACJ;AAEA,gBAAI,MAAM,QAAQ,KAAK,MAAM,SAAS,GAAG;AACrC,qBAAO,KAAK,EAAE,MAAM,IAAI,QAAQ;AAAA,YACpC;AAEA,mBAAO,OAAO,KAAK,EAAE;AAAA,UACzB,GAAG,SAAS;AAAA,QAChB;AAGA,YAAI,cAAc,QAAQ;AAAA,MAC9B;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,8BAA8B,WAAgC;AACnE,QAAM,MAAiB,CAAC;AAExB,SAAO,KAAK,SAAS,EAAE,IAAI,CAAC,cAAc;AACtC,UAAM,UAAU,UAAU,SAAS;AAEnC,UAAM,QAA8B,CAAC;AAErC,YAAQ,MAAM,QAAQ,CAAC,SAAiB;AACpC,YAAM,KAAK,IAAI;AAAA,IACnB,CAAC;AAED,QAAI,OAAO,KAAK,QAAQ,QAAQ,EAAE,QAAQ;AACtC,YAAM,SAAkB;AAAA,QACpB,OAAO;AAAA,QACP,OAAO,8BAA8B,QAAQ,QAAQ;AAAA,MACzD;AAEA,UAAI,KAAK,MAAM;AAAA,IACnB,OAAO;AACH,UAAI,KAAK;AAAA,QACL,OAAO;AAAA,QACP;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;AChHO,IAAK,oBAAL,kBAAKA,uBAAL;AAEH,EAAAA,mBAAA,gBAAa;AACb,EAAAA,mBAAA,WAAQ;AAIR,EAAAA,mBAAA,UAAO;AACP,EAAAA,mBAAA,aAAU;AAIV,EAAAA,mBAAA,eAAY;AAZJ,SAAAA;AAAA,GAAA;AAiBL,IAAK,gBAAL,kBAAKC,mBAAL;AAEH,EAAAA,eAAA,eAAY;AACZ,EAAAA,eAAA,UAAO;AAIP,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,sBAAmB;AAInB,EAAAA,eAAA,iBAAc;AAlBN,SAAAA;AAAA,GAAA;","names":["ReferenceCategory","ReferenceType"]}

package/dist/markdown.cjs

@@ -59,7 +59,7 @@ function heading(title, canonical, description, refCategory, refType, refContext
   let uDesc = [
     (0, import_unist_builder.u)(
       "heading",
-      { depth: START_DEPTH_LEVEL },
+      { depth: uTitle.depth + 1 },
       [(0, import_unist_builder.u)("text", `!description`)]
     ),
     (0, import_unist_builder.u)("paragraph", [(0, import_unist_builder.u)("text", description)])
@@ -186,6 +186,7 @@ function definitions(definitions2) {
           name: prop.name,
           type: prop.type,
           description: prop.description,
+          context: prop.context,
           properties: prop.properties
           // TODO: fix ts
         },
@@ -202,11 +203,31 @@ function properties(depth, props, output = []) {
   const uPropName = (0, import_unist_builder.u)("paragraph", { depth }, [(0, import_unist_builder.u)("text", `!name ${paramName}`)]);
   const uPropType = (0, import_unist_builder.u)("paragraph", { depth }, [(0, import_unist_builder.u)("text", `!type ${props.type}`)]);
   const uPropDesc = (0, import_unist_builder.u)("paragraph", { depth }, [(0, import_unist_builder.u)("text", props.description || "")]);
+  const uContext = [];
+  if (props.context && Object.keys(props.context)) {
+    uContext.push((0, import_unist_builder.u)(
+      "heading",
+      { depth: depth + 1 },
+      [
+        (0, import_unist_builder.u)("text", `!context`)
+      ]
+    ));
+    for (const [key, value] of Object.entries(props.context)) {
+      uContext.push(
+        (0, import_unist_builder.u)(
+          "heading",
+          { depth: uContext[0].depth + 1 },
+          [(0, import_unist_builder.u)("text", `!${key} ${value}`)]
+        )
+      );
+    }
+  }
   output.push(
     uPropTitle,
     uPropName,
     uPropType,
-    uPropDesc
+    uPropDesc,
+    ...uContext
   );
   if (props.properties) {
     const deepDepth = depth + 1;
@@ -241,11 +262,13 @@ function referenceAST(ref) {
     ref.type,
     ref.context
   );
+  md.push(
+    mdHeading.title
+  );
   if ((_a = mdHeading == null ? void 0 : mdHeading.description) == null ? void 0 : _a.length) {
     md.push(...mdHeading.description);
   }
   md.push(
-    mdHeading.title,
     mdHeading.canonical
   );
   if (mdHeading.category) {

package/dist/markdown.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../markdown.ts","../src/markdown/index.ts","../src/markdown/utils.ts"],"sourcesContent":["export * from \"./src/markdown\";\n","import {remark} from \"remark\";\nimport remarkStringify from \"remark-stringify\";\n\nimport {Reference} from \"../types\";\n\nimport {definitions, examples, heading, root} from \"./utils\";\n\n// TODO: any\nexport function compile(ast: any) {\n    return remark()\n        // .use(unlimitedHeadings)\n        .use(remarkStringify, {\n            bullet: '-',\n            fences: true,\n            listItemIndent: 'one',\n            incrementListMarker: false,\n            handlers: {\n                heading(node) {\n                    return `${\"#\".repeat(node.depth)} ${node.children[0].value}`;\n                },\n            },\n        })\n        .stringify(root(ast));\n}\n\nexport function referenceAST(ref: Reference) {\n    const md = []\n\n    const mdHeading = heading(\n        ref.title,\n        ref.canonical,\n        ref.description,\n        ref.category,\n        ref.type,\n        ref.context\n    )\n\n    if (mdHeading?.description?.length) {\n        md.push(...mdHeading.description)\n    }\n\n    md.push(\n        mdHeading.title,\n        mdHeading.canonical,\n    )\n\n    if (mdHeading.category) {\n        md.push(mdHeading.category)\n    }\n\n    if (mdHeading.type) {\n        md.push(mdHeading.type)\n    }\n\n    if (mdHeading?.context?.length) {\n        md.push(...mdHeading.context)\n    }\n\n    const mdExamples = examples(ref.examples)\n    const mdDefinitions = definitions(ref.definitions)\n    md.push(...mdExamples, ...mdDefinitions)\n\n    return md;\n}\n","import {u} from \"unist-builder\";\n\nimport {\n    ExampleRoot,\n    Definition,\n    ReferenceCategory,\n    ReferenceContext,\n    ReferenceType,\n    DefinitionProperty\n} from \"../types\";\n\n// START_DEPTH_LEVEL is the start depth level for the markdown AST\n// starts from 2 because 1 is reserved for the title\nconst START_DEPTH_LEVEL = 2\n\n// TODO: fix any\nexport function root(ast: any) {\n    return u('root', ast);\n}\n\nexport function heading(\n    title: string,\n    canonical: string,\n    description: string,\n    refCategory?: ReferenceCategory,\n    refType?: ReferenceType,\n    refContext?: ReferenceContext\n) {\n    const uTitle = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL},\n        [u('text', `!!references ${title}`)]\n    )\n\n    const uCanonical = u(\n        'heading',\n        {depth: uTitle.depth + 1},\n        [u('text', `!canonical ${canonical}`)]\n    )\n\n    let uDesc = [\n        u(\n            'heading',\n            {depth: START_DEPTH_LEVEL},\n            [u('text', `!description`),]\n        ),\n        u('paragraph', [u('text', description)])\n    ]\n\n\n    let uRefCategory\n    if (refCategory) {\n        uRefCategory = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!category ${refCategory}`)]\n        )\n    }\n\n    let uRefType\n    if (refType) {\n        uRefType = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!type ${refType}`)]\n        )\n    }\n\n    let uContext = []\n\n    if (refContext && Object.keys(refContext)) {\n        uContext.push(u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n\n        for (const [key, value] of Object.entries(refContext)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    return {\n        title: uTitle,\n        canonical: uCanonical,\n        description: uDesc,\n        category: uRefCategory || null,\n        type: uRefType || null,\n        context: uContext || null\n    }\n}\n\nexport function examples(examples: ExampleRoot) {\n    const md = []\n\n    const uExampleRoot = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL + 1},\n        [u('text', `!examples`)]\n    )\n    md.push(uExampleRoot)\n\n    examples.groups.forEach(group => {\n        const uExampleGroups = u(\n            'heading',\n            {depth: uExampleRoot.depth + 1},\n            [u('text', `!!groups`)]\n        )\n        md.push(uExampleGroups)\n\n        const uGroupDescription = u(\n            'heading',\n            {depth: uExampleGroups.depth + 1},\n            [u('text', `!description ${group.description}`)]\n        )\n        md.push(uGroupDescription)\n\n        group.examples.forEach(example => {\n            const uExamples = u(\n                'heading',\n                {depth: uExampleGroups.depth + 1},\n                [u('text', `!!examples`)]\n            )\n            md.push(uExamples)\n\n            const codeBlock = u(\n                'heading',\n                {depth: uExamples.depth + 1},\n                [u('text', `!codeblock`)]\n            )\n            md.push(codeBlock)\n\n            const codeBlockTitle = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!title ${example.codeblock.title}`)]\n            )\n            md.push(codeBlockTitle)\n\n            const tabs = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!!tabs`)]\n            )\n            md.push(tabs)\n\n            example.codeblock.tabs.forEach(tab => {\n                const code = u('code', {\n                    lang: tab.language,\n                    meta: `!code ${tab.title}`\n                }, tab.code);\n\n                md.push(code)\n            })\n\n        })\n    })\n\n    return md\n}\n\nexport function definitions(definitions: Definition[]) {\n    const md: any[] = []\n\n    definitions.forEach(definition => {\n        const uDefinition = u(\n            'heading',\n            {depth: START_DEPTH_LEVEL + 1},\n            [u('text', `!!definitions`)]\n        )\n        md.push(uDefinition)\n\n        md.push(u(\n            'heading',\n            {depth: uDefinition.depth + 1},\n            [u('text', `!title ${definition.title}`)]\n        ))\n\n        definition.properties.forEach(prop => {\n            properties(\n                uDefinition.depth + 1,\n                {\n                    name: prop.name,\n                    type: prop.type,\n                    description: prop.description,\n                    properties: prop.properties  // TODO: fix ts\n                },\n                md,\n            )\n        })\n    })\n\n    return md\n}\n\n// TODO: any[]\nexport function properties(\n    depth: number,\n    props: DefinitionProperty,\n    output: any[] = []\n) {\n    const paramName = props.name;\n\n    const propTitle = `!!properties ${paramName}`; // TODO: check if `!!properties is enough`\n    const uPropTitle = u('heading', {depth}, [u('text', propTitle)]);\n    const uPropName = u('paragraph', {depth}, [u('text', `!name ${paramName}`)]);\n    const uPropType = u('paragraph', {depth}, [u('text', `!type ${props.type}`)]);\n    const uPropDesc = u('paragraph', {depth}, [u('text', props.description || '')]);\n\n    output.push(\n        uPropTitle,\n        uPropName,\n        uPropType,\n        uPropDesc\n    );\n\n    if (props.properties) {\n        const deepDepth = depth + 1\n\n        for (const prop of props.properties) {\n            properties(deepDepth, prop, output)\n        }\n    }\n}\n\n\n\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAqB;AACrB,8BAA4B;;;ACD5B,2BAAgB;AAahB,IAAM,oBAAoB;AAGnB,SAAS,KAAK,KAAU;AAC3B,aAAO,wBAAE,QAAQ,GAAG;AACxB;AAEO,SAAS,QACZ,OACA,WACA,aACA,aACA,SACA,YACF;AACE,QAAM,aAAS;AAAA,IACX;AAAA,IACA,EAAC,OAAO,kBAAiB;AAAA,IACzB,KAAC,wBAAE,QAAQ,gBAAgB,KAAK,EAAE,CAAC;AAAA,EACvC;AAEA,QAAM,iBAAa;AAAA,IACf;AAAA,IACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,IACxB,KAAC,wBAAE,QAAQ,cAAc,SAAS,EAAE,CAAC;AAAA,EACzC;AAEA,MAAI,QAAQ;AAAA,QACR;AAAA,MACI;AAAA,MACA,EAAC,OAAO,kBAAiB;AAAA,MACzB,KAAC,wBAAE,QAAQ,cAAc,CAAE;AAAA,IAC/B;AAAA,QACA,wBAAE,aAAa,KAAC,wBAAE,QAAQ,WAAW,CAAC,CAAC;AAAA,EAC3C;AAGA,MAAI;AACJ,MAAI,aAAa;AACb,uBAAe;AAAA,MACX;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,KAAC,wBAAE,QAAQ,aAAa,WAAW,EAAE,CAAC;AAAA,IAC1C;AAAA,EACJ;AAEA,MAAI;AACJ,MAAI,SAAS;AACT,mBAAW;AAAA,MACP;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,KAAC,wBAAE,QAAQ,SAAS,OAAO,EAAE,CAAC;AAAA,IAClC;AAAA,EACJ;AAEA,MAAI,WAAW,CAAC;AAEhB,MAAI,cAAc,OAAO,KAAK,UAAU,GAAG;AACvC,aAAS,SAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB;AAAA,YACI,wBAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAGD,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,UAAU,GAAG;AACnD,eAAS;AAAA,YAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,KAAC,wBAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,OAAO;AAAA,IACP,WAAW;AAAA,IACX,aAAa;AAAA,IACb,UAAU,gBAAgB;AAAA,IAC1B,MAAM,YAAY;AAAA,IAClB,SAAS,YAAY;AAAA,EACzB;AACJ;AAEO,SAAS,SAASA,WAAuB;AAC5C,QAAM,KAAK,CAAC;AAEZ,QAAM,mBAAe;AAAA,IACjB;AAAA,IACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,IAC7B,KAAC,wBAAE,QAAQ,WAAW,CAAC;AAAA,EAC3B;AACA,KAAG,KAAK,YAAY;AAEpB,EAAAA,UAAS,OAAO,QAAQ,WAAS;AAC7B,UAAM,qBAAiB;AAAA,MACnB;AAAA,MACA,EAAC,OAAO,aAAa,QAAQ,EAAC;AAAA,MAC9B,KAAC,wBAAE,QAAQ,UAAU,CAAC;AAAA,IAC1B;AACA,OAAG,KAAK,cAAc;AAEtB,UAAM,wBAAoB;AAAA,MACtB;AAAA,MACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,MAChC,KAAC,wBAAE,QAAQ,gBAAgB,MAAM,WAAW,EAAE,CAAC;AAAA,IACnD;AACA,OAAG,KAAK,iBAAiB;AAEzB,UAAM,SAAS,QAAQ,aAAW;AAC9B,YAAM,gBAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,QAChC,KAAC,wBAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,gBAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,qBAAiB;AAAA,QACnB;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,UAAU,QAAQ,UAAU,KAAK,EAAE,CAAC;AAAA,MACnD;AACA,SAAG,KAAK,cAAc;AAEtB,YAAM,WAAO;AAAA,QACT;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,QAAQ,CAAC;AAAA,MACxB;AACA,SAAG,KAAK,IAAI;AAEZ,cAAQ,UAAU,KAAK,QAAQ,SAAO;AAClC,cAAM,WAAO,wBAAE,QAAQ;AAAA,UACnB,MAAM,IAAI;AAAA,UACV,MAAM,SAAS,IAAI,KAAK;AAAA,QAC5B,GAAG,IAAI,IAAI;AAEX,WAAG,KAAK,IAAI;AAAA,MAChB,CAAC;AAAA,IAEL,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAEO,SAAS,YAAYC,cAA2B;AACnD,QAAM,KAAY,CAAC;AAEnB,EAAAA,aAAY,QAAQ,gBAAc;AAC9B,UAAM,kBAAc;AAAA,MAChB;AAAA,MACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,MAC7B,KAAC,wBAAE,QAAQ,eAAe,CAAC;AAAA,IAC/B;AACA,OAAG,KAAK,WAAW;AAEnB,OAAG,SAAK;AAAA,MACJ;AAAA,MACA,EAAC,OAAO,YAAY,QAAQ,EAAC;AAAA,MAC7B,KAAC,wBAAE,QAAQ,UAAU,WAAW,KAAK,EAAE,CAAC;AAAA,IAC5C,CAAC;AAED,eAAW,WAAW,QAAQ,UAAQ;AAClC;AAAA,QACI,YAAY,QAAQ;AAAA,QACpB;AAAA,UACI,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,UACX,aAAa,KAAK;AAAA,UAClB,YAAY,KAAK;AAAA;AAAA,QACrB;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAGO,SAAS,WACZ,OACA,OACA,SAAgB,CAAC,GACnB;AACE,QAAM,YAAY,MAAM;AAExB,QAAM,YAAY,gBAAgB,SAAS;AAC3C,QAAM,iBAAa,wBAAE,WAAW,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,CAAC,CAAC;AAC/D,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,SAAS,EAAE,CAAC,CAAC;AAC3E,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,MAAM,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,MAAM,eAAe,EAAE,CAAC,CAAC;AAE9E,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAEA,MAAI,MAAM,YAAY;AAClB,UAAM,YAAY,QAAQ;AAE1B,eAAW,QAAQ,MAAM,YAAY;AACjC,iBAAW,WAAW,MAAM,MAAM;AAAA,IACtC;AAAA,EACJ;AACJ;;;AD/NO,SAAS,QAAQ,KAAU;AAC9B,aAAO,sBAAO,EAET,IAAI,wBAAAC,SAAiB;AAAA,IAClB,QAAQ;AAAA,IACR,QAAQ;AAAA,IACR,gBAAgB;AAAA,IAChB,qBAAqB;AAAA,IACrB,UAAU;AAAA,MACN,QAAQ,MAAM;AACV,eAAO,GAAG,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK;AAAA,MAC9D;AAAA,IACJ;AAAA,EACJ,CAAC,EACA,UAAU,KAAK,GAAG,CAAC;AAC5B;AAEO,SAAS,aAAa,KAAgB;AAzB7C;AA0BI,QAAM,KAAK,CAAC;AAEZ,QAAM,YAAY;AAAA,IACd,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,EACR;AAEA,OAAI,4CAAW,gBAAX,mBAAwB,QAAQ;AAChC,OAAG,KAAK,GAAG,UAAU,WAAW;AAAA,EACpC;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,IACV,UAAU;AAAA,EACd;AAEA,MAAI,UAAU,UAAU;AACpB,OAAG,KAAK,UAAU,QAAQ;AAAA,EAC9B;AAEA,MAAI,UAAU,MAAM;AAChB,OAAG,KAAK,UAAU,IAAI;AAAA,EAC1B;AAEA,OAAI,4CAAW,YAAX,mBAAoB,QAAQ;AAC5B,OAAG,KAAK,GAAG,UAAU,OAAO;AAAA,EAChC;AAEA,QAAM,aAAa,SAAS,IAAI,QAAQ;AACxC,QAAM,gBAAgB,YAAY,IAAI,WAAW;AACjD,KAAG,KAAK,GAAG,YAAY,GAAG,aAAa;AAEvC,SAAO;AACX;","names":["examples","definitions","remarkStringify"]}
+{"version":3,"sources":["../markdown.ts","../src/markdown/index.ts","../src/markdown/utils.ts"],"sourcesContent":["export * from \"./src/markdown/index\";\n","import {remark} from \"remark\";\nimport remarkStringify from \"remark-stringify\";\n\nimport {Reference} from \"../types\";\n\nimport {definitions, examples, heading, root} from \"./utils\";\n\n// TODO: any\nexport function compile(ast: any) {\n    return remark()\n        // .use(unlimitedHeadings)\n        .use(remarkStringify, {\n            bullet: '-',\n            fences: true,\n            listItemIndent: 'one',\n            incrementListMarker: false,\n            handlers: {\n                heading(node) {\n                    return `${\"#\".repeat(node.depth)} ${node.children[0].value}`;\n                },\n            },\n        })\n        .stringify(root(ast));\n}\n\nexport function referenceAST(ref: Reference) {\n    const md = []\n\n    const mdHeading = heading(\n        ref.title,\n        ref.canonical,\n        ref.description,\n        ref.category,\n        ref.type,\n        ref.context\n    )\n\n    md.push(\n        mdHeading.title,\n    )\n\n    if (mdHeading?.description?.length) {\n        md.push(...mdHeading.description)\n    }\n\n    md.push(\n        mdHeading.canonical,\n    )\n\n    if (mdHeading.category) {\n        md.push(mdHeading.category)\n    }\n\n    if (mdHeading.type) {\n        md.push(mdHeading.type)\n    }\n\n    if (mdHeading?.context?.length) {\n        md.push(...mdHeading.context)\n    }\n\n    const mdExamples = examples(ref.examples)\n    const mdDefinitions = definitions(ref.definitions)\n    md.push(...mdExamples, ...mdDefinitions)\n\n    return md;\n}\n","import {u} from \"unist-builder\";\n\nimport {\n    ExampleRoot,\n    Definition,\n    ReferenceCategory,\n    ReferenceContext,\n    ReferenceType,\n    DefinitionProperty\n} from \"../types\";\n\n// START_DEPTH_LEVEL is the start depth level for the markdown AST\n// starts from 2 because 1 is reserved for the title\nconst START_DEPTH_LEVEL = 2\n\n// TODO: fix any\nexport function root(ast: any) {\n    return u('root', ast);\n}\n\nexport function heading(\n    title: string,\n    canonical: string,\n    description: string,\n    refCategory?: ReferenceCategory,\n    refType?: ReferenceType,\n    refContext?: ReferenceContext\n) {\n    const uTitle = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL},\n        [u('text', `!!references ${title}`)]\n    )\n\n    const uCanonical = u(\n        'heading',\n        {depth: uTitle.depth + 1},\n        [u('text', `!canonical ${canonical}`)]\n    )\n\n    let uDesc = [\n        u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!description`),]\n        ),\n        u('paragraph', [u('text', description)])\n    ]\n\n    let uRefCategory\n    if (refCategory) {\n        uRefCategory = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!category ${refCategory}`)]\n        )\n    }\n\n    let uRefType\n    if (refType) {\n        uRefType = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!type ${refType}`)]\n        )\n    }\n\n    let uContext = []\n\n    if (refContext && Object.keys(refContext)) {\n        uContext.push(u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n\n        for (const [key, value] of Object.entries(refContext)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    return {\n        title: uTitle,\n        canonical: uCanonical,\n        description: uDesc,\n        category: uRefCategory || null,\n        type: uRefType || null,\n        context: uContext || null\n    }\n}\n\nexport function examples(examples: ExampleRoot) {\n    const md = []\n\n    const uExampleRoot = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL + 1},\n        [u('text', `!examples`)]\n    )\n    md.push(uExampleRoot)\n\n    examples.groups.forEach(group => {\n        const uExampleGroups = u(\n            'heading',\n            {depth: uExampleRoot.depth + 1},\n            [u('text', `!!groups`)]\n        )\n        md.push(uExampleGroups)\n\n        const uGroupDescription = u(\n            'heading',\n            {depth: uExampleGroups.depth + 1},\n            [u('text', `!description ${group.description}`)]\n        )\n        md.push(uGroupDescription)\n\n        group.examples.forEach(example => {\n            const uExamples = u(\n                'heading',\n                {depth: uExampleGroups.depth + 1},\n                [u('text', `!!examples`)]\n            )\n            md.push(uExamples)\n\n            const codeBlock = u(\n                'heading',\n                {depth: uExamples.depth + 1},\n                [u('text', `!codeblock`)]\n            )\n            md.push(codeBlock)\n\n            const codeBlockTitle = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!title ${example.codeblock.title}`)]\n            )\n            md.push(codeBlockTitle)\n\n            const tabs = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!!tabs`)]\n            )\n            md.push(tabs)\n\n            example.codeblock.tabs.forEach(tab => {\n                const code = u('code', {\n                    lang: tab.language,\n                    meta: `!code ${tab.title}`\n                }, tab.code);\n\n                md.push(code)\n            })\n\n        })\n    })\n\n    return md\n}\n\nexport function definitions(definitions: Definition[]) {\n    const md: any[] = []\n\n    definitions.forEach(definition => {\n        const uDefinition = u(\n            'heading',\n            {depth: START_DEPTH_LEVEL + 1},\n            [u('text', `!!definitions`)]\n        )\n        md.push(uDefinition)\n\n        md.push(u(\n            'heading',\n            {depth: uDefinition.depth + 1},\n            [u('text', `!title ${definition.title}`)]\n        ))\n\n        definition.properties.forEach(prop => {\n            properties(\n                uDefinition.depth + 1,\n                {\n                    name: prop.name,\n                    type: prop.type,\n                    description: prop.description,\n                    context: prop.context,\n                    properties: prop.properties  // TODO: fix ts\n                },\n                md,\n            )\n        })\n    })\n\n    return md\n}\n\n// TODO: any[]\nexport function properties(\n    depth: number,\n    props: DefinitionProperty,\n    output: any[] = []\n) {\n    const paramName = props.name;\n\n    const propTitle = `!!properties ${paramName}`; // TODO: check if `!!properties is enough`\n    const uPropTitle = u('heading', {depth}, [u('text', propTitle)]);\n    const uPropName = u('paragraph', {depth}, [u('text', `!name ${paramName}`)]);\n    const uPropType = u('paragraph', {depth}, [u('text', `!type ${props.type}`)]);\n    const uPropDesc = u('paragraph', {depth}, [u('text', props.description || '')]);\n    const uContext = []\n\n    if (props.context && Object.keys(props.context)) {\n        uContext.push(u(\n            'heading',\n            {depth: depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n        for (const [key, value] of Object.entries(props.context)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    output.push(\n        uPropTitle,\n        uPropName,\n        uPropType,\n        uPropDesc,\n        ...uContext\n    );\n\n    if (props.properties) {\n        const deepDepth = depth + 1\n\n        for (const prop of props.properties) {\n            properties(deepDepth, prop, output)\n        }\n    }\n}\n\n\n\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAqB;AACrB,8BAA4B;;;ACD5B,2BAAgB;AAahB,IAAM,oBAAoB;AAGnB,SAAS,KAAK,KAAU;AAC3B,aAAO,wBAAE,QAAQ,GAAG;AACxB;AAEO,SAAS,QACZ,OACA,WACA,aACA,aACA,SACA,YACF;AACE,QAAM,aAAS;AAAA,IACX;AAAA,IACA,EAAC,OAAO,kBAAiB;AAAA,IACzB,KAAC,wBAAE,QAAQ,gBAAgB,KAAK,EAAE,CAAC;AAAA,EACvC;AAEA,QAAM,iBAAa;AAAA,IACf;AAAA,IACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,IACxB,KAAC,wBAAE,QAAQ,cAAc,SAAS,EAAE,CAAC;AAAA,EACzC;AAEA,MAAI,QAAQ;AAAA,QACR;AAAA,MACI;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,KAAC,wBAAE,QAAQ,cAAc,CAAE;AAAA,IAC/B;AAAA,QACA,wBAAE,aAAa,KAAC,wBAAE,QAAQ,WAAW,CAAC,CAAC;AAAA,EAC3C;AAEA,MAAI;AACJ,MAAI,aAAa;AACb,uBAAe;AAAA,MACX;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,KAAC,wBAAE,QAAQ,aAAa,WAAW,EAAE,CAAC;AAAA,IAC1C;AAAA,EACJ;AAEA,MAAI;AACJ,MAAI,SAAS;AACT,mBAAW;AAAA,MACP;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,KAAC,wBAAE,QAAQ,SAAS,OAAO,EAAE,CAAC;AAAA,IAClC;AAAA,EACJ;AAEA,MAAI,WAAW,CAAC;AAEhB,MAAI,cAAc,OAAO,KAAK,UAAU,GAAG;AACvC,aAAS,SAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB;AAAA,YACI,wBAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAGD,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,UAAU,GAAG;AACnD,eAAS;AAAA,YAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,KAAC,wBAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,OAAO;AAAA,IACP,WAAW;AAAA,IACX,aAAa;AAAA,IACb,UAAU,gBAAgB;AAAA,IAC1B,MAAM,YAAY;AAAA,IAClB,SAAS,YAAY;AAAA,EACzB;AACJ;AAEO,SAAS,SAASA,WAAuB;AAC5C,QAAM,KAAK,CAAC;AAEZ,QAAM,mBAAe;AAAA,IACjB;AAAA,IACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,IAC7B,KAAC,wBAAE,QAAQ,WAAW,CAAC;AAAA,EAC3B;AACA,KAAG,KAAK,YAAY;AAEpB,EAAAA,UAAS,OAAO,QAAQ,WAAS;AAC7B,UAAM,qBAAiB;AAAA,MACnB;AAAA,MACA,EAAC,OAAO,aAAa,QAAQ,EAAC;AAAA,MAC9B,KAAC,wBAAE,QAAQ,UAAU,CAAC;AAAA,IAC1B;AACA,OAAG,KAAK,cAAc;AAEtB,UAAM,wBAAoB;AAAA,MACtB;AAAA,MACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,MAChC,KAAC,wBAAE,QAAQ,gBAAgB,MAAM,WAAW,EAAE,CAAC;AAAA,IACnD;AACA,OAAG,KAAK,iBAAiB;AAEzB,UAAM,SAAS,QAAQ,aAAW;AAC9B,YAAM,gBAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,QAChC,KAAC,wBAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,gBAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,qBAAiB;AAAA,QACnB;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,UAAU,QAAQ,UAAU,KAAK,EAAE,CAAC;AAAA,MACnD;AACA,SAAG,KAAK,cAAc;AAEtB,YAAM,WAAO;AAAA,QACT;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,KAAC,wBAAE,QAAQ,QAAQ,CAAC;AAAA,MACxB;AACA,SAAG,KAAK,IAAI;AAEZ,cAAQ,UAAU,KAAK,QAAQ,SAAO;AAClC,cAAM,WAAO,wBAAE,QAAQ;AAAA,UACnB,MAAM,IAAI;AAAA,UACV,MAAM,SAAS,IAAI,KAAK;AAAA,QAC5B,GAAG,IAAI,IAAI;AAEX,WAAG,KAAK,IAAI;AAAA,MAChB,CAAC;AAAA,IAEL,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAEO,SAAS,YAAYC,cAA2B;AACnD,QAAM,KAAY,CAAC;AAEnB,EAAAA,aAAY,QAAQ,gBAAc;AAC9B,UAAM,kBAAc;AAAA,MAChB;AAAA,MACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,MAC7B,KAAC,wBAAE,QAAQ,eAAe,CAAC;AAAA,IAC/B;AACA,OAAG,KAAK,WAAW;AAEnB,OAAG,SAAK;AAAA,MACJ;AAAA,MACA,EAAC,OAAO,YAAY,QAAQ,EAAC;AAAA,MAC7B,KAAC,wBAAE,QAAQ,UAAU,WAAW,KAAK,EAAE,CAAC;AAAA,IAC5C,CAAC;AAED,eAAW,WAAW,QAAQ,UAAQ;AAClC;AAAA,QACI,YAAY,QAAQ;AAAA,QACpB;AAAA,UACI,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,UACX,aAAa,KAAK;AAAA,UAClB,SAAS,KAAK;AAAA,UACd,YAAY,KAAK;AAAA;AAAA,QACrB;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAGO,SAAS,WACZ,OACA,OACA,SAAgB,CAAC,GACnB;AACE,QAAM,YAAY,MAAM;AAExB,QAAM,YAAY,gBAAgB,SAAS;AAC3C,QAAM,iBAAa,wBAAE,WAAW,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,CAAC,CAAC;AAC/D,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,SAAS,EAAE,CAAC,CAAC;AAC3E,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,SAAS,MAAM,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAM,gBAAY,wBAAE,aAAa,EAAC,MAAK,GAAG,KAAC,wBAAE,QAAQ,MAAM,eAAe,EAAE,CAAC,CAAC;AAC9E,QAAM,WAAW,CAAC;AAElB,MAAI,MAAM,WAAW,OAAO,KAAK,MAAM,OAAO,GAAG;AAC7C,aAAS,SAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,QAAQ,EAAC;AAAA,MACjB;AAAA,YACI,wBAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAED,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,OAAO,GAAG;AACtD,eAAS;AAAA,YAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,KAAC,wBAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACP;AAEA,MAAI,MAAM,YAAY;AAClB,UAAM,YAAY,QAAQ;AAE1B,eAAW,QAAQ,MAAM,YAAY;AACjC,iBAAW,WAAW,MAAM,MAAM;AAAA,IACtC;AAAA,EACJ;AACJ;;;ADpPO,SAAS,QAAQ,KAAU;AAC9B,aAAO,sBAAO,EAET,IAAI,wBAAAC,SAAiB;AAAA,IAClB,QAAQ;AAAA,IACR,QAAQ;AAAA,IACR,gBAAgB;AAAA,IAChB,qBAAqB;AAAA,IACrB,UAAU;AAAA,MACN,QAAQ,MAAM;AACV,eAAO,GAAG,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK;AAAA,MAC9D;AAAA,IACJ;AAAA,EACJ,CAAC,EACA,UAAU,KAAK,GAAG,CAAC;AAC5B;AAEO,SAAS,aAAa,KAAgB;AAzB7C;AA0BI,QAAM,KAAK,CAAC;AAEZ,QAAM,YAAY;AAAA,IACd,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,EACR;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,EACd;AAEA,OAAI,4CAAW,gBAAX,mBAAwB,QAAQ;AAChC,OAAG,KAAK,GAAG,UAAU,WAAW;AAAA,EACpC;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,EACd;AAEA,MAAI,UAAU,UAAU;AACpB,OAAG,KAAK,UAAU,QAAQ;AAAA,EAC9B;AAEA,MAAI,UAAU,MAAM;AAChB,OAAG,KAAK,UAAU,IAAI;AAAA,EAC1B;AAEA,OAAI,4CAAW,YAAX,mBAAoB,QAAQ;AAC5B,OAAG,KAAK,GAAG,UAAU,OAAO;AAAA,EAChC;AAEA,QAAM,aAAa,SAAS,IAAI,QAAQ;AACxC,QAAM,gBAAgB,YAAY,IAAI,WAAW;AACjD,KAAG,KAAK,GAAG,YAAY,GAAG,aAAa;AAEvC,SAAO;AACX;","names":["examples","definitions","remarkStringify"]}

package/dist/markdown.d.cts

@@ -1,4 +1,4 @@
-import { R as Reference } from './types-C8Pm_zQH.cjs';
+import { R as Reference } from './types-CbDJSEtC.cjs';
 
 declare function compile(ast: any): string;
 declare function referenceAST(ref: Reference): any[];

package/dist/markdown.d.ts

@@ -1,4 +1,4 @@
-import { R as Reference } from './types-C8Pm_zQH.js';
+import { R as Reference } from './types-CbDJSEtC.js';
 
 declare function compile(ast: any): string;
 declare function referenceAST(ref: Reference): any[];

package/dist/markdown.js

@@ -22,7 +22,7 @@ function heading(title, canonical, description, refCategory, refType, refContext
   let uDesc = [
     u(
       "heading",
-      { depth: START_DEPTH_LEVEL },
+      { depth: uTitle.depth + 1 },
       [u("text", `!description`)]
     ),
     u("paragraph", [u("text", description)])
@@ -149,6 +149,7 @@ function definitions(definitions2) {
           name: prop.name,
           type: prop.type,
           description: prop.description,
+          context: prop.context,
           properties: prop.properties
           // TODO: fix ts
         },
@@ -165,11 +166,31 @@ function properties(depth, props, output = []) {
   const uPropName = u("paragraph", { depth }, [u("text", `!name ${paramName}`)]);
   const uPropType = u("paragraph", { depth }, [u("text", `!type ${props.type}`)]);
   const uPropDesc = u("paragraph", { depth }, [u("text", props.description || "")]);
+  const uContext = [];
+  if (props.context && Object.keys(props.context)) {
+    uContext.push(u(
+      "heading",
+      { depth: depth + 1 },
+      [
+        u("text", `!context`)
+      ]
+    ));
+    for (const [key, value] of Object.entries(props.context)) {
+      uContext.push(
+        u(
+          "heading",
+          { depth: uContext[0].depth + 1 },
+          [u("text", `!${key} ${value}`)]
+        )
+      );
+    }
+  }
   output.push(
     uPropTitle,
     uPropName,
     uPropType,
-    uPropDesc
+    uPropDesc,
+    ...uContext
   );
   if (props.properties) {
     const deepDepth = depth + 1;
@@ -204,11 +225,13 @@ function referenceAST(ref) {
     ref.type,
     ref.context
   );
+  md.push(
+    mdHeading.title
+  );
   if ((_a = mdHeading == null ? void 0 : mdHeading.description) == null ? void 0 : _a.length) {
     md.push(...mdHeading.description);
   }
   md.push(
-    mdHeading.title,
     mdHeading.canonical
   );
   if (mdHeading.category) {

package/dist/markdown.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/markdown/index.ts","../src/markdown/utils.ts"],"sourcesContent":["import {remark} from \"remark\";\nimport remarkStringify from \"remark-stringify\";\n\nimport {Reference} from \"../types\";\n\nimport {definitions, examples, heading, root} from \"./utils\";\n\n// TODO: any\nexport function compile(ast: any) {\n    return remark()\n        // .use(unlimitedHeadings)\n        .use(remarkStringify, {\n            bullet: '-',\n            fences: true,\n            listItemIndent: 'one',\n            incrementListMarker: false,\n            handlers: {\n                heading(node) {\n                    return `${\"#\".repeat(node.depth)} ${node.children[0].value}`;\n                },\n            },\n        })\n        .stringify(root(ast));\n}\n\nexport function referenceAST(ref: Reference) {\n    const md = []\n\n    const mdHeading = heading(\n        ref.title,\n        ref.canonical,\n        ref.description,\n        ref.category,\n        ref.type,\n        ref.context\n    )\n\n    if (mdHeading?.description?.length) {\n        md.push(...mdHeading.description)\n    }\n\n    md.push(\n        mdHeading.title,\n        mdHeading.canonical,\n    )\n\n    if (mdHeading.category) {\n        md.push(mdHeading.category)\n    }\n\n    if (mdHeading.type) {\n        md.push(mdHeading.type)\n    }\n\n    if (mdHeading?.context?.length) {\n        md.push(...mdHeading.context)\n    }\n\n    const mdExamples = examples(ref.examples)\n    const mdDefinitions = definitions(ref.definitions)\n    md.push(...mdExamples, ...mdDefinitions)\n\n    return md;\n}\n","import {u} from \"unist-builder\";\n\nimport {\n    ExampleRoot,\n    Definition,\n    ReferenceCategory,\n    ReferenceContext,\n    ReferenceType,\n    DefinitionProperty\n} from \"../types\";\n\n// START_DEPTH_LEVEL is the start depth level for the markdown AST\n// starts from 2 because 1 is reserved for the title\nconst START_DEPTH_LEVEL = 2\n\n// TODO: fix any\nexport function root(ast: any) {\n    return u('root', ast);\n}\n\nexport function heading(\n    title: string,\n    canonical: string,\n    description: string,\n    refCategory?: ReferenceCategory,\n    refType?: ReferenceType,\n    refContext?: ReferenceContext\n) {\n    const uTitle = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL},\n        [u('text', `!!references ${title}`)]\n    )\n\n    const uCanonical = u(\n        'heading',\n        {depth: uTitle.depth + 1},\n        [u('text', `!canonical ${canonical}`)]\n    )\n\n    let uDesc = [\n        u(\n            'heading',\n            {depth: START_DEPTH_LEVEL},\n            [u('text', `!description`),]\n        ),\n        u('paragraph', [u('text', description)])\n    ]\n\n\n    let uRefCategory\n    if (refCategory) {\n        uRefCategory = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!category ${refCategory}`)]\n        )\n    }\n\n    let uRefType\n    if (refType) {\n        uRefType = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!type ${refType}`)]\n        )\n    }\n\n    let uContext = []\n\n    if (refContext && Object.keys(refContext)) {\n        uContext.push(u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n\n        for (const [key, value] of Object.entries(refContext)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    return {\n        title: uTitle,\n        canonical: uCanonical,\n        description: uDesc,\n        category: uRefCategory || null,\n        type: uRefType || null,\n        context: uContext || null\n    }\n}\n\nexport function examples(examples: ExampleRoot) {\n    const md = []\n\n    const uExampleRoot = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL + 1},\n        [u('text', `!examples`)]\n    )\n    md.push(uExampleRoot)\n\n    examples.groups.forEach(group => {\n        const uExampleGroups = u(\n            'heading',\n            {depth: uExampleRoot.depth + 1},\n            [u('text', `!!groups`)]\n        )\n        md.push(uExampleGroups)\n\n        const uGroupDescription = u(\n            'heading',\n            {depth: uExampleGroups.depth + 1},\n            [u('text', `!description ${group.description}`)]\n        )\n        md.push(uGroupDescription)\n\n        group.examples.forEach(example => {\n            const uExamples = u(\n                'heading',\n                {depth: uExampleGroups.depth + 1},\n                [u('text', `!!examples`)]\n            )\n            md.push(uExamples)\n\n            const codeBlock = u(\n                'heading',\n                {depth: uExamples.depth + 1},\n                [u('text', `!codeblock`)]\n            )\n            md.push(codeBlock)\n\n            const codeBlockTitle = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!title ${example.codeblock.title}`)]\n            )\n            md.push(codeBlockTitle)\n\n            const tabs = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!!tabs`)]\n            )\n            md.push(tabs)\n\n            example.codeblock.tabs.forEach(tab => {\n                const code = u('code', {\n                    lang: tab.language,\n                    meta: `!code ${tab.title}`\n                }, tab.code);\n\n                md.push(code)\n            })\n\n        })\n    })\n\n    return md\n}\n\nexport function definitions(definitions: Definition[]) {\n    const md: any[] = []\n\n    definitions.forEach(definition => {\n        const uDefinition = u(\n            'heading',\n            {depth: START_DEPTH_LEVEL + 1},\n            [u('text', `!!definitions`)]\n        )\n        md.push(uDefinition)\n\n        md.push(u(\n            'heading',\n            {depth: uDefinition.depth + 1},\n            [u('text', `!title ${definition.title}`)]\n        ))\n\n        definition.properties.forEach(prop => {\n            properties(\n                uDefinition.depth + 1,\n                {\n                    name: prop.name,\n                    type: prop.type,\n                    description: prop.description,\n                    properties: prop.properties  // TODO: fix ts\n                },\n                md,\n            )\n        })\n    })\n\n    return md\n}\n\n// TODO: any[]\nexport function properties(\n    depth: number,\n    props: DefinitionProperty,\n    output: any[] = []\n) {\n    const paramName = props.name;\n\n    const propTitle = `!!properties ${paramName}`; // TODO: check if `!!properties is enough`\n    const uPropTitle = u('heading', {depth}, [u('text', propTitle)]);\n    const uPropName = u('paragraph', {depth}, [u('text', `!name ${paramName}`)]);\n    const uPropType = u('paragraph', {depth}, [u('text', `!type ${props.type}`)]);\n    const uPropDesc = u('paragraph', {depth}, [u('text', props.description || '')]);\n\n    output.push(\n        uPropTitle,\n        uPropName,\n        uPropType,\n        uPropDesc\n    );\n\n    if (props.properties) {\n        const deepDepth = depth + 1\n\n        for (const prop of props.properties) {\n            properties(deepDepth, prop, output)\n        }\n    }\n}\n\n\n\n"],"mappings":";AAAA,SAAQ,cAAa;AACrB,OAAO,qBAAqB;;;ACD5B,SAAQ,SAAQ;AAahB,IAAM,oBAAoB;AAGnB,SAAS,KAAK,KAAU;AAC3B,SAAO,EAAE,QAAQ,GAAG;AACxB;AAEO,SAAS,QACZ,OACA,WACA,aACA,aACA,SACA,YACF;AACE,QAAM,SAAS;AAAA,IACX;AAAA,IACA,EAAC,OAAO,kBAAiB;AAAA,IACzB,CAAC,EAAE,QAAQ,gBAAgB,KAAK,EAAE,CAAC;AAAA,EACvC;AAEA,QAAM,aAAa;AAAA,IACf;AAAA,IACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,IACxB,CAAC,EAAE,QAAQ,cAAc,SAAS,EAAE,CAAC;AAAA,EACzC;AAEA,MAAI,QAAQ;AAAA,IACR;AAAA,MACI;AAAA,MACA,EAAC,OAAO,kBAAiB;AAAA,MACzB,CAAC,EAAE,QAAQ,cAAc,CAAE;AAAA,IAC/B;AAAA,IACA,EAAE,aAAa,CAAC,EAAE,QAAQ,WAAW,CAAC,CAAC;AAAA,EAC3C;AAGA,MAAI;AACJ,MAAI,aAAa;AACb,mBAAe;AAAA,MACX;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,CAAC,EAAE,QAAQ,aAAa,WAAW,EAAE,CAAC;AAAA,IAC1C;AAAA,EACJ;AAEA,MAAI;AACJ,MAAI,SAAS;AACT,eAAW;AAAA,MACP;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,CAAC,EAAE,QAAQ,SAAS,OAAO,EAAE,CAAC;AAAA,IAClC;AAAA,EACJ;AAEA,MAAI,WAAW,CAAC;AAEhB,MAAI,cAAc,OAAO,KAAK,UAAU,GAAG;AACvC,aAAS,KAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB;AAAA,QACI,EAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAGD,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,UAAU,GAAG;AACnD,eAAS;AAAA,QAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,CAAC,EAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,OAAO;AAAA,IACP,WAAW;AAAA,IACX,aAAa;AAAA,IACb,UAAU,gBAAgB;AAAA,IAC1B,MAAM,YAAY;AAAA,IAClB,SAAS,YAAY;AAAA,EACzB;AACJ;AAEO,SAAS,SAASA,WAAuB;AAC5C,QAAM,KAAK,CAAC;AAEZ,QAAM,eAAe;AAAA,IACjB;AAAA,IACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,IAC7B,CAAC,EAAE,QAAQ,WAAW,CAAC;AAAA,EAC3B;AACA,KAAG,KAAK,YAAY;AAEpB,EAAAA,UAAS,OAAO,QAAQ,WAAS;AAC7B,UAAM,iBAAiB;AAAA,MACnB;AAAA,MACA,EAAC,OAAO,aAAa,QAAQ,EAAC;AAAA,MAC9B,CAAC,EAAE,QAAQ,UAAU,CAAC;AAAA,IAC1B;AACA,OAAG,KAAK,cAAc;AAEtB,UAAM,oBAAoB;AAAA,MACtB;AAAA,MACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,MAChC,CAAC,EAAE,QAAQ,gBAAgB,MAAM,WAAW,EAAE,CAAC;AAAA,IACnD;AACA,OAAG,KAAK,iBAAiB;AAEzB,UAAM,SAAS,QAAQ,aAAW;AAC9B,YAAM,YAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,QAChC,CAAC,EAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,YAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,iBAAiB;AAAA,QACnB;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,UAAU,QAAQ,UAAU,KAAK,EAAE,CAAC;AAAA,MACnD;AACA,SAAG,KAAK,cAAc;AAEtB,YAAM,OAAO;AAAA,QACT;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,QAAQ,CAAC;AAAA,MACxB;AACA,SAAG,KAAK,IAAI;AAEZ,cAAQ,UAAU,KAAK,QAAQ,SAAO;AAClC,cAAM,OAAO,EAAE,QAAQ;AAAA,UACnB,MAAM,IAAI;AAAA,UACV,MAAM,SAAS,IAAI,KAAK;AAAA,QAC5B,GAAG,IAAI,IAAI;AAEX,WAAG,KAAK,IAAI;AAAA,MAChB,CAAC;AAAA,IAEL,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAEO,SAAS,YAAYC,cAA2B;AACnD,QAAM,KAAY,CAAC;AAEnB,EAAAA,aAAY,QAAQ,gBAAc;AAC9B,UAAM,cAAc;AAAA,MAChB;AAAA,MACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,MAC7B,CAAC,EAAE,QAAQ,eAAe,CAAC;AAAA,IAC/B;AACA,OAAG,KAAK,WAAW;AAEnB,OAAG,KAAK;AAAA,MACJ;AAAA,MACA,EAAC,OAAO,YAAY,QAAQ,EAAC;AAAA,MAC7B,CAAC,EAAE,QAAQ,UAAU,WAAW,KAAK,EAAE,CAAC;AAAA,IAC5C,CAAC;AAED,eAAW,WAAW,QAAQ,UAAQ;AAClC;AAAA,QACI,YAAY,QAAQ;AAAA,QACpB;AAAA,UACI,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,UACX,aAAa,KAAK;AAAA,UAClB,YAAY,KAAK;AAAA;AAAA,QACrB;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAGO,SAAS,WACZ,OACA,OACA,SAAgB,CAAC,GACnB;AACE,QAAM,YAAY,MAAM;AAExB,QAAM,YAAY,gBAAgB,SAAS;AAC3C,QAAM,aAAa,EAAE,WAAW,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,CAAC,CAAC;AAC/D,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,SAAS,EAAE,CAAC,CAAC;AAC3E,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,MAAM,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,MAAM,eAAe,EAAE,CAAC,CAAC;AAE9E,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAEA,MAAI,MAAM,YAAY;AAClB,UAAM,YAAY,QAAQ;AAE1B,eAAW,QAAQ,MAAM,YAAY;AACjC,iBAAW,WAAW,MAAM,MAAM;AAAA,IACtC;AAAA,EACJ;AACJ;;;AD/NO,SAAS,QAAQ,KAAU;AAC9B,SAAO,OAAO,EAET,IAAI,iBAAiB;AAAA,IAClB,QAAQ;AAAA,IACR,QAAQ;AAAA,IACR,gBAAgB;AAAA,IAChB,qBAAqB;AAAA,IACrB,UAAU;AAAA,MACN,QAAQ,MAAM;AACV,eAAO,GAAG,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK;AAAA,MAC9D;AAAA,IACJ;AAAA,EACJ,CAAC,EACA,UAAU,KAAK,GAAG,CAAC;AAC5B;AAEO,SAAS,aAAa,KAAgB;AAzB7C;AA0BI,QAAM,KAAK,CAAC;AAEZ,QAAM,YAAY;AAAA,IACd,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,EACR;AAEA,OAAI,4CAAW,gBAAX,mBAAwB,QAAQ;AAChC,OAAG,KAAK,GAAG,UAAU,WAAW;AAAA,EACpC;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,IACV,UAAU;AAAA,EACd;AAEA,MAAI,UAAU,UAAU;AACpB,OAAG,KAAK,UAAU,QAAQ;AAAA,EAC9B;AAEA,MAAI,UAAU,MAAM;AAChB,OAAG,KAAK,UAAU,IAAI;AAAA,EAC1B;AAEA,OAAI,4CAAW,YAAX,mBAAoB,QAAQ;AAC5B,OAAG,KAAK,GAAG,UAAU,OAAO;AAAA,EAChC;AAEA,QAAM,aAAa,SAAS,IAAI,QAAQ;AACxC,QAAM,gBAAgB,YAAY,IAAI,WAAW;AACjD,KAAG,KAAK,GAAG,YAAY,GAAG,aAAa;AAEvC,SAAO;AACX;","names":["examples","definitions"]}
+{"version":3,"sources":["../src/markdown/index.ts","../src/markdown/utils.ts"],"sourcesContent":["import {remark} from \"remark\";\nimport remarkStringify from \"remark-stringify\";\n\nimport {Reference} from \"../types\";\n\nimport {definitions, examples, heading, root} from \"./utils\";\n\n// TODO: any\nexport function compile(ast: any) {\n    return remark()\n        // .use(unlimitedHeadings)\n        .use(remarkStringify, {\n            bullet: '-',\n            fences: true,\n            listItemIndent: 'one',\n            incrementListMarker: false,\n            handlers: {\n                heading(node) {\n                    return `${\"#\".repeat(node.depth)} ${node.children[0].value}`;\n                },\n            },\n        })\n        .stringify(root(ast));\n}\n\nexport function referenceAST(ref: Reference) {\n    const md = []\n\n    const mdHeading = heading(\n        ref.title,\n        ref.canonical,\n        ref.description,\n        ref.category,\n        ref.type,\n        ref.context\n    )\n\n    md.push(\n        mdHeading.title,\n    )\n\n    if (mdHeading?.description?.length) {\n        md.push(...mdHeading.description)\n    }\n\n    md.push(\n        mdHeading.canonical,\n    )\n\n    if (mdHeading.category) {\n        md.push(mdHeading.category)\n    }\n\n    if (mdHeading.type) {\n        md.push(mdHeading.type)\n    }\n\n    if (mdHeading?.context?.length) {\n        md.push(...mdHeading.context)\n    }\n\n    const mdExamples = examples(ref.examples)\n    const mdDefinitions = definitions(ref.definitions)\n    md.push(...mdExamples, ...mdDefinitions)\n\n    return md;\n}\n","import {u} from \"unist-builder\";\n\nimport {\n    ExampleRoot,\n    Definition,\n    ReferenceCategory,\n    ReferenceContext,\n    ReferenceType,\n    DefinitionProperty\n} from \"../types\";\n\n// START_DEPTH_LEVEL is the start depth level for the markdown AST\n// starts from 2 because 1 is reserved for the title\nconst START_DEPTH_LEVEL = 2\n\n// TODO: fix any\nexport function root(ast: any) {\n    return u('root', ast);\n}\n\nexport function heading(\n    title: string,\n    canonical: string,\n    description: string,\n    refCategory?: ReferenceCategory,\n    refType?: ReferenceType,\n    refContext?: ReferenceContext\n) {\n    const uTitle = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL},\n        [u('text', `!!references ${title}`)]\n    )\n\n    const uCanonical = u(\n        'heading',\n        {depth: uTitle.depth + 1},\n        [u('text', `!canonical ${canonical}`)]\n    )\n\n    let uDesc = [\n        u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!description`),]\n        ),\n        u('paragraph', [u('text', description)])\n    ]\n\n    let uRefCategory\n    if (refCategory) {\n        uRefCategory = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!category ${refCategory}`)]\n        )\n    }\n\n    let uRefType\n    if (refType) {\n        uRefType = u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [u('text', `!type ${refType}`)]\n        )\n    }\n\n    let uContext = []\n\n    if (refContext && Object.keys(refContext)) {\n        uContext.push(u(\n            'heading',\n            {depth: uTitle.depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n\n        for (const [key, value] of Object.entries(refContext)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    return {\n        title: uTitle,\n        canonical: uCanonical,\n        description: uDesc,\n        category: uRefCategory || null,\n        type: uRefType || null,\n        context: uContext || null\n    }\n}\n\nexport function examples(examples: ExampleRoot) {\n    const md = []\n\n    const uExampleRoot = u(\n        'heading',\n        {depth: START_DEPTH_LEVEL + 1},\n        [u('text', `!examples`)]\n    )\n    md.push(uExampleRoot)\n\n    examples.groups.forEach(group => {\n        const uExampleGroups = u(\n            'heading',\n            {depth: uExampleRoot.depth + 1},\n            [u('text', `!!groups`)]\n        )\n        md.push(uExampleGroups)\n\n        const uGroupDescription = u(\n            'heading',\n            {depth: uExampleGroups.depth + 1},\n            [u('text', `!description ${group.description}`)]\n        )\n        md.push(uGroupDescription)\n\n        group.examples.forEach(example => {\n            const uExamples = u(\n                'heading',\n                {depth: uExampleGroups.depth + 1},\n                [u('text', `!!examples`)]\n            )\n            md.push(uExamples)\n\n            const codeBlock = u(\n                'heading',\n                {depth: uExamples.depth + 1},\n                [u('text', `!codeblock`)]\n            )\n            md.push(codeBlock)\n\n            const codeBlockTitle = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!title ${example.codeblock.title}`)]\n            )\n            md.push(codeBlockTitle)\n\n            const tabs = u(\n                'heading',\n                {depth: codeBlock.depth + 1},\n                [u('text', `!!tabs`)]\n            )\n            md.push(tabs)\n\n            example.codeblock.tabs.forEach(tab => {\n                const code = u('code', {\n                    lang: tab.language,\n                    meta: `!code ${tab.title}`\n                }, tab.code);\n\n                md.push(code)\n            })\n\n        })\n    })\n\n    return md\n}\n\nexport function definitions(definitions: Definition[]) {\n    const md: any[] = []\n\n    definitions.forEach(definition => {\n        const uDefinition = u(\n            'heading',\n            {depth: START_DEPTH_LEVEL + 1},\n            [u('text', `!!definitions`)]\n        )\n        md.push(uDefinition)\n\n        md.push(u(\n            'heading',\n            {depth: uDefinition.depth + 1},\n            [u('text', `!title ${definition.title}`)]\n        ))\n\n        definition.properties.forEach(prop => {\n            properties(\n                uDefinition.depth + 1,\n                {\n                    name: prop.name,\n                    type: prop.type,\n                    description: prop.description,\n                    context: prop.context,\n                    properties: prop.properties  // TODO: fix ts\n                },\n                md,\n            )\n        })\n    })\n\n    return md\n}\n\n// TODO: any[]\nexport function properties(\n    depth: number,\n    props: DefinitionProperty,\n    output: any[] = []\n) {\n    const paramName = props.name;\n\n    const propTitle = `!!properties ${paramName}`; // TODO: check if `!!properties is enough`\n    const uPropTitle = u('heading', {depth}, [u('text', propTitle)]);\n    const uPropName = u('paragraph', {depth}, [u('text', `!name ${paramName}`)]);\n    const uPropType = u('paragraph', {depth}, [u('text', `!type ${props.type}`)]);\n    const uPropDesc = u('paragraph', {depth}, [u('text', props.description || '')]);\n    const uContext = []\n\n    if (props.context && Object.keys(props.context)) {\n        uContext.push(u(\n            'heading',\n            {depth: depth + 1},\n            [\n                u('text', `!context`),\n            ]\n        ))\n\n        for (const [key, value] of Object.entries(props.context)) {\n            uContext.push(u(\n                    'heading',\n                    {depth: uContext[0].depth + 1},\n                    [u('text', `!${key} ${value}`)]\n                )\n            )\n        }\n    }\n\n    output.push(\n        uPropTitle,\n        uPropName,\n        uPropType,\n        uPropDesc,\n        ...uContext\n    );\n\n    if (props.properties) {\n        const deepDepth = depth + 1\n\n        for (const prop of props.properties) {\n            properties(deepDepth, prop, output)\n        }\n    }\n}\n\n\n\n"],"mappings":";AAAA,SAAQ,cAAa;AACrB,OAAO,qBAAqB;;;ACD5B,SAAQ,SAAQ;AAahB,IAAM,oBAAoB;AAGnB,SAAS,KAAK,KAAU;AAC3B,SAAO,EAAE,QAAQ,GAAG;AACxB;AAEO,SAAS,QACZ,OACA,WACA,aACA,aACA,SACA,YACF;AACE,QAAM,SAAS;AAAA,IACX;AAAA,IACA,EAAC,OAAO,kBAAiB;AAAA,IACzB,CAAC,EAAE,QAAQ,gBAAgB,KAAK,EAAE,CAAC;AAAA,EACvC;AAEA,QAAM,aAAa;AAAA,IACf;AAAA,IACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,IACxB,CAAC,EAAE,QAAQ,cAAc,SAAS,EAAE,CAAC;AAAA,EACzC;AAEA,MAAI,QAAQ;AAAA,IACR;AAAA,MACI;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,CAAC,EAAE,QAAQ,cAAc,CAAE;AAAA,IAC/B;AAAA,IACA,EAAE,aAAa,CAAC,EAAE,QAAQ,WAAW,CAAC,CAAC;AAAA,EAC3C;AAEA,MAAI;AACJ,MAAI,aAAa;AACb,mBAAe;AAAA,MACX;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,CAAC,EAAE,QAAQ,aAAa,WAAW,EAAE,CAAC;AAAA,IAC1C;AAAA,EACJ;AAEA,MAAI;AACJ,MAAI,SAAS;AACT,eAAW;AAAA,MACP;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB,CAAC,EAAE,QAAQ,SAAS,OAAO,EAAE,CAAC;AAAA,IAClC;AAAA,EACJ;AAEA,MAAI,WAAW,CAAC;AAEhB,MAAI,cAAc,OAAO,KAAK,UAAU,GAAG;AACvC,aAAS,KAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,OAAO,QAAQ,EAAC;AAAA,MACxB;AAAA,QACI,EAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAGD,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,UAAU,GAAG;AACnD,eAAS;AAAA,QAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,CAAC,EAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,OAAO;AAAA,IACP,WAAW;AAAA,IACX,aAAa;AAAA,IACb,UAAU,gBAAgB;AAAA,IAC1B,MAAM,YAAY;AAAA,IAClB,SAAS,YAAY;AAAA,EACzB;AACJ;AAEO,SAAS,SAASA,WAAuB;AAC5C,QAAM,KAAK,CAAC;AAEZ,QAAM,eAAe;AAAA,IACjB;AAAA,IACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,IAC7B,CAAC,EAAE,QAAQ,WAAW,CAAC;AAAA,EAC3B;AACA,KAAG,KAAK,YAAY;AAEpB,EAAAA,UAAS,OAAO,QAAQ,WAAS;AAC7B,UAAM,iBAAiB;AAAA,MACnB;AAAA,MACA,EAAC,OAAO,aAAa,QAAQ,EAAC;AAAA,MAC9B,CAAC,EAAE,QAAQ,UAAU,CAAC;AAAA,IAC1B;AACA,OAAG,KAAK,cAAc;AAEtB,UAAM,oBAAoB;AAAA,MACtB;AAAA,MACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,MAChC,CAAC,EAAE,QAAQ,gBAAgB,MAAM,WAAW,EAAE,CAAC;AAAA,IACnD;AACA,OAAG,KAAK,iBAAiB;AAEzB,UAAM,SAAS,QAAQ,aAAW;AAC9B,YAAM,YAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,eAAe,QAAQ,EAAC;AAAA,QAChC,CAAC,EAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,YAAY;AAAA,QACd;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,YAAY,CAAC;AAAA,MAC5B;AACA,SAAG,KAAK,SAAS;AAEjB,YAAM,iBAAiB;AAAA,QACnB;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,UAAU,QAAQ,UAAU,KAAK,EAAE,CAAC;AAAA,MACnD;AACA,SAAG,KAAK,cAAc;AAEtB,YAAM,OAAO;AAAA,QACT;AAAA,QACA,EAAC,OAAO,UAAU,QAAQ,EAAC;AAAA,QAC3B,CAAC,EAAE,QAAQ,QAAQ,CAAC;AAAA,MACxB;AACA,SAAG,KAAK,IAAI;AAEZ,cAAQ,UAAU,KAAK,QAAQ,SAAO;AAClC,cAAM,OAAO,EAAE,QAAQ;AAAA,UACnB,MAAM,IAAI;AAAA,UACV,MAAM,SAAS,IAAI,KAAK;AAAA,QAC5B,GAAG,IAAI,IAAI;AAEX,WAAG,KAAK,IAAI;AAAA,MAChB,CAAC;AAAA,IAEL,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAEO,SAAS,YAAYC,cAA2B;AACnD,QAAM,KAAY,CAAC;AAEnB,EAAAA,aAAY,QAAQ,gBAAc;AAC9B,UAAM,cAAc;AAAA,MAChB;AAAA,MACA,EAAC,OAAO,oBAAoB,EAAC;AAAA,MAC7B,CAAC,EAAE,QAAQ,eAAe,CAAC;AAAA,IAC/B;AACA,OAAG,KAAK,WAAW;AAEnB,OAAG,KAAK;AAAA,MACJ;AAAA,MACA,EAAC,OAAO,YAAY,QAAQ,EAAC;AAAA,MAC7B,CAAC,EAAE,QAAQ,UAAU,WAAW,KAAK,EAAE,CAAC;AAAA,IAC5C,CAAC;AAED,eAAW,WAAW,QAAQ,UAAQ;AAClC;AAAA,QACI,YAAY,QAAQ;AAAA,QACpB;AAAA,UACI,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,UACX,aAAa,KAAK;AAAA,UAClB,SAAS,KAAK;AAAA,UACd,YAAY,KAAK;AAAA;AAAA,QACrB;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;AAGO,SAAS,WACZ,OACA,OACA,SAAgB,CAAC,GACnB;AACE,QAAM,YAAY,MAAM;AAExB,QAAM,YAAY,gBAAgB,SAAS;AAC3C,QAAM,aAAa,EAAE,WAAW,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,CAAC,CAAC;AAC/D,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,SAAS,EAAE,CAAC,CAAC;AAC3E,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,SAAS,MAAM,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAM,YAAY,EAAE,aAAa,EAAC,MAAK,GAAG,CAAC,EAAE,QAAQ,MAAM,eAAe,EAAE,CAAC,CAAC;AAC9E,QAAM,WAAW,CAAC;AAElB,MAAI,MAAM,WAAW,OAAO,KAAK,MAAM,OAAO,GAAG;AAC7C,aAAS,KAAK;AAAA,MACV;AAAA,MACA,EAAC,OAAO,QAAQ,EAAC;AAAA,MACjB;AAAA,QACI,EAAE,QAAQ,UAAU;AAAA,MACxB;AAAA,IACJ,CAAC;AAED,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,OAAO,GAAG;AACtD,eAAS;AAAA,QAAK;AAAA,UACN;AAAA,UACA,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC;AAAA,UAC7B,CAAC,EAAE,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACP;AAEA,MAAI,MAAM,YAAY;AAClB,UAAM,YAAY,QAAQ;AAE1B,eAAW,QAAQ,MAAM,YAAY;AACjC,iBAAW,WAAW,MAAM,MAAM;AAAA,IACtC;AAAA,EACJ;AACJ;;;ADpPO,SAAS,QAAQ,KAAU;AAC9B,SAAO,OAAO,EAET,IAAI,iBAAiB;AAAA,IAClB,QAAQ;AAAA,IACR,QAAQ;AAAA,IACR,gBAAgB;AAAA,IAChB,qBAAqB;AAAA,IACrB,UAAU;AAAA,MACN,QAAQ,MAAM;AACV,eAAO,GAAG,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK;AAAA,MAC9D;AAAA,IACJ;AAAA,EACJ,CAAC,EACA,UAAU,KAAK,GAAG,CAAC;AAC5B;AAEO,SAAS,aAAa,KAAgB;AAzB7C;AA0BI,QAAM,KAAK,CAAC;AAEZ,QAAM,YAAY;AAAA,IACd,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,IACJ,IAAI;AAAA,EACR;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,EACd;AAEA,OAAI,4CAAW,gBAAX,mBAAwB,QAAQ;AAChC,OAAG,KAAK,GAAG,UAAU,WAAW;AAAA,EACpC;AAEA,KAAG;AAAA,IACC,UAAU;AAAA,EACd;AAEA,MAAI,UAAU,UAAU;AACpB,OAAG,KAAK,UAAU,QAAQ;AAAA,EAC9B;AAEA,MAAI,UAAU,MAAM;AAChB,OAAG,KAAK,UAAU,IAAI;AAAA,EAC1B;AAEA,OAAI,4CAAW,YAAX,mBAAoB,QAAQ;AAC5B,OAAG,KAAK,GAAG,UAAU,OAAO;AAAA,EAChC;AAEA,QAAM,aAAa,SAAS,IAAI,QAAQ;AACxC,QAAM,gBAAgB,YAAY,IAAI,WAAW;AACjD,KAAG,KAAK,GAAG,YAAY,GAAG,aAAa;AAEvC,SAAO;AACX;","names":["examples","definitions"]}

package/dist/{types-C8Pm_zQH.d.cts → types-CbDJSEtC.d.cts}

@@ -74,6 +74,7 @@ interface DefinitionProperty {
     name: string;
     type: string;
     description: string;
+    context?: any;
     properties?: DefinitionProperty[];
 }
 

package/dist/{types-C8Pm_zQH.d.ts → types-CbDJSEtC.d.ts}

@@ -74,6 +74,7 @@ interface DefinitionProperty {
     name: string;
     type: string;
     description: string;
+    context?: any;
     properties?: DefinitionProperty[];
 }
 

package/markdown.ts

@@ -1 +1 @@
-export * from "./src/markdown";
+export * from "./src/markdown/index";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/uniform",
-  "version": "0.1.0-xyd.3",
+  "version": "0.1.0-xyd.5",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -11,20 +11,23 @@
     "./content": "./dist/content.js"
   },
   "dependencies": {
+    "codehike": "^1.0.3",
+    "gray-matter": "^4.0.3",
     "remark": "^15.0.1",
     "remark-stringify": "^11.0.0",
-    "gray-matter": "^4.0.3",
     "unist-builder": "^4.0.0",
     "unist-util-visit": "^5.0.0",
-    "codehike": "^1.0.3",
-    "@xyd-js/core": "0.1.0-xyd.1"
-  },
-  "devDependencies": {
-    "tsup": "^8.3.0"
+    "@xyd-js/core": "0.1.0-xyd.2"
   },
   "peerDependencies": {
     "@mdx-js/mdx": "^3.1.0"
   },
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "rimraf": "^3.0.2",
+    "tsup": "^8.3.0",
+    "typescript": "^4.5.5"
+  },
   "scripts": {
     "clean": "rimraf build",
     "prebuild": "pnpm clean",

package/src/markdown/index.ts

@@ -35,12 +35,15 @@ export function referenceAST(ref: Reference) {
         ref.context
     )
 
+    md.push(
+        mdHeading.title,
+    )
+
     if (mdHeading?.description?.length) {
         md.push(...mdHeading.description)
     }
 
     md.push(
-        mdHeading.title,
         mdHeading.canonical,
     )
 

package/src/markdown/utils.ts

@@ -41,13 +41,12 @@ export function heading(
     let uDesc = [
         u(
             'heading',
-            {depth: START_DEPTH_LEVEL},
+            {depth: uTitle.depth + 1},
             [u('text', `!description`),]
         ),
         u('paragraph', [u('text', description)])
     ]
 
-
     let uRefCategory
     if (refCategory) {
         uRefCategory = u(
@@ -191,6 +190,7 @@ export function definitions(definitions: Definition[]) {
                     name: prop.name,
                     type: prop.type,
                     description: prop.description,
+                    context: prop.context,
                     properties: prop.properties  // TODO: fix ts
                 },
                 md,
@@ -214,12 +214,33 @@ export function properties(
     const uPropName = u('paragraph', {depth}, [u('text', `!name ${paramName}`)]);
     const uPropType = u('paragraph', {depth}, [u('text', `!type ${props.type}`)]);
     const uPropDesc = u('paragraph', {depth}, [u('text', props.description || '')]);
+    const uContext = []
+
+    if (props.context && Object.keys(props.context)) {
+        uContext.push(u(
+            'heading',
+            {depth: depth + 1},
+            [
+                u('text', `!context`),
+            ]
+        ))
+
+        for (const [key, value] of Object.entries(props.context)) {
+            uContext.push(u(
+                    'heading',
+                    {depth: uContext[0].depth + 1},
+                    [u('text', `!${key} ${value}`)]
+                )
+            )
+        }
+    }
 
     output.push(
         uPropTitle,
         uPropName,
         uPropType,
-        uPropDesc
+        uPropDesc,
+        ...uContext
     );
 
     if (props.properties) {

package/src/types.ts

@@ -116,6 +116,7 @@ export interface Definition {
 
     properties: DefinitionProperty[];
 
+
     type?: string;
 
     id?: string;
@@ -130,5 +131,7 @@ export interface DefinitionProperty {
 
     description: string;
 
+    context?: any // TODO: better type
+
     properties?: DefinitionProperty[];
 }

package/tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "ES2020",
     "module": "ESNext",
-    "moduleResolution": "bundler",
+    "moduleResolution": "node",
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,