@clarify-labs/cli 0.10.3 → 0.11.1
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/output/cli/commands/mcp.d.ts +27 -0
- package/output/cli/mcp/orama-loader.d.ts +56 -0
- package/output/cli/mcp/search-server.d.ts +34 -0
- package/output/cli/program.d.ts +0 -1
- package/output/cli.cjs +294 -13
- package/output/cli.cjs.map +1 -1
- package/output/cli.js +295 -14
- package/output/cli.js.map +1 -1
- package/output/core/config/config-schema.d.ts +138 -253
- package/output/core/config/config.d.ts +2 -1
- package/output/core/config/options.d.ts +0 -8
- package/output/core/config/user-config.d.ts +4 -3
- package/output/core/plugin/hooks.d.ts +0 -1
- package/output/core/project/project-info.d.ts +3 -3
- package/output/core/runtime/html-template.d.ts +0 -6
- package/output/core/runtime/ssg.d.ts +1 -1
- package/output/core/runtime/virtual-modules.d.ts +1 -5
- package/output/{engine-BDdPszs2.cjs → engine-Cbn_coqg.cjs} +569 -170
- package/output/engine-Cbn_coqg.cjs.map +1 -0
- package/output/{engine-CyFtr8Pz.js → engine-CxnKEKv8.js} +558 -171
- package/output/engine-CxnKEKv8.js.map +1 -0
- package/output/index.cjs +1 -1
- package/output/index.js +1 -1
- package/output/parsers/routes/routes.d.ts +7 -11
- package/output/parsers/routes/routes.test-utils.d.ts +2 -2
- package/output/plugins/content-artifacts/artifacts.d.ts +0 -2
- package/output/plugins/mcp-search/index.d.ts +15 -0
- package/output/plugins/mcp-search/mcp-config.d.ts +72 -0
- package/output/plugins/mcp-search/orama-index.d.ts +153 -0
- package/output/plugins/openapi/virtual-modules.d.ts +0 -1
- package/output/plugins/page-search/index.d.ts +2 -0
- package/output/plugins/source-links/source-links.d.ts +3 -3
- package/output/types.d.ts +64 -33
- package/package.json +6 -4
- package/output/engine-BDdPszs2.cjs.map +0 -1
- package/output/engine-CyFtr8Pz.js.map +0 -1
- package/output/plugins/search-index/index.d.ts +0 -2
- /package/output/plugins/{search-index → page-search}/search-language.d.ts +0 -0
|
@@ -1,238 +1,73 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { ClarifyVariableValue } from '../../types.js';
|
|
3
|
-
export declare const
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
dir: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"ltr">, z.ZodLiteral<"rtl">]>>;
|
|
16
|
-
}, z.core.$strip>;
|
|
17
|
-
export declare const clarifyI18nConfigSchema: z.ZodObject<{
|
|
18
|
-
defaultLocale: z.ZodOptional<z.ZodString>;
|
|
19
|
-
missing: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"fallback">, z.ZodLiteral<"404">, z.ZodLiteral<"hide">]>>;
|
|
20
|
-
locales: z.ZodArray<z.ZodObject<{
|
|
21
|
-
code: z.ZodString;
|
|
22
|
-
label: z.ZodString;
|
|
23
|
-
dir: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"ltr">, z.ZodLiteral<"rtl">]>>;
|
|
24
|
-
}, z.core.$strip>>;
|
|
25
|
-
}, z.core.$strip>;
|
|
26
|
-
export declare const clarifyNavbarLinkSchema: z.ZodObject<{
|
|
27
|
-
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
28
|
-
href: z.ZodString;
|
|
29
|
-
external: z.ZodOptional<z.ZodBoolean>;
|
|
30
|
-
}, z.core.$strip>;
|
|
31
|
-
export declare const clarifyBannerConfigOptionsSchema: z.ZodObject<{
|
|
32
|
-
content: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
33
|
-
dismissible: z.ZodOptional<z.ZodBoolean>;
|
|
34
|
-
link: z.ZodOptional<z.ZodObject<{
|
|
35
|
-
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
36
|
-
href: z.ZodString;
|
|
37
|
-
external: z.ZodOptional<z.ZodBoolean>;
|
|
38
|
-
}, z.core.$strip>>;
|
|
39
|
-
}, z.core.$strict>;
|
|
40
|
-
export declare const clarifyFooterConfigSchema: z.ZodObject<{
|
|
41
|
-
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
42
|
-
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
43
|
-
href: z.ZodString;
|
|
44
|
-
external: z.ZodOptional<z.ZodBoolean>;
|
|
45
|
-
}, z.core.$strip>>>;
|
|
46
|
-
socials: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
47
|
-
copyright: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
|
|
48
|
-
}, z.core.$strict>;
|
|
49
|
-
export declare const clarifyVariableValueSchema: z.ZodType<ClarifyVariableValue>;
|
|
50
|
-
export declare const clarifyVariablesConfigSchema: z.ZodRecord<z.ZodString, z.ZodType<ClarifyVariableValue, unknown, z.core.$ZodTypeInternals<ClarifyVariableValue, unknown>>>;
|
|
51
|
-
export declare const clarifySourceConfigSchema: z.ZodObject<{
|
|
52
|
-
repository: z.ZodString;
|
|
53
|
-
branch: z.ZodOptional<z.ZodString>;
|
|
54
|
-
directory: z.ZodOptional<z.ZodString>;
|
|
55
|
-
}, z.core.$strip>;
|
|
56
|
-
export declare const clarifyPagesItemSchema: z.ZodType<import('../../types.js').ClarifyPagesItem, import('../../types.js').ClarifyPagesItem>;
|
|
57
|
-
export declare const clarifyPagesGroupSchema: z.ZodType<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup>;
|
|
58
|
-
export declare const clarifyPagesConfigSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodType<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup, z.core.$ZodTypeInternals<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup>>>, z.ZodLiteral<"FileTree">]>;
|
|
59
|
-
export declare const clarifyTabItemSchema: z.ZodObject<{
|
|
60
|
-
tab: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
61
|
-
icon: z.ZodOptional<z.ZodString>;
|
|
62
|
-
pages: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodType<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup, z.core.$ZodTypeInternals<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup>>>, z.ZodLiteral<"FileTree">]>>;
|
|
63
|
-
}, z.core.$strip>;
|
|
64
|
-
export declare const clarifyTabsConfigSchema: z.ZodArray<z.ZodObject<{
|
|
65
|
-
tab: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
66
|
-
icon: z.ZodOptional<z.ZodString>;
|
|
67
|
-
pages: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodType<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup, z.core.$ZodTypeInternals<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup>>>, z.ZodLiteral<"FileTree">]>>;
|
|
68
|
-
}, z.core.$strip>>;
|
|
69
|
-
export declare const clarifyThemePresetSchema: z.ZodEnum<{
|
|
70
|
-
default: "default";
|
|
71
|
-
base: "base";
|
|
72
|
-
}>;
|
|
73
|
-
export declare const clarifyThemeModeColorValueSchema: z.ZodObject<{
|
|
74
|
-
light: z.ZodOptional<z.ZodString>;
|
|
75
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
76
|
-
}, z.core.$strip>;
|
|
77
|
-
export declare const clarifyThemeColorValueSchema: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
78
|
-
light: z.ZodOptional<z.ZodString>;
|
|
79
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
80
|
-
}, z.core.$strip>]>;
|
|
81
|
-
export declare const clarifyThemeColorTokensConfigSchema: z.ZodObject<{
|
|
82
|
-
primary: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
83
|
-
light: z.ZodOptional<z.ZodString>;
|
|
84
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
85
|
-
}, z.core.$strip>]>>;
|
|
86
|
-
accent: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
87
|
-
light: z.ZodOptional<z.ZodString>;
|
|
88
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
89
|
-
}, z.core.$strip>]>>;
|
|
90
|
-
background: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
91
|
-
light: z.ZodOptional<z.ZodString>;
|
|
92
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
93
|
-
}, z.core.$strip>]>>;
|
|
94
|
-
foreground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
95
|
-
light: z.ZodOptional<z.ZodString>;
|
|
96
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
97
|
-
}, z.core.$strip>]>>;
|
|
98
|
-
surface: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
99
|
-
light: z.ZodOptional<z.ZodString>;
|
|
100
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
101
|
-
}, z.core.$strip>]>>;
|
|
102
|
-
muted: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
103
|
-
light: z.ZodOptional<z.ZodString>;
|
|
104
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
105
|
-
}, z.core.$strip>]>>;
|
|
106
|
-
border: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
107
|
-
light: z.ZodOptional<z.ZodString>;
|
|
108
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
109
|
-
}, z.core.$strip>]>>;
|
|
110
|
-
codeBackground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
111
|
-
light: z.ZodOptional<z.ZodString>;
|
|
112
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
113
|
-
}, z.core.$strip>]>>;
|
|
114
|
-
}, z.core.$strip>;
|
|
115
|
-
export declare const clarifyThemeRadiusTokensConfigSchema: z.ZodObject<{
|
|
116
|
-
sm: z.ZodOptional<z.ZodString>;
|
|
117
|
-
md: z.ZodOptional<z.ZodString>;
|
|
118
|
-
lg: z.ZodOptional<z.ZodString>;
|
|
119
|
-
xl: z.ZodOptional<z.ZodString>;
|
|
120
|
-
}, z.core.$strip>;
|
|
121
|
-
export declare const clarifyThemeTokensConfigSchema: z.ZodObject<{
|
|
122
|
-
colors: z.ZodOptional<z.ZodObject<{
|
|
123
|
-
primary: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
124
|
-
light: z.ZodOptional<z.ZodString>;
|
|
125
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
126
|
-
}, z.core.$strip>]>>;
|
|
127
|
-
accent: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
128
|
-
light: z.ZodOptional<z.ZodString>;
|
|
129
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
130
|
-
}, z.core.$strip>]>>;
|
|
131
|
-
background: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
132
|
-
light: z.ZodOptional<z.ZodString>;
|
|
133
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
134
|
-
}, z.core.$strip>]>>;
|
|
135
|
-
foreground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
136
|
-
light: z.ZodOptional<z.ZodString>;
|
|
137
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
138
|
-
}, z.core.$strip>]>>;
|
|
139
|
-
surface: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
140
|
-
light: z.ZodOptional<z.ZodString>;
|
|
141
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
142
|
-
}, z.core.$strip>]>>;
|
|
143
|
-
muted: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
144
|
-
light: z.ZodOptional<z.ZodString>;
|
|
145
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
146
|
-
}, z.core.$strip>]>>;
|
|
147
|
-
border: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
148
|
-
light: z.ZodOptional<z.ZodString>;
|
|
149
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
150
|
-
}, z.core.$strip>]>>;
|
|
151
|
-
codeBackground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
152
|
-
light: z.ZodOptional<z.ZodString>;
|
|
153
|
-
dark: z.ZodOptional<z.ZodString>;
|
|
154
|
-
}, z.core.$strip>]>>;
|
|
155
|
-
}, z.core.$strip>>;
|
|
156
|
-
radius: z.ZodOptional<z.ZodObject<{
|
|
157
|
-
sm: z.ZodOptional<z.ZodString>;
|
|
158
|
-
md: z.ZodOptional<z.ZodString>;
|
|
159
|
-
lg: z.ZodOptional<z.ZodString>;
|
|
160
|
-
xl: z.ZodOptional<z.ZodString>;
|
|
161
|
-
}, z.core.$strip>>;
|
|
162
|
-
}, z.core.$strip>;
|
|
163
|
-
export declare const clarifyThemeLayoutConfigSchema: z.ZodObject<{
|
|
164
|
-
maxWidth: z.ZodOptional<z.ZodString>;
|
|
165
|
-
}, z.core.$strip>;
|
|
166
|
-
export declare const clarifyThemeConfigSchema: z.ZodObject<{
|
|
167
|
-
preset: z.ZodOptional<z.ZodEnum<{
|
|
168
|
-
default: "default";
|
|
169
|
-
base: "base";
|
|
3
|
+
export declare const clarifyFeaturesConfigSchema: z.ZodObject<{
|
|
4
|
+
search: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
5
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
6
|
+
mcp: z.ZodDefault<z.ZodBoolean>;
|
|
7
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
8
|
+
enabled: boolean;
|
|
9
|
+
} | {
|
|
10
|
+
enabled: boolean;
|
|
11
|
+
mcp: boolean;
|
|
12
|
+
}, boolean | {
|
|
13
|
+
enabled: boolean;
|
|
14
|
+
mcp: boolean;
|
|
170
15
|
}>>;
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
}, z.core.$strip>>;
|
|
212
|
-
}, z.core.$strip>>;
|
|
213
|
-
layout: z.ZodOptional<z.ZodObject<{
|
|
214
|
-
maxWidth: z.ZodOptional<z.ZodString>;
|
|
215
|
-
}, z.core.$strip>>;
|
|
216
|
-
editor: z.ZodOptional<z.ZodBoolean>;
|
|
217
|
-
}, z.core.$strip>;
|
|
16
|
+
repository: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
17
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
18
|
+
url: z.ZodOptional<z.ZodString>;
|
|
19
|
+
branch: z.ZodOptional<z.ZodString>;
|
|
20
|
+
directory: z.ZodOptional<z.ZodString>;
|
|
21
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
22
|
+
enabled: boolean;
|
|
23
|
+
} | {
|
|
24
|
+
enabled: boolean;
|
|
25
|
+
url?: string | undefined;
|
|
26
|
+
branch?: string | undefined;
|
|
27
|
+
directory?: string | undefined;
|
|
28
|
+
}, boolean | {
|
|
29
|
+
enabled: boolean;
|
|
30
|
+
url?: string | undefined;
|
|
31
|
+
branch?: string | undefined;
|
|
32
|
+
directory?: string | undefined;
|
|
33
|
+
}>>;
|
|
34
|
+
themeEditor: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
35
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
36
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
37
|
+
enabled: boolean;
|
|
38
|
+
} | {
|
|
39
|
+
enabled: boolean;
|
|
40
|
+
}, boolean | {
|
|
41
|
+
enabled: boolean;
|
|
42
|
+
}>>;
|
|
43
|
+
openapi: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
44
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
45
|
+
playground: z.ZodDefault<z.ZodBoolean>;
|
|
46
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
47
|
+
enabled: boolean;
|
|
48
|
+
} | {
|
|
49
|
+
enabled: boolean;
|
|
50
|
+
playground: boolean;
|
|
51
|
+
}, boolean | {
|
|
52
|
+
enabled: boolean;
|
|
53
|
+
playground: boolean;
|
|
54
|
+
}>>;
|
|
55
|
+
}, z.core.$strict>;
|
|
218
56
|
export declare const clarifyProjectConfigSchema: z.ZodObject<{
|
|
219
57
|
title: z.ZodOptional<z.ZodString>;
|
|
220
58
|
description: z.ZodOptional<z.ZodString>;
|
|
221
59
|
siteUrl: z.ZodOptional<z.ZodString>;
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
branch: z.ZodOptional<z.ZodString>;
|
|
225
|
-
directory: z.ZodOptional<z.ZodString>;
|
|
226
|
-
}, z.core.$strip>>;
|
|
60
|
+
routePrefix: z.ZodDefault<z.ZodString>;
|
|
61
|
+
assetPrefix: z.ZodOptional<z.ZodString>;
|
|
227
62
|
logo: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
228
63
|
light: z.ZodOptional<z.ZodString>;
|
|
229
64
|
dark: z.ZodOptional<z.ZodString>;
|
|
230
|
-
}, z.core.$
|
|
65
|
+
}, z.core.$strict>]>>;
|
|
231
66
|
homeUrl: z.ZodOptional<z.ZodString>;
|
|
232
67
|
favicon: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
233
68
|
light: z.ZodOptional<z.ZodString>;
|
|
234
69
|
dark: z.ZodOptional<z.ZodString>;
|
|
235
|
-
}, z.core.$
|
|
70
|
+
}, z.core.$strict>]>>;
|
|
236
71
|
theme: z.ZodOptional<z.ZodObject<{
|
|
237
72
|
preset: z.ZodOptional<z.ZodEnum<{
|
|
238
73
|
default: "default";
|
|
@@ -243,57 +78,59 @@ export declare const clarifyProjectConfigSchema: z.ZodObject<{
|
|
|
243
78
|
primary: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
244
79
|
light: z.ZodOptional<z.ZodString>;
|
|
245
80
|
dark: z.ZodOptional<z.ZodString>;
|
|
246
|
-
}, z.core.$
|
|
81
|
+
}, z.core.$strict>]>>;
|
|
247
82
|
accent: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
248
83
|
light: z.ZodOptional<z.ZodString>;
|
|
249
84
|
dark: z.ZodOptional<z.ZodString>;
|
|
250
|
-
}, z.core.$
|
|
85
|
+
}, z.core.$strict>]>>;
|
|
251
86
|
background: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
252
87
|
light: z.ZodOptional<z.ZodString>;
|
|
253
88
|
dark: z.ZodOptional<z.ZodString>;
|
|
254
|
-
}, z.core.$
|
|
89
|
+
}, z.core.$strict>]>>;
|
|
255
90
|
foreground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
256
91
|
light: z.ZodOptional<z.ZodString>;
|
|
257
92
|
dark: z.ZodOptional<z.ZodString>;
|
|
258
|
-
}, z.core.$
|
|
93
|
+
}, z.core.$strict>]>>;
|
|
259
94
|
surface: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
260
95
|
light: z.ZodOptional<z.ZodString>;
|
|
261
96
|
dark: z.ZodOptional<z.ZodString>;
|
|
262
|
-
}, z.core.$
|
|
97
|
+
}, z.core.$strict>]>>;
|
|
263
98
|
muted: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
264
99
|
light: z.ZodOptional<z.ZodString>;
|
|
265
100
|
dark: z.ZodOptional<z.ZodString>;
|
|
266
|
-
}, z.core.$
|
|
101
|
+
}, z.core.$strict>]>>;
|
|
267
102
|
border: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
268
103
|
light: z.ZodOptional<z.ZodString>;
|
|
269
104
|
dark: z.ZodOptional<z.ZodString>;
|
|
270
|
-
}, z.core.$
|
|
105
|
+
}, z.core.$strict>]>>;
|
|
271
106
|
codeBackground: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
272
107
|
light: z.ZodOptional<z.ZodString>;
|
|
273
108
|
dark: z.ZodOptional<z.ZodString>;
|
|
274
|
-
}, z.core.$
|
|
275
|
-
}, z.core.$
|
|
109
|
+
}, z.core.$strict>]>>;
|
|
110
|
+
}, z.core.$strict>>;
|
|
276
111
|
radius: z.ZodOptional<z.ZodObject<{
|
|
277
112
|
sm: z.ZodOptional<z.ZodString>;
|
|
278
113
|
md: z.ZodOptional<z.ZodString>;
|
|
279
114
|
lg: z.ZodOptional<z.ZodString>;
|
|
280
115
|
xl: z.ZodOptional<z.ZodString>;
|
|
281
|
-
}, z.core.$
|
|
282
|
-
}, z.core.$
|
|
116
|
+
}, z.core.$strict>>;
|
|
117
|
+
}, z.core.$strict>>;
|
|
283
118
|
layout: z.ZodOptional<z.ZodObject<{
|
|
284
119
|
maxWidth: z.ZodOptional<z.ZodString>;
|
|
285
|
-
}, z.core.$
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
routePrefix: z.ZodOptional<z.ZodString>;
|
|
289
|
-
assetPrefix: z.ZodOptional<z.ZodString>;
|
|
290
|
-
navbar: z.ZodOptional<z.ZodObject<{
|
|
120
|
+
}, z.core.$strict>>;
|
|
121
|
+
}, z.core.$strict>>;
|
|
122
|
+
navigation: z.ZodOptional<z.ZodObject<{
|
|
291
123
|
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
292
124
|
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
293
125
|
href: z.ZodString;
|
|
294
126
|
external: z.ZodOptional<z.ZodBoolean>;
|
|
295
|
-
}, z.core.$
|
|
296
|
-
|
|
127
|
+
}, z.core.$strict>>>;
|
|
128
|
+
tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
129
|
+
tab: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
130
|
+
icon: z.ZodOptional<z.ZodString>;
|
|
131
|
+
pages: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodType<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup, z.core.$ZodTypeInternals<import('../../types.js').ClarifyPagesGroup, import('../../types.js').ClarifyPagesGroup>>>, z.ZodLiteral<"FileTree">]>>;
|
|
132
|
+
}, z.core.$strict>>>;
|
|
133
|
+
}, z.core.$strict>>;
|
|
297
134
|
banner: z.ZodOptional<z.ZodObject<{
|
|
298
135
|
content: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
299
136
|
dismissible: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -301,31 +138,79 @@ export declare const clarifyProjectConfigSchema: z.ZodObject<{
|
|
|
301
138
|
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
302
139
|
href: z.ZodString;
|
|
303
140
|
external: z.ZodOptional<z.ZodBoolean>;
|
|
304
|
-
}, z.core.$
|
|
141
|
+
}, z.core.$strict>>;
|
|
305
142
|
}, z.core.$strict>>;
|
|
306
143
|
footer: z.ZodOptional<z.ZodObject<{
|
|
307
144
|
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
308
145
|
label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
|
|
309
146
|
href: z.ZodString;
|
|
310
147
|
external: z.ZodOptional<z.ZodBoolean>;
|
|
311
|
-
}, z.core.$
|
|
148
|
+
}, z.core.$strict>>>;
|
|
312
149
|
socials: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
313
150
|
copyright: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
|
|
314
151
|
}, z.core.$strict>>;
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
defaultLocale: z.ZodOptional<z.ZodString>;
|
|
152
|
+
locales: z.ZodOptional<z.ZodObject<{
|
|
153
|
+
default: z.ZodOptional<z.ZodString>;
|
|
318
154
|
missing: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"fallback">, z.ZodLiteral<"404">, z.ZodLiteral<"hide">]>>;
|
|
319
155
|
locales: z.ZodArray<z.ZodObject<{
|
|
320
156
|
code: z.ZodString;
|
|
321
157
|
label: z.ZodString;
|
|
322
158
|
dir: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"ltr">, z.ZodLiteral<"rtl">]>>;
|
|
323
|
-
}, z.core.$
|
|
324
|
-
}, z.core.$
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
}, z.core.$
|
|
159
|
+
}, z.core.$strict>>;
|
|
160
|
+
}, z.core.$strict>>;
|
|
161
|
+
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<ClarifyVariableValue, unknown, z.core.$ZodTypeInternals<ClarifyVariableValue, unknown>>>>;
|
|
162
|
+
features: z.ZodOptional<z.ZodObject<{
|
|
163
|
+
search: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
164
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
165
|
+
mcp: z.ZodDefault<z.ZodBoolean>;
|
|
166
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
167
|
+
enabled: boolean;
|
|
168
|
+
} | {
|
|
169
|
+
enabled: boolean;
|
|
170
|
+
mcp: boolean;
|
|
171
|
+
}, boolean | {
|
|
172
|
+
enabled: boolean;
|
|
173
|
+
mcp: boolean;
|
|
174
|
+
}>>;
|
|
175
|
+
repository: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
176
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
177
|
+
url: z.ZodOptional<z.ZodString>;
|
|
178
|
+
branch: z.ZodOptional<z.ZodString>;
|
|
179
|
+
directory: z.ZodOptional<z.ZodString>;
|
|
180
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
181
|
+
enabled: boolean;
|
|
182
|
+
} | {
|
|
183
|
+
enabled: boolean;
|
|
184
|
+
url?: string | undefined;
|
|
185
|
+
branch?: string | undefined;
|
|
186
|
+
directory?: string | undefined;
|
|
187
|
+
}, boolean | {
|
|
188
|
+
enabled: boolean;
|
|
189
|
+
url?: string | undefined;
|
|
190
|
+
branch?: string | undefined;
|
|
191
|
+
directory?: string | undefined;
|
|
192
|
+
}>>;
|
|
193
|
+
themeEditor: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
194
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
195
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
196
|
+
enabled: boolean;
|
|
197
|
+
} | {
|
|
198
|
+
enabled: boolean;
|
|
199
|
+
}, boolean | {
|
|
200
|
+
enabled: boolean;
|
|
201
|
+
}>>;
|
|
202
|
+
openapi: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodDefault<z.ZodObject<{
|
|
203
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
204
|
+
playground: z.ZodDefault<z.ZodBoolean>;
|
|
205
|
+
}, z.core.$strict>>]>>, z.ZodTransform<{
|
|
206
|
+
enabled: boolean;
|
|
207
|
+
} | {
|
|
208
|
+
enabled: boolean;
|
|
209
|
+
playground: boolean;
|
|
210
|
+
}, boolean | {
|
|
211
|
+
enabled: boolean;
|
|
212
|
+
playground: boolean;
|
|
213
|
+
}>>;
|
|
214
|
+
}, z.core.$strict>>;
|
|
215
|
+
}, z.core.$strict>;
|
|
331
216
|
export type ClarifyProjectConfigInput = z.input<typeof clarifyProjectConfigSchema>;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
import { ClarifyProjectConfig, ResolvedProjectConfig } from '../../types.js';
|
|
1
|
+
import { ClarifyFeaturesConfig, ClarifyProjectConfig, ResolvedClarifyFeaturesConfig, ResolvedProjectConfig } from '../../types.js';
|
|
2
2
|
export declare function validateProjectConfig(value: unknown): ClarifyProjectConfig;
|
|
3
|
+
export declare function resolveFeaturesConfig(features?: ClarifyFeaturesConfig): ResolvedClarifyFeaturesConfig;
|
|
3
4
|
export declare function resolveProjectConfig(config?: ClarifyProjectConfig): ResolvedProjectConfig;
|
|
@@ -6,11 +6,6 @@ export type ClarifyBuildOptions = ClarifyProjectConfig & {
|
|
|
6
6
|
rootDirectory?: string;
|
|
7
7
|
/** Output directory for the built docs site. When omitted, Vite's build.outDir is used. */
|
|
8
8
|
outputDirectory?: string;
|
|
9
|
-
/** Static generation behavior. */
|
|
10
|
-
ssg?: {
|
|
11
|
-
/** Fail the build when SSG fails. Default: true. */
|
|
12
|
-
failOnError?: boolean;
|
|
13
|
-
};
|
|
14
9
|
/** Clarify plugin extensions for translation, search, and other build-time features. */
|
|
15
10
|
plugins?: ClarifyPlugin[];
|
|
16
11
|
};
|
|
@@ -18,8 +13,5 @@ export type ResolvedBuildOptions = {
|
|
|
18
13
|
projectRoot: string;
|
|
19
14
|
rootDirectory: string;
|
|
20
15
|
outputDirectory?: string;
|
|
21
|
-
ssg: {
|
|
22
|
-
failOnError: boolean;
|
|
23
|
-
};
|
|
24
16
|
};
|
|
25
17
|
export declare function resolveBuildOptions(options?: ClarifyBuildOptions): ResolvedBuildOptions;
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { ConfigEnv } from 'vite';
|
|
2
|
-
import { ClarifyProjectConfig } from '../../types.js';
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
import { ClarifyProjectConfig, ClarifyPlugin } from '../../types.js';
|
|
3
|
+
export type ClarifyConfig = ClarifyProjectConfig & {
|
|
4
|
+
plugins?: ClarifyPlugin[];
|
|
5
|
+
};
|
|
5
6
|
export declare function defineConfig(config: ClarifyConfig): ClarifyConfig;
|
|
6
7
|
/**
|
|
7
8
|
* Config filenames Clarify CLI looks for at the project root, in resolution
|
|
@@ -2,6 +2,5 @@ import { ViteDevServer } from 'vite';
|
|
|
2
2
|
import { ClarifyEmitAsset, ClarifyHookContext, ClarifyPipelineHooks, ClarifyPlugin } from '../../types.js';
|
|
3
3
|
export declare function runHooks<K extends keyof ClarifyPipelineHooks>(plugins: ClarifyPlugin[], hookName: K, input: Parameters<NonNullable<ClarifyPipelineHooks[K]>>[0], ctx: ClarifyHookContext): Promise<Parameters<NonNullable<ClarifyPipelineHooks[K]>>[0]>;
|
|
4
4
|
export declare function runDevConfigureServerHooks(plugins: ClarifyPlugin[], server: ViteDevServer, ctx: ClarifyHookContext): Promise<void>;
|
|
5
|
-
export declare function runCollectorHooks<T>(plugins: ClarifyPlugin[], hookName: string, ctx: ClarifyHookContext): Promise<T[]>;
|
|
6
5
|
export declare function runBuildAssetsHooks(plugins: ClarifyPlugin[], ctx: ClarifyHookContext): Promise<ClarifyEmitAsset[]>;
|
|
7
6
|
export declare function runBuildDoneHooks(plugins: ClarifyPlugin[], ctx: ClarifyHookContext): Promise<void>;
|
|
@@ -11,7 +11,7 @@ import { ClarifyProjectContext } from '../../types.js';
|
|
|
11
11
|
* - `contentRoot`: the resolved content root directory name (relative to
|
|
12
12
|
* the project root, e.g. `"source"`).
|
|
13
13
|
* - `projectRoot`: the absolute project root path.
|
|
14
|
-
* - `
|
|
14
|
+
* - `locales`: locale information when localization is configured.
|
|
15
15
|
*/
|
|
16
16
|
export declare const CLARIFY_DEV_PROJECT_INFO_ENDPOINT = "/dev/project-info";
|
|
17
17
|
/**
|
|
@@ -26,8 +26,8 @@ export type ProjectInfoResponse = {
|
|
|
26
26
|
contentFileExtensions: readonly string[];
|
|
27
27
|
contentRoot: string;
|
|
28
28
|
projectRoot: string;
|
|
29
|
-
|
|
30
|
-
|
|
29
|
+
locales?: {
|
|
30
|
+
default: string;
|
|
31
31
|
locales: string[];
|
|
32
32
|
};
|
|
33
33
|
};
|
|
@@ -1,10 +1,4 @@
|
|
|
1
1
|
import { ClarifyProjectContext, ContentRoute, ResolvedProjectConfig } from '../../types.js';
|
|
2
|
-
/** Inject `lang` (and optional `dir`) onto the `<html>` tag for the route locale. */
|
|
3
|
-
export declare function injectHtmlLocaleAttributes(html: string, contextOrConfig: ClarifyProjectContext | ResolvedProjectConfig, route?: ContentRoute): string;
|
|
4
|
-
/** Set, replace, or remove a `<meta name="...">` tag in `<head>`. */
|
|
5
|
-
export declare function setNamedMeta(html: string, name: string, content: string | undefined): string;
|
|
6
|
-
/** Remove any existing canonical link and (if a URL is resolved) inject a fresh one. */
|
|
7
|
-
export declare function injectCanonicalUrl(html: string, contextOrConfig: ClarifyProjectContext | ResolvedProjectConfig, route?: ContentRoute): string;
|
|
8
2
|
/**
|
|
9
3
|
* Render the SSR result into the built HTML template: set `<title>`, the
|
|
10
4
|
* description/keywords meta, the canonical link, the `<html lang/dir>`, and
|
|
@@ -7,4 +7,4 @@ export declare function routeOutputFiles(outputDirectory: string, route: Content
|
|
|
7
7
|
export declare const SSR_ENTRY_CODE = "import { renderToHTML } from '@clarify-labs/renderer/server';\nimport { routes, navigation } from 'virtual:clarify/routes/server';\nimport { config } from 'virtual:clarify/config';\nimport { openApiSpecs } from 'virtual:clarify/openapi/server';\nimport { runtimeSlots } from 'virtual:clarify/slots';\n\nexport async function render(url) {\n // Pre-resolve every slot component factory so renderToString can use\n // them synchronously (renderToString has no Suspense support).\n const entries = Object.values(runtimeSlots).flat()\n await Promise.all(entries.map(async (entry) => {\n const mod = await entry.loadComponent()\n entry._resolved = mod.default\n }))\n return renderToHTML({ config, routes, navigation, openApiSpecs, runtimeSlots, url, themeEditor: config.theme.editor });\n}";
|
|
8
8
|
export declare function createTempEntryFile(content: string): string;
|
|
9
9
|
export declare function buildSSRBundle(root: string, ssrEntry: string, ssrOutDir: string, plugins: Plugin[]): Promise<void>;
|
|
10
|
-
export declare function renderSSGRoutes(routes: ContentRoute[], contextOrConfig: ClarifyProjectContext | ResolvedProjectConfig, outputDirectory: string, ssrBundlePath: string
|
|
10
|
+
export declare function renderSSGRoutes(routes: ContentRoute[], contextOrConfig: ClarifyProjectContext | ResolvedProjectConfig, outputDirectory: string, ssrBundlePath: string): Promise<void>;
|
|
@@ -1,11 +1,7 @@
|
|
|
1
1
|
import { ClarifyPlugin, ContentDiagnostic, ContentRoute, NavigationTree, ResolvedBuildOptions, ResolvedProjectConfig } from '../../types.js';
|
|
2
|
-
export declare const VIRTUAL_CONFIG = "virtual:clarify/config";
|
|
3
2
|
export declare const VIRTUAL_ROUTES = "virtual:clarify/routes";
|
|
4
|
-
export declare const VIRTUAL_SERVER_ROUTES = "virtual:clarify/routes/server";
|
|
5
3
|
export declare const VIRTUAL_OPENAPI = "virtual:clarify/openapi";
|
|
6
4
|
export declare const VIRTUAL_OPENAPI_SERVER = "virtual:clarify/openapi/server";
|
|
7
|
-
export declare const VIRTUAL_SLOTS = "virtual:clarify/slots";
|
|
8
|
-
export declare const VIRTUAL_SLOT = "virtual:clarify/slot";
|
|
9
5
|
export declare const VIRTUAL_CLIENT_ENTRY = "virtual:clarify/entry-client";
|
|
10
6
|
export type VirtualModules = Map<string, string>;
|
|
11
7
|
type BuildVirtualModulesArgs = {
|
|
@@ -31,7 +27,7 @@ export declare function stripVirtualPrefix(id: string): string;
|
|
|
31
27
|
* if the ID is not a Clarify virtual module.
|
|
32
28
|
*/
|
|
33
29
|
export declare function resolveVirtualModuleId(id: string, modules: VirtualModules, routes: readonly ContentRoute[]): string | null;
|
|
34
|
-
export declare function generateConfigModule(projectConfig: ResolvedProjectConfig,
|
|
30
|
+
export declare function generateConfigModule(projectConfig: ResolvedProjectConfig, version?: string): string;
|
|
35
31
|
export declare function generateRoutesModule(routes: ContentRoute[], navigation: NavigationTree, mode?: 'client' | 'server'): string;
|
|
36
32
|
export declare function createClientEntryModule(options?: CreateClientEntryModuleOptions): string;
|
|
37
33
|
/**
|