@xyd-js/uniform 0.1.0-xyd.4 → 0.1.0-xyd.56

package/src/types.ts

@@ -1,3 +1,180 @@
+import React from "react";
+import {HighlightedCode} from "codehike/code";
+
+// TODO: type, and category also as generic?
+export interface Reference<
+    C = ReferenceContext,
+    M extends DefinitionMeta = DefinitionMeta,
+    VM extends DefinitionVariantMeta = DefinitionVariantMeta
+> {
+    title: string;
+    description: string | React.ReactNode;
+    canonical: string;
+
+    definitions: Definition<M, VM>[] // TODO: in the future from generic?
+    examples: ExampleRoot
+
+
+    category?: ReferenceCategory; // TODO: do we need that?
+
+    type?: ReferenceType; // TODO: do we need that?
+
+    context?: C;
+
+    /**
+     * TODO: !!!! BETTER !!!!
+     * @internal
+     */
+    __UNSAFE_selector?: (selector: string) => any;
+}
+
+export type DefinitionOpenAPIMeta = Meta<"contentType" | "required" | "definitionDescription">;
+export type DefinitionTypeDocMeta = Meta<"type">;
+export type DefinitionGraphqlMeta = Meta<"type" | "graphqlName">;
+
+export type DefinitionMeta = DefinitionOpenAPIMeta | DefinitionTypeDocMeta | DefinitionGraphqlMeta
+
+export type SymbolDef = {
+    id?: string | string[];
+
+    canonical?: string | string[];
+}
+
+export interface Definition<
+    M extends DefinitionMeta = DefinitionMeta,
+    VM extends DefinitionVariantMeta = DefinitionVariantMeta
+> {
+    title: string;
+
+    properties: DefinitionProperty[];
+
+    rootProperty?: DefinitionProperty
+
+    variants?: DefinitionVariant<VM>[];
+
+    description?: string | React.ReactNode;
+
+    meta?: M[];
+
+    /**
+     * @internal
+     */
+    symbolDef?: SymbolDef;
+
+    /**
+     * @internal
+     */
+    id?: string;
+
+    /**
+     * @internal
+     */
+    type?: string;
+}
+
+export type DefinitionVariantOpenAPIMeta = Meta<"status" | "contentType" | "definitionDescription" | "required">;
+export type CommonDefinitionVariantMeta = Meta<"symbolName">;
+
+export type DefinitionVariantMeta = CommonDefinitionVariantMeta | DefinitionVariantOpenAPIMeta
+
+export interface DefinitionVariant<
+    M extends DefinitionVariantMeta = DefinitionVariantMeta
+> {
+    title: string;
+
+    properties: DefinitionProperty[];
+
+    rootProperty?: DefinitionProperty
+
+    description?: string | React.ReactNode;
+
+    symbolDef?: SymbolDef;
+
+    meta?: M[];
+}
+
+export interface Meta<T = string> {
+    name: T;
+
+    value?: unknown; // TODO: better type?
+}
+
+export type DefinitionPropertyMeta = Meta<"required" | "deprecated" | "internal" | "defaults" | "nullable" | "example" | "examples" | "minimum" | "maximum" | "enum-type"> // TODO: better solution than enum-type?
+
+export enum DEFINED_DEFINITION_PROPERTY_TYPE {
+    UNION = "$$union",
+
+    XOR = "$$xor",
+
+    ARRAY = "$$array",
+
+    ENUM = "$$enum",
+
+    // TYPE = "$$type", TODO: good idea?
+}
+
+export interface DefinitionProperty {
+    name: string;
+
+    type: string | DEFINED_DEFINITION_PROPERTY_TYPE
+
+    description: string | React.ReactNode;
+
+    // TODO: in the future more advanced examples?
+    examples?: string | string[];
+
+    symbolDef?: SymbolDef;
+
+    meta?: DefinitionPropertyMeta[];
+
+    context?: any // TODO: better type
+
+    properties?: DefinitionProperty[];
+
+    ofProperty?: DefinitionProperty;
+}
+
+export interface ExampleRoot {
+    groups: ExampleGroup[];
+}
+
+export interface ExampleGroup {
+    description?: string;
+
+    examples: Example[];
+}
+
+export interface Example {
+    description?: string; // TODO: replace with title ?
+
+    codeblock: CodeBlock;
+}
+
+export interface CodeBlock {
+    title?: string;
+
+    tabs: CodeBlockTab[];
+}
+
+export interface CodeBlockTab {
+    // title of the tab e.g "JavaScript"
+    title: string;
+
+    // code in the tab e.g "console.log('Hello World')"
+    code: string
+
+    // language of the code e.g "js"
+    language: string;
+
+    // context of the generation method e.g openapi or graphql
+    context?: ExampleContext;
+
+    // TODO: highlighted code
+    highlighted?: HighlightedCode;
+}
+
+export type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;
+
 // TODO: concept only
 export enum ReferenceCategory {
     // for React
@@ -23,14 +200,28 @@ export enum ReferenceType {
     // end for React
 
     // for API
+    // TODO: better type system for specific api typesl like gql or rest
     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",
+    REST_HTTP_OPTIONS = "rest_options",
+    REST_HTTP_HEAD = "rest_head",
+    REST_HTTP_TRACE = "rest_trace",
+
+    REST_COMPONENT_SCHEMA = "rest_component_schema",
     // ---
     GRAPHQL_QUERY = "graphql_query",
     GRAPHQL_MUTATION = "graphql_mutation",
+    GRAPHQL_SUBSCRIPTION = "graphql_subscription",
+
+    GRAPHQL_SCALAR = "graphql_scalar",
+    GRAPHQL_OBJECT = "graphql_object",
+    GRAPHQL_INTERFACE = "graphql_interface",
+    GRAPHQL_UNION = "graphql_union",
+    GRAPHQL_ENUM = "graphql_enum",
+    GRAPHQL_INPUT = "graphql_input",
     // end for API
 
     // for code
@@ -38,40 +229,58 @@ export enum ReferenceType {
     // end for code
 }
 
-export interface GraphQLReferenceContext {
-}
-
-// TODO: custom value?
-export interface OpenAPIReferenceContext {
-    method: string;
+export interface BaseReferenceContext {
+    group?: string[];
 
-    path: string;
+    scopes?: string[];
 }
 
-export type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext;
+export interface GraphQLReferenceContext extends BaseReferenceContext {
+    /**
+     * @internal
+     */
+    graphqlTypeShort: string;
 
-export interface ExampleRoot {
-    groups: ExampleGroup[];
+    graphqlName: string;
 }
 
-export interface ExampleGroup {
-    description?: string;
+// TODO: custom value?
+export interface OpenAPIReferenceContext extends BaseReferenceContext {
+    method?: string;
 
-    examples: Example[];
-}
+    path?: string;
 
-export interface Example {
-    description?: string; // TODO: replace with title ?
+    fullPath?: string;
 
-    codeblock: CodeBlock;
+    componentSchema?: string
 }
 
-export interface CodeBlock {
-    title?: string;
-
-    tabs: CodeBlockTab[];
+export type TypeDocReferenceContextMeta = Meta<"internal">
+
+// Add TypeDocReferenceContext to the union type
+export interface TypeDocReferenceContext extends BaseReferenceContext {
+    symbolId: string;
+    symbolName: string;
+    symbolKind: number;
+    packageName: string;
+    fileName: string;
+    fileFullPath: string;
+    line: number;
+    col: number;
+    signatureText: {
+        code: string;
+        lang: string;
+    };
+    sourcecode: {
+        code: string;
+        lang: string;
+    };
+    category?: string;
+    meta?: TypeDocReferenceContextMeta[]
 }
 
+export type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext | TypeDocReferenceContext
+
 export interface GraphQLExampleContext {
     schema?: any; // TODO:
 }
@@ -82,53 +291,4 @@ export interface OpenAPIExampleContext {
     content?: string;
 }
 
-export type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;
-
-export interface CodeBlockTab {
-    // title of the tab e.g "JavaScript"
-    title: string;
-
-    // code in the tab e.g "console.log('Hello World')"
-    code: string
-    
-    // language of the code e.g "js"
-    language: string;
 
-    // context of the generation method e.g openapi or graphql
-    context?: ExampleContext;
-}
-
-export interface Reference {
-    title: string;
-    description: string;
-    canonical: string;
-
-    definitions: Definition[]
-    examples: ExampleRoot
-
-    category?: ReferenceCategory; // TODO: do we need that?
-    type?: ReferenceType; // TODO: do we need that?
-    context?: ReferenceContext;
-}
-
-export interface Definition {
-    title: string;
-
-    properties: DefinitionProperty[];
-
-    type?: string;
-
-    id?: string;
-
-    description?: string;
-}
-
-export interface DefinitionProperty {
-    name: string;
-
-    type: string;
-
-    description: string;
-
-    properties?: DefinitionProperty[];
-}

package/tsconfig.json

@@ -1,5 +1,8 @@
 {
   "compilerOptions": {
+    "paths": {
+      "@xyd-js/core": ["../xyd-core/index.ts"],
+    },
     "target": "ES2020",
     "module": "ESNext",
     "moduleResolution": "node",
@@ -11,7 +14,7 @@
     "declaration": true,
     "declarationMap": true,
     "incremental": true,
-    "tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo"
+    "tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo",
   },
   "include": ["examples/basic-example/**/*.ts", "src/**/*.ts"],
   "exclude": ["node_modules", "dist"]

package/vitest.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['src/**/*.test.ts' ,'packages/ts/**/*.test.ts'],
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      include: ['src/**/*.ts', 'packages/ts/**/*.ts'],
+      exclude: ['src/**/*.test.ts', 'src/**/*.d.ts', 'packages/ts/**/*.test.ts', 'packages/ts/**/*.d.ts']
+    }
+  }
+}); 

package/dist/types-C8Pm_zQH.d.cts

@@ -1,80 +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 {
-    title: string;
-    description: string;
-    canonical: string;
-    definitions: Definition[];
-    examples: ExampleRoot;
-    category?: ReferenceCategory;
-    type?: ReferenceType;
-    context?: ReferenceContext;
-}
-interface Definition {
-    title: string;
-    properties: DefinitionProperty[];
-    type?: string;
-    id?: string;
-    description?: string;
-}
-interface DefinitionProperty {
-    name: string;
-    type: string;
-    description: string;
-    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/dist/types-C8Pm_zQH.d.ts

@@ -1,80 +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 {
-    title: string;
-    description: string;
-    canonical: string;
-    definitions: Definition[];
-    examples: ExampleRoot;
-    category?: ReferenceCategory;
-    type?: ReferenceType;
-    context?: ReferenceContext;
-}
-interface Definition {
-    title: string;
-    properties: DefinitionProperty[];
-    type?: string;
-    id?: string;
-    description?: string;
-}
-interface DefinitionProperty {
-    name: string;
-    type: string;
-    description: string;
-    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"
-//     })],
-// });
-
-