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

package/dist/types-C8Pm_zQH.d.cts

@@ -0,0 +1,80 @@
+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

@@ -0,0 +1,80 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/uniform",
-  "version": "0.1.0-xyd.2",
+  "version": "0.1.0-xyd.3",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -17,7 +17,7 @@
     "unist-builder": "^4.0.0",
     "unist-util-visit": "^5.0.0",
     "codehike": "^1.0.3",
-    "@xyd-js/core": "0.1.0-xyd.0"
+    "@xyd-js/core": "0.1.0-xyd.1"
   },
   "devDependencies": {
     "tsup": "^8.3.0"