@astryxdesign/cli 0.3.0-canary.ee705d8 → 0.3.0-canary.f4607ea

package/api/theme/build/build.d.mts

@@ -21,13 +21,18 @@ export function importSpecifier(relDir: string, base: string): string;
  * `logger` (silent by default).
  *
  * @param {string} file - Theme file path, resolved against `cwd`.
- * @param {{out?: string, check?: boolean}} [options] - `out` overrides the output CSS path; `check` compares against on-disk outputs instead of writing.
+ * @param {{out?: string, check?: boolean, iconsSpecifier?: string}} [options] -
+ *   `out` overrides the output CSS path; `check` compares against on-disk outputs
+ *   instead of writing. `iconsSpecifier` overrides the icon registry import
+ *   specifier in the generated module (e.g. `./icons.mjs`); when omitted, the
+ *   specifier scraped from the theme source is emitted unchanged.
  * @param {{cwd?: string}} [ctx]
  * @returns {Promise<import('../theme.type.mjs').ThemeBuildResponse | import('../theme.type.mjs').ThemeBuildCheckResponse | null>}
  */
 export function themeBuild(file: string, options?: {
     out?: string;
     check?: boolean;
+    iconsSpecifier?: string;
 }, { cwd }?: {
     cwd?: string;
 }): Promise<import("../theme.type.mjs").ThemeBuildResponse | import("../theme.type.mjs").ThemeBuildCheckResponse | null>;

package/api/theme/build/build.mjs

@@ -726,13 +726,30 @@ function extractIconInfo(filePath) {
  * Generate a minimal JS module for a built theme.
  * Includes the theme name, marker, and re-exports the icon registry.
  * All styling is in the CSS file.
+ *
+ * The icon registry is imported rather than inlined because it holds React
+ * elements, which cannot be serialized. `extractIconInfo` lifts the specifier
+ * out of the TypeScript source, where an extensionless `./icons` is resolved by
+ * the TypeScript resolver — but the artifact here is ESM JavaScript, which
+ * requires a fully specified path. Only the caller knows what its own build
+ * will emit and under what name, so `iconsSpecifier` lets it say. When it is
+ * not given, the scraped specifier is emitted unchanged.
+ *
  * @param {any} themeDef
  * @param {{exportName: string, importPath: string} | null} iconInfo
+ * @param {string} [iconsSpecifier] - Overrides the scraped icon import specifier.
  * @returns {string}
  */
-function generateBuiltModule(themeDef, iconInfo) {
+function generateBuiltModule(themeDef, iconInfo, iconsSpecifier) {
+  // Preserve the historical generated bytes when no override is supplied.
+  // User-provided specifiers need string-literal encoding so quotes and
+  // backslashes cannot produce invalid JavaScript.
+  const renderedSpecifier =
+    iconsSpecifier === undefined
+      ? `'${iconInfo?.importPath}'`
+      : JSON.stringify(iconsSpecifier);
   const iconImport = iconInfo
-    ? `import { ${iconInfo.exportName} } from '${iconInfo.importPath}';\n`
+    ? `import { ${iconInfo.exportName} } from ${renderedSpecifier};\n`
     : '';
   const iconsField = iconInfo ? `  icons: ${iconInfo.exportName},` : '';
   const iconReExport = iconInfo ? `\nexport { ${iconInfo.exportName} };\n` : '';
@@ -970,7 +987,11 @@ function validatePrivateVars(themeDef) {
  * `logger` (silent by default).
  *
  * @param {string} file - Theme file path, resolved against `cwd`.
- * @param {{out?: string, check?: boolean}} [options] - `out` overrides the output CSS path; `check` compares against on-disk outputs instead of writing.
+ * @param {{out?: string, check?: boolean, iconsSpecifier?: string}} [options] -
+ *   `out` overrides the output CSS path; `check` compares against on-disk outputs
+ *   instead of writing. `iconsSpecifier` overrides the icon registry import
+ *   specifier in the generated module (e.g. `./icons.mjs`); when omitted, the
+ *   specifier scraped from the theme source is emitted unchanged.
  * @param {{cwd?: string}} [ctx]
  * @returns {Promise<import('../theme.type.mjs').ThemeBuildResponse | import('../theme.type.mjs').ThemeBuildCheckResponse | null>}
  */
@@ -1185,7 +1206,11 @@ export async function themeBuild(
     generatedHeader(sourceRelative, 'css', buildCommand, versions) + css;
   const jsContent =
     generatedHeader(sourceRelative, 'js', buildCommand, versions) +
-    generateBuiltModule(resolvedTheme || themeDef, iconInfo);
+    generateBuiltModule(
+      resolvedTheme || themeDef,
+      iconInfo,
+      options.iconsSpecifier,
+    );
   const dtsContent =
     generatedHeader(sourceRelative, 'ts', buildCommand, versions) +
     generateBuiltTypes(themeDef, iconInfo, variantsFileName);

package/api/theme/themeBuild.doc.mjs

@@ -19,11 +19,13 @@ export const doc = {
     "via @astryxdesign/core's shared generator (the single source of truth, so the build " +
     'emits the exact CSS the <Theme> runtime does), writes a scoped CSS file, a JS module ' +
     'that re-exports the built theme, and a .d.ts (plus an optional .variants.d.ts when the ' +
-    'theme adds custom prop values). With {check: true} it writes nothing and instead compares ' +
+    'theme adds custom prop values). When another build step emits the icon registry, ' +
+    '{iconsSpecifier} declares the fully specified module path for the generated JS import. ' +
+    'With {check: true} it writes nothing and instead compares ' +
     'each output against disk, returning the drift: the CI guard for committed, generated theme CSS.',
   importPath: '@astryxdesign/cli/api',
   signature:
-    'themeBuild(file: string, options?: {out?: string, check?: boolean}, ctx?: {cwd?: string}): Promise<ThemeBuildResponse | ThemeBuildCheckResponse | null>',
+    'themeBuild(file: string, options?: {out?: string, check?: boolean, iconsSpecifier?: string}, ctx?: {cwd?: string}): Promise<ThemeBuildResponse | ThemeBuildCheckResponse | null>',
   keywords: [
     'theme',
     'build',
@@ -54,6 +56,12 @@ export const doc = {
         'Compile in memory and compare each output against what is on disk instead of writing: the CI drift guard.',
       default: 'false',
     },
+    {
+      name: 'options.iconsSpecifier',
+      type: 'string',
+      description:
+        'Override the icon-registry import specifier in the generated JS module, for example ./icons.mjs. When omitted, the source specifier is preserved.',
+    },
     {
       name: 'ctx.cwd',
       type: 'string',
@@ -102,6 +110,10 @@ export const doc = {
       label: 'Check for drift (CI)',
       code: "const r = await themeBuild('src/themes/ocean.ts', {check: true});",
     },
+    {
+      label: 'Use a separately compiled icon registry',
+      code: "const r = await themeBuild('src/themes/ocean.ts', {iconsSpecifier: './icons.mjs'});",
+    },
   ],
   command: 'theme build',
   related: ['themeAdd', 'themeList', 'listThemes'],

package/assets/templates/blocks/components/Stepper/StepperStatus.doc.mjs

@@ -7,7 +7,7 @@ export const doc = {
   name: 'Stepper — Validation Status',
   displayName: 'Stepper — Validation Status',
   description:
-    'Semantic status per step in a verification flow: success shows a green check, error a red glyph, accent the in-progress step. Status sets the indicator color and glyph only — never the connector — and is announced to assistive tech as text.',
+    'Semantic status per step in a verification flow: success shows a green check, error a red glyph, accent the in-progress step. Status sets the indicator color and glyph only, never the connector, and is announced to assistive tech as text.',
   isReady: true,
   aspectRatio: 4 / 3,
   componentsUsed: ['Stepper'],

package/clients/cli/commands/build-theme.icons-specifier.test.mjs

@@ -0,0 +1,225 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file Regression tests for `astryx theme build --icons-specifier`.
+ *
+ * The generated module imports the icon registry rather than inlining it,
+ * because the registry holds React elements. `extractIconInfo` lifts that
+ * specifier out of the TypeScript source, where an extensionless `./icons` is
+ * resolved by the TypeScript resolver — but the artifact is ESM JavaScript,
+ * which requires a fully specified path, so Node cannot load it. See #4620.
+ *
+ * Only the caller knows what its own build emits and under what name (the same
+ * source compiled by tsup lands at `icons.mjs` in a package with no `"type"`
+ * field and at `icons.js` in one with `"type": "module"`), so the specifier is
+ * declared rather than inferred. Absent the flag, output is byte-for-byte what
+ * it was before, which keeps the default no-`--out` flow — where the neighbour
+ * is an uncompiled `icons.tsx` that only a bundler can resolve — working.
+ */
+
+import {describe, it, expect, beforeAll, beforeEach, afterEach} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as os from 'node:os';
+import {ensureCoreBuilt} from './ensure-core-built.mjs';
+import {runCli} from '../../../test-utils/run-cli.mjs';
+
+/**
+ * The emitted icon import, or null. Reads the statement rather than the whole
+ * file: the `@generated` header quotes the source filename and a usage example,
+ * so a substring search over the file matches comment text too.
+ */
+function iconImportLine(generated) {
+  const match = generated.match(/^import .*$/m);
+  return match ? match[0] : null;
+}
+
+/** A theme whose registry arrives via a relative import, plus that module. */
+function writeThemeWithIcons(dir, name) {
+  fs.mkdirSync(dir, {recursive: true});
+  fs.writeFileSync(
+    path.join(dir, 'icons.mjs'),
+    'export const testIcons = {};\n',
+  );
+  const file = path.join(dir, `${name}.mjs`);
+  fs.writeFileSync(
+    file,
+    `import {testIcons} from './icons';\n` +
+      `export default {\n` +
+      `  name: ${JSON.stringify(name)},\n` +
+      `  icons: testIcons,\n` +
+      `  tokens: {'--color-bg': '#fff'},\n` +
+      `};\n`,
+  );
+  return file;
+}
+
+beforeAll(() => {
+  ensureCoreBuilt();
+}, 200_000);
+
+let tmpDir;
+beforeEach(() => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-icons-specifier-'));
+});
+afterEach(() => {
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+describe('theme build --icons-specifier', () => {
+  it('emits the declared specifier', async () => {
+    const project = path.join(tmpDir, 'project');
+    const themeFile = writeThemeWithIcons(project, 'declared');
+
+    const result = await runCli(
+      [
+        'theme',
+        'build',
+        path.relative(project, themeFile),
+        '--icons-specifier',
+        './icons.mjs',
+      ],
+      project,
+    );
+    expect(result.code).toBe(0);
+
+    const generated = fs.readFileSync(
+      path.join(project, 'declared.js'),
+      'utf8',
+    );
+    expect(iconImportLine(generated)).toBe(
+      'import { testIcons } from "./icons.mjs";',
+    );
+  });
+
+  it('accepts a specifier the generator could never have inferred', async () => {
+    const project = path.join(tmpDir, 'project');
+    const themeFile = writeThemeWithIcons(project, 'custom');
+
+    const result = await runCli(
+      [
+        'theme',
+        'build',
+        path.relative(project, themeFile),
+        '--icons-specifier',
+        '../build/registry/icons.js',
+      ],
+      project,
+    );
+    expect(result.code).toBe(0);
+
+    const generated = fs.readFileSync(path.join(project, 'custom.js'), 'utf8');
+    expect(iconImportLine(generated)).toBe(
+      'import { testIcons } from "../build/registry/icons.js";',
+    );
+  });
+
+  it('encodes the declared specifier as a valid JavaScript string', async () => {
+    const project = path.join(tmpDir, 'project');
+    const themeFile = writeThemeWithIcons(project, 'encoded');
+
+    const result = await runCli(
+      [
+        'theme',
+        'build',
+        path.relative(project, themeFile),
+        '--icons-specifier',
+        "./icon's.mjs",
+      ],
+      project,
+    );
+    expect(result.code).toBe(0);
+
+    const generated = fs.readFileSync(path.join(project, 'encoded.js'), 'utf8');
+    expect(iconImportLine(generated)).toBe(
+      'import { testIcons } from "./icon\'s.mjs";',
+    );
+  });
+
+  it('combines with the current --check flow', async () => {
+    const project = path.join(tmpDir, 'project');
+    const themeFile = writeThemeWithIcons(project, 'checked');
+    const relativeTheme = path.relative(project, themeFile);
+
+    const built = await runCli(
+      [
+        'theme',
+        'build',
+        relativeTheme,
+        '--icons-specifier',
+        './icons.mjs',
+      ],
+      project,
+    );
+    expect(built.code).toBe(0);
+
+    const withoutSpecifier = await runCli(
+      ['theme', 'build', relativeTheme, '--check'],
+      project,
+    );
+    expect(withoutSpecifier.code).toBe(1);
+
+    const withSpecifier = await runCli(
+      [
+        'theme',
+        'build',
+        relativeTheme,
+        '--check',
+        '--icons-specifier',
+        './icons.mjs',
+      ],
+      project,
+    );
+    expect(withSpecifier.code).toBe(0);
+  });
+
+  it('leaves the scraped specifier untouched when the flag is absent', async () => {
+    const project = path.join(tmpDir, 'project');
+    const themeFile = writeThemeWithIcons(project, 'untouched');
+
+    const result = await runCli(
+      ['theme', 'build', path.relative(project, themeFile)],
+      project,
+    );
+    expect(result.code).toBe(0);
+
+    // The pre-flag behaviour, preserved: no extension is invented. In this
+    // layout the neighbour is a source file only a bundler can resolve, so
+    // adding one would break a build that works today.
+    const generated = fs.readFileSync(
+      path.join(project, 'untouched.js'),
+      'utf8',
+    );
+    expect(iconImportLine(generated)).toBe(
+      "import { testIcons } from './icons';",
+    );
+  });
+
+  it('is inert for a theme with no icons field', async () => {
+    const project = path.join(tmpDir, 'project');
+    fs.mkdirSync(project, {recursive: true});
+    const themeFile = path.join(project, 'plain.mjs');
+    fs.writeFileSync(
+      themeFile,
+      `export default {name: 'plain', tokens: {'--color-bg': '#fff'}};\n`,
+    );
+
+    const result = await runCli(
+      [
+        'theme',
+        'build',
+        path.relative(project, themeFile),
+        '--icons-specifier',
+        './icons.mjs',
+      ],
+      project,
+    );
+    expect(result.code).toBe(0);
+
+    // No icons field means no import to rewrite, so the flag has nothing to act
+    // on and must not introduce one.
+    const generated = fs.readFileSync(path.join(project, 'plain.js'), 'utf8');
+    expect(iconImportLine(generated)).toBeNull();
+    expect(generated).not.toContain('icons:');
+  });
+});

package/clients/cli/commands/build-theme.mjs

@@ -57,13 +57,15 @@ function resolveCliBin() {
  * Resolves with the child's exit code; never rejects.
  *
  * @param {string} file - The theme file argument, as the user passed it.
- * @param {{out?: string}} options - Parsed command options (only `out` is forwarded).
+ * @param {{out?: string, iconsSpecifier?: string}} options - Parsed command
+ *   options that affect generated output.
  * @returns {Promise<number>}
  */
 function runThemeBuildOnceChild(file, options) {
   const cliBin = resolveCliBin();
   const args = [cliBin, 'theme', 'build', file];
   if (options.out) args.push('--out', options.out);
+  if (options.iconsSpecifier) args.push('--icons-specifier', options.iconsSpecifier);
   return new Promise((/** @type {(code: number) => void} */ resolve) => {
     const child = spawn(process.execPath, args, {
       stdio: 'inherit',
@@ -83,7 +85,7 @@ function runThemeBuildOnceChild(file, options) {
  *
  * @param {string} file - The theme file argument, as the user passed it.
  * @param {string} filePath - Absolute path to the theme file.
- * @param {{out?: string}} options - Parsed command options.
+ * @param {{out?: string, iconsSpecifier?: string}} options - Parsed command options.
  * @returns {Promise<void>} Resolves when the watcher is stopped (Ctrl-C).
  */
 async function runThemeBuildWatch(file, filePath, options) {
@@ -204,7 +206,7 @@ export function registerTheme(program) {
     fn: themeBuildFn,
     action: async (
       /** @type {string} */ file,
-      /** @type {{out?: string, watch?: boolean, check?: boolean}} */ options,
+      /** @type {{out?: string, watch?: boolean, check?: boolean, iconsSpecifier?: string}} */ options,
     ) => {
       const filePath = path.resolve(process.cwd(), file);
       const json = program.opts().json || false;
@@ -247,7 +249,11 @@ export function registerTheme(program) {
       try {
         const result = await themeBuild(
           file,
-          {out: options.out, check: options.check},
+          {
+            out: options.out,
+            check: options.check,
+            iconsSpecifier: options.iconsSpecifier,
+          },
           {cwd: process.cwd()},
         );
         if (json && result) jsonOut(result);

package/clients/cli/commands/theme-build.doc.mjs

@@ -18,11 +18,19 @@ export const doc = {
   description:
     'Compiles a file that calls defineTheme() into a scoped CSS file, a JS module, and ' +
     'type declarations: the exact CSS the <Theme> runtime emits. With --check it writes ' +
-    'nothing and instead reports whether the committed outputs have drifted from source.',
+    'nothing and instead reports whether the committed outputs have drifted from source. ' +
+    'When a separate build step emits the icon registry, --icons-specifier declares the ' +
+    'fully specified module path that the generated JS should import.',
   fn: 'themeBuild',
   args: [{name: 'file', param: 'file', required: true}],
   options: [
     {flag: '-o, --out <path>', param: 'options.out', description: 'Output CSS file path'},
+    {
+      flag: '--icons-specifier <specifier>',
+      param: 'options.iconsSpecifier',
+      description:
+        'Override the icon-registry import in the generated JS module (for example, ./icons.mjs)',
+    },
     {
       flag: '-w, --watch',
       description: 'Rebuild automatically when the theme file changes (Ctrl-C to stop)',
@@ -43,6 +51,10 @@ export const doc = {
       label: 'Check for drift (CI)',
       cli: 'astryx theme build ./src/themes/ocean.ts --check',
     },
+    {
+      label: 'Build against a separately compiled icon registry',
+      cli: 'astryx theme build ./src/themes/ocean.ts --icons-specifier ./icons.mjs',
+    },
   ],
   exitCodes: [
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astryxdesign/cli",
-  "version": "0.3.0-canary.ee705d8",
+  "version": "0.3.0-canary.f4607ea",
   "displayName": "CLI",
   "description": "Scaffold projects, browse templates, generate themes, and get agent-ready docs from the command line.",
   "author": "Meta Open Source",
@@ -84,10 +84,10 @@
     "zod": "^4.4.3"
   },
   "peerDependencies": {
-    "@astryxdesign/charts": "0.3.0-canary.ee705d8",
-    "@astryxdesign/core": "0.3.0-canary.ee705d8",
-    "@astryxdesign/lab": "0.3.0-canary.ee705d8",
-    "@astryxdesign/theme-neutral": "0.3.0-canary.ee705d8",
+    "@astryxdesign/charts": "0.3.0-canary.f4607ea",
+    "@astryxdesign/core": "0.3.0-canary.f4607ea",
+    "@astryxdesign/lab": "0.3.0-canary.f4607ea",
+    "@astryxdesign/theme-neutral": "0.3.0-canary.f4607ea",
     "gpt-tokenizer": "^3.4.0"
   },
   "peerDependenciesMeta": {
@@ -105,10 +105,10 @@
     }
   },
   "devDependencies": {
-    "@astryxdesign/charts": "0.3.0-canary.ee705d8",
-    "@astryxdesign/core": "0.3.0-canary.ee705d8",
-    "@astryxdesign/lab": "0.3.0-canary.ee705d8",
-    "@astryxdesign/theme-neutral": "0.3.0-canary.ee705d8",
+    "@astryxdesign/charts": "0.3.0-canary.f4607ea",
+    "@astryxdesign/core": "0.3.0-canary.f4607ea",
+    "@astryxdesign/lab": "0.3.0-canary.f4607ea",
+    "@astryxdesign/theme-neutral": "0.3.0-canary.f4607ea",
     "gpt-tokenizer": "^3.4.0"
   },
   "scripts": {