@xyd-js/uniform 0.1.0-xyd.14 → 0.1.0-xyd.17

package/dist/types-BK7L2PZz.d.ts

@@ -1,81 +0,0 @@
-declare enum ReferenceCategory {
-    COMPONENTS = "components",
-    HOOKS = "hooks",
-    REST = "rest",
-    GRAPHQL = "graphql",
-    FUNCTIONS = "functions"
-}
-declare enum ReferenceType {
-    COMPONENT = "component",
-    HOOK = "hook",
-    REST_HTTP_GET = "rest_get",
-    REST_HTTP_POST = "rest_post",
-    REST_HTTP_PUT = "rest_put",
-    REST_HTTP_PATCH = "rest_patch",
-    REST_HTTP_DELETE = "rest_delete",
-    GRAPHQL_QUERY = "graphql_query",
-    GRAPHQL_MUTATION = "graphql_mutation",
-    FUNCTION_JS = "function_js"
-}
-interface GraphQLReferenceContext {
-}
-interface OpenAPIReferenceContext {
-    method: string;
-    path: string;
-}
-type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;
-interface ExampleRoot {
-    groups: ExampleGroup[];
-}
-interface ExampleGroup {
-    description?: string;
-    examples: Example[];
-}
-interface Example {
-    description?: string;
-    codeblock: CodeBlock;
-}
-interface CodeBlock {
-    title?: string;
-    tabs: CodeBlockTab[];
-}
-interface GraphQLExampleContext {
-    schema?: any;
-}
-interface OpenAPIExampleContext {
-    status?: number;
-    content?: string;
-}
-type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;
-interface CodeBlockTab {
-    title: string;
-    code: string;
-    language: string;
-    context?: ExampleContext;
-}
-interface Reference<C = ReferenceContext> {
-    title: string;
-    description: string;
-    canonical: string;
-    definitions: Definition[];
-    examples: ExampleRoot;
-    category?: ReferenceCategory;
-    type?: ReferenceType;
-    context?: C;
-}
-interface Definition {
-    title: string;
-    properties: DefinitionProperty[];
-    type?: string;
-    id?: string;
-    description?: string;
-}
-interface DefinitionProperty {
-    name: string;
-    type: string;
-    description: string;
-    context?: any;
-    properties?: DefinitionProperty[];
-}
-
-export { type CodeBlock as C, type Definition as D, type ExampleRoot as E, type GraphQLReferenceContext as G, type OpenAPIReferenceContext as O, type Reference as R, ReferenceCategory as a, ReferenceType as b, type ReferenceContext as c, type ExampleGroup as d, type Example as e, type GraphQLExampleContext as f, type OpenAPIExampleContext as g, type ExampleContext as h, type CodeBlockTab as i, type DefinitionProperty as j };

package/src/utils.ts

@@ -1,123 +0,0 @@
-import path from 'path';
-import matter from 'gray-matter';
-import {Sidebar, FrontMatter, PageFrontMatter} from "@xyd-js/core";
-
-import {Reference} from "./types";
-import uniform from "./index";
-
-// interface UniformFrontMatter extends FrontMatter { // TODO: it's concept only
-//     scopes?: string
-// }
-
-type GroupMap = {
-    [key: string]: {
-        __groups: GroupMap
-        pages: Set<string>
-    }
-}
-
-export interface pluginNavigationOptions {
-    urlPrefix: string
-}
-
-export function pluginNavigation(options: pluginNavigationOptions) {
-    if (!options.urlPrefix) {
-        throw new Error("urlPrefix is required")
-    }
-
-    return function pluginNavigationInner(cb: (cb: () => {
-        pageFrontMatter: PageFrontMatter
-        sidebar: Sidebar[]
-    }) => void) {
-        const pageFrontMatter: PageFrontMatter = {}
-        const groupMaps: GroupMap = {}
-
-        cb(() => {
-            return {
-                pageFrontMatter: pageFrontMatter,
-                sidebar: convertGroupMapsToNavigations(groupMaps) as Sidebar[]
-            }
-        })
-
-        return (ref: Reference) => {
-            const content = matter(ref.description || "") // TODO: pluginMatter before?
-
-            if (content.data) {
-                const data = content.data as FrontMatter
-
-                const pagePath = path.join(options.urlPrefix, ref.canonical)
-
-                if (data.title) {
-                    pageFrontMatter[pagePath] = {
-                        title: data.title,
-                    }
-                }
-
-                if (data.group) {
-                    if (typeof content?.data?.group === "string") {
-                        // TODO: seek nested group (it's not always from 0)
-                        throw new Error("group as string is not supported yet")
-                    }
-
-                    content.data.group.reduce((groups: GroupMap, group: string, i: number) => {
-                        if (!groups[group]) {
-                            groups[group] = {
-                                __groups: {},
-                                pages: new Set()
-                            }
-                        }
-
-                        if (i === content.data.group.length - 1) {
-                            groups[group].pages.add(pagePath)
-                        }
-
-                        return groups[group].__groups
-                    }, groupMaps)
-                }
-
-                // back description to original without frontmatter
-                ref.description = content.content
-            }
-        }
-    }
-}
-
-
-function convertGroupMapsToNavigations(groupMaps: GroupMap): Sidebar[] {
-    const nav: Sidebar[] = []
-
-    Object.keys(groupMaps).map((groupName) => {
-        const current = groupMaps[groupName]
-
-        const pages: string[] | Sidebar[] = []
-
-        current.pages.forEach((page: string) => {
-            pages.push(page)
-        })
-
-        if (Object.keys(current.__groups).length) {
-            const subNav: Sidebar = {
-                group: groupName,
-                pages: convertGroupMapsToNavigations(current.__groups)
-            }
-
-            nav.push(subNav)
-        } else {
-            nav.push({
-                group: groupName,
-                pages,
-            })
-        }
-    })
-
-    return nav
-}
-
-// example usage:
-// const response = uniform([/* references */], {
-//     plugins: [pluginNavigation({
-//         urlPrefix: "/docs"
-//     })],
-// });
-
-