@astryxdesign/cli 0.1.5 → 0.1.6-canary.02f2602

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.
Files changed (53) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/docs/integration-authoring.md +105 -0
  3. package/docs/internationalization.doc.mjs +243 -0
  4. package/package.json +13 -9
  5. package/src/api/integration-block-exports.test.mjs +240 -0
  6. package/src/api/template-suffix.test.mjs +246 -0
  7. package/src/api/template.mjs +104 -28
  8. package/src/api/validate-integration.mjs +0 -8
  9. package/src/config.mjs +5 -14
  10. package/src/doc.mjs +27 -0
  11. package/src/doc.test.mjs +383 -0
  12. package/src/integration.mjs +4 -15
  13. package/src/lib/component-discovery.importpath.test.mjs +59 -0
  14. package/src/lib/component-discovery.mjs +15 -5
  15. package/src/lib/component-format.mjs +45 -13
  16. package/src/lib/component-format.test.mjs +95 -1
  17. package/src/lib/component-loader.mjs +104 -2
  18. package/src/lib/componentDocOverlay.test.mjs +111 -0
  19. package/src/lib/config-schema.mjs +0 -30
  20. package/src/lib/hook-format.mjs +8 -3
  21. package/src/lib/xle/registry.mjs +0 -5
  22. package/src/schemas/doc-schema.mjs +226 -0
  23. package/src/schemas/template-schema.mjs +47 -0
  24. package/src/template.mjs +9 -67
  25. package/src/types/config.d.ts +11 -66
  26. package/src/types/doc.d.ts +23 -0
  27. package/src/types/integration.d.ts +7 -18
  28. package/src/types/template-api.d.ts +14 -50
  29. package/templates/blocks/components/Avatar/AvatarGroup.tsx +5 -7
  30. package/templates/blocks/components/Avatar/AvatarShowcase.tsx +4 -6
  31. package/templates/blocks/components/Avatar/AvatarUserCard.tsx +3 -5
  32. package/templates/blocks/components/Avatar/AvatarWithImage.tsx +8 -6
  33. package/templates/blocks/components/Avatar/AvatarWithStatus.tsx +3 -5
  34. package/templates/blocks/components/ChatComposerInput/ChatComposerInputControlledInput.tsx +1 -1
  35. package/templates/blocks/components/ChatComposerInput/ChatComposerInputDisabled.tsx +1 -1
  36. package/templates/blocks/components/ChatComposerInput/ChatComposerInputMentionTrigger.tsx +1 -1
  37. package/templates/blocks/components/ChatComposerInput/ChatComposerInputMultipleTriggers.tsx +1 -1
  38. package/templates/blocks/components/ChatComposerInput/ChatComposerInputShowcase.tsx +1 -1
  39. package/templates/blocks/components/ChatComposerInput/ChatComposerInputSlashCommands.tsx +1 -1
  40. package/templates/blocks/components/Table/TableGroupedRowsTable.doc.mjs +14 -0
  41. package/templates/blocks/components/Table/TableGroupedRowsTable.tsx +66 -0
  42. package/templates/blocks/components/Table/TableRowIndexTable.doc.mjs +14 -0
  43. package/templates/blocks/components/Table/TableRowIndexTable.tsx +47 -0
  44. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenLiveRegion.doc.mjs +14 -0
  45. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenLiveRegion.tsx +41 -0
  46. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenShowcase.doc.mjs +13 -0
  47. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenShowcase.tsx +78 -0
  48. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenStructuralHeading.doc.mjs +14 -0
  49. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenStructuralHeading.tsx +38 -0
  50. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenSupplementaryContext.doc.mjs +14 -0
  51. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenSupplementaryContext.tsx +47 -0
  52. package/templates/pages/theme-showcase/page.tsx +7 -7
  53. package/templates/themes/neutral/neutralTheme.ts +63 -32
@@ -1,7 +1,7 @@
1
1
  // Copyright (c) Meta Platforms, Inc. and affiliates.
2
2
 
3
3
  import {describe, it, expect} from 'vitest';
4
- import {formatFull} from './component-format.mjs';
4
+ import {formatBrief, formatFull} from './component-format.mjs';
5
5
 
6
6
  describe('formatFull sub-component rendering', () => {
7
7
  // Regression guard: sub-components are sometimes declared as a bare
@@ -93,3 +93,97 @@ describe('formatFull theming override keys', () => {
93
93
  expect(out).not.toContain("'astryx-table-cell': {");
94
94
  });
95
95
  });
96
+
97
+ /** Pipes that actually separate cells — a `\|` is content, not a separator. */
98
+ function cellPipes(row) {
99
+ return (row.match(/(?<!\\)\|/g) || []).length;
100
+ }
101
+
102
+ describe('markdown table cells escape their pipes', () => {
103
+ // A prop type is a union, and a union is spelled with `|` — the very
104
+ // character GFM uses to separate cells. Backticks do not protect it: a row
105
+ // with more cells than the header has columns gets its excess *discarded*,
106
+ // so an unescaped `gap: 0 | 0.5 | ...` silently eats its own Default and
107
+ // Description columns. See packages/core/src/Markdown/parser.ts, which
108
+ // splits on unescaped pipes and preserves `\|` as literal.
109
+ it('keeps a union-typed prop row at four cells', () => {
110
+ const docs = {
111
+ name: 'Grid',
112
+ description: 'A grid.',
113
+ props: [
114
+ {
115
+ name: 'gap',
116
+ type: '0 | 0.5 | 1 | 1.5 | 2 | 3 | 4 | 5 | 6 | 8 | 10',
117
+ default: '2',
118
+ description: 'Spacing between all items.',
119
+ },
120
+ ],
121
+ };
122
+ const row = formatFull(docs)
123
+ .split('\n')
124
+ .find(l => l.startsWith('| `gap`'));
125
+
126
+ // A 4-column row has exactly 5 separators. Unescaped, this row had 15.
127
+ expect(cellPipes(row)).toBe(5);
128
+ expect(row).toContain('\\|');
129
+ // The columns the unescaped pipes were swallowing.
130
+ expect(row).toContain('`2`');
131
+ expect(row).toContain('Spacing between all items.');
132
+ });
133
+
134
+ it('escapes pipes in a description too', () => {
135
+ const docs = {
136
+ name: 'AppShell',
137
+ description: 'A shell.',
138
+ props: [
139
+ {
140
+ name: 'mobileNav',
141
+ type: 'ReactNode',
142
+ description: "Config. breakpoint is 'sm' | 'md' | 'lg' | 'none'.",
143
+ },
144
+ ],
145
+ };
146
+ const row = formatFull(docs)
147
+ .split('\n')
148
+ .find(l => l.startsWith('| `mobileNav`'));
149
+
150
+ expect(cellPipes(row)).toBe(5);
151
+ });
152
+ });
153
+
154
+ describe('formatBrief signature stays terse', () => {
155
+ // `--detail brief` exists to be token-cheap. It hoists union-typed props into
156
+ // the signature because a short enum reads at a glance — but an 11-member
157
+ // spacing scale does not, and Stack carries four of them (gap, padding,
158
+ // paddingInline, paddingBlock), so the same scale got printed four times.
159
+ // Long unions stay in the terse prop list, exactly as they did when the type
160
+ // was still the bare name `SpacingStep`.
161
+ it('hoists a short enum but not a long scale', () => {
162
+ const docs = {
163
+ name: 'HStack',
164
+ description: 'A stack.',
165
+ props: [
166
+ {
167
+ name: 'gap',
168
+ type: '0 | 0.5 | 1 | 1.5 | 2 | 3 | 4 | 5 | 6 | 8 | 10',
169
+ description: 'Gap.',
170
+ },
171
+ {name: 'wrap', type: "'nowrap' | 'wrap' | 'wrap-reverse'", description: 'Wrap.'},
172
+ {
173
+ name: 'hAlign',
174
+ type: "'start' | 'center' | 'end' | 'between' | 'around' | 'evenly'",
175
+ description: 'Align.',
176
+ },
177
+ ],
178
+ };
179
+ const signature = formatBrief(docs, 'HStack', '').split('\n')[0];
180
+
181
+ // Short enums still earn their place in the signature.
182
+ expect(signature).toContain('wrap: nowrap|wrap|wrap-reverse');
183
+ expect(signature).toContain('hAlign: start|center|end|between|around|evenly');
184
+ // The long scale does not.
185
+ expect(signature).not.toContain('0|0.5|1|1.5|2|3|4|5|6|8|10');
186
+ // But the prop is still named, so it is not lost.
187
+ expect(formatBrief(docs, 'HStack', '')).toContain('gap');
188
+ });
189
+ });
@@ -5,6 +5,59 @@
5
5
  */
6
6
 
7
7
  import {pathToFileURL} from 'node:url';
8
+ import {importUserModule} from './module-loader.mjs';
9
+ import {formatZodError} from './config-schema.mjs';
10
+ import {ComponentDocSchema} from '../schemas/doc-schema.mjs';
11
+
12
+ /**
13
+ * Load a component doc through the shared load/validation boundary.
14
+ *
15
+ * This is the typed counterpart to {@link loadDocs}: it loads `.doc.ts` via
16
+ * jiti (and `.doc.mjs`/`.doc.js` via native import) and validates against
17
+ * {@link ComponentDocSchema}. That schema accepts BOTH formats, so this loader
18
+ * reads whichever the file uses:
19
+ * - NEW: the factory default export
20
+ * (`export default createComponentDoc({...})` / `createFunctionDoc` /
21
+ * `createDoc`) — the same single-export convention
22
+ * {@link loadModuleWithSchema} uses for config/integration/template. These
23
+ * carry a stamped `type` and validate against the matching per-kind schema.
24
+ * - OLD: the legacy loose `export const docs = {...}` (no `type`), validated
25
+ * against the permissive legacy union.
26
+ * The default export wins when both are present. Throws a readable
27
+ * `formatZodError`-style message on failure. Translations (`docsZh`/
28
+ * `docsDense`) are merged exactly as {@link loadDocs} does so callers see
29
+ * identical output.
30
+ *
31
+ * @param {string} docPath absolute path to a `.doc.{ts,mjs,js}` file
32
+ * @param {{zh?: boolean, dense?: boolean, lang?: string}} [opts]
33
+ * @returns {Promise<object>} the validated (and optionally translated) doc
34
+ */
35
+ export async function loadComponentDoc(
36
+ docPath,
37
+ {zh = false, dense = false, lang} = {},
38
+ ) {
39
+ const mod = await importUserModule(docPath);
40
+ const authored = mod?.default ?? mod?.docs;
41
+
42
+ const result = ComponentDocSchema.safeParse(authored);
43
+ if (!result.success) {
44
+ throw new Error(formatZodError(docPath, result.error));
45
+ }
46
+ const docs = authored;
47
+
48
+ const locale = lang || (dense ? 'dense' : zh ? 'zh' : null);
49
+ if (!locale) return docs;
50
+
51
+ const translationKey =
52
+ locale === 'zh' ? 'docsZh' : locale === 'dense' ? 'docsDense' : null;
53
+ if (!translationKey || !mod[translationKey]) return docs;
54
+
55
+ const translation = mod[translationKey];
56
+ if (translation.props || translation.components?.some(c => c.props)) {
57
+ return translation;
58
+ }
59
+ return mergeTranslation(docs, translation);
60
+ }
8
61
 
9
62
  export function mergeTranslation(docs, translation) {
10
63
  if (!translation) return docs;
@@ -91,15 +144,64 @@ export async function loadDocs(readmePath, {zh = false, dense = false, lang} = {
91
144
 
92
145
  const translation = mod[translationKey];
93
146
 
94
- // If the translation is a full ComponentDoc (legacy docsZh shape), return it directly
147
+ // A full ComponentDoc-shaped translation (legacy docsZh shape) used to be
148
+ // returned wholesale. That made it a REPLACEMENT, not an overlay: any prop
149
+ // the translation had not caught up with simply ceased to exist —
150
+ // `component Button --zh` silently omitted `isInterruptible` and
151
+ // `isIconOnly`. A reader of the translated docs cannot discover a prop that
152
+ // is not there. Overlay it instead, so an untranslated prop falls back to
153
+ // its English entry. (Same principle as the reference-doc overlays, #2182.)
95
154
  if (translation.props || translation.components?.some(c => c.props)) {
96
- return translation;
155
+ return overlayComponentDoc(docs, translation);
97
156
  }
98
157
 
99
158
  // Otherwise it's a TranslationDoc — merge it onto docs
100
159
  return mergeTranslation(docs, translation);
101
160
  }
102
161
 
162
+ /**
163
+ * Overlay a full-ComponentDoc-shaped translation onto the English doc.
164
+ *
165
+ * Base order and completeness win; the translation supplies text for the
166
+ * entries it covers. Props are matched by name, never by position, so a
167
+ * translation that is missing entries (or lists them in another order) can no
168
+ * longer drop or misattribute one.
169
+ *
170
+ * @param {any} docs Base (English) component doc.
171
+ * @param {any} translation Translated doc, possibly covering only some props.
172
+ * @returns {any} Merged doc with every base prop present.
173
+ */
174
+ function overlayComponentDoc(docs, translation) {
175
+ /** Merge one prop list: keep base entries and order, translate what's covered. */
176
+ const overlayProps = (baseProps, tProps) => {
177
+ if (!baseProps) return baseProps;
178
+ const byName = new Map((tProps ?? []).map(p => [p.name, p]));
179
+ return baseProps.map(prop => {
180
+ const t = byName.get(prop.name);
181
+ // Take the translated text, but never let it drop the prop's contract
182
+ // (type/default/required stay authoritative from the English doc).
183
+ return t ? {...prop, ...t, name: prop.name, type: prop.type} : prop;
184
+ });
185
+ };
186
+
187
+ const merged = {...docs, ...translation};
188
+
189
+ merged.props = overlayProps(docs.props, translation.props);
190
+
191
+ if (docs.components) {
192
+ const tByName = new Map(
193
+ (translation.components ?? []).map(c => [c.name, c]),
194
+ );
195
+ merged.components = docs.components.map(base => {
196
+ const t = tByName.get(base.name);
197
+ if (!t) return base;
198
+ return {...base, ...t, props: overlayProps(base.props, t.props)};
199
+ });
200
+ }
201
+
202
+ return merged;
203
+ }
204
+
103
205
  /**
104
206
  * Find the doc file for a component, checking both top-level
105
207
  * and nested directories. Prefers {Name}.doc.mjs, then README.md
@@ -0,0 +1,111 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /**
4
+ * @file Guards translated/compressed component docs against dropping props.
5
+ * @input packages/core/src/{Name}/{Name}.doc.mjs — its `docs`, `docsZh`, `docsDense`.
6
+ * @output Vitest failures naming every prop that exists in `docs` but vanishes
7
+ * from a translated view.
8
+ * @position Regression gate for component-loader.mjs.
9
+ *
10
+ * A `docsZh` that carries its own `props` array used to REPLACE the base doc
11
+ * wholesale, so any prop the translation had not caught up with simply ceased
12
+ * to exist: `astryx component Button --zh` silently omitted `isInterruptible`
13
+ * and `isIconOnly`. A reader of the translated docs cannot discover a prop that
14
+ * is not there, and CLAUDE.md tells every AI agent to read these docs.
15
+ *
16
+ * Translations are now an overlay: a prop the translation does not cover falls
17
+ * back to its English entry rather than disappearing. Same principle as the
18
+ * reference-doc overlays in #2182 — an overlay covering a subset must not
19
+ * destroy what it does not cover.
20
+ */
21
+
22
+ import {describe, it, expect} from 'vitest';
23
+ import * as fs from 'node:fs';
24
+ import * as path from 'node:path';
25
+ import {pathToFileURL} from 'node:url';
26
+ import {loadDocs} from './component-loader.mjs';
27
+
28
+ const CORE_SRC = path.join(
29
+ import.meta.dirname,
30
+ '..',
31
+ '..',
32
+ '..',
33
+ 'core',
34
+ 'src',
35
+ );
36
+
37
+ /** Component dirs that ship a doc file. */
38
+ function componentDocs() {
39
+ const out = [];
40
+ for (const dir of fs.readdirSync(CORE_SRC)) {
41
+ const docPath = path.join(CORE_SRC, dir, `${dir}.doc.mjs`);
42
+ if (!fs.existsSync(docPath)) continue;
43
+ if (!fs.readdirSync(path.join(CORE_SRC, dir)).includes(`${dir}.doc.mjs`)) {
44
+ continue; // case-exact match only
45
+ }
46
+ out.push({name: dir, docPath});
47
+ }
48
+ return out;
49
+ }
50
+
51
+ /** Prop names on a doc, across single- and multi-component shapes. */
52
+ function propNames(doc) {
53
+ const names = new Set();
54
+ for (const p of doc?.props ?? []) names.add(p.name);
55
+ for (const c of doc?.components ?? []) {
56
+ for (const p of c.props ?? []) names.add(`${c.name ?? '?'}.${p.name}`);
57
+ }
58
+ return names;
59
+ }
60
+
61
+ describe('translated component docs never drop a prop', () => {
62
+ const comps = componentDocs();
63
+
64
+ it('finds component docs to check', () => {
65
+ expect(comps.length).toBeGreaterThan(0);
66
+ });
67
+
68
+ for (const {name, docPath} of comps) {
69
+ for (const locale of ['zh', 'dense']) {
70
+ it(`${name} --${locale}: documents every prop the English doc documents`, async () => {
71
+ const mod = await import(pathToFileURL(docPath).href);
72
+ const key = locale === 'zh' ? 'docsZh' : 'docsDense';
73
+ if (!mod[key]) return; // no overlay, nothing to drift
74
+
75
+ const english = propNames(mod.docs);
76
+ const translated = propNames(
77
+ await loadDocs(docPath, {[locale]: true}),
78
+ );
79
+
80
+ const dropped = [...english].filter(p => !translated.has(p));
81
+ expect(
82
+ dropped,
83
+ `${name}.doc.mjs ${key} drops ${dropped.length} prop(s) from the ` +
84
+ `--${locale} view: ${dropped.join(', ')}. A reader of the ` +
85
+ `translated docs cannot discover a prop that is not there. An ` +
86
+ `untranslated prop must fall back to its English entry, not vanish.`,
87
+ ).toEqual([]);
88
+ });
89
+ }
90
+ }
91
+ });
92
+
93
+ describe('the reported symptom', () => {
94
+ it('astryx component Button --zh still lists isInterruptible and isIconOnly', async () => {
95
+ const docPath = path.join(CORE_SRC, 'Button', 'Button.doc.mjs');
96
+ const zh = await loadDocs(docPath, {zh: true});
97
+ const names = propNames(zh);
98
+ expect(names.has('isInterruptible')).toBe(true);
99
+ expect(names.has('isIconOnly')).toBe(true);
100
+ });
101
+
102
+ it('keeps the translated descriptions it does have', async () => {
103
+ const docPath = path.join(CORE_SRC, 'Button', 'Button.doc.mjs');
104
+ const mod = await import(pathToFileURL(docPath).href);
105
+ const zh = await loadDocs(docPath, {zh: true});
106
+
107
+ const translated = mod.docsZh.props.find(p => p.name === 'variant');
108
+ const merged = zh.props.find(p => p.name === 'variant');
109
+ expect(merged.description).toBe(translated.description);
110
+ });
111
+ });
@@ -73,33 +73,3 @@ export function formatZodError(label, error) {
73
73
  .join('; ');
74
74
  return `${label} is invalid: ${issues}`;
75
75
  }
76
-
77
- /**
78
- * @param {unknown} config
79
- * @returns {import('../types/config').AstryxConfig}
80
- */
81
- export function validateConfig(config) {
82
- const result = AstryxConfigSchema.safeParse(config);
83
- if (!result.success) {
84
- throw new Error(
85
- formatZodError('astryx.config default export', result.error),
86
- );
87
- }
88
- return result.data;
89
- }
90
-
91
- /**
92
- * @param {unknown} integration
93
- * @param {string} [label]
94
- * @returns {import('../types/integration').AstryxIntegration}
95
- */
96
- export function validateIntegration(
97
- integration,
98
- label = 'integration manifest',
99
- ) {
100
- const result = AstryxIntegrationSchema.safeParse(integration);
101
- if (!result.success) {
102
- throw new Error(formatZodError(label, result.error));
103
- }
104
- return result.data;
105
- }
@@ -11,6 +11,7 @@
11
11
 
12
12
  import {discoverHooks, findHookDoc} from './hook-discovery.mjs';
13
13
  import {loadDocs} from './component-loader.mjs';
14
+ import {mdCell} from './component-format.mjs';
14
15
 
15
16
  /**
16
17
  * Build a signature string from hook docs.
@@ -51,9 +52,11 @@ function formatParamsTable(params) {
51
52
  lines.push('| Param | Type | Default | Description |');
52
53
  lines.push('|-------|------|---------|-------------|');
53
54
  for (const p of params) {
54
- const def = p.default ? `\`${p.default}\`` : '\u2014';
55
+ const def = p.default ? `\`${mdCell(p.default)}\`` : '\u2014';
55
56
  const req = p.required ? ' **(required)**' : '';
56
- lines.push(`| \`${p.name}\` | \`${p.type}\` | ${def} | ${p.description}${req} |`);
57
+ lines.push(
58
+ `| \`${mdCell(p.name)}\` | \`${mdCell(p.type)}\` | ${def} | ${mdCell(p.description)}${req} |`,
59
+ );
57
60
  }
58
61
  return lines.join('\n');
59
62
  }
@@ -67,7 +70,9 @@ function formatReturnsTable(returns) {
67
70
  lines.push('| Field | Type | Description |');
68
71
  lines.push('|-------|------|-------------|');
69
72
  for (const r of returns) {
70
- lines.push(`| \`${r.name}\` | \`${r.type}\` | ${r.description} |`);
73
+ lines.push(
74
+ `| \`${mdCell(r.name)}\` | \`${mdCell(r.type)}\` | ${mdCell(r.description)} |`,
75
+ );
71
76
  }
72
77
  return lines.join('\n');
73
78
  }
@@ -230,8 +230,3 @@ export async function buildRegistry({cwd = process.cwd()} = {}) {
230
230
  };
231
231
  return cachedRegistry;
232
232
  }
233
-
234
- /** Test seam — drop the module-level cache. */
235
- export function resetRegistryCache() {
236
- cachedRegistry = null;
237
- }
@@ -0,0 +1,226 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /**
4
+ * @file Doc load-boundary schemas.
5
+ *
6
+ * The Zod schemas doc discovery runs a loaded doc value through (see
7
+ * `loadComponentDoc`). {@link ComponentDocSchema} accepts BOTH the new stamped
8
+ * formats and the legacy loose `export const docs = {...}` shape, so existing
9
+ * docs keep loading unchanged. Kept free of any `@astryxdesign/core` import so
10
+ * the hot path that loads them (doc discovery, `astryx init`) does not require
11
+ * core's built `dist/`. The authoring factories live in
12
+ * `@astryxdesign/core/authoring` and are re-exported from `../doc.mjs` for the
13
+ * public `@astryxdesign/cli/doc` surface.
14
+ */
15
+
16
+ import {z} from 'zod';
17
+
18
+ /**
19
+ * A single documented prop. Mirrors `PropDoc` from
20
+ * `@astryxdesign/core/docs-types`. Only `name`, `type`, and `description` are
21
+ * required; everything else is optional. Extra fields (e.g. `slotElements`)
22
+ * pass through so the schema does not have to track every evolution of the
23
+ * rich playground/element surface.
24
+ */
25
+ const PropSchema = z
26
+ .object({
27
+ name: z.string().min(1, 'prop name is required'),
28
+ type: z.string().min(1, 'prop type is required'),
29
+ description: z.string(),
30
+ default: z.string().optional(),
31
+ required: z.boolean().optional(),
32
+ })
33
+ .passthrough();
34
+
35
+ /** A single documented function/hook parameter (mirrors `HookParamDoc`). */
36
+ const ParamSchema = z
37
+ .object({
38
+ name: z.string().min(1, 'param name is required'),
39
+ type: z.string().min(1, 'param type is required'),
40
+ description: z.string(),
41
+ default: z.string().optional(),
42
+ required: z.boolean().optional(),
43
+ })
44
+ .passthrough();
45
+
46
+ /** A single documented function/hook return field (mirrors `HookReturnDoc`). */
47
+ const ReturnSchema = z
48
+ .object({
49
+ name: z.string().min(1, 'return name is required'),
50
+ type: z.string().min(1, 'return type is required'),
51
+ description: z.string(),
52
+ })
53
+ .passthrough();
54
+
55
+ /**
56
+ * Fields shared by every doc kind. Deliberately permissive on the rich blobs
57
+ * (usage/theming/playground) — those are large and still evolving, so they are
58
+ * `z.unknown()` passthrough rather than enumerated.
59
+ *
60
+ * `group` vs `parent` are distinct concepts and intentionally separate fields:
61
+ * - `group` is a FLAT sidebar bucket label. Many docs can share a group; it
62
+ * is not an inheritance key.
63
+ * - `parent` is a DIRECTED inheritance/composition pointer — a doc naming the
64
+ * doc it belongs to (e.g. a sub-component naming its parent component). The
65
+ * legacy `subComponentOf` field is a synonym; both map to the same concept.
66
+ *
67
+ * `relatedDocs` is a single flat curated cross-reference list. It replaces the
68
+ * legacy split `relatedComponents` + `relatedHooks`; a downstream reader can
69
+ * merge the legacy pair into it.
70
+ */
71
+ const BaseDocFields = {
72
+ /** Name of the documented unit, without any prefix. Required. */
73
+ name: z.string().min(1, 'name is required'),
74
+ /** Human-readable display name for gallery/sidebar. */
75
+ displayName: z.string().optional(),
76
+ /** One-line/short description. */
77
+ description: z.string().optional(),
78
+ /** Usage documentation (description, best practices, anatomy, slotElements). */
79
+ usage: z.unknown().optional(),
80
+ /** Flat sidebar grouping label (not an inheritance key). */
81
+ group: z.string().optional(),
82
+ /** Overview-page functional category. */
83
+ category: z.string().optional(),
84
+ /** CLI fuzzy-search keywords. */
85
+ keywords: z.array(z.string()).optional(),
86
+ /** Directed inheritance/composition pointer to the doc this belongs to. */
87
+ parent: z.string().optional(),
88
+ /** Flat curated cross-reference list of related doc names. */
89
+ relatedDocs: z.array(z.string()).optional(),
90
+ /** Hide the whole doc from human-facing UI (stays importable/discoverable). */
91
+ hidden: z.boolean().optional(),
92
+ /** Exclude from the categorized overview page (kept in sidebar/CLI). */
93
+ isHiddenFromOverview: z.boolean().optional(),
94
+ };
95
+
96
+ /**
97
+ * New-format schema for a stamped component doc (`type: 'component'`). The
98
+ * top-level component keys are enumerated, but nested blobs stay loose so real
99
+ * docs are not rejected. `.passthrough()` keeps unknown top-level fields
100
+ * (translations, element descriptors, ...) flowing through.
101
+ */
102
+ export const ComponentDocKindSchema = z
103
+ .object({
104
+ ...BaseDocFields,
105
+ type: z.literal('component'),
106
+ props: z.array(PropSchema),
107
+ theming: z.unknown().optional(),
108
+ playground: z.unknown().optional(),
109
+ examples: z.array(z.unknown()).optional(),
110
+ })
111
+ .passthrough();
112
+
113
+ /**
114
+ * New-format schema for a stamped function doc (`type: 'function'`). Covers any
115
+ * function, including hooks: an inputs (`params`) + outputs (`returns`) surface.
116
+ */
117
+ export const FunctionDocKindSchema = z
118
+ .object({
119
+ ...BaseDocFields,
120
+ type: z.literal('function'),
121
+ params: z.array(ParamSchema),
122
+ returns: z.array(ReturnSchema),
123
+ })
124
+ .passthrough();
125
+
126
+ /**
127
+ * New-format schema for a stamped generic doc (`type: 'generic'`) — reference
128
+ * and topic docs. Just the shared base plus the discriminant.
129
+ */
130
+ export const GenericDocKindSchema = z
131
+ .object({
132
+ ...BaseDocFields,
133
+ type: z.literal('generic'),
134
+ })
135
+ .passthrough();
136
+
137
+ /**
138
+ * The stamped-doc contract: one of the three new per-kind schemas, discriminated
139
+ * by the injected `type`. Used when a loaded doc carries a `type` field.
140
+ */
141
+ export const StampedDocSchema = z.discriminatedUnion('type', [
142
+ ComponentDocKindSchema,
143
+ FunctionDocKindSchema,
144
+ GenericDocKindSchema,
145
+ ]);
146
+
147
+ // ── Legacy loose format (unchanged, kept for back-compat) ─────────────
148
+ //
149
+ // The pre-factory docs are authored as a loose, untyped object with no `type`
150
+ // discriminant and validated by shape. Enumerated top-level fields observed
151
+ // across the existing loose docs:
152
+ // name, displayName, description, group, category, keywords,
153
+ // isHiddenFromOverview, hidden, hiddenComponents, usage, props, components,
154
+ // subComponentOf, playground, theming, examples, params, returns,
155
+ // relatedComponents, relatedHooks, relatedDocs, parent, importPath.
156
+
157
+ const LegacyBaseDocSchema = z.object({
158
+ name: z.string().min(1, 'name is required'),
159
+ displayName: z.string().optional(),
160
+ description: z.string().optional(),
161
+ group: z.string().optional(),
162
+ category: z.string().optional(),
163
+ keywords: z.array(z.string()).optional(),
164
+ isHiddenFromOverview: z.boolean().optional(),
165
+ hidden: z.boolean().optional(),
166
+ hiddenComponents: z.array(z.string()).optional(),
167
+ usage: z.unknown().optional(),
168
+ playground: z.unknown().optional(),
169
+ theming: z.unknown().optional(),
170
+ examples: z.array(z.unknown()).optional(),
171
+ showcase: z.unknown().optional(),
172
+ // `parent` and legacy `subComponentOf` are synonyms; both accepted here so a
173
+ // parent-based doc that omits a stamped `type` still validates.
174
+ parent: z.string().optional(),
175
+ relatedDocs: z.array(z.string()).optional(),
176
+ relatedComponents: z.array(z.string()).optional(),
177
+ relatedHooks: z.array(z.string()).optional(),
178
+ });
179
+
180
+ /** Legacy: directory exporting a single primary component (props inline). */
181
+ const LegacySingleComponentDocSchema = LegacyBaseDocSchema.extend({
182
+ props: z.array(PropSchema),
183
+ }).passthrough();
184
+
185
+ /** Legacy: directory exporting multiple components (props on each entry). */
186
+ const LegacyMultiComponentDocSchema = LegacyBaseDocSchema.extend({
187
+ components: z.array(z.unknown()),
188
+ }).passthrough();
189
+
190
+ /** Legacy: a standalone hook doc — inputs (`params`) + outputs (`returns`). */
191
+ const LegacyHookDocSchema = LegacyBaseDocSchema.extend({
192
+ params: z.array(ParamSchema),
193
+ returns: z.array(ReturnSchema),
194
+ }).passthrough();
195
+
196
+ /** Legacy: a sub-component doc parented via `subComponentOf`. */
197
+ const LegacySubComponentDocSchema = LegacyBaseDocSchema.extend({
198
+ subComponentOf: z.string().min(1, 'subComponentOf is required'),
199
+ description: z.string(),
200
+ props: z.array(PropSchema),
201
+ }).passthrough();
202
+
203
+ /**
204
+ * The permissive legacy union. `subComponentOf` is listed first so a doc that
205
+ * carries both `subComponentOf` and `props` is validated as a sub-component
206
+ * (the more specific shape); hook (`params`/`returns`) before multi/single.
207
+ */
208
+ export const LegacyDocSchema = z.union([
209
+ LegacySubComponentDocSchema,
210
+ LegacyHookDocSchema,
211
+ LegacyMultiComponentDocSchema,
212
+ LegacySingleComponentDocSchema,
213
+ ]);
214
+
215
+ /**
216
+ * The LOAD-boundary contract for a doc. Handles BOTH formats:
217
+ * - NEW: a stamped doc (`type: 'component' | 'function' | 'generic'`,
218
+ * produced by the factories) is validated against the matching per-kind
219
+ * schema in {@link StampedDocSchema}.
220
+ * - OLD: a loose, unstamped doc is validated against the permissive
221
+ * {@link LegacyDocSchema} union (the three legacy shapes + standalone hook).
222
+ *
223
+ * Discovery validates the SHAPE, not "was it made by the factory". Both formats
224
+ * normalize into the same internal shape consumers already expect.
225
+ */
226
+ export const ComponentDocSchema = z.union([StampedDocSchema, LegacyDocSchema]);