@xyd-js/uniform 0.1.0-xyd.6 → 0.1.0-xyd.68

package/dist/types-BiglsETJ.d.cts

@@ -0,0 +1,180 @@
+import React from 'react';
+import { HighlightedCode } from 'codehike/code';
+
+interface Reference<C = ReferenceContext, M extends DefinitionMeta = DefinitionMeta, VM extends DefinitionVariantMeta = DefinitionVariantMeta> {
+    title: string;
+    description: string | React.ReactNode;
+    canonical: string;
+    definitions: Definition<M, VM>[];
+    examples: ExampleRoot;
+    category?: ReferenceCategory;
+    type?: ReferenceType;
+    context?: C;
+    /**
+     * TODO: !!!! BETTER !!!!
+     * @internal
+     */
+    __UNSAFE_selector?: (selector: string) => any;
+}
+type DefinitionOpenAPIMeta = Meta<"contentType" | "required" | "definitionDescription">;
+type DefinitionTypeDocMeta = Meta<"type">;
+type DefinitionGraphqlMeta = Meta<"type" | "graphqlName">;
+type DefinitionMeta = DefinitionOpenAPIMeta | DefinitionTypeDocMeta | DefinitionGraphqlMeta;
+type SymbolDef = {
+    id?: string | string[];
+    canonical?: string | string[];
+};
+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;
+}
+type DefinitionVariantOpenAPIMeta = Meta<"status" | "contentType" | "definitionDescription" | "required">;
+type CommonDefinitionVariantMeta = Meta<"symbolName">;
+type DefinitionVariantMeta = CommonDefinitionVariantMeta | DefinitionVariantOpenAPIMeta;
+interface DefinitionVariant<M extends DefinitionVariantMeta = DefinitionVariantMeta> {
+    title: string;
+    properties: DefinitionProperty[];
+    rootProperty?: DefinitionProperty;
+    description?: string | React.ReactNode;
+    symbolDef?: SymbolDef;
+    meta?: M[];
+}
+interface Meta<T = string> {
+    name: T;
+    value?: unknown;
+}
+type DefinitionPropertyMeta = Meta<"required" | "deprecated" | "internal" | "defaults" | "nullable" | "example" | "examples" | "minimum" | "maximum" | "enum-type">;
+declare enum DEFINED_DEFINITION_PROPERTY_TYPE {
+    UNION = "$$union",
+    XOR = "$$xor",
+    ARRAY = "$$array",
+    ENUM = "$$enum"
+}
+interface DefinitionProperty {
+    name: string;
+    type: string | DEFINED_DEFINITION_PROPERTY_TYPE;
+    description: string | React.ReactNode;
+    examples?: string | string[];
+    symbolDef?: SymbolDef;
+    meta?: DefinitionPropertyMeta[];
+    context?: any;
+    properties?: DefinitionProperty[];
+    ofProperty?: DefinitionProperty;
+}
+interface ExampleRoot {
+    groups: ExampleGroup[];
+}
+interface ExampleGroup {
+    description?: string;
+    examples: Example[];
+}
+interface Example {
+    description?: string;
+    codeblock: CodeBlock;
+}
+interface CodeBlock {
+    title?: string;
+    tabs: CodeBlockTab[];
+}
+interface CodeBlockTab {
+    title: string;
+    code: string;
+    language: string;
+    context?: ExampleContext;
+    highlighted?: HighlightedCode;
+}
+type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;
+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",
+    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",
+    FUNCTION_JS = "function_js"
+}
+interface BaseReferenceContext {
+    group?: string[];
+    scopes?: string[];
+}
+interface GraphQLReferenceContext extends BaseReferenceContext {
+    /**
+     * @internal
+     */
+    graphqlTypeShort: string;
+    graphqlName: string;
+}
+interface OpenAPIReferenceContext extends BaseReferenceContext {
+    method?: string;
+    path?: string;
+    fullPath?: string;
+    componentSchema?: string;
+}
+type TypeDocReferenceContextMeta = Meta<"internal">;
+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[];
+}
+type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext | TypeDocReferenceContext;
+interface GraphQLExampleContext {
+    schema?: any;
+}
+interface OpenAPIExampleContext {
+    status?: number;
+    content?: string;
+}
+
+export { type BaseReferenceContext as B, type CommonDefinitionVariantMeta as C, type DefinitionOpenAPIMeta as D, type ExampleRoot as E, type GraphQLReferenceContext as G, type Meta as M, type OpenAPIReferenceContext as O, type Reference as R, type SymbolDef as S, type TypeDocReferenceContextMeta as T, type DefinitionTypeDocMeta as a, type DefinitionGraphqlMeta as b, type DefinitionMeta as c, type Definition as d, type DefinitionVariantOpenAPIMeta as e, type DefinitionVariantMeta as f, type DefinitionVariant as g, type DefinitionPropertyMeta as h, DEFINED_DEFINITION_PROPERTY_TYPE as i, type DefinitionProperty as j, type ExampleGroup as k, type Example as l, type CodeBlock as m, type CodeBlockTab as n, type ExampleContext as o, ReferenceCategory as p, ReferenceType as q, type TypeDocReferenceContext as r, type ReferenceContext as s, type GraphQLExampleContext as t, type OpenAPIExampleContext as u };

package/dist/types-BiglsETJ.d.ts

@@ -0,0 +1,180 @@
+import React from 'react';
+import { HighlightedCode } from 'codehike/code';
+
+interface Reference<C = ReferenceContext, M extends DefinitionMeta = DefinitionMeta, VM extends DefinitionVariantMeta = DefinitionVariantMeta> {
+    title: string;
+    description: string | React.ReactNode;
+    canonical: string;
+    definitions: Definition<M, VM>[];
+    examples: ExampleRoot;
+    category?: ReferenceCategory;
+    type?: ReferenceType;
+    context?: C;
+    /**
+     * TODO: !!!! BETTER !!!!
+     * @internal
+     */
+    __UNSAFE_selector?: (selector: string) => any;
+}
+type DefinitionOpenAPIMeta = Meta<"contentType" | "required" | "definitionDescription">;
+type DefinitionTypeDocMeta = Meta<"type">;
+type DefinitionGraphqlMeta = Meta<"type" | "graphqlName">;
+type DefinitionMeta = DefinitionOpenAPIMeta | DefinitionTypeDocMeta | DefinitionGraphqlMeta;
+type SymbolDef = {
+    id?: string | string[];
+    canonical?: string | string[];
+};
+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;
+}
+type DefinitionVariantOpenAPIMeta = Meta<"status" | "contentType" | "definitionDescription" | "required">;
+type CommonDefinitionVariantMeta = Meta<"symbolName">;
+type DefinitionVariantMeta = CommonDefinitionVariantMeta | DefinitionVariantOpenAPIMeta;
+interface DefinitionVariant<M extends DefinitionVariantMeta = DefinitionVariantMeta> {
+    title: string;
+    properties: DefinitionProperty[];
+    rootProperty?: DefinitionProperty;
+    description?: string | React.ReactNode;
+    symbolDef?: SymbolDef;
+    meta?: M[];
+}
+interface Meta<T = string> {
+    name: T;
+    value?: unknown;
+}
+type DefinitionPropertyMeta = Meta<"required" | "deprecated" | "internal" | "defaults" | "nullable" | "example" | "examples" | "minimum" | "maximum" | "enum-type">;
+declare enum DEFINED_DEFINITION_PROPERTY_TYPE {
+    UNION = "$$union",
+    XOR = "$$xor",
+    ARRAY = "$$array",
+    ENUM = "$$enum"
+}
+interface DefinitionProperty {
+    name: string;
+    type: string | DEFINED_DEFINITION_PROPERTY_TYPE;
+    description: string | React.ReactNode;
+    examples?: string | string[];
+    symbolDef?: SymbolDef;
+    meta?: DefinitionPropertyMeta[];
+    context?: any;
+    properties?: DefinitionProperty[];
+    ofProperty?: DefinitionProperty;
+}
+interface ExampleRoot {
+    groups: ExampleGroup[];
+}
+interface ExampleGroup {
+    description?: string;
+    examples: Example[];
+}
+interface Example {
+    description?: string;
+    codeblock: CodeBlock;
+}
+interface CodeBlock {
+    title?: string;
+    tabs: CodeBlockTab[];
+}
+interface CodeBlockTab {
+    title: string;
+    code: string;
+    language: string;
+    context?: ExampleContext;
+    highlighted?: HighlightedCode;
+}
+type ExampleContext = GraphQLExampleContext | OpenAPIExampleContext;
+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",
+    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",
+    FUNCTION_JS = "function_js"
+}
+interface BaseReferenceContext {
+    group?: string[];
+    scopes?: string[];
+}
+interface GraphQLReferenceContext extends BaseReferenceContext {
+    /**
+     * @internal
+     */
+    graphqlTypeShort: string;
+    graphqlName: string;
+}
+interface OpenAPIReferenceContext extends BaseReferenceContext {
+    method?: string;
+    path?: string;
+    fullPath?: string;
+    componentSchema?: string;
+}
+type TypeDocReferenceContextMeta = Meta<"internal">;
+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[];
+}
+type ReferenceContext = GraphQLReferenceContext | OpenAPIReferenceContext | TypeDocReferenceContext;
+interface GraphQLExampleContext {
+    schema?: any;
+}
+interface OpenAPIExampleContext {
+    status?: number;
+    content?: string;
+}
+
+export { type BaseReferenceContext as B, type CommonDefinitionVariantMeta as C, type DefinitionOpenAPIMeta as D, type ExampleRoot as E, type GraphQLReferenceContext as G, type Meta as M, type OpenAPIReferenceContext as O, type Reference as R, type SymbolDef as S, type TypeDocReferenceContextMeta as T, type DefinitionTypeDocMeta as a, type DefinitionGraphqlMeta as b, type DefinitionMeta as c, type Definition as d, type DefinitionVariantOpenAPIMeta as e, type DefinitionVariantMeta as f, type DefinitionVariant as g, type DefinitionPropertyMeta as h, DEFINED_DEFINITION_PROPERTY_TYPE as i, type DefinitionProperty as j, type ExampleGroup as k, type Example as l, type CodeBlock as m, type CodeBlockTab as n, type ExampleContext as o, ReferenceCategory as p, ReferenceType as q, type TypeDocReferenceContext as r, type ReferenceContext as s, type GraphQLExampleContext as t, type OpenAPIExampleContext as u };

package/index.ts

@@ -1,8 +1,14 @@
-export {default} from "./src/index"
+export * from "./src/types"
+export type {
+    UniformPlugin,
+    UniformPluginArgs
+} from "./src/index"
+
+export { default } from "./src/index"
 
 export {
-    pluginNavigation
-} from "./src/utils"
+    pluginJsonView,
+    pluginNavigation,
+} from "./src/plugins"
 
-export * from "./src/types"
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/uniform",
-  "version": "0.1.0-xyd.6",
+  "version": "0.1.0-xyd.68",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -12,27 +12,29 @@
   },
   "dependencies": {
     "codehike": "^1.0.3",
-    "gray-matter": "^4.0.3",
     "mdast-util-from-markdown": "^2.0.2",
-    "mdast-util-to-markdown": "^2.1.2",
     "remark": "^15.0.1",
     "remark-stringify": "^11.0.0",
     "unist-builder": "^4.0.0",
     "unist-util-visit": "^5.0.0",
-    "@xyd-js/core": "0.1.0-xyd.4"
+    "@xyd-js/core": "0.1.0-xyd.66"
   },
   "peerDependencies": {
     "@mdx-js/mdx": "^3.1.0"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^1.3.1",
     "@types/node": "^22.10.5",
     "rimraf": "^3.0.2",
     "tsup": "^8.3.0",
-    "typescript": "^4.5.5"
+    "typescript": "^4.5.5",
+    "vitest": "^1.3.1"
   },
   "scripts": {
     "clean": "rimraf build",
     "prebuild": "pnpm clean",
-    "build": "tsup"
+    "build": "tsup",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage"
   }
 }

package/src/index.ts

@@ -1,8 +1,22 @@
 // Define the new PluginV type with a callback function that returns another function
 import {Reference} from "./types";
 
+export * from "./types";
+
 // Define the new PluginV type with a callback function that returns another function
-export type UniformPlugin<T> = (cb: (cb: () => T) => void) => (ref: Reference) => void;
+export type UniformPluginArgs = {
+    references: Reference[] | Reference,
+    defer: (defer: () => any) => void;
+
+    // TODO: maybe in the future
+    // visit: (selector: string | "[method] [path]", callback: (...args: any[]) => void) => void;
+}
+
+
+export type UniformPluginRestArgs = {
+    index: number;
+}
+export type UniformPlugin<T> = (args: UniformPluginArgs) => (ref: Reference, restArgs: UniformPluginRestArgs) => void;
 
 // Utility type to infer if a type is an array and avoid wrapping it into an array twice
 type NormalizeArray<T> = T extends Array<infer U> ? U[] : T;
@@ -35,22 +49,28 @@ export default function uniform<T extends UniformPlugin<any>[]>(
         out: {} as { [K in keyof ResultType]: ResultType[K] }
     };
 
-
-    const finishCallbacks = new Set();
-
     config.plugins.forEach((plugin) => {
-        const call = plugin(cb => {
-            finishCallbacks.add(cb);
+        let defer: any = undefined; // fix any
+
+        const call = plugin({
+            references: references,
+            defer: (cb) => {
+                if (typeof cb === "function") {
+                    defer = cb
+                }
+            },
+            // visit: (pattern, callback) => {
+            // }
         })
 
-        references.forEach((ref) => {
-            call(ref)
+        references.map((ref, i) => {
+            call(ref, {
+                index: i,
+            })
         });
-    })
 
-    finishCallbacks.forEach(cb => {
-        if (typeof cb === "function") {
-            const resp = cb()
+        if (typeof defer === "function") {
+            const resp = defer()
             if (typeof resp !== "object") {
                 throw new Error(`Invalid callback return type: ${typeof resp}`)
             }
@@ -59,10 +79,8 @@ export default function uniform<T extends UniformPlugin<any>[]>(
                 ...response.out,
                 ...resp
             }
-        } else {
-            throw new Error(`Invalid callback type: ${typeof cb}`)
         }
-    });
+    })
 
     return response;
 }
@@ -72,8 +90,8 @@ export default function uniform<T extends UniformPlugin<any>[]>(
 //     return (ref: Reference) => {
 //     };
 // };
-// function examplePlugin(cb: (cb: () => { value: boolean }) => void) {
-//     cb(() => ({
+// function examplePlugin(defer: (defer: () => { value: boolean }) => void) {
+//     defer(() => ({
 //         value: true,
 //     }));
 //

package/src/markdown/index.ts

@@ -29,7 +29,7 @@ export function referenceAST(ref: Reference) {
     const mdHeading = heading(
         ref.title,
         ref.canonical,
-        ref.description,
+        typeof ref.description === "string" ? ref.description : "",
         ref.category,
         ref.type,
         ref.context

package/src/markdown/utils.ts

@@ -79,12 +79,24 @@ export function heading(
 
 
         for (const [key, value] of Object.entries(refContext)) {
-            uContext.push(u(
-                    'heading',
-                    {depth: uContext[0].depth + 1},
-                    [u('text', `!${key} ${value}`)]
-                )
-            )
+            if (typeof value === "object") {
+                // TODO: support ```<lang> ??
+                if (value.code) {
+                    uContext.push(
+                        u('heading', {depth: uContext[0].depth + 1}, [u('text', `!${key}`)])
+                    );
+
+                    uContext.push(
+                        u('code', {lang: value.lang}, value.code)
+                    );
+
+                    continue;
+                }
+            }
+
+            uContext.push(
+                u('heading', {depth: uContext[0].depth + 1}, [u('text', `!${key} ${value.toString()}`)])
+            );
         }
     }
 

package/src/plugins/__tests__/pluginJsonView.test.ts

@@ -0,0 +1,132 @@
+import { describe, it, expect } from 'vitest';
+import fs from 'fs';
+import { pluginJsonView } from '../pluginJsonView';
+import type { Reference } from '../../types';
+import uniform from '../../index'
+
+describe('pluginJsonView', () => {
+    it('should handle properties without examples', () => {
+        const plugin = pluginJsonView();
+
+        const inputs: Reference[] = [
+            {
+                title: 'Test title',
+                description: 'Test description',
+                canonical: 'test-canonical',
+                examples: {
+                    groups: []
+                },
+                "definitions": [
+                    {
+                        "title": "Properties",
+                        "properties": [
+                            {
+                                "name": "charset",
+                                "type": "string",
+                                "description": "Character encoding for the document\n",
+                                "examples": [
+                                    "\"UTF-8\""
+                                ]
+                            },
+                            {
+                                "name": "robots",
+                                "type": "string",
+                                "description": "Standard meta tag for controlling search engine crawling and indexing\n",
+                                "examples": [
+                                    "\"index, follow\"",
+                                    "\"noindex, nofollow\""
+                                ]
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                title: 'Test title',
+                description: 'Test description',
+                canonical: 'test-canonical',
+                examples: {
+                    groups: []
+                },
+                "definitions": [
+                    {
+                        "title": "Properties",
+                        "properties": [
+                            {
+                                "name": "charset",
+                                "type": "string",
+                                "description": "Character encoding for the document\n",
+                                "examples": [
+                                    "UTF-8"
+                                ]
+                            },
+                            {
+                                "name": "robots",
+                                "type": "string",
+                                "description": "Standard meta tag for controlling search engine crawling and indexing\n",
+                                "examples": [
+                                    "index, follow",
+                                    "noindex, nofollow"
+                                ]
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                title: 'Test title',
+                description: 'Test description',
+                canonical: 'test-canonical',
+                examples: {
+                    groups: []
+                },
+                "definitions": [
+                    {
+                        "title": "Properties",
+                        "properties": [
+                            {
+                                "name": "robots",
+                                "type": "string",
+                                "description": "Standard meta tag for controlling search engine crawling and indexing\n",
+                                "examples": [
+                                    "index, follow",
+                                    "noindex, nofollow"
+                                ]
+                            },
+                            {
+                                "name": "charset",
+                                "type": "string",
+                                "description": "Character encoding for the document\n",
+                                "examples": [
+                                    "UTF-8"
+                                ]
+                            },
+                        ]
+                    }
+                ]
+            }
+        ];
+
+        const outputs: string[] = [
+            '{\n' +
+            '    "charset": "UTF-8",\n' +
+            '    "robots": "index, follow" // or "noindex, nofollow"\n' +
+            '}',
+
+            '{\n' +
+            '    "charset": "UTF-8",\n' +
+            '    "robots": "index, follow" // or "noindex, nofollow"\n' +
+            '}',
+
+            '{\n' +
+            '    "robots": "index, follow", // or "noindex, nofollow"\n' +
+            '    "charset": "UTF-8"\n' +
+            '}',
+        ]
+        const result = uniform(inputs, {
+            plugins: [plugin]
+        });
+
+        expect(result.out.jsonViews).toStrictEqual(outputs);
+    });
+}); 

package/src/plugins/index.ts

@@ -0,0 +1,2 @@
+export { pluginJsonView } from "./pluginJsonView"
+export { pluginNavigation } from "./pluginNavigation"