@xyd-js/uniform 0.0.0-build

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { R as Reference } from './types-BiglsETJ.js';
+export { B as BaseReferenceContext, m as CodeBlock, n as CodeBlockTab, C as CommonDefinitionVariantMeta, i as DEFINED_DEFINITION_PROPERTY_TYPE, d as Definition, b as DefinitionGraphqlMeta, c as DefinitionMeta, D as DefinitionOpenAPIMeta, j as DefinitionProperty, h as DefinitionPropertyMeta, a as DefinitionTypeDocMeta, g as DefinitionVariant, f as DefinitionVariantMeta, e as DefinitionVariantOpenAPIMeta, l as Example, o as ExampleContext, k as ExampleGroup, E as ExampleRoot, t as GraphQLExampleContext, G as GraphQLReferenceContext, M as Meta, u as OpenAPIExampleContext, O as OpenAPIReferenceContext, p as ReferenceCategory, s as ReferenceContext, q as ReferenceType, S as SymbolDef, r as TypeDocReferenceContext, T as TypeDocReferenceContextMeta } from './types-BiglsETJ.js';
+import { Settings, MetadataMap, Sidebar } from '@xyd-js/core';
+import 'react';
+import 'codehike/code';
+
+type UniformPluginArgs = {
+    references: Reference[] | Reference;
+    defer: (defer: () => any) => void;
+};
+type UniformPluginRestArgs = {
+    index: number;
+};
+type UniformPlugin<T> = (args: UniformPluginArgs) => (ref: Reference, restArgs: UniformPluginRestArgs) => void;
+type NormalizeArray<T> = T extends Array<infer U> ? U[] : T;
+type PluginResult<T extends UniformPlugin<any>> = T extends UniformPlugin<infer R> ? R : never;
+type MergePluginResults<T extends UniformPlugin<any>[]> = {
+    [K in keyof UnionToIntersection<PluginResult<T[number]>>]: NormalizeArray<UnionToIntersection<PluginResult<T[number]>>[K]>;
+};
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+declare function uniform<T extends UniformPlugin<any>[]>(references: Reference[], config: {
+    plugins: T;
+}): {
+    references: Reference[];
+    out: MergePluginResults<T> extends infer T_1 ? { [K in keyof T_1]: MergePluginResults<T>[K]; } : never;
+};
+
+interface pluginJsonViewOptions {
+}
+type pluginJsonViewOutput = {
+    jsonViews: string;
+};
+declare function pluginJsonView(options?: pluginJsonViewOptions): UniformPlugin<pluginJsonViewOutput>;
+
+interface pluginNavigationOptions {
+    urlPrefix: string;
+    defaultGroup?: string;
+}
+type pluginNavigationOutput = {
+    pageFrontMatter: MetadataMap;
+    sidebar: Sidebar[];
+};
+declare function pluginNavigation(settings: Settings, options: pluginNavigationOptions): UniformPlugin<pluginNavigationOutput>;
+
+export { Reference, type UniformPlugin, type UniformPluginArgs, uniform as default, pluginJsonView, pluginNavigation };

package/dist/index.js

@@ -0,0 +1,194 @@
+// src/types.ts
+var DEFINED_DEFINITION_PROPERTY_TYPE = /* @__PURE__ */ ((DEFINED_DEFINITION_PROPERTY_TYPE2) => {
+  DEFINED_DEFINITION_PROPERTY_TYPE2["UNION"] = "$$union";
+  DEFINED_DEFINITION_PROPERTY_TYPE2["XOR"] = "$$xor";
+  DEFINED_DEFINITION_PROPERTY_TYPE2["ARRAY"] = "$$array";
+  DEFINED_DEFINITION_PROPERTY_TYPE2["ENUM"] = "$$enum";
+  return DEFINED_DEFINITION_PROPERTY_TYPE2;
+})(DEFINED_DEFINITION_PROPERTY_TYPE || {});
+var ReferenceCategory = /* @__PURE__ */ ((ReferenceCategory2) => {
+  ReferenceCategory2["COMPONENTS"] = "components";
+  ReferenceCategory2["HOOKS"] = "hooks";
+  ReferenceCategory2["REST"] = "rest";
+  ReferenceCategory2["GRAPHQL"] = "graphql";
+  ReferenceCategory2["FUNCTIONS"] = "functions";
+  return ReferenceCategory2;
+})(ReferenceCategory || {});
+var ReferenceType = /* @__PURE__ */ ((ReferenceType2) => {
+  ReferenceType2["COMPONENT"] = "component";
+  ReferenceType2["HOOK"] = "hook";
+  ReferenceType2["REST_HTTP_GET"] = "rest_get";
+  ReferenceType2["REST_HTTP_POST"] = "rest_post";
+  ReferenceType2["REST_HTTP_PUT"] = "rest_put";
+  ReferenceType2["REST_HTTP_PATCH"] = "rest_patch";
+  ReferenceType2["REST_HTTP_DELETE"] = "rest_delete";
+  ReferenceType2["REST_HTTP_OPTIONS"] = "rest_options";
+  ReferenceType2["REST_HTTP_HEAD"] = "rest_head";
+  ReferenceType2["REST_HTTP_TRACE"] = "rest_trace";
+  ReferenceType2["REST_COMPONENT_SCHEMA"] = "rest_component_schema";
+  ReferenceType2["GRAPHQL_QUERY"] = "graphql_query";
+  ReferenceType2["GRAPHQL_MUTATION"] = "graphql_mutation";
+  ReferenceType2["GRAPHQL_SUBSCRIPTION"] = "graphql_subscription";
+  ReferenceType2["GRAPHQL_SCALAR"] = "graphql_scalar";
+  ReferenceType2["GRAPHQL_OBJECT"] = "graphql_object";
+  ReferenceType2["GRAPHQL_INTERFACE"] = "graphql_interface";
+  ReferenceType2["GRAPHQL_UNION"] = "graphql_union";
+  ReferenceType2["GRAPHQL_ENUM"] = "graphql_enum";
+  ReferenceType2["GRAPHQL_INPUT"] = "graphql_input";
+  ReferenceType2["FUNCTION_JS"] = "function_js";
+  return ReferenceType2;
+})(ReferenceType || {});
+
+// src/index.ts
+function uniform(references, config) {
+  const response = {
+    references,
+    out: {}
+  };
+  config.plugins.forEach((plugin) => {
+    let defer = void 0;
+    const call = plugin({
+      references,
+      defer: (cb) => {
+        if (typeof cb === "function") {
+          defer = cb;
+        }
+      }
+      // visit: (pattern, callback) => {
+      // }
+    });
+    references.map((ref, i) => {
+      call(ref, {
+        index: i
+      });
+    });
+    if (typeof defer === "function") {
+      const resp = defer();
+      if (typeof resp !== "object") {
+        throw new Error(`Invalid callback return type: ${typeof resp}`);
+      }
+      response.out = {
+        ...response.out,
+        ...resp
+      };
+    }
+  });
+  return response;
+}
+
+// src/plugins/pluginJsonView.ts
+function pluginJsonView(options) {
+  return function pluginJsonViewInner({
+    defer
+  }) {
+    const jsonViews = [];
+    defer(() => ({
+      jsonViews
+    }));
+    return (ref) => {
+      const lines = [];
+      lines.push("{");
+      ref.definitions.forEach((def) => {
+        def.properties.forEach((prop, index) => {
+          var _a;
+          const value = (((_a = prop.examples) == null ? void 0 : _a[0]) || "").replace(/^"|"$|[^a-zA-Z0-9\s\-_.,:/@#=;+()]/g, "");
+          const comment = prop.examples && prop.examples.length > 1 ? ` // or "${prop.examples[1].replace(/^"|"$|[^a-zA-Z0-9\s\-_.,:/@#=;+()]/g, "")}"` : "";
+          const isLast = index === def.properties.length - 1;
+          lines.push(`    "${prop.name}": "${value}"${isLast ? "" : ","}${comment}`);
+        });
+      });
+      lines.push("}");
+      jsonViews.push(lines.join("\n"));
+    };
+  };
+}
+
+// src/plugins/pluginNavigation.ts
+import path from "path";
+var DEFAULT_VIRTUAL_FOLDER = ".xyd/.cache/.content";
+var DEFAULT_GROUP_NAME = "API Reference";
+function pluginNavigation(settings, options) {
+  if (!options.urlPrefix) {
+    throw new Error("urlPrefix is required");
+  }
+  return function pluginNavigationInner({
+    defer
+  }) {
+    const pageFrontMatter = {};
+    const groupMaps = {};
+    defer(() => ({
+      pageFrontMatter,
+      sidebar: convertGroupMapsToSidebar(settings, groupMaps)
+    }));
+    return (ref) => {
+      const dataCtx = ref.context;
+      const pagePath = path.join(options.urlPrefix, ref.canonical);
+      let group = (dataCtx == null ? void 0 : dataCtx.group) || [];
+      let title = ref.title;
+      if (pageFrontMatter[pagePath]) {
+        console.error("(pluginNavigation): pageFrontMatter[pagePath] already exists", pagePath);
+      }
+      if (!group) {
+        group = [options.defaultGroup || DEFAULT_GROUP_NAME];
+      }
+      pageFrontMatter[pagePath] = {
+        title
+      };
+      if (typeof group === "string") {
+        throw new Error("group as string is not supported yet");
+      }
+      group.reduce((groups, groupName, i) => {
+        if (!groups[groupName]) {
+          groups[groupName] = {
+            __groups: {},
+            pages: /* @__PURE__ */ new Set()
+          };
+        }
+        if (i === group.length - 1) {
+          groups[groupName].pages.add(pagePath);
+        }
+        return groups[groupName].__groups;
+      }, groupMaps);
+    };
+  };
+}
+function convertGroupMapsToSidebar(settings, groupMaps) {
+  const nav = [];
+  Object.keys(groupMaps).map((groupName) => {
+    const current = groupMaps[groupName];
+    const pages = [];
+    current.pages.forEach((page) => {
+      var _a, _b;
+      if ((_b = (_a = settings == null ? void 0 : settings.engine) == null ? void 0 : _a.uniform) == null ? void 0 : _b.store) {
+        pages.push(page);
+        return;
+      }
+      pages.push({
+        virtual: path.join(DEFAULT_VIRTUAL_FOLDER, page),
+        page
+      });
+    });
+    if (Object.keys(current.__groups).length) {
+      const subNav = {
+        group: groupName,
+        pages: convertGroupMapsToSidebar(settings, current.__groups)
+      };
+      nav.push(subNav);
+      return;
+    }
+    nav.push({
+      group: groupName,
+      pages
+    });
+  });
+  return nav;
+}
+export {
+  DEFINED_DEFINITION_PROPERTY_TYPE,
+  ReferenceCategory,
+  ReferenceType,
+  uniform as default,
+  pluginJsonView,
+  pluginNavigation
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts","../src/index.ts","../src/plugins/pluginJsonView.ts","../src/plugins/pluginNavigation.ts"],"sourcesContent":["import React from \"react\";\nimport {HighlightedCode} from \"codehike/code\";\n\n// TODO: type, and category also as generic?\nexport interface Reference<\n    C = ReferenceContext,\n    M extends DefinitionMeta = DefinitionMeta,\n    VM extends DefinitionVariantMeta = DefinitionVariantMeta\n> {\n    title: string;\n    description: string | React.ReactNode;\n    canonical: string;\n\n    definitions: Definition<M, VM>[] // TODO: in the future from generic?\n    examples: ExampleRoot\n\n\n    category?: ReferenceCategory; // TODO: do we need that?\n\n    type?: ReferenceType; // TODO: do we need that?\n\n    context?: C;\n\n    /**\n     * TODO: !!!! BETTER !!!!\n     * @internal\n     */\n    __UNSAFE_selector?: (selector: string) => any;\n}\n\nexport type DefinitionOpenAPIMeta = Meta<\"contentType\" | \"required\" | \"definitionDescription\">;\nexport type DefinitionTypeDocMeta = Meta<\"type\">;\nexport type DefinitionGraphqlMeta = Meta<\"type\" | \"graphqlName\">;\n\nexport type DefinitionMeta = DefinitionOpenAPIMeta | DefinitionTypeDocMeta | DefinitionGraphqlMeta\n\nexport type SymbolDef = {\n    id?: string | string[];\n\n    canonical?: string | string[];\n}\n\nexport interface Definition<\n    M extends DefinitionMeta = DefinitionMeta,\n    VM extends DefinitionVariantMeta = DefinitionVariantMeta\n> {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n    rootProperty?: DefinitionProperty\n\n    variants?: DefinitionVariant<VM>[];\n\n    description?: string | React.ReactNode;\n\n    meta?: M[];\n\n    /**\n     * @internal\n     */\n    symbolDef?: SymbolDef;\n\n    /**\n     * @internal\n     */\n    id?: string;\n\n    /**\n     * @internal\n     */\n    type?: string;\n}\n\nexport type DefinitionVariantOpenAPIMeta = Meta<\"status\" | \"contentType\" | \"definitionDescription\" | \"required\">;\nexport type CommonDefinitionVariantMeta = Meta<\"symbolName\">;\n\nexport type DefinitionVariantMeta = CommonDefinitionVariantMeta | DefinitionVariantOpenAPIMeta\n\nexport interface DefinitionVariant<\n    M extends DefinitionVariantMeta = DefinitionVariantMeta\n> {\n    title: string;\n\n    properties: DefinitionProperty[];\n\n    rootProperty?: DefinitionProperty\n\n    description?: string | React.ReactNode;\n\n    symbolDef?: SymbolDef;\n\n    meta?: M[];\n}\n\nexport interface Meta<T = string> {\n    name: T;\n\n    value?: unknown; // TODO: better type?\n}\n\nexport type DefinitionPropertyMeta = Meta<\"required\" | \"deprecated\" | \"internal\" | \"defaults\" | \"nullable\" | \"example\" | \"examples\" | \"minimum\" | \"maximum\" | \"enum-type\"> // TODO: better solution than enum-type?\n\nexport enum DEFINED_DEFINITION_PROPERTY_TYPE {\n    UNION = \"$$union\",\n\n    XOR = \"$$xor\",\n\n    ARRAY = \"$$array\",\n\n    ENUM = \"$$enum\",\n\n    // TYPE = \"$$type\", TODO: good idea?\n}\n\nexport interface DefinitionProperty {\n    name: string;\n\n    type: string | DEFINED_DEFINITION_PROPERTY_TYPE\n\n    description: string | React.ReactNode;\n\n    // TODO: in the future more advanced examples?\n    examples?: string | string[];\n\n    symbolDef?: SymbolDef;\n\n    meta?: DefinitionPropertyMeta[];\n\n    context?: any // TODO: better type\n\n    properties?: DefinitionProperty[];\n\n    ofProperty?: DefinitionProperty;\n}\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 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    // TODO: highlighted code\n    highlighted?: HighlightedCode;\n}\n\nexport type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;\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    // TODO: better type system for specific api typesl like gql or rest\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    REST_HTTP_OPTIONS = \"rest_options\",\n    REST_HTTP_HEAD = \"rest_head\",\n    REST_HTTP_TRACE = \"rest_trace\",\n\n    REST_COMPONENT_SCHEMA = \"rest_component_schema\",\n    // ---\n    GRAPHQL_QUERY = \"graphql_query\",\n    GRAPHQL_MUTATION = \"graphql_mutation\",\n    GRAPHQL_SUBSCRIPTION = \"graphql_subscription\",\n\n    GRAPHQL_SCALAR = \"graphql_scalar\",\n    GRAPHQL_OBJECT = \"graphql_object\",\n    GRAPHQL_INTERFACE = \"graphql_interface\",\n    GRAPHQL_UNION = \"graphql_union\",\n    GRAPHQL_ENUM = \"graphql_enum\",\n    GRAPHQL_INPUT = \"graphql_input\",\n    // end for API\n\n    // for code\n    FUNCTION_JS = \"function_js\",\n    // end for code\n}\n\nexport interface BaseReferenceContext {\n    group?: string[];\n\n    scopes?: string[];\n}\n\nexport interface GraphQLReferenceContext extends BaseReferenceContext {\n    /**\n     * @internal\n     */\n    graphqlTypeShort: string;\n\n    graphqlName: string;\n}\n\n// TODO: custom value?\nexport interface OpenAPIReferenceContext extends BaseReferenceContext {\n    method?: string;\n\n    path?: string;\n\n    fullPath?: string;\n\n    componentSchema?: string\n}\n\nexport type TypeDocReferenceContextMeta = Meta<\"internal\">\n\n// Add TypeDocReferenceContext to the union type\nexport interface TypeDocReferenceContext extends BaseReferenceContext {\n    symbolId: string;\n    symbolName: string;\n    symbolKind: number;\n    packageName: string;\n    fileName: string;\n    fileFullPath: string;\n    line: number;\n    col: number;\n    signatureText: {\n        code: string;\n        lang: string;\n    };\n    sourcecode: {\n        code: string;\n        lang: string;\n    };\n    category?: string;\n    meta?: TypeDocReferenceContextMeta[]\n}\n\nexport type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext | TypeDocReferenceContext\n\nexport interface GraphQLExampleContext {\n    schema?: any; // TODO:\n}\n\nexport interface OpenAPIExampleContext {\n    status?: number;\n\n    content?: string;\n}\n\n\n","// Define the new PluginV type with a callback function that returns another function\nimport {Reference} from \"./types\";\n\nexport * from \"./types\";\n\n// Define the new PluginV type with a callback function that returns another function\nexport type UniformPluginArgs = {\n    references: Reference[] | Reference,\n    defer: (defer: () => any) => void;\n\n    // TODO: maybe in the future\n    // visit: (selector: string | \"[method] [path]\", callback: (...args: any[]) => void) => void;\n}\n\n\nexport type UniformPluginRestArgs = {\n    index: number;\n}\nexport type UniformPlugin<T> = (args: UniformPluginArgs) => (ref: Reference, restArgs: UniformPluginRestArgs) => 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    config.plugins.forEach((plugin) => {\n        let defer: any = undefined; // fix any\n\n        const call = plugin({\n            references: references,\n            defer: (cb) => {\n                if (typeof cb === \"function\") {\n                    defer = cb\n                }\n            },\n            // visit: (pattern, callback) => {\n            // }\n        })\n\n        references.map((ref, i) => {\n            call(ref, {\n                index: i,\n            })\n        });\n\n        if (typeof defer === \"function\") {\n            const resp = defer()\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        }\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(defer: (defer: () => { value: boolean }) => void) {\n//     defer(() => ({\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 type { UniformPluginArgs, UniformPlugin } from \"../index\";\nimport { Reference } from \"../types\";\n\nexport interface pluginJsonViewOptions {\n}\n\ntype pluginJsonViewOutput = {\n    jsonViews: string;\n}\n\nexport function pluginJsonView(\n    options?: pluginJsonViewOptions\n): UniformPlugin<pluginJsonViewOutput> {\n\n    return function pluginJsonViewInner({\n        defer,\n    }: UniformPluginArgs) {\n        const jsonViews: string[] = [];\n\n        defer(() => ({\n            jsonViews\n        }))\n\n        return (ref: Reference) => {\n            // Build the output string manually to ensure exact format\n            const lines: string[] = [];\n            lines.push('{');\n            \n            ref.definitions.forEach(def => {\n                def.properties.forEach((prop, index) => {\n                    // Remove any quotes and trailing characters from the value\n                    const value = (prop.examples?.[0] || '').replace(/^\"|\"$|[^a-zA-Z0-9\\s\\-_.,:/@#=;+()]/g, '');\n                    const comment = prop.examples && prop.examples.length > 1 \n                        ? ` // or \"${(prop.examples as string[])[1].replace(/^\"|\"$|[^a-zA-Z0-9\\s\\-_.,:/@#=;+()]/g, '')}\"`\n                        : '';\n                    const isLast = index === def.properties.length - 1;\n                    // Add comma after the value but before the comment\n                    lines.push(`    \"${prop.name}\": \"${value}\"${isLast ? '' : ','}${comment}`);\n                });\n            });\n            \n            lines.push('}');\n            \n            jsonViews.push(lines.join('\\n'));\n        }\n    }\n}\n\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginJsonView({\n//         \n//     })],\n// });\n","import path from 'node:path';\n\nimport type { Sidebar, Metadata, MetadataMap, Settings, PageURL } from \"@xyd-js/core\";\n\nimport type { UniformPluginArgs, UniformPlugin } from \"../index\";\nimport { CodeBlockTab, Example, ExampleGroup, Reference } from \"../types\";\n\nconst DEFAULT_VIRTUAL_FOLDER = \".xyd/.cache/.content\" // TODO: share this + .xyd/.build/.content for build\n\nconst DEFAULT_GROUP_NAME = \"API Reference\" // TODO: configurable\n\ntype GroupMap = {\n    [key: string]: {\n        __groups: GroupMap\n        pages: Set<string>\n    }\n}\n\nexport interface pluginNavigationOptions {\n    urlPrefix: string\n    defaultGroup?: string\n}\n\ntype pluginNavigationOutput = {\n    pageFrontMatter: MetadataMap;\n    sidebar: Sidebar[];\n}\n\nexport function pluginNavigation(\n    settings: Settings,\n    options: pluginNavigationOptions\n): UniformPlugin<pluginNavigationOutput> {\n    if (!options.urlPrefix) {\n        throw new Error(\"urlPrefix is required\")\n    }\n\n    return function pluginNavigationInner({\n        defer,\n    }: UniformPluginArgs) {\n        const pageFrontMatter: MetadataMap = {}\n        const groupMaps: GroupMap = {}\n\n        defer(() => ({\n            pageFrontMatter,\n            sidebar: convertGroupMapsToSidebar(settings, groupMaps) as Sidebar[]\n        }))\n\n        return (ref: Reference) => {\n            const dataCtx = ref.context\n            const pagePath = path.join(options.urlPrefix, ref.canonical)\n\n            let group = dataCtx?.group || []\n            let title = ref.title\n\n            if (pageFrontMatter[pagePath]) {\n                console.error(\"(pluginNavigation): pageFrontMatter[pagePath] already exists\", pagePath)\n            }\n\n            if (!group) {\n                group = [options.defaultGroup || DEFAULT_GROUP_NAME]\n            }\n\n            pageFrontMatter[pagePath] = {\n                title,\n            }\n\n            if (typeof 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            group.reduce((groups: GroupMap, groupName: string, i: number) => {\n                if (!groups[groupName]) {\n                    groups[groupName] = {\n                        __groups: {},\n                        pages: new Set()\n                    }\n                }\n\n                if (i === group.length - 1) {\n                    groups[groupName].pages.add(pagePath)\n                }\n\n                return groups[groupName].__groups\n            }, groupMaps)\n        }\n    }\n}\n\nfunction convertGroupMapsToSidebar(settings: Settings, groupMaps: GroupMap): Sidebar[] {\n    const nav: Sidebar[] = []\n\n    Object.keys(groupMaps).map((groupName) => {\n        const current = groupMaps[groupName]\n\n        const pages: PageURL[] = []\n\n        current.pages.forEach((page: string) => {\n            if (settings?.engine?.uniform?.store) {\n                pages.push(page)\n                return\n            }\n            pages.push({\n                virtual: path.join(DEFAULT_VIRTUAL_FOLDER, page),\n                page: page,\n            })\n        })\n\n        if (Object.keys(current.__groups).length) {\n            const subNav: Sidebar = {\n                group: groupName,\n                pages: convertGroupMapsToSidebar(settings, current.__groups)\n            }\n\n            nav.push(subNav)\n\n            return\n        }\n\n        nav.push({\n            group: groupName,\n            pages,\n        })\n    })\n\n    return nav\n}\n\n// TODO: in the future xyd settings must be removed cuz uniform will be part of opendocs\n// example usage:\n// const response = uniform([/* references */], {\n//     plugins: [pluginNavigation({}, {\n//         urlPrefix: \"/docs\"\n//     })],\n// });\n"],"mappings":";AAuGO,IAAK,mCAAL,kBAAKA,sCAAL;AACH,EAAAA,kCAAA,WAAQ;AAER,EAAAA,kCAAA,SAAM;AAEN,EAAAA,kCAAA,WAAQ;AAER,EAAAA,kCAAA,UAAO;AAPC,SAAAA;AAAA,GAAA;AA2EL,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;AAKP,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AACnB,EAAAA,eAAA,uBAAoB;AACpB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,qBAAkB;AAElB,EAAAA,eAAA,2BAAwB;AAExB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,sBAAmB;AACnB,EAAAA,eAAA,0BAAuB;AAEvB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,oBAAiB;AACjB,EAAAA,eAAA,uBAAoB;AACpB,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,kBAAe;AACf,EAAAA,eAAA,mBAAgB;AAIhB,EAAAA,eAAA,iBAAc;AAhCN,SAAAA;AAAA,GAAA;;;AChKG,SAAR,QACH,YACA,QACF;AAKE,QAAM,WAGF;AAAA,IACA;AAAA,IACA,KAAK,CAAC;AAAA,EACV;AAEA,SAAO,QAAQ,QAAQ,CAAC,WAAW;AAC/B,QAAI,QAAa;AAEjB,UAAM,OAAO,OAAO;AAAA,MAChB;AAAA,MACA,OAAO,CAAC,OAAO;AACX,YAAI,OAAO,OAAO,YAAY;AAC1B,kBAAQ;AAAA,QACZ;AAAA,MACJ;AAAA;AAAA;AAAA,IAGJ,CAAC;AAED,eAAW,IAAI,CAAC,KAAK,MAAM;AACvB,WAAK,KAAK;AAAA,QACN,OAAO;AAAA,MACX,CAAC;AAAA,IACL,CAAC;AAED,QAAI,OAAO,UAAU,YAAY;AAC7B,YAAM,OAAO,MAAM;AACnB,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;AAAA,EACJ,CAAC;AAED,SAAO;AACX;;;AC3EO,SAAS,eACZ,SACmC;AAEnC,SAAO,SAAS,oBAAoB;AAAA,IAChC;AAAA,EACJ,GAAsB;AAClB,UAAM,YAAsB,CAAC;AAE7B,UAAM,OAAO;AAAA,MACT;AAAA,IACJ,EAAE;AAEF,WAAO,CAAC,QAAmB;AAEvB,YAAM,QAAkB,CAAC;AACzB,YAAM,KAAK,GAAG;AAEd,UAAI,YAAY,QAAQ,SAAO;AAC3B,YAAI,WAAW,QAAQ,CAAC,MAAM,UAAU;AA7BxD;AA+BoB,gBAAM,WAAS,UAAK,aAAL,mBAAgB,OAAM,IAAI,QAAQ,uCAAuC,EAAE;AAC1F,gBAAM,UAAU,KAAK,YAAY,KAAK,SAAS,SAAS,IAClD,WAAY,KAAK,SAAsB,CAAC,EAAE,QAAQ,uCAAuC,EAAE,CAAC,MAC5F;AACN,gBAAM,SAAS,UAAU,IAAI,WAAW,SAAS;AAEjD,gBAAM,KAAK,QAAQ,KAAK,IAAI,OAAO,KAAK,IAAI,SAAS,KAAK,GAAG,GAAG,OAAO,EAAE;AAAA,QAC7E,CAAC;AAAA,MACL,CAAC;AAED,YAAM,KAAK,GAAG;AAEd,gBAAU,KAAK,MAAM,KAAK,IAAI,CAAC;AAAA,IACnC;AAAA,EACJ;AACJ;;;AC9CA,OAAO,UAAU;AAOjB,IAAM,yBAAyB;AAE/B,IAAM,qBAAqB;AAmBpB,SAAS,iBACZ,UACA,SACqC;AACrC,MAAI,CAAC,QAAQ,WAAW;AACpB,UAAM,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AAEA,SAAO,SAAS,sBAAsB;AAAA,IAClC;AAAA,EACJ,GAAsB;AAClB,UAAM,kBAA+B,CAAC;AACtC,UAAM,YAAsB,CAAC;AAE7B,UAAM,OAAO;AAAA,MACT;AAAA,MACA,SAAS,0BAA0B,UAAU,SAAS;AAAA,IAC1D,EAAE;AAEF,WAAO,CAAC,QAAmB;AACvB,YAAM,UAAU,IAAI;AACpB,YAAM,WAAW,KAAK,KAAK,QAAQ,WAAW,IAAI,SAAS;AAE3D,UAAI,SAAQ,mCAAS,UAAS,CAAC;AAC/B,UAAI,QAAQ,IAAI;AAEhB,UAAI,gBAAgB,QAAQ,GAAG;AAC3B,gBAAQ,MAAM,gEAAgE,QAAQ;AAAA,MAC1F;AAEA,UAAI,CAAC,OAAO;AACR,gBAAQ,CAAC,QAAQ,gBAAgB,kBAAkB;AAAA,MACvD;AAEA,sBAAgB,QAAQ,IAAI;AAAA,QACxB;AAAA,MACJ;AAEA,UAAI,OAAO,UAAU,UAAU;AAE3B,cAAM,IAAI,MAAM,sCAAsC;AAAA,MAC1D;AAEA,YAAM,OAAO,CAAC,QAAkB,WAAmB,MAAc;AAC7D,YAAI,CAAC,OAAO,SAAS,GAAG;AACpB,iBAAO,SAAS,IAAI;AAAA,YAChB,UAAU,CAAC;AAAA,YACX,OAAO,oBAAI,IAAI;AAAA,UACnB;AAAA,QACJ;AAEA,YAAI,MAAM,MAAM,SAAS,GAAG;AACxB,iBAAO,SAAS,EAAE,MAAM,IAAI,QAAQ;AAAA,QACxC;AAEA,eAAO,OAAO,SAAS,EAAE;AAAA,MAC7B,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ;AACJ;AAEA,SAAS,0BAA0B,UAAoB,WAAgC;AACnF,QAAM,MAAiB,CAAC;AAExB,SAAO,KAAK,SAAS,EAAE,IAAI,CAAC,cAAc;AACtC,UAAM,UAAU,UAAU,SAAS;AAEnC,UAAM,QAAmB,CAAC;AAE1B,YAAQ,MAAM,QAAQ,CAAC,SAAiB;AAjGhD;AAkGY,WAAI,gDAAU,WAAV,mBAAkB,YAAlB,mBAA2B,OAAO;AAClC,cAAM,KAAK,IAAI;AACf;AAAA,MACJ;AACA,YAAM,KAAK;AAAA,QACP,SAAS,KAAK,KAAK,wBAAwB,IAAI;AAAA,QAC/C;AAAA,MACJ,CAAC;AAAA,IACL,CAAC;AAED,QAAI,OAAO,KAAK,QAAQ,QAAQ,EAAE,QAAQ;AACtC,YAAM,SAAkB;AAAA,QACpB,OAAO;AAAA,QACP,OAAO,0BAA0B,UAAU,QAAQ,QAAQ;AAAA,MAC/D;AAEA,UAAI,KAAK,MAAM;AAEf;AAAA,IACJ;AAEA,QAAI,KAAK;AAAA,MACL,OAAO;AAAA,MACP;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AAED,SAAO;AACX;","names":["DEFINED_DEFINITION_PROPERTY_TYPE","ReferenceCategory","ReferenceType"]}

package/dist/markdown.cjs

@@ -0,0 +1,302 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// markdown.ts
+var markdown_exports = {};
+__export(markdown_exports, {
+  compile: () => compile,
+  referenceAST: () => referenceAST
+});
+module.exports = __toCommonJS(markdown_exports);
+
+// src/markdown/index.ts
+var import_remark = require("remark");
+var import_remark_stringify = __toESM(require("remark-stringify"), 1);
+
+// src/markdown/utils.ts
+var import_mdast_util_from_markdown = require("mdast-util-from-markdown");
+var import_unist_builder = require("unist-builder");
+var START_DEPTH_LEVEL = 2;
+function root(ast) {
+  return (0, import_unist_builder.u)("root", ast);
+}
+function heading(title, canonical, description, refCategory, refType, refContext) {
+  const uTitle = (0, import_unist_builder.u)(
+    "heading",
+    { depth: START_DEPTH_LEVEL },
+    [(0, import_unist_builder.u)("text", `!!references ${title}`)]
+  );
+  const uCanonical = (0, import_unist_builder.u)(
+    "heading",
+    { depth: uTitle.depth + 1 },
+    [(0, import_unist_builder.u)("text", `!canonical ${canonical}`)]
+  );
+  let uDesc = [
+    (0, import_unist_builder.u)(
+      "heading",
+      { depth: uTitle.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!description`)]
+    ),
+    (0, import_unist_builder.u)("paragraph", [(0, import_unist_builder.u)("text", description)])
+  ];
+  let uRefCategory;
+  if (refCategory) {
+    uRefCategory = (0, import_unist_builder.u)(
+      "heading",
+      { depth: uTitle.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!category ${refCategory}`)]
+    );
+  }
+  let uRefType;
+  if (refType) {
+    uRefType = (0, import_unist_builder.u)(
+      "heading",
+      { depth: uTitle.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!type ${refType}`)]
+    );
+  }
+  let uContext = [];
+  if (refContext && Object.keys(refContext)) {
+    uContext.push((0, import_unist_builder.u)(
+      "heading",
+      { depth: uTitle.depth + 1 },
+      [
+        (0, import_unist_builder.u)("text", `!context`)
+      ]
+    ));
+    for (const [key, value] of Object.entries(refContext)) {
+      if (typeof value === "object") {
+        if (value.code) {
+          uContext.push(
+            (0, import_unist_builder.u)("heading", { depth: uContext[0].depth + 1 }, [(0, import_unist_builder.u)("text", `!${key}`)])
+          );
+          uContext.push(
+            (0, import_unist_builder.u)("code", { lang: value.lang }, value.code)
+          );
+          continue;
+        }
+      }
+      uContext.push(
+        (0, import_unist_builder.u)("heading", { depth: uContext[0].depth + 1 }, [(0, import_unist_builder.u)("text", `!${key} ${value.toString()}`)])
+      );
+    }
+  }
+  return {
+    title: uTitle,
+    canonical: uCanonical,
+    description: uDesc,
+    category: uRefCategory || null,
+    type: uRefType || null,
+    context: uContext || null
+  };
+}
+function examples(examples2) {
+  const md = [];
+  const uExampleRoot = (0, import_unist_builder.u)(
+    "heading",
+    { depth: START_DEPTH_LEVEL + 1 },
+    [(0, import_unist_builder.u)("text", `!examples`)]
+  );
+  md.push(uExampleRoot);
+  examples2.groups.forEach((group) => {
+    const uExampleGroups = (0, import_unist_builder.u)(
+      "heading",
+      { depth: uExampleRoot.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!!groups`)]
+    );
+    md.push(uExampleGroups);
+    const uGroupDescription = (0, import_unist_builder.u)(
+      "heading",
+      { depth: uExampleGroups.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!description ${group.description}`)]
+    );
+    md.push(uGroupDescription);
+    group.examples.forEach((example) => {
+      const uExamples = (0, import_unist_builder.u)(
+        "heading",
+        { depth: uExampleGroups.depth + 1 },
+        [(0, import_unist_builder.u)("text", `!!examples`)]
+      );
+      md.push(uExamples);
+      const codeBlock = (0, import_unist_builder.u)(
+        "heading",
+        { depth: uExamples.depth + 1 },
+        [(0, import_unist_builder.u)("text", `!codeblock`)]
+      );
+      md.push(codeBlock);
+      const codeBlockTitle = (0, import_unist_builder.u)(
+        "heading",
+        { depth: codeBlock.depth + 1 },
+        [(0, import_unist_builder.u)("text", `!title ${example.codeblock.title}`)]
+      );
+      md.push(codeBlockTitle);
+      const tabs = (0, import_unist_builder.u)(
+        "heading",
+        { depth: codeBlock.depth + 1 },
+        [(0, import_unist_builder.u)("text", `!!tabs`)]
+      );
+      md.push(tabs);
+      example.codeblock.tabs.forEach((tab) => {
+        const code = (0, import_unist_builder.u)("code", {
+          lang: tab.language,
+          meta: `!code ${tab.title}`
+        }, tab.code);
+        md.push(code);
+      });
+    });
+  });
+  return md;
+}
+function definitions(definitions2) {
+  const md = [];
+  definitions2.forEach((definition) => {
+    const uDefinition = (0, import_unist_builder.u)(
+      "heading",
+      { depth: START_DEPTH_LEVEL + 1 },
+      [(0, import_unist_builder.u)("text", `!!definitions`)]
+    );
+    md.push(uDefinition);
+    md.push((0, import_unist_builder.u)(
+      "heading",
+      { depth: uDefinition.depth + 1 },
+      [(0, import_unist_builder.u)("text", `!title ${definition.title}`)]
+    ));
+    definition.properties.forEach((prop) => {
+      properties(
+        uDefinition.depth + 1,
+        {
+          name: prop.name,
+          type: prop.type,
+          description: prop.description,
+          context: prop.context,
+          properties: prop.properties
+          // TODO: fix ts
+        },
+        md
+      );
+    });
+  });
+  return md;
+}
+function properties(depth, props, output = []) {
+  const paramName = props.name;
+  const propTitle = `!!properties ${paramName}`;
+  const uPropTitle = (0, import_unist_builder.u)("heading", { depth }, [(0, import_unist_builder.u)("text", propTitle)]);
+  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 markdownAst = (0, import_mdast_util_from_markdown.fromMarkdown)(props.description || "");
+  const uPropDesc = (0, import_unist_builder.u)("paragraph", { depth }, markdownAst.children);
+  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,
+    ...uContext
+  );
+  if (props.properties) {
+    const deepDepth = depth + 1;
+    for (const prop of props.properties) {
+      properties(deepDepth, prop, output);
+    }
+  }
+}
+
+// src/markdown/index.ts
+function compile(ast) {
+  return (0, import_remark.remark)().use(import_remark_stringify.default, {
+    bullet: "-",
+    fences: true,
+    listItemIndent: "one",
+    incrementListMarker: false,
+    handlers: {
+      heading(node) {
+        return `${"#".repeat(node.depth)} ${node.children[0].value}`;
+      }
+    }
+  }).stringify(root(ast));
+}
+function referenceAST(ref) {
+  var _a, _b;
+  const md = [];
+  const mdHeading = heading(
+    ref.title,
+    ref.canonical,
+    typeof ref.description === "string" ? ref.description : "",
+    ref.category,
+    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.canonical
+  );
+  if (mdHeading.category) {
+    md.push(mdHeading.category);
+  }
+  if (mdHeading.type) {
+    md.push(mdHeading.type);
+  }
+  if ((_b = mdHeading == null ? void 0 : mdHeading.context) == null ? void 0 : _b.length) {
+    md.push(...mdHeading.context);
+  }
+  const mdExamples = examples(ref.examples);
+  const mdDefinitions = definitions(ref.definitions);
+  md.push(...mdExamples, ...mdDefinitions);
+  return md;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  compile,
+  referenceAST
+});
+//# sourceMappingURL=markdown.cjs.map

package/dist/markdown.cjs.map

@@ -0,0 +1 @@
+{"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        typeof ref.description === \"string\" ? 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 { fromMarkdown } from \"mdast-util-from-markdown\";\nimport {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            if (typeof value === \"object\") {\n                // TODO: support ```<lang> ??\n                if (value.code) {\n                    uContext.push(\n                        u('heading', {depth: uContext[0].depth + 1}, [u('text', `!${key}`)])\n                    );\n\n                    uContext.push(\n                        u('code', {lang: value.lang}, value.code)\n                    );\n\n                    continue;\n                }\n            }\n\n            uContext.push(\n                u('heading', {depth: uContext[0].depth + 1}, [u('text', `!${key} ${value.toString()}`)])\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 markdownAst = fromMarkdown(props.description || '');\n    const uPropDesc = u(\"paragraph\", { depth }, markdownAst.children);\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,sCAA6B;AAC7B,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,UAAI,OAAO,UAAU,UAAU;AAE3B,YAAI,MAAM,MAAM;AACZ,mBAAS;AAAA,gBACL,wBAAE,WAAW,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC,GAAG,KAAC,wBAAE,QAAQ,IAAI,GAAG,EAAE,CAAC,CAAC;AAAA,UACvE;AAEA,mBAAS;AAAA,gBACL,wBAAE,QAAQ,EAAC,MAAM,MAAM,KAAI,GAAG,MAAM,IAAI;AAAA,UAC5C;AAEA;AAAA,QACJ;AAAA,MACJ;AAEA,eAAS;AAAA,YACL,wBAAE,WAAW,EAAC,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAC,GAAG,KAAC,wBAAE,QAAQ,IAAI,GAAG,IAAI,MAAM,SAAS,CAAC,EAAE,CAAC,CAAC;AAAA,MAC3F;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,kBAAc,8CAAa,MAAM,eAAe,EAAE;AACxD,QAAM,gBAAY,wBAAE,aAAa,EAAE,MAAM,GAAG,YAAY,QAAQ;AAChE,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;;;ADlQO,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,OAAO,IAAI,gBAAgB,WAAW,IAAI,cAAc;AAAA,IACxD,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

@@ -0,0 +1,8 @@
+import { R as Reference } from './types-BiglsETJ.cjs';
+import 'react';
+import 'codehike/code';
+
+declare function compile(ast: any): string;
+declare function referenceAST(ref: Reference): any[];
+
+export { compile, referenceAST };

package/dist/markdown.d.ts

@@ -0,0 +1,8 @@
+import { R as Reference } from './types-BiglsETJ.js';
+import 'react';
+import 'codehike/code';
+
+declare function compile(ast: any): string;
+declare function referenceAST(ref: Reference): any[];
+
+export { compile, referenceAST };