polen 0.11.0-next.25 → 0.11.0-next.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/api/config/input.d.ts +183 -0
- package/build/api/config/input.d.ts.map +1 -1
- package/build/api/config/input.js +2 -0
- package/build/api/config/input.js.map +1 -1
- package/build/api/config/normalized.d.ts +297 -0
- package/build/api/config/normalized.d.ts.map +1 -1
- package/build/api/config/normalized.js +47 -0
- package/build/api/config/normalized.js.map +1 -1
- package/build/api/config-template/template.d.ts +81 -0
- package/build/api/config-template/template.d.ts.map +1 -1
- package/build/api/config-template/template.js +18 -1
- package/build/api/config-template/template.js.map +1 -1
- package/build/api/examples/scanner.d.ts.map +1 -1
- package/build/api/examples/scanner.js +11 -0
- package/build/api/examples/scanner.js.map +1 -1
- package/build/api/examples/schemas/catalog.d.ts +36 -0
- package/build/api/examples/schemas/catalog.d.ts.map +1 -1
- package/build/api/examples/schemas/example/example.d.ts +37 -0
- package/build/api/examples/schemas/example/example.d.ts.map +1 -1
- package/build/api/examples/schemas/example/example.js +5 -0
- package/build/api/examples/schemas/example/example.js.map +1 -1
- package/build/api/reference/$.d.ts +4 -0
- package/build/api/reference/$.d.ts.map +1 -0
- package/build/api/reference/$.js +4 -0
- package/build/api/reference/$.js.map +1 -0
- package/build/api/reference/catalog.d.ts +69 -0
- package/build/api/reference/catalog.d.ts.map +1 -0
- package/build/api/reference/catalog.js +44 -0
- package/build/api/reference/catalog.js.map +1 -0
- package/build/api/reference/config.d.ts +616 -0
- package/build/api/reference/config.d.ts.map +1 -0
- package/build/api/reference/config.js +162 -0
- package/build/api/reference/config.js.map +1 -0
- package/build/api/reference/scanner.d.ts +26 -0
- package/build/api/reference/scanner.d.ts.map +1 -0
- package/build/api/reference/scanner.js +27 -0
- package/build/api/reference/scanner.js.map +1 -0
- package/build/lib/grafaid/schema/format-default-value.d.ts +11 -0
- package/build/lib/grafaid/schema/format-default-value.d.ts.map +1 -0
- package/build/lib/grafaid/schema/format-default-value.js +20 -0
- package/build/lib/grafaid/schema/format-default-value.js.map +1 -0
- package/build/lib/grafaid/schema/schema.d.ts +1 -0
- package/build/lib/grafaid/schema/schema.d.ts.map +1 -1
- package/build/lib/grafaid/schema/schema.js +1 -0
- package/build/lib/grafaid/schema/schema.js.map +1 -1
- package/build/template/components/ArgumentAnnotation.d.ts +2 -1
- package/build/template/components/ArgumentAnnotation.d.ts.map +1 -1
- package/build/template/components/ArgumentAnnotation.js +14 -4
- package/build/template/components/ArgumentAnnotation.js.map +1 -1
- package/build/template/components/ArgumentListAnnotation.d.ts +1 -0
- package/build/template/components/ArgumentListAnnotation.d.ts.map +1 -1
- package/build/template/components/ArgumentListAnnotation.js +21 -8
- package/build/template/components/ArgumentListAnnotation.js.map +1 -1
- package/build/template/components/Changelog/groups/FieldArgument.d.ts.map +1 -1
- package/build/template/components/Changelog/groups/FieldArgument.js +0 -1
- package/build/template/components/Changelog/groups/FieldArgument.js.map +1 -1
- package/build/template/components/CodeBlock.d.ts.map +1 -1
- package/build/template/components/CodeBlock.js +1 -1
- package/build/template/components/CodeBlock.js.map +1 -1
- package/build/template/components/Description.js +1 -1
- package/build/template/components/Description.js.map +1 -1
- package/build/template/components/ExampleLink.d.ts.map +1 -1
- package/build/template/components/ExampleLink.js +2 -1
- package/build/template/components/ExampleLink.js.map +1 -1
- package/build/template/components/Field.d.ts +2 -0
- package/build/template/components/Field.d.ts.map +1 -1
- package/build/template/components/Field.js +42 -4
- package/build/template/components/Field.js.map +1 -1
- package/build/template/components/FieldList.d.ts +2 -1
- package/build/template/components/FieldList.d.ts.map +1 -1
- package/build/template/components/FieldList.js +14 -3
- package/build/template/components/FieldList.js.map +1 -1
- package/build/template/components/FieldListSection.d.ts.map +1 -1
- package/build/template/components/FieldListSection.js +6 -1
- package/build/template/components/FieldListSection.js.map +1 -1
- package/build/template/components/GraphQLDocument.d.ts.map +1 -1
- package/build/template/components/GraphQLDocument.js +2 -1
- package/build/template/components/GraphQLDocument.js.map +1 -1
- package/build/template/components/GraphQLInteractive/GraphQLInteractive.d.ts +2 -0
- package/build/template/components/GraphQLInteractive/GraphQLInteractive.d.ts.map +1 -1
- package/build/template/components/GraphQLInteractive/GraphQLInteractive.js +4 -3
- package/build/template/components/GraphQLInteractive/GraphQLInteractive.js.map +1 -1
- package/build/template/components/GraphQLInteractive/lib/parser.d.ts +2 -2
- package/build/template/components/GraphQLInteractive/lib/parser.d.ts.map +1 -1
- package/build/template/components/GraphQLInteractive/lib/parser.js +17 -12
- package/build/template/components/GraphQLInteractive/lib/parser.js.map +1 -1
- package/build/template/components/IAPIndicator.d.ts +12 -0
- package/build/template/components/IAPIndicator.d.ts.map +1 -0
- package/build/template/components/IAPIndicator.js +21 -0
- package/build/template/components/IAPIndicator.js.map +1 -0
- package/build/template/components/Link.d.ts +1 -2
- package/build/template/components/Link.d.ts.map +1 -1
- package/build/template/components/Link.js +5 -2
- package/build/template/components/Link.js.map +1 -1
- package/build/template/components/NamedType.d.ts.map +1 -1
- package/build/template/components/NamedType.js +9 -5
- package/build/template/components/NamedType.js.map +1 -1
- package/build/template/components/ReferenceLink.d.ts +3 -2
- package/build/template/components/ReferenceLink.d.ts.map +1 -1
- package/build/template/components/ReferenceLink.js +5 -3
- package/build/template/components/ReferenceLink.js.map +1 -1
- package/build/template/components/TypeAnnotation.d.ts +2 -0
- package/build/template/components/TypeAnnotation.d.ts.map +1 -1
- package/build/template/components/TypeAnnotation.js +4 -4
- package/build/template/components/TypeAnnotation.js.map +1 -1
- package/build/template/components/ViewModeToggle.d.ts +3 -0
- package/build/template/components/ViewModeToggle.d.ts.map +1 -0
- package/build/template/components/ViewModeToggle.js +9 -0
- package/build/template/components/ViewModeToggle.js.map +1 -0
- package/build/template/components/graphql/type-link.d.ts +2 -0
- package/build/template/components/graphql/type-link.d.ts.map +1 -1
- package/build/template/components/graphql/type-link.js +17 -4
- package/build/template/components/graphql/type-link.js.map +1 -1
- package/build/template/components/home/PlaygroundPreview.d.ts.map +1 -1
- package/build/template/components/home/PlaygroundPreview.js +3 -2
- package/build/template/components/home/PlaygroundPreview.js.map +1 -1
- package/build/template/components/sidebar/SidebarItem.d.ts.map +1 -1
- package/build/template/components/sidebar/SidebarItem.js +18 -5
- package/build/template/components/sidebar/SidebarItem.js.map +1 -1
- package/build/template/contexts/ReferenceConfigContext.d.ts +16 -0
- package/build/template/contexts/ReferenceConfigContext.d.ts.map +1 -0
- package/build/template/contexts/ReferenceConfigContext.js +14 -0
- package/build/template/contexts/ReferenceConfigContext.js.map +1 -0
- package/build/template/contexts/ViewModeContext.d.ts +14 -0
- package/build/template/contexts/ViewModeContext.d.ts.map +1 -0
- package/build/template/contexts/ViewModeContext.js +40 -0
- package/build/template/contexts/ViewModeContext.js.map +1 -0
- package/build/template/hooks/use-examples.d.ts +3 -0
- package/build/template/hooks/use-examples.d.ts.map +1 -1
- package/build/template/hooks/useAlignedColumns.d.ts +10 -0
- package/build/template/hooks/useAlignedColumns.d.ts.map +1 -0
- package/build/template/hooks/useAlignedColumns.js +17 -0
- package/build/template/hooks/useAlignedColumns.js.map +1 -0
- package/build/template/routes/examples/_.d.ts +9 -0
- package/build/template/routes/examples/_.d.ts.map +1 -1
- package/build/template/routes/examples/_index.d.ts +6 -0
- package/build/template/routes/examples/_index.d.ts.map +1 -1
- package/build/template/routes/examples/name.d.ts +9 -0
- package/build/template/routes/examples/name.d.ts.map +1 -1
- package/build/template/routes/examples/name.js +6 -2
- package/build/template/routes/examples/name.js.map +1 -1
- package/build/template/routes/reference.d.ts.map +1 -1
- package/build/template/routes/reference.js +37 -10
- package/build/template/routes/reference.js.map +1 -1
- package/build/vite/plugins/core.d.ts.map +1 -1
- package/build/vite/plugins/core.js +6 -0
- package/build/vite/plugins/core.js.map +1 -1
- package/build/vite/plugins/examples.d.ts.map +1 -1
- package/build/vite/plugins/examples.js +10 -1
- package/build/vite/plugins/examples.js.map +1 -1
- package/build/vite/plugins/index.d.ts +1 -0
- package/build/vite/plugins/index.d.ts.map +1 -1
- package/build/vite/plugins/index.js +1 -0
- package/build/vite/plugins/index.js.map +1 -1
- package/build/vite/plugins/navbar.d.ts.map +1 -1
- package/build/vite/plugins/navbar.js +3 -1
- package/build/vite/plugins/navbar.js.map +1 -1
- package/build/vite/plugins/reference.d.ts +19 -0
- package/build/vite/plugins/reference.d.ts.map +1 -0
- package/build/vite/plugins/reference.js +96 -0
- package/build/vite/plugins/reference.js.map +1 -0
- package/package.json +1 -7
- package/src/api/config/input.ts +2 -0
- package/src/api/config/normalized.ts +54 -0
- package/src/api/config-template/template.ts +18 -1
- package/src/api/examples/scanner.ts +14 -0
- package/src/api/examples/schemas/example/example.ts +6 -0
- package/src/api/reference/$.ts +3 -0
- package/src/api/reference/catalog.ts +55 -0
- package/src/api/reference/config.ts +193 -0
- package/src/api/reference/scanner.ts +53 -0
- package/src/lib/grafaid/schema/format-default-value.ts +22 -0
- package/src/lib/grafaid/schema/schema.ts +2 -0
- package/src/template/components/ArgumentAnnotation.tsx +58 -9
- package/src/template/components/ArgumentListAnnotation.tsx +50 -17
- package/src/template/components/Changelog/groups/FieldArgument.tsx +0 -1
- package/src/template/components/CodeBlock.tsx +1 -0
- package/src/template/components/Description.tsx +1 -1
- package/src/template/components/ExampleLink.tsx +2 -1
- package/src/template/components/Field.tsx +148 -20
- package/src/template/components/FieldList.tsx +28 -13
- package/src/template/components/FieldListSection.tsx +12 -2
- package/src/template/components/GraphQLDocument.tsx +2 -0
- package/src/template/components/GraphQLInteractive/GraphQLInteractive.tsx +6 -1
- package/src/template/components/GraphQLInteractive/lib/parser.ts +16 -3
- package/src/template/components/IAPIndicator.tsx +73 -0
- package/src/template/components/Link.tsx +9 -3
- package/src/template/components/NamedType.tsx +54 -28
- package/src/template/components/ReferenceLink.tsx +17 -10
- package/src/template/components/TypeAnnotation.tsx +17 -5
- package/src/template/components/ViewModeToggle.tsx +27 -0
- package/src/template/components/graphql/type-link.tsx +52 -9
- package/src/template/components/home/PlaygroundPreview.tsx +3 -0
- package/src/template/components/sidebar/SidebarItem.tsx +21 -5
- package/src/template/contexts/ReferenceConfigContext.tsx +37 -0
- package/src/template/contexts/ViewModeContext.tsx +64 -0
- package/src/template/hooks/useAlignedColumns.ts +19 -0
- package/src/template/routes/examples/name.tsx +13 -1
- package/src/template/routes/reference.tsx +67 -23
- package/src/types/virtual-modules.d.ts +5 -0
- package/src/vite/plugins/core.ts +6 -0
- package/src/vite/plugins/examples.ts +12 -0
- package/src/vite/plugins/index.ts +1 -0
- package/src/vite/plugins/navbar.ts +4 -1
- package/src/vite/plugins/reference.ts +130 -0
- package/build/lib/extensible-data/$.d.ts +0 -2
- package/build/lib/extensible-data/$.d.ts.map +0 -1
- package/build/lib/extensible-data/$.js +0 -2
- package/build/lib/extensible-data/$.js.map +0 -1
- package/build/lib/extensible-data/extensible-data.d.ts +0 -17
- package/build/lib/extensible-data/extensible-data.d.ts.map +0 -1
- package/build/lib/extensible-data/extensible-data.js +0 -24
- package/build/lib/extensible-data/extensible-data.js.map +0 -1
- package/build/lib/vite-plugin-reactive-data/$.d.ts +0 -2
- package/build/lib/vite-plugin-reactive-data/$.d.ts.map +0 -1
- package/build/lib/vite-plugin-reactive-data/$.js +0 -2
- package/build/lib/vite-plugin-reactive-data/$.js.map +0 -1
- package/build/lib/vite-plugin-reactive-data/vite-plugin-reactive-data.d.ts +0 -32
- package/build/lib/vite-plugin-reactive-data/vite-plugin-reactive-data.d.ts.map +0 -1
- package/build/lib/vite-plugin-reactive-data/vite-plugin-reactive-data.js +0 -85
- package/build/lib/vite-plugin-reactive-data/vite-plugin-reactive-data.js.map +0 -1
- package/build/template/components/ArgumentList.d.ts +0 -6
- package/build/template/components/ArgumentList.d.ts.map +0 -1
- package/build/template/components/ArgumentList.js +0 -9
- package/build/template/components/ArgumentList.js.map +0 -1
- package/src/lib/extensible-data/$.ts +0 -1
- package/src/lib/extensible-data/extensible-data.ts +0 -38
- package/src/lib/vite-plugin-reactive-data/$.ts +0 -1
- package/src/lib/vite-plugin-reactive-data/vite-plugin-reactive-data.ts +0 -124
- package/src/template/components/ArgumentList.tsx +0 -22
@@ -0,0 +1,616 @@
|
|
1
|
+
import { S } from '#lib/kit-temp/effect';
|
2
|
+
/**
|
3
|
+
* Diagnostic controls for reference documentation.
|
4
|
+
*/
|
5
|
+
export declare const ReferenceDiagnostics: S.Struct<{
|
6
|
+
/**
|
7
|
+
* Control diagnostics for missing or invalid reference content.
|
8
|
+
*
|
9
|
+
* @default true (info in dev, warning in build)
|
10
|
+
*/
|
11
|
+
validation: S.optional<S.Union<[typeof S.Boolean, S.Struct<{
|
12
|
+
enabled: typeof S.Boolean;
|
13
|
+
dev: S.optional<S.Struct<{
|
14
|
+
enabled: S.optional<typeof S.Boolean>;
|
15
|
+
severity: S.optional<S.Enums<{
|
16
|
+
readonly error: "error";
|
17
|
+
readonly warning: "warning";
|
18
|
+
readonly info: "info";
|
19
|
+
}>>;
|
20
|
+
}>>;
|
21
|
+
build: S.optional<S.Struct<{
|
22
|
+
enabled: S.optional<typeof S.Boolean>;
|
23
|
+
severity: S.optional<S.Enums<{
|
24
|
+
readonly error: "error";
|
25
|
+
readonly warning: "warning";
|
26
|
+
readonly info: "info";
|
27
|
+
}>>;
|
28
|
+
}>>;
|
29
|
+
}>]>>;
|
30
|
+
}>;
|
31
|
+
export type ReferenceDiagnostics = S.Schema.Type<typeof ReferenceDiagnostics>;
|
32
|
+
/**
|
33
|
+
* Configuration for how descriptions are displayed in reference documentation.
|
34
|
+
*/
|
35
|
+
export declare const DescriptionsView: S.Struct<{
|
36
|
+
/**
|
37
|
+
* Default view mode for descriptions.
|
38
|
+
* - 'expanded': Show full descriptions (default)
|
39
|
+
* - 'compact': Show condensed view
|
40
|
+
*
|
41
|
+
* @default 'expanded'
|
42
|
+
*/
|
43
|
+
defaultMode: S.optional<S.Literal<["compact", "expanded"]>>;
|
44
|
+
/**
|
45
|
+
* Whether to show the view mode toggle control.
|
46
|
+
* Allows users to switch between compact and expanded views.
|
47
|
+
*
|
48
|
+
* @default true
|
49
|
+
*/
|
50
|
+
showControl: S.optional<typeof S.Boolean>;
|
51
|
+
}>;
|
52
|
+
export type DescriptionsView = S.Schema.Type<typeof DescriptionsView>;
|
53
|
+
export declare const ReferenceConfigObject: S.Struct<{
|
54
|
+
/**
|
55
|
+
* Control whether the reference documentation is enabled.
|
56
|
+
* - true: Always enabled (show in nav even if no schema exists)
|
57
|
+
* - false: Always disabled (hide even if schema exists)
|
58
|
+
* - undefined: Auto-detect based on schema presence (default behavior)
|
59
|
+
*
|
60
|
+
* @default undefined (auto-detect based on schema presence)
|
61
|
+
* @example
|
62
|
+
* // Always show reference section
|
63
|
+
* reference: { enabled: true }
|
64
|
+
*
|
65
|
+
* @example
|
66
|
+
* // Never show reference
|
67
|
+
* reference: { enabled: false }
|
68
|
+
*
|
69
|
+
* @example
|
70
|
+
* // Auto-detect based on schema (default)
|
71
|
+
* reference: { }
|
72
|
+
*/
|
73
|
+
enabled: S.optional<typeof S.Boolean>;
|
74
|
+
/**
|
75
|
+
* Configuration for how descriptions are displayed.
|
76
|
+
*
|
77
|
+
* @example
|
78
|
+
* // Use compact mode by default
|
79
|
+
* descriptionsView: {
|
80
|
+
* defaultMode: 'compact'
|
81
|
+
* }
|
82
|
+
*
|
83
|
+
* @example
|
84
|
+
* // Hide the view mode toggle
|
85
|
+
* descriptionsView: {
|
86
|
+
* showControl: false
|
87
|
+
* }
|
88
|
+
*/
|
89
|
+
descriptionsView: S.optional<S.Struct<{
|
90
|
+
/**
|
91
|
+
* Default view mode for descriptions.
|
92
|
+
* - 'expanded': Show full descriptions (default)
|
93
|
+
* - 'compact': Show condensed view
|
94
|
+
*
|
95
|
+
* @default 'expanded'
|
96
|
+
*/
|
97
|
+
defaultMode: S.optional<S.Literal<["compact", "expanded"]>>;
|
98
|
+
/**
|
99
|
+
* Whether to show the view mode toggle control.
|
100
|
+
* Allows users to switch between compact and expanded views.
|
101
|
+
*
|
102
|
+
* @default true
|
103
|
+
*/
|
104
|
+
showControl: S.optional<typeof S.Boolean>;
|
105
|
+
}>>;
|
106
|
+
/**
|
107
|
+
* Configuration for how field nullability is rendered.
|
108
|
+
* - 'bangMark': Show '!' after non-nullable types (GraphQL style)
|
109
|
+
* - 'questionMark': Show '?' after nullable field names (TypeScript style)
|
110
|
+
*
|
111
|
+
* @default 'bangMark'
|
112
|
+
* @example
|
113
|
+
* // Use TypeScript-style nullability rendering
|
114
|
+
* nullabilityRendering: 'questionMark'
|
115
|
+
*/
|
116
|
+
nullabilityRendering: S.optional<S.Literal<["questionMark", "bangMark"]>>;
|
117
|
+
/**
|
118
|
+
* Diagnostic controls for reference documentation.
|
119
|
+
*
|
120
|
+
* @example
|
121
|
+
* // Enable all diagnostics with defaults
|
122
|
+
* diagnostics: {
|
123
|
+
* validation: true
|
124
|
+
* }
|
125
|
+
*
|
126
|
+
* @example
|
127
|
+
* // Fine-grained control
|
128
|
+
* diagnostics: {
|
129
|
+
* validation: {
|
130
|
+
* enabled: true,
|
131
|
+
* dev: { severity: 'error' },
|
132
|
+
* build: { severity: 'warning' }
|
133
|
+
* }
|
134
|
+
* }
|
135
|
+
*/
|
136
|
+
diagnostics: S.optional<S.Struct<{
|
137
|
+
/**
|
138
|
+
* Control diagnostics for missing or invalid reference content.
|
139
|
+
*
|
140
|
+
* @default true (info in dev, warning in build)
|
141
|
+
*/
|
142
|
+
validation: S.optional<S.Union<[typeof S.Boolean, S.Struct<{
|
143
|
+
enabled: typeof S.Boolean;
|
144
|
+
dev: S.optional<S.Struct<{
|
145
|
+
enabled: S.optional<typeof S.Boolean>;
|
146
|
+
severity: S.optional<S.Enums<{
|
147
|
+
readonly error: "error";
|
148
|
+
readonly warning: "warning";
|
149
|
+
readonly info: "info";
|
150
|
+
}>>;
|
151
|
+
}>>;
|
152
|
+
build: S.optional<S.Struct<{
|
153
|
+
enabled: S.optional<typeof S.Boolean>;
|
154
|
+
severity: S.optional<S.Enums<{
|
155
|
+
readonly error: "error";
|
156
|
+
readonly warning: "warning";
|
157
|
+
readonly info: "info";
|
158
|
+
}>>;
|
159
|
+
}>>;
|
160
|
+
}>]>>;
|
161
|
+
}>>;
|
162
|
+
}>;
|
163
|
+
export type ReferenceConfigObject = S.Schema.Type<typeof ReferenceConfigObject>;
|
164
|
+
/**
|
165
|
+
* Reference configuration with boolean shorthand support.
|
166
|
+
* - true: Enable with defaults
|
167
|
+
* - false: Disable completely
|
168
|
+
* - object: Fine-grained control
|
169
|
+
*/
|
170
|
+
export declare const ReferenceConfig: S.transform<S.Union<[typeof S.Boolean, S.Struct<{
|
171
|
+
/**
|
172
|
+
* Control whether the reference documentation is enabled.
|
173
|
+
* - true: Always enabled (show in nav even if no schema exists)
|
174
|
+
* - false: Always disabled (hide even if schema exists)
|
175
|
+
* - undefined: Auto-detect based on schema presence (default behavior)
|
176
|
+
*
|
177
|
+
* @default undefined (auto-detect based on schema presence)
|
178
|
+
* @example
|
179
|
+
* // Always show reference section
|
180
|
+
* reference: { enabled: true }
|
181
|
+
*
|
182
|
+
* @example
|
183
|
+
* // Never show reference
|
184
|
+
* reference: { enabled: false }
|
185
|
+
*
|
186
|
+
* @example
|
187
|
+
* // Auto-detect based on schema (default)
|
188
|
+
* reference: { }
|
189
|
+
*/
|
190
|
+
enabled: S.optional<typeof S.Boolean>;
|
191
|
+
/**
|
192
|
+
* Configuration for how descriptions are displayed.
|
193
|
+
*
|
194
|
+
* @example
|
195
|
+
* // Use compact mode by default
|
196
|
+
* descriptionsView: {
|
197
|
+
* defaultMode: 'compact'
|
198
|
+
* }
|
199
|
+
*
|
200
|
+
* @example
|
201
|
+
* // Hide the view mode toggle
|
202
|
+
* descriptionsView: {
|
203
|
+
* showControl: false
|
204
|
+
* }
|
205
|
+
*/
|
206
|
+
descriptionsView: S.optional<S.Struct<{
|
207
|
+
/**
|
208
|
+
* Default view mode for descriptions.
|
209
|
+
* - 'expanded': Show full descriptions (default)
|
210
|
+
* - 'compact': Show condensed view
|
211
|
+
*
|
212
|
+
* @default 'expanded'
|
213
|
+
*/
|
214
|
+
defaultMode: S.optional<S.Literal<["compact", "expanded"]>>;
|
215
|
+
/**
|
216
|
+
* Whether to show the view mode toggle control.
|
217
|
+
* Allows users to switch between compact and expanded views.
|
218
|
+
*
|
219
|
+
* @default true
|
220
|
+
*/
|
221
|
+
showControl: S.optional<typeof S.Boolean>;
|
222
|
+
}>>;
|
223
|
+
/**
|
224
|
+
* Configuration for how field nullability is rendered.
|
225
|
+
* - 'bangMark': Show '!' after non-nullable types (GraphQL style)
|
226
|
+
* - 'questionMark': Show '?' after nullable field names (TypeScript style)
|
227
|
+
*
|
228
|
+
* @default 'bangMark'
|
229
|
+
* @example
|
230
|
+
* // Use TypeScript-style nullability rendering
|
231
|
+
* nullabilityRendering: 'questionMark'
|
232
|
+
*/
|
233
|
+
nullabilityRendering: S.optional<S.Literal<["questionMark", "bangMark"]>>;
|
234
|
+
/**
|
235
|
+
* Diagnostic controls for reference documentation.
|
236
|
+
*
|
237
|
+
* @example
|
238
|
+
* // Enable all diagnostics with defaults
|
239
|
+
* diagnostics: {
|
240
|
+
* validation: true
|
241
|
+
* }
|
242
|
+
*
|
243
|
+
* @example
|
244
|
+
* // Fine-grained control
|
245
|
+
* diagnostics: {
|
246
|
+
* validation: {
|
247
|
+
* enabled: true,
|
248
|
+
* dev: { severity: 'error' },
|
249
|
+
* build: { severity: 'warning' }
|
250
|
+
* }
|
251
|
+
* }
|
252
|
+
*/
|
253
|
+
diagnostics: S.optional<S.Struct<{
|
254
|
+
/**
|
255
|
+
* Control diagnostics for missing or invalid reference content.
|
256
|
+
*
|
257
|
+
* @default true (info in dev, warning in build)
|
258
|
+
*/
|
259
|
+
validation: S.optional<S.Union<[typeof S.Boolean, S.Struct<{
|
260
|
+
enabled: typeof S.Boolean;
|
261
|
+
dev: S.optional<S.Struct<{
|
262
|
+
enabled: S.optional<typeof S.Boolean>;
|
263
|
+
severity: S.optional<S.Enums<{
|
264
|
+
readonly error: "error";
|
265
|
+
readonly warning: "warning";
|
266
|
+
readonly info: "info";
|
267
|
+
}>>;
|
268
|
+
}>>;
|
269
|
+
build: S.optional<S.Struct<{
|
270
|
+
enabled: S.optional<typeof S.Boolean>;
|
271
|
+
severity: S.optional<S.Enums<{
|
272
|
+
readonly error: "error";
|
273
|
+
readonly warning: "warning";
|
274
|
+
readonly info: "info";
|
275
|
+
}>>;
|
276
|
+
}>>;
|
277
|
+
}>]>>;
|
278
|
+
}>>;
|
279
|
+
}>]>, S.Struct<{
|
280
|
+
/**
|
281
|
+
* Control whether the reference documentation is enabled.
|
282
|
+
* - true: Always enabled (show in nav even if no schema exists)
|
283
|
+
* - false: Always disabled (hide even if schema exists)
|
284
|
+
* - undefined: Auto-detect based on schema presence (default behavior)
|
285
|
+
*
|
286
|
+
* @default undefined (auto-detect based on schema presence)
|
287
|
+
* @example
|
288
|
+
* // Always show reference section
|
289
|
+
* reference: { enabled: true }
|
290
|
+
*
|
291
|
+
* @example
|
292
|
+
* // Never show reference
|
293
|
+
* reference: { enabled: false }
|
294
|
+
*
|
295
|
+
* @example
|
296
|
+
* // Auto-detect based on schema (default)
|
297
|
+
* reference: { }
|
298
|
+
*/
|
299
|
+
enabled: S.optional<typeof S.Boolean>;
|
300
|
+
/**
|
301
|
+
* Configuration for how descriptions are displayed.
|
302
|
+
*
|
303
|
+
* @example
|
304
|
+
* // Use compact mode by default
|
305
|
+
* descriptionsView: {
|
306
|
+
* defaultMode: 'compact'
|
307
|
+
* }
|
308
|
+
*
|
309
|
+
* @example
|
310
|
+
* // Hide the view mode toggle
|
311
|
+
* descriptionsView: {
|
312
|
+
* showControl: false
|
313
|
+
* }
|
314
|
+
*/
|
315
|
+
descriptionsView: S.optional<S.Struct<{
|
316
|
+
/**
|
317
|
+
* Default view mode for descriptions.
|
318
|
+
* - 'expanded': Show full descriptions (default)
|
319
|
+
* - 'compact': Show condensed view
|
320
|
+
*
|
321
|
+
* @default 'expanded'
|
322
|
+
*/
|
323
|
+
defaultMode: S.optional<S.Literal<["compact", "expanded"]>>;
|
324
|
+
/**
|
325
|
+
* Whether to show the view mode toggle control.
|
326
|
+
* Allows users to switch between compact and expanded views.
|
327
|
+
*
|
328
|
+
* @default true
|
329
|
+
*/
|
330
|
+
showControl: S.optional<typeof S.Boolean>;
|
331
|
+
}>>;
|
332
|
+
/**
|
333
|
+
* Configuration for how field nullability is rendered.
|
334
|
+
* - 'bangMark': Show '!' after non-nullable types (GraphQL style)
|
335
|
+
* - 'questionMark': Show '?' after nullable field names (TypeScript style)
|
336
|
+
*
|
337
|
+
* @default 'bangMark'
|
338
|
+
* @example
|
339
|
+
* // Use TypeScript-style nullability rendering
|
340
|
+
* nullabilityRendering: 'questionMark'
|
341
|
+
*/
|
342
|
+
nullabilityRendering: S.optional<S.Literal<["questionMark", "bangMark"]>>;
|
343
|
+
/**
|
344
|
+
* Diagnostic controls for reference documentation.
|
345
|
+
*
|
346
|
+
* @example
|
347
|
+
* // Enable all diagnostics with defaults
|
348
|
+
* diagnostics: {
|
349
|
+
* validation: true
|
350
|
+
* }
|
351
|
+
*
|
352
|
+
* @example
|
353
|
+
* // Fine-grained control
|
354
|
+
* diagnostics: {
|
355
|
+
* validation: {
|
356
|
+
* enabled: true,
|
357
|
+
* dev: { severity: 'error' },
|
358
|
+
* build: { severity: 'warning' }
|
359
|
+
* }
|
360
|
+
* }
|
361
|
+
*/
|
362
|
+
diagnostics: S.optional<S.Struct<{
|
363
|
+
/**
|
364
|
+
* Control diagnostics for missing or invalid reference content.
|
365
|
+
*
|
366
|
+
* @default true (info in dev, warning in build)
|
367
|
+
*/
|
368
|
+
validation: S.optional<S.Union<[typeof S.Boolean, S.Struct<{
|
369
|
+
enabled: typeof S.Boolean;
|
370
|
+
dev: S.optional<S.Struct<{
|
371
|
+
enabled: S.optional<typeof S.Boolean>;
|
372
|
+
severity: S.optional<S.Enums<{
|
373
|
+
readonly error: "error";
|
374
|
+
readonly warning: "warning";
|
375
|
+
readonly info: "info";
|
376
|
+
}>>;
|
377
|
+
}>>;
|
378
|
+
build: S.optional<S.Struct<{
|
379
|
+
enabled: S.optional<typeof S.Boolean>;
|
380
|
+
severity: S.optional<S.Enums<{
|
381
|
+
readonly error: "error";
|
382
|
+
readonly warning: "warning";
|
383
|
+
readonly info: "info";
|
384
|
+
}>>;
|
385
|
+
}>>;
|
386
|
+
}>]>>;
|
387
|
+
}>>;
|
388
|
+
}>>;
|
389
|
+
export type ReferenceConfig = S.Schema.Type<typeof ReferenceConfig>;
|
390
|
+
export declare const make: (props: void | {
|
391
|
+
readonly enabled?: boolean | undefined;
|
392
|
+
readonly diagnostics?: {
|
393
|
+
readonly validation?: boolean | {
|
394
|
+
readonly build?: {
|
395
|
+
readonly enabled?: boolean | undefined;
|
396
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
397
|
+
} | undefined;
|
398
|
+
readonly enabled: boolean;
|
399
|
+
readonly dev?: {
|
400
|
+
readonly enabled?: boolean | undefined;
|
401
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
402
|
+
} | undefined;
|
403
|
+
} | undefined;
|
404
|
+
} | undefined;
|
405
|
+
readonly descriptionsView?: {
|
406
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
407
|
+
readonly showControl?: boolean | undefined;
|
408
|
+
} | undefined;
|
409
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
410
|
+
}, options?: S.MakeOptions) => {
|
411
|
+
readonly enabled?: boolean | undefined;
|
412
|
+
readonly diagnostics?: {
|
413
|
+
readonly validation?: boolean | {
|
414
|
+
readonly build?: {
|
415
|
+
readonly enabled?: boolean | undefined;
|
416
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
417
|
+
} | undefined;
|
418
|
+
readonly enabled: boolean;
|
419
|
+
readonly dev?: {
|
420
|
+
readonly enabled?: boolean | undefined;
|
421
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
422
|
+
} | undefined;
|
423
|
+
} | undefined;
|
424
|
+
} | undefined;
|
425
|
+
readonly descriptionsView?: {
|
426
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
427
|
+
readonly showControl?: boolean | undefined;
|
428
|
+
} | undefined;
|
429
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
430
|
+
};
|
431
|
+
export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is {
|
432
|
+
readonly enabled?: boolean | undefined;
|
433
|
+
readonly diagnostics?: {
|
434
|
+
readonly validation?: boolean | {
|
435
|
+
readonly build?: {
|
436
|
+
readonly enabled?: boolean | undefined;
|
437
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
438
|
+
} | undefined;
|
439
|
+
readonly enabled: boolean;
|
440
|
+
readonly dev?: {
|
441
|
+
readonly enabled?: boolean | undefined;
|
442
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
443
|
+
} | undefined;
|
444
|
+
} | undefined;
|
445
|
+
} | undefined;
|
446
|
+
readonly descriptionsView?: {
|
447
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
448
|
+
readonly showControl?: boolean | undefined;
|
449
|
+
} | undefined;
|
450
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
451
|
+
};
|
452
|
+
export declare const decode: (i: boolean | {
|
453
|
+
readonly enabled?: boolean | undefined;
|
454
|
+
readonly diagnostics?: {
|
455
|
+
readonly validation?: boolean | {
|
456
|
+
readonly enabled: boolean;
|
457
|
+
readonly build?: {
|
458
|
+
readonly enabled?: boolean | undefined;
|
459
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
460
|
+
} | undefined;
|
461
|
+
readonly dev?: {
|
462
|
+
readonly enabled?: boolean | undefined;
|
463
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
464
|
+
} | undefined;
|
465
|
+
} | undefined;
|
466
|
+
} | undefined;
|
467
|
+
readonly descriptionsView?: {
|
468
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
469
|
+
readonly showControl?: boolean | undefined;
|
470
|
+
} | undefined;
|
471
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
472
|
+
}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => import("effect/Effect").Effect<{
|
473
|
+
readonly enabled?: boolean | undefined;
|
474
|
+
readonly diagnostics?: {
|
475
|
+
readonly validation?: boolean | {
|
476
|
+
readonly build?: {
|
477
|
+
readonly enabled?: boolean | undefined;
|
478
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
479
|
+
} | undefined;
|
480
|
+
readonly enabled: boolean;
|
481
|
+
readonly dev?: {
|
482
|
+
readonly enabled?: boolean | undefined;
|
483
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
484
|
+
} | undefined;
|
485
|
+
} | undefined;
|
486
|
+
} | undefined;
|
487
|
+
readonly descriptionsView?: {
|
488
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
489
|
+
readonly showControl?: boolean | undefined;
|
490
|
+
} | undefined;
|
491
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
492
|
+
}, import("effect/ParseResult").ParseError, never>;
|
493
|
+
export declare const decodeSync: (i: boolean | {
|
494
|
+
readonly enabled?: boolean | undefined;
|
495
|
+
readonly diagnostics?: {
|
496
|
+
readonly validation?: boolean | {
|
497
|
+
readonly enabled: boolean;
|
498
|
+
readonly build?: {
|
499
|
+
readonly enabled?: boolean | undefined;
|
500
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
501
|
+
} | undefined;
|
502
|
+
readonly dev?: {
|
503
|
+
readonly enabled?: boolean | undefined;
|
504
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
505
|
+
} | undefined;
|
506
|
+
} | undefined;
|
507
|
+
} | undefined;
|
508
|
+
readonly descriptionsView?: {
|
509
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
510
|
+
readonly showControl?: boolean | undefined;
|
511
|
+
} | undefined;
|
512
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
513
|
+
}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => {
|
514
|
+
readonly enabled?: boolean | undefined;
|
515
|
+
readonly diagnostics?: {
|
516
|
+
readonly validation?: boolean | {
|
517
|
+
readonly build?: {
|
518
|
+
readonly enabled?: boolean | undefined;
|
519
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
520
|
+
} | undefined;
|
521
|
+
readonly enabled: boolean;
|
522
|
+
readonly dev?: {
|
523
|
+
readonly enabled?: boolean | undefined;
|
524
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
525
|
+
} | undefined;
|
526
|
+
} | undefined;
|
527
|
+
} | undefined;
|
528
|
+
readonly descriptionsView?: {
|
529
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
530
|
+
readonly showControl?: boolean | undefined;
|
531
|
+
} | undefined;
|
532
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
533
|
+
};
|
534
|
+
export declare const encode: (a: {
|
535
|
+
readonly enabled?: boolean | undefined;
|
536
|
+
readonly diagnostics?: {
|
537
|
+
readonly validation?: boolean | {
|
538
|
+
readonly build?: {
|
539
|
+
readonly enabled?: boolean | undefined;
|
540
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
541
|
+
} | undefined;
|
542
|
+
readonly enabled: boolean;
|
543
|
+
readonly dev?: {
|
544
|
+
readonly enabled?: boolean | undefined;
|
545
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
546
|
+
} | undefined;
|
547
|
+
} | undefined;
|
548
|
+
} | undefined;
|
549
|
+
readonly descriptionsView?: {
|
550
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
551
|
+
readonly showControl?: boolean | undefined;
|
552
|
+
} | undefined;
|
553
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
554
|
+
}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => import("effect/Effect").Effect<boolean | {
|
555
|
+
readonly enabled?: boolean | undefined;
|
556
|
+
readonly diagnostics?: {
|
557
|
+
readonly validation?: boolean | {
|
558
|
+
readonly enabled: boolean;
|
559
|
+
readonly build?: {
|
560
|
+
readonly enabled?: boolean | undefined;
|
561
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
562
|
+
} | undefined;
|
563
|
+
readonly dev?: {
|
564
|
+
readonly enabled?: boolean | undefined;
|
565
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
566
|
+
} | undefined;
|
567
|
+
} | undefined;
|
568
|
+
} | undefined;
|
569
|
+
readonly descriptionsView?: {
|
570
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
571
|
+
readonly showControl?: boolean | undefined;
|
572
|
+
} | undefined;
|
573
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
574
|
+
}, import("effect/ParseResult").ParseError, never>;
|
575
|
+
export declare const encodeSync: (a: {
|
576
|
+
readonly enabled?: boolean | undefined;
|
577
|
+
readonly diagnostics?: {
|
578
|
+
readonly validation?: boolean | {
|
579
|
+
readonly build?: {
|
580
|
+
readonly enabled?: boolean | undefined;
|
581
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
582
|
+
} | undefined;
|
583
|
+
readonly enabled: boolean;
|
584
|
+
readonly dev?: {
|
585
|
+
readonly enabled?: boolean | undefined;
|
586
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
587
|
+
} | undefined;
|
588
|
+
} | undefined;
|
589
|
+
} | undefined;
|
590
|
+
readonly descriptionsView?: {
|
591
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
592
|
+
readonly showControl?: boolean | undefined;
|
593
|
+
} | undefined;
|
594
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
595
|
+
}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => boolean | {
|
596
|
+
readonly enabled?: boolean | undefined;
|
597
|
+
readonly diagnostics?: {
|
598
|
+
readonly validation?: boolean | {
|
599
|
+
readonly enabled: boolean;
|
600
|
+
readonly build?: {
|
601
|
+
readonly enabled?: boolean | undefined;
|
602
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
603
|
+
} | undefined;
|
604
|
+
readonly dev?: {
|
605
|
+
readonly enabled?: boolean | undefined;
|
606
|
+
readonly severity?: "error" | "warning" | "info" | undefined;
|
607
|
+
} | undefined;
|
608
|
+
} | undefined;
|
609
|
+
} | undefined;
|
610
|
+
readonly descriptionsView?: {
|
611
|
+
readonly defaultMode?: "compact" | "expanded" | undefined;
|
612
|
+
readonly showControl?: boolean | undefined;
|
613
|
+
} | undefined;
|
614
|
+
readonly nullabilityRendering?: "questionMark" | "bangMark" | undefined;
|
615
|
+
};
|
616
|
+
//# sourceMappingURL=config.d.ts.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/api/reference/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAMxC;;GAEG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAM7E;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;;;OAKG;;EAKH,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAMrE,eAAO,MAAM,qBAAqB;IAChC;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;OAcG;;QA/DH;;;;;;WAMG;;QAGH;;;;;WAKG;;;IAoDH;;;;;;;;;OASG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;QArHH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;EAuHH,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAE/E;;;;;GAKG;AACH,eAAO,MAAM,eAAe;IApF1B;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;OAcG;;QA/DH;;;;;;WAMG;;QAGH;;;;;WAKG;;;IAoDH;;;;;;;;;OASG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;QArHH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;IA6CH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;OAcG;;QA/DH;;;;;;WAMG;;QAGH;;;;;WAKG;;;IAoDH;;;;;;;;;OASG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;QArHH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;GA0JH,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAA;AAMnE,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA6B,CAAA;AAM9C,eAAO,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;CAAwB,CAAA;AAMvC,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kDAA4B,CAAA;AAC/C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAgC,CAAA;AACvD,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kDAA4B,CAAA;AAC/C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAgC,CAAA"}
|