@astryxdesign/cli 0.1.6-canary.2e2e960 → 0.1.6-canary.30b6a8c

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 (44) hide show
  1. package/package.json +9 -13
  2. package/src/api/template.mjs +28 -104
  3. package/src/api/validate-integration.mjs +8 -0
  4. package/src/config.mjs +14 -5
  5. package/src/integration.mjs +15 -4
  6. package/src/lib/component-discovery.mjs +5 -15
  7. package/src/lib/component-loader.mjs +0 -53
  8. package/src/lib/config-schema.mjs +30 -0
  9. package/src/lib/xle/registry.mjs +5 -0
  10. package/src/template.mjs +67 -9
  11. package/src/types/config.d.ts +66 -11
  12. package/src/types/integration.d.ts +18 -7
  13. package/src/types/template-api.d.ts +50 -14
  14. package/templates/blocks/components/Avatar/AvatarGroup.tsx +7 -5
  15. package/templates/blocks/components/Avatar/AvatarShowcase.tsx +6 -4
  16. package/templates/blocks/components/Avatar/AvatarUserCard.tsx +5 -3
  17. package/templates/blocks/components/Avatar/AvatarWithImage.tsx +6 -8
  18. package/templates/blocks/components/Avatar/AvatarWithStatus.tsx +5 -3
  19. package/templates/blocks/components/ChatComposerInput/ChatComposerInputControlledInput.tsx +1 -1
  20. package/templates/blocks/components/ChatComposerInput/ChatComposerInputDisabled.tsx +1 -1
  21. package/templates/blocks/components/ChatComposerInput/ChatComposerInputMentionTrigger.tsx +1 -1
  22. package/templates/blocks/components/ChatComposerInput/ChatComposerInputMultipleTriggers.tsx +1 -1
  23. package/templates/blocks/components/ChatComposerInput/ChatComposerInputShowcase.tsx +1 -1
  24. package/templates/blocks/components/ChatComposerInput/ChatComposerInputSlashCommands.tsx +1 -1
  25. package/templates/pages/theme-showcase/page.tsx +7 -7
  26. package/templates/themes/neutral/neutralTheme.ts +32 -63
  27. package/docs/integration-authoring.md +0 -105
  28. package/docs/internationalization.doc.mjs +0 -243
  29. package/src/api/integration-block-exports.test.mjs +0 -240
  30. package/src/api/template-suffix.test.mjs +0 -246
  31. package/src/doc.mjs +0 -27
  32. package/src/doc.test.mjs +0 -383
  33. package/src/lib/component-discovery.importpath.test.mjs +0 -59
  34. package/src/schemas/doc-schema.mjs +0 -226
  35. package/src/schemas/template-schema.mjs +0 -47
  36. package/src/types/doc.d.ts +0 -23
  37. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenLiveRegion.doc.mjs +0 -14
  38. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenLiveRegion.tsx +0 -41
  39. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenShowcase.doc.mjs +0 -13
  40. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenShowcase.tsx +0 -78
  41. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenStructuralHeading.doc.mjs +0 -14
  42. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenStructuralHeading.tsx +0 -38
  43. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenSupplementaryContext.doc.mjs +0 -14
  44. package/templates/blocks/components/VisuallyHidden/VisuallyHiddenSupplementaryContext.tsx +0 -47
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@astryxdesign/cli",
3
- "version": "0.1.6-canary.2e2e960",
3
+ "version": "0.1.6-canary.30b6a8c",
4
4
  "displayName": "CLI",
5
5
  "description": "Scaffold projects, browse templates, generate themes, and get agent-ready docs from the command line.",
6
6
  "author": "Meta Open Source",
@@ -47,10 +47,6 @@
47
47
  "types": "./src/types/integration.d.ts",
48
48
  "import": "./src/integration.mjs"
49
49
  },
50
- "./doc": {
51
- "types": "./src/types/doc.d.ts",
52
- "import": "./src/doc.mjs"
53
- },
54
50
  "./template": {
55
51
  "types": "./src/types/template-api.d.ts",
56
52
  "import": "./src/template.mjs"
@@ -79,10 +75,10 @@
79
75
  "zod": "^4.4.3"
80
76
  },
81
77
  "peerDependencies": {
82
- "@astryxdesign/charts": "0.1.6-canary.2e2e960",
83
- "@astryxdesign/core": "0.1.6-canary.2e2e960",
84
- "@astryxdesign/lab": "0.1.6-canary.2e2e960",
85
- "@astryxdesign/theme-neutral": "0.1.6-canary.2e2e960",
78
+ "@astryxdesign/charts": "0.1.6-canary.30b6a8c",
79
+ "@astryxdesign/core": "0.1.6-canary.30b6a8c",
80
+ "@astryxdesign/lab": "0.1.6-canary.30b6a8c",
81
+ "@astryxdesign/theme-neutral": "0.1.6-canary.30b6a8c",
86
82
  "gpt-tokenizer": "^3.4.0"
87
83
  },
88
84
  "peerDependenciesMeta": {
@@ -100,10 +96,10 @@
100
96
  }
101
97
  },
102
98
  "devDependencies": {
103
- "@astryxdesign/charts": "0.1.6-canary.2e2e960",
104
- "@astryxdesign/core": "0.1.6-canary.2e2e960",
105
- "@astryxdesign/lab": "0.1.6-canary.2e2e960",
106
- "@astryxdesign/theme-neutral": "0.1.6-canary.2e2e960",
99
+ "@astryxdesign/charts": "0.1.6-canary.30b6a8c",
100
+ "@astryxdesign/core": "0.1.6-canary.30b6a8c",
101
+ "@astryxdesign/lab": "0.1.6-canary.30b6a8c",
102
+ "@astryxdesign/theme-neutral": "0.1.6-canary.30b6a8c",
107
103
  "gpt-tokenizer": "^3.4.0"
108
104
  },
109
105
  "scripts": {
@@ -6,9 +6,8 @@
6
6
 
7
7
  import * as fs from 'node:fs';
8
8
  import * as path from 'node:path';
9
- import {createJiti} from 'jiti';
10
9
  import {loadModuleWithSchema} from '../lib/module-loader.mjs';
11
- import {TemplateEnvelopeSchema} from '../schemas/template-schema.mjs';
10
+ import {TemplateEnvelopeSchema} from '../template.mjs';
12
11
  import {CLI_ROOT, discoverExternalPackages} from '../utils/paths.mjs';
13
12
  import {
14
13
  assertWithin,
@@ -22,54 +21,9 @@ import {Project} from '../lib/project.mjs';
22
21
  /** Identity used for core (built-in) templates in package-scoped listings. */
23
22
  const CORE_PACKAGE = '@astryxdesign/core';
24
23
 
25
- /**
26
- * Canonical basename suffixes for template-spec files, in precedence order.
27
- * A template spec exports a `createBlockTemplate`/`createPageTemplate` result
28
- * (a scaffoldable TEMPLATE), so `.template.*` is the descriptive family name.
29
- */
30
- const TEMPLATE_SUFFIXES = ['.template.ts', '.template.mjs', '.template.js'];
31
-
32
- /**
33
- * Legacy basename suffixes for template-spec files, in precedence order.
34
- * `.doc.*` was inherited from the component-doc convention before templates
35
- * had their own name; it is still accepted during the transition window.
36
- */
24
+ /** Doc-file basename suffixes for integration templates, in precedence order. */
37
25
  const DOC_SUFFIXES = ['.doc.ts', '.doc.mjs', '.doc.js'];
38
26
 
39
- /**
40
- * The union of canonical + legacy template-spec suffixes, canonical first so
41
- * `.template.*` wins over `.doc.*` when both stems exist. All template
42
- * discovery matches this union so a `Foo.template.ts` file is treated exactly
43
- * like a legacy `Foo.doc.mjs`.
44
- */
45
- const ALL_TEMPLATE_SUFFIXES = [...TEMPLATE_SUFFIXES, ...DOC_SUFFIXES];
46
-
47
- /**
48
- * The template-spec suffix present on `file`, or null if none matches.
49
- * Recognizes both the canonical `.template.*` and legacy `.doc.*` families.
50
- * @param {string} file
51
- * @returns {string | null}
52
- */
53
- function matchedTemplateSuffix(file) {
54
- return ALL_TEMPLATE_SUFFIXES.find(suffix => file.endsWith(suffix)) ?? null;
55
- }
56
-
57
- /**
58
- * RegExp matching either template-spec suffix family at end of a basename.
59
- * Used where a per-file regex is convenient (e.g. block discovery walks).
60
- */
61
- const TEMPLATE_SUFFIX_RE = /\.(template|doc)\.(ts|mjs|js)$/;
62
-
63
- let jitiInstance;
64
- /** Lazily-created jiti for loading `.ts` template specs (JSX-capable). */
65
- function getJiti() {
66
- if (!jitiInstance) {
67
- jitiInstance = createJiti(import.meta.url, {jsx: true});
68
- }
69
- return jitiInstance;
70
- }
71
-
72
-
73
27
  /**
74
28
  * Load an integration template doc module and validate it against the template
75
29
  * envelope at the load boundary. Default export only — `.ts` via jiti,
@@ -133,29 +87,12 @@ export function stripTemplateAssetRefs(source) {
133
87
  source,
134
88
  );
135
89
  }
136
- /**
137
- * Load a template-spec module and return its metadata object. Supports both
138
- * families of suffix:
139
- * - Legacy `.doc.*` core/external specs export `export const doc = {...}`.
140
- * - Specs authored with `createPageTemplate`/`createBlockTemplate` export the
141
- * stamped object as the default export.
142
- * Prefers the default export, falling back to the named `doc` export, so a
143
- * `Foo.template.ts` (default export) is read identically to a legacy
144
- * `Foo.doc.mjs` (`doc` export). `.ts` is loaded via jiti; `.mjs`/`.js` via a
145
- * native dynamic import. Returns null if the file does not exist.
146
- *
147
- * @param {string} docPath absolute path to the spec file
148
- * @returns {Promise<Record<string, unknown> | undefined | null>}
149
- */
150
90
  async function loadDocModule(docPath) {
151
91
  if (!fs.existsSync(docPath)) return null;
152
- const docModule = docPath.endsWith('.ts')
153
- ? await getJiti().import(docPath)
154
- : await import(`file://${docPath}`);
155
- return docModule.default ?? docModule.doc;
92
+ const docModule = await import(`file://${docPath}`);
93
+ return docModule.doc;
156
94
  }
157
95
 
158
-
159
96
  export {discoverAll as discoverTemplates};
160
97
 
161
98
  export function listTemplates() {
@@ -185,20 +122,6 @@ function findDocFiles(dir, pattern) {
185
122
  return results;
186
123
  }
187
124
 
188
- /**
189
- * Resolve the template-spec file for a core page directory: the first existing
190
- * `template.<suffix>` in canonical-then-legacy precedence, or null.
191
- * @param {string} dirPath
192
- * @returns {string | null}
193
- */
194
- function findPageDocFile(dirPath) {
195
- for (const suffix of ALL_TEMPLATE_SUFFIXES) {
196
- const candidate = path.join(dirPath, `template${suffix}`);
197
- if (fs.existsSync(candidate)) return candidate;
198
- }
199
- return null;
200
- }
201
-
202
125
  async function discoverPages() {
203
126
  if (!fs.existsSync(PAGES_DIR)) return [];
204
127
  const dirs = fs
@@ -208,9 +131,7 @@ async function discoverPages() {
208
131
  const templates = [];
209
132
  for (const dir of dirs) {
210
133
  const dirPath = path.join(PAGES_DIR, dir.name);
211
- const docPath =
212
- findPageDocFile(dirPath) ?? path.join(dirPath, 'template.doc.mjs');
213
- const doc = await loadDocModule(docPath);
134
+ const doc = await loadDocModule(path.join(dirPath, 'template.doc.mjs'));
214
135
  templates.push({
215
136
  type: 'page',
216
137
  dirName: dir.name,
@@ -220,18 +141,17 @@ async function discoverPages() {
220
141
  isReady: doc?.isReady ?? true,
221
142
  scaffold: doc?.scaffold ?? false,
222
143
  filePath: path.join(dirPath, 'page.tsx'),
223
- docPath,
144
+ docPath: path.join(dirPath, 'template.doc.mjs'),
224
145
  });
225
146
  }
226
147
  return templates;
227
148
  }
228
149
 
229
150
  async function discoverBlocks() {
230
- const docFiles = findDocFiles(BLOCKS_DIR, TEMPLATE_SUFFIX_RE);
151
+ const docFiles = findDocFiles(BLOCKS_DIR, /\.doc\.mjs$/);
231
152
  const blocks = [];
232
153
  for (const docPath of docFiles) {
233
- const suffix = matchedTemplateSuffix(docPath);
234
- const basename = path.basename(docPath, suffix);
154
+ const basename = path.basename(docPath, '.doc.mjs');
235
155
  const tsxPath = path.join(path.dirname(docPath), basename + '.tsx');
236
156
  if (!fs.existsSync(tsxPath)) continue;
237
157
  const doc = await loadDocModule(docPath);
@@ -253,7 +173,6 @@ async function discoverBlocks() {
253
173
  return blocks;
254
174
  }
255
175
 
256
-
257
176
  /**
258
177
  * Discover blocks from external packages that declare `astryx.blocks` in
259
178
  * their package.json. Same shape as discoverBlocks() output.
@@ -266,10 +185,9 @@ async function discoverExternalBlocks(cwd = process.cwd()) {
266
185
 
267
186
  for (const ext of externals) {
268
187
  if (!ext.blocksDir || !fs.existsSync(ext.blocksDir)) continue;
269
- const docFiles = findDocFiles(ext.blocksDir, TEMPLATE_SUFFIX_RE);
188
+ const docFiles = findDocFiles(ext.blocksDir, /\.doc\.mjs$/);
270
189
  for (const docPath of docFiles) {
271
- const suffix = matchedTemplateSuffix(docPath);
272
- const basename = path.basename(docPath, suffix);
190
+ const basename = path.basename(docPath, '.doc.mjs');
273
191
  const tsxPath = path.join(path.dirname(docPath), basename + '.tsx');
274
192
  if (!fs.existsSync(tsxPath)) continue;
275
193
  const doc = await loadDocModule(docPath);
@@ -340,9 +258,8 @@ async function discoverAllWithErrors(cwd = process.cwd()) {
340
258
  export {discoverAllWithErrors};
341
259
 
342
260
  /**
343
- * Recursively collect integration template-spec files under `root`.
344
- * Returns absolute paths to files ending in one of ALL_TEMPLATE_SUFFIXES
345
- * (canonical `.template.*` or legacy `.doc.*`).
261
+ * Recursively collect integration template doc files under `root`.
262
+ * Returns absolute paths to files ending in one of DOC_SUFFIXES.
346
263
  *
347
264
  * @param {string} root
348
265
  * @returns {string[]}
@@ -355,7 +272,7 @@ function findIntegrationDocFiles(root) {
355
272
  const full = path.join(dir, entry.name);
356
273
  if (entry.isDirectory()) {
357
274
  walk(full);
358
- } else if (ALL_TEMPLATE_SUFFIXES.some(suffix => entry.name.endsWith(suffix))) {
275
+ } else if (DOC_SUFFIXES.some(suffix => entry.name.endsWith(suffix))) {
359
276
  results.push(full);
360
277
  }
361
278
  }
@@ -364,17 +281,24 @@ function findIntegrationDocFiles(root) {
364
281
  return results;
365
282
  }
366
283
 
284
+ /**
285
+ * The doc-file suffix present on `file`, or null if none matches.
286
+ * @param {string} file
287
+ */
288
+ function matchedDocSuffix(file) {
289
+ return DOC_SUFFIXES.find(suffix => file.endsWith(suffix)) ?? null;
290
+ }
291
+
367
292
  /**
368
293
  * Discover templates contributed by configured integrations.
369
294
  *
370
295
  * For each integration with a resolved `templates` root, every
371
- * `<id>.template.{ts,mjs,js}` (or legacy `<id>.doc.{ts,mjs,js}`) file is a
372
- * template whose id is its path relative to the templates root with the
373
- * matched suffix stripped (kebab-case, may be nested). The doc's `type`
374
- * (page|block) decides scaffolding — there is no `/pages` vs `/blocks`
375
- * requirement. A same-stem sibling source file (`<id>.tsx`) is required; a doc
376
- * missing its source, or missing `type`, is an integration error and that
377
- * template is skipped (recorded in `errors`).
296
+ * `<id>.doc.{ts,mjs,js}` file is a template whose id is its path relative to
297
+ * the templates root with the `.doc.*` suffix stripped (kebab-case, may be
298
+ * nested). The doc's `type` (page|block) decides scaffolding — there is no
299
+ * `/pages` vs `/blocks` requirement. A same-stem sibling source file
300
+ * (`<id>.tsx`) is required; a doc missing its source, or missing `type`, is
301
+ * an integration error and that template is skipped (recorded in `errors`).
378
302
  *
379
303
  * @param {string} [cwd]
380
304
  * @returns {Promise<{templates: object[], errors: {package: string, template?: string, message: string}[]}>}
@@ -420,7 +344,7 @@ export async function discoverIntegrationTemplatesForOne(integration) {
420
344
  if (!root || !fs.existsSync(root)) return {templates, errors};
421
345
 
422
346
  for (const docPath of findIntegrationDocFiles(root)) {
423
- const suffix = matchedTemplateSuffix(docPath);
347
+ const suffix = matchedDocSuffix(docPath);
424
348
  const id = path
425
349
  .relative(root, docPath)
426
350
  .slice(0, -suffix.length)
@@ -67,6 +67,11 @@ function error(code, message) {
67
67
  return {code, severity: 'error', message};
68
68
  }
69
69
 
70
+ /** @param {string} code @param {string} message @returns {Issue} */
71
+ function warning(code, message) {
72
+ return {code, severity: 'warning', message};
73
+ }
74
+
70
75
  /**
71
76
  * Verify each declared contribution root exists on disk. A declared-but-missing
72
77
  * root is a `missing_root` error.
@@ -360,3 +365,6 @@ export function summarizeIssues(issues) {
360
365
  }
361
366
  return {errors, warnings};
362
367
  }
368
+
369
+ // Re-export issue constructors for callers/tests that want them.
370
+ export {error as integrationError, warning as integrationWarning};
package/src/config.mjs CHANGED
@@ -1,9 +1,18 @@
1
1
  // Copyright (c) Meta Platforms, Inc. and affiliates.
2
2
 
3
3
  /**
4
- * Re-export of the config-authoring helper, which now lives in
5
- * `@astryxdesign/core/config` so an app's config file gets type feedback
6
- * without depending on the CLI. Kept here so existing
7
- * `@astryxdesign/cli/config` imports continue to work unchanged.
4
+ * Type-preserving helper for the Astryx config file.
5
+ *
6
+ * This is an intentionally tiny runtime identity function: it returns its
7
+ * argument unchanged. Its value is the exported TypeScript surface from
8
+ * `@astryxdesign/cli/config`, so config files get editor/type feedback without
9
+ * coupling to CLI internals. Validation is NOT performed here — it happens at
10
+ * the load boundary (see `loadModuleWithSchema` + `AstryxConfigSchema`).
11
+ *
12
+ * @template {import('./types/config').AstryxConfig} T
13
+ * @param {T} config
14
+ * @returns {T}
8
15
  */
9
- export {createConfig} from '@astryxdesign/core/config';
16
+ export function createConfig(config) {
17
+ return config;
18
+ }
@@ -1,8 +1,19 @@
1
1
  // Copyright (c) Meta Platforms, Inc. and affiliates.
2
2
 
3
3
  /**
4
- * Re-export of the integration-authoring helper, which now lives in
5
- * `@astryxdesign/core/authoring`. Kept here so existing
6
- * `@astryxdesign/cli/integration` imports continue to work unchanged.
4
+ * Type-preserving helper for an Astryx integration manifest.
5
+ *
6
+ * This is an intentionally tiny runtime identity function: it returns its
7
+ * argument unchanged. Its value is the exported TypeScript surface from
8
+ * `@astryxdesign/cli/integration`, so manifests get editor/type feedback
9
+ * without coupling to CLI internals. Validation is NOT performed here — it
10
+ * happens at the load boundary (see `loadModuleWithSchema` +
11
+ * `AstryxIntegrationSchema`).
12
+ *
13
+ * @template {import('./types/integration').AstryxIntegration} T
14
+ * @param {T} integration
15
+ * @returns {T}
7
16
  */
8
- export {createIntegration} from '@astryxdesign/core/authoring';
17
+ export function createIntegration(integration) {
18
+ return integration;
19
+ }
@@ -273,24 +273,14 @@ export function findComponentReadme(coreDir, name) {
273
273
  * For "Button" finds src/Button/XDSButton.tsx
274
274
  * For "Layout" finds src/Layout/XDSLayout/XDSLayout.tsx
275
275
  * For "Card" finds src/Layout/Container/XDSCard.tsx (deep search fallback)
276
- *
277
- * Hooks and other functions are authored as `.ts` (e.g. `useMediaQuery.ts`,
278
- * `useResizable.ts`), so `.ts` candidates are searched alongside `.tsx`. Without
279
- * this, deriving the import path for a `.ts`-authored function falls back to the
280
- * bare `@astryxdesign/core` root instead of its tree-shakeable subpath.
281
276
  */
282
277
  export function findComponentSource(coreDir, name) {
283
278
  const srcDir = path.join(coreDir, 'src');
284
- // Try the prefixed forms (`XDSButton.tsx`) first since that is the current
285
- // on-disk convention, then the bare forms (`Button.tsx`) that the Astryx-prefix
286
- // migration (P4) renames to. `.tsx` before `.ts` within each so a component's
287
- // `.tsx` wins over a same-named `.ts` helper; `.ts` covers hooks/functions.
288
- const candidateFiles = [
289
- `XDS${name}.tsx`,
290
- `${name}.tsx`,
291
- `XDS${name}.ts`,
292
- `${name}.ts`,
293
- ];
279
+ // Try the prefixed form (`XDSButton.tsx`) first since that is the current
280
+ // on-disk convention, then the bare form (`Button.tsx`) that the Astryx-prefix
281
+ // migration (P4) renames to. Listing the prefixed name first keeps behavior
282
+ // identical until files are actually renamed.
283
+ const candidateFiles = [`XDS${name}.tsx`, `${name}.tsx`];
294
284
 
295
285
  function searchDir(dirPath) {
296
286
  if (!fs.existsSync(dirPath)) return null;
@@ -5,59 +5,6 @@
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
- }
61
8
 
62
9
  export function mergeTranslation(docs, translation) {
63
10
  if (!translation) return docs;
@@ -73,3 +73,33 @@ 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
+ }
@@ -230,3 +230,8 @@ 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
+ }
package/src/template.mjs CHANGED
@@ -1,15 +1,73 @@
1
1
  // Copyright (c) Meta Platforms, Inc. and affiliates.
2
2
 
3
3
  /**
4
- * @file Static template authoring API (public `@astryxdesign/cli/template`).
4
+ * @file Static template authoring API.
5
5
  *
6
- * The `createPageTemplate`/`createBlockTemplate` authoring helpers now live in
7
- * `@astryxdesign/core/authoring` and are re-exported here so existing
8
- * `@astryxdesign/cli/template` imports keep working. The Zod load-boundary
9
- * schemas live in `./schemas/template-schema.mjs` (core-free) and are
10
- * re-exported here for back-compat; internal hot-path code imports them from
11
- * the schema module directly so it never depends on core's built `dist/`.
6
+ * Helpers for authoring Astryx page/block template docs. Like
7
+ * `createConfig`/`createIntegration`, these are tiny runtime identity helpers
8
+ * whose real value is the exported TypeScript surface from
9
+ * `@astryxdesign/cli/template`. They inject the discriminant `type` so a
10
+ * discovered doc always knows whether it is a page or a block. They do NOT
11
+ * validate validation happens at the load boundary, where integration
12
+ * template discovery runs the module's default export through
13
+ * {@link TemplateEnvelopeSchema} (see `loadModuleWithSchema`).
12
14
  */
13
15
 
14
- export {createPageTemplate, createBlockTemplate} from '@astryxdesign/core/authoring';
15
- export {BaseTemplateSchema, TemplateEnvelopeSchema} from './schemas/template-schema.mjs';
16
+ import {z} from 'zod';
17
+
18
+ const PreviewSchema = z
19
+ .object({
20
+ image: z.string().optional(),
21
+ aspectRatio: z.string().optional(),
22
+ })
23
+ .strict();
24
+
25
+ /**
26
+ * Shared authored-template shape. `type` is injected by the create* helpers,
27
+ * so authors never write it. Inline source/sourceFile are intentionally NOT
28
+ * part of v1 — a template's source is the required same-stem sibling file.
29
+ * Exported so integration template discovery can validate the stamped result.
30
+ */
31
+ export const BaseTemplateSchema = z
32
+ .object({
33
+ name: z.string().min(1, 'name is required'),
34
+ description: z.string().min(1, 'description is required'),
35
+ category: z.string().optional(),
36
+ componentsUsed: z.array(z.string()).optional(),
37
+ preview: PreviewSchema.optional(),
38
+ })
39
+ .strict();
40
+
41
+ /**
42
+ * The metadata envelope integration template discovery validates: a stamped
43
+ * template doc. This is the LOAD-boundary contract — a hand-written plain
44
+ * object that matches this shape is accepted (discovery does not check "was it
45
+ * made by the factory", only the shape).
46
+ */
47
+ export const TemplateEnvelopeSchema = BaseTemplateSchema.extend({
48
+ type: z.enum(['page', 'block']),
49
+ });
50
+
51
+ /**
52
+ * Author an Astryx page template doc. Stamp-only: returns the def with
53
+ * `type: 'page'` injected. Validation happens at the load boundary.
54
+ *
55
+ * @template {import('./types/template-api').AstryxPageTemplateInput} T
56
+ * @param {T} def
57
+ * @returns {T & {type: 'page'}}
58
+ */
59
+ export function createPageTemplate(def) {
60
+ return /** @type {T & {type: 'page'}} */ ({...def, type: 'page'});
61
+ }
62
+
63
+ /**
64
+ * Author an Astryx block template doc. Stamp-only: returns the def with
65
+ * `type: 'block'` injected. Validation happens at the load boundary.
66
+ *
67
+ * @template {import('./types/template-api').AstryxBlockTemplateInput} T
68
+ * @param {T} def
69
+ * @returns {T & {type: 'block'}}
70
+ */
71
+ export function createBlockTemplate(def) {
72
+ return /** @type {T & {type: 'block'}} */ ({...def, type: 'block'});
73
+ }
@@ -1,15 +1,70 @@
1
1
  // Copyright (c) Meta Platforms, Inc. and affiliates.
2
2
 
3
3
  /**
4
- * The config-authoring surface moved to `@astryxdesign/core/config` so an app's
5
- * config file gets type feedback without depending on the CLI. Re-exported here
6
- * so existing `@astryxdesign/cli/config` type imports keep resolving.
4
+ * A command to run as part of a post-codemod hook. Returned by a hook's
5
+ * `buildCommand` and executed via `execFile` after codemods write files.
7
6
  */
8
- export type {
9
- PostCodemodCommand,
10
- PostCodemodHook,
11
- XleComponent,
12
- AstryxConfig,
13
- } from '@astryxdesign/core/config';
14
-
15
- export {createConfig} from '@astryxdesign/core/config';
7
+ export interface PostCodemodCommand {
8
+ command: string;
9
+ args?: string[];
10
+ options?: {
11
+ cwd?: string;
12
+ env?: NodeJS.ProcessEnv;
13
+ timeout?: number;
14
+ };
15
+ }
16
+
17
+ /**
18
+ * A post-codemod hook. `buildCommand` receives the package directory and the
19
+ * list of files changed by codemods, and returns the command to run (or a
20
+ * nullish value to skip).
21
+ */
22
+ export type PostCodemodHook = {
23
+ name?: string;
24
+ buildCommand: (ctx: {
25
+ packageDir: string;
26
+ files: string[];
27
+ }) =>
28
+ | PostCodemodCommand
29
+ | null
30
+ | undefined
31
+ | Promise<PostCodemodCommand | null | undefined>;
32
+ };
33
+
34
+ /** A component XLE layout expressions can reference by name via `{hint}`. */
35
+ export interface XleComponent {
36
+ /** Import specifier the component is imported from, e.g. '@/components/KpiCard'. */
37
+ from: string;
38
+ /** Optional human description shown in tooling. */
39
+ description?: string;
40
+ /** Import as the module's default export instead of a named export. Defaults to false. */
41
+ default?: boolean;
42
+ }
43
+
44
+ /** User config exported from astryx.config.{ts,mjs,js}. */
45
+ export interface AstryxConfig {
46
+ /** Integration package names to load. */
47
+ integrations?: string[];
48
+ /** Where to file issues/feedback for this project. */
49
+ issuesUrl?: string;
50
+ /** Lifecycle hooks. */
51
+ hooks?: {
52
+ postCodemod?: PostCodemodHook[];
53
+ };
54
+ /**
55
+ * EXPERIMENTAL — shape may change and is not part of the stable config
56
+ * contract. Provisional home for features still being proven out.
57
+ */
58
+ experimental?: {
59
+ /** Experimental XLE (layout expression) configuration. */
60
+ xle?: {
61
+ /**
62
+ * Register app-local components so XLE layout expressions can
63
+ * reference them by name via {hint}. Keyed by component name.
64
+ */
65
+ components?: Record<string, XleComponent>;
66
+ };
67
+ };
68
+ }
69
+
70
+ export declare function createConfig<T extends AstryxConfig>(config: T): T;