An open source design system that's fully customizable and agent ready
TypeScript
fix(theme): support CustomTextTypes module augmentation (#5013) (#5029)
jibin jose5d7503bc25d5
diff --git a/.changeset/theme-custom-text-types.md b/.changeset/theme-custom-text-types.mdnew file mode 100644index 0000000000..87d44f17c3--- /dev/null+++ b/.changeset/theme-custom-text-types.md@@ -0,0 +1,7 @@+---+'@astryxdesign/cli': patch+---++[fix] theme: support `CustomTextTypes` module augmentation for custom Text variants (#5013)++@jibin7josediff --git a/packages/cli/api/theme/build/build.mjs b/packages/cli/api/theme/build/build.mjsindex 2564b4b3d0..828dd4e98d 100644--- a/packages/cli/api/theme/build/build.mjs+++ b/packages/cli/api/theme/build/build.mjs@@ -1013,31 +1013,44 @@ function resolveCoreRoot() {const _componentDeclCache = new Map();/*** @param {string} pascalName+ * @param {{includeTypes?: boolean}} [options]* @returns {string}*/-function readComponentDeclarations(pascalName) {- if (_componentDeclCache.has(pascalName)) {- return _componentDeclCache.get(pascalName) ?? '';+function readComponentDeclarations(pascalName, options = {}) {+ const includeTypes = options.includeTypes === true;+ const cacheKey = `${pascalName}:${includeTypes ? 'with-types' : 'index-only'}`;+ if (_componentDeclCache.has(cacheKey)) {+ return _componentDeclCache.get(cacheKey) ?? '';}let contents = '';const coreRoot = resolveCoreRoot();if (coreRoot) {- const candidates = [- path.join(coreRoot, 'dist', pascalName, 'index.d.ts'),- path.join(coreRoot, 'src', pascalName, 'index.ts'),+ const candidateSets = [+ [path.join(coreRoot, 'dist', pascalName, 'index.d.ts')],+ [path.join(coreRoot, 'src', pascalName, 'index.ts')],];- for (const file of candidates) {- try {- if (fs.existsSync(file)) {- contents = fs.readFileSync(file, 'utf-8');- break;+ if (includeTypes) {+ candidateSets[0].push(+ path.join(coreRoot, 'dist', pascalName, 'types.d.ts'),+ );+ candidateSets[1].push(path.join(coreRoot, 'src', pascalName, 'types.ts'));+ }+ for (const files of candidateSets) {+ if (fs.existsSync(files[0])) {+ for (const file of files) {+ try {+ if (fs.existsSync(file)) {+ contents += fs.readFileSync(file, 'utf-8') + '\n';+ }+ } catch {+ // ignore+ }}- } catch {- // ignore and try the next candidate+ if (contents) break;}}}- _componentDeclCache.set(pascalName, contents);+ _componentDeclCache.set(cacheKey, contents);return contents;}@@ -1163,10 +1176,11 @@ async function resolveAugmentationTargetCandidates(componentName) {* re-exported) as a type/interface.* @param {string} pascalName* @param {string} interfaceName+ * @param {{includeTypes?: boolean}} [options]* @returns {boolean}*/-function componentHasAugmentableInterface(pascalName, interfaceName) {- const decl = readComponentDeclarations(pascalName);+function componentHasAugmentableInterface(pascalName, interfaceName, options) {+ const decl = readComponentDeclarations(pascalName, options);if (!decl) return false;// Require an actual interface declaration in this public subpath, not just a// type re-export. Module augmentation only widens consumers that import the@@ -1199,6 +1213,56 @@ function isComponentValueAugmentationPoint(pascalName, interfaceName) {);}+/**+ * Extension points whose public module and interface do not follow the usual+ * `<Component><Prop>Map` convention. TextType reads CustomTextTypes from the+ * theme module, so both classification and declaration emission must resolve+ * this same public augmentation point.+ *+ * @type {Record<string, {moduleName: string, interfaceName: string, includeTypes?: boolean}>}+ */+const AUGMENTATION_OVERRIDES = {+ 'text.type': {+ moduleName: 'theme',+ interfaceName: 'CustomTextTypes',+ includeTypes: true,+ },+};++/**+ * Resolve the public module/interface that can widen a component prop value.+ * @param {string} component+ * @param {string} prop+ * @returns {Promise<{moduleName: string, interfaceName: string}|null>}+ */+async function resolveAugmentationTarget(component, prop) {+ const override = AUGMENTATION_OVERRIDES[`${component}.${prop}`];+ if (override) {+ return componentHasAugmentableInterface(+ override.moduleName,+ override.interfaceName,+ {includeTypes: override.includeTypes},+ )+ ? {moduleName: override.moduleName, interfaceName: override.interfaceName}+ : null;+ }++ const propPascal = prop.charAt(0).toUpperCase() + prop.slice(1);+ const target = (await resolveAugmentationTargetCandidates(component)).find(+ candidate =>+ isComponentValueAugmentationPoint(+ candidate.moduleName,+ `${candidate.interfacePrefix}${propPascal}Map`,+ ),+ );+ return target+ ? {+ moduleName: target.moduleName,+ interfaceName: `${target.interfacePrefix}${propPascal}Map`,+ }+ : null;+}+/*** Adaptation values from resolved runtime rules, raw input, or normalized built* metadata. Built modules intentionally omit `__adaptationRules`, so every CLI@@ -1503,14 +1567,7 @@ async function classifyComponentValue(component, prop, value) {return 'builtin';}- const propPascal = prop.charAt(0).toUpperCase() + prop.slice(1);- const target = (await resolveAugmentationTargetCandidates(component)).find(- candidate =>- isComponentValueAugmentationPoint(- candidate.moduleName,- `${candidate.interfacePrefix}${propPascal}Map`,- ),- );+ const target = await resolveAugmentationTarget(component, prop);return target ? 'enrollment' : 'unresolved';}@@ -1668,15 +1725,7 @@ async function generateVariantDeclarationsAsync(themeDef) {for (const [prop, values] of Object.entries(props)) {if (values.size === 0) continue;- const propPascal = prop.charAt(0).toUpperCase() + prop.slice(1);- const target = (- await resolveAugmentationTargetCandidates(component)- ).find(candidate =>- isComponentValueAugmentationPoint(- candidate.moduleName,- `${candidate.interfacePrefix}${propPascal}Map`,- ),- );+ const target = await resolveAugmentationTarget(component, prop);// Resolve the augmentation point again to name it. Classification has// already established that one exists (that is what `enrollment` means),@@ -1687,7 +1736,7 @@ async function generateVariantDeclarationsAsync(themeDef) {if (!target) continue;const modulePath = `@astryxdesign/core/${target.moduleName}`;- const interfaceName = `${target.interfacePrefix}${propPascal}Map`;+ const {interfaceName} = target;sections.push(`declare module '${modulePath}' {`);sections.push(` interface ${interfaceName} {`);diff --git a/packages/cli/clients/cli/commands/build-theme.variants.test.mjs b/packages/cli/clients/cli/commands/build-theme.variants.test.mjsindex 50fe65b1cc..a504be2c7f 100644--- a/packages/cli/clients/cli/commands/build-theme.variants.test.mjs+++ b/packages/cli/clients/cli/commands/build-theme.variants.test.mjs@@ -99,6 +99,33 @@ describe('theme build custom-variant augmentations', () => {expect(dts).not.toMatch(/XDSButtonVariantMap/);});+ it('targets CustomTextTypes in core/theme for a custom text type', async () => {+ const themeFile = writeTheme(+ tmpDir,+ `export default {+ name: 'variants-theme',+ tokens: { '--color-bg': '#fff' },+ components: {+ text: { 'type:customTextType': { fontSize: '24px' } },+ },+ };\n`,+ );++ const result = await runCli(+ ['theme', 'build', path.relative(tmpDir, themeFile)],+ tmpDir,+ );+ expect(result.code).toBe(0);++ const variantsPath = path.join(tmpDir, 'variants-theme.variants.d.ts');+ expect(fs.existsSync(variantsPath)).toBe(true);+ const dts = fs.readFileSync(variantsPath, 'utf-8');++ expect(dts).toContain("declare module '@astryxdesign/core/theme'");+ expect(dts).toMatch(/interface CustomTextTypes\b/);+ expect(dts).toContain("'customTextType': true;");+ });+it('emits Heading custom types and skips props with no augmentation point', async () => {const themeFile = writeTheme(tmpDir,@@ -428,7 +455,10 @@ describe('theme build custom-variant augmentations', () => {section: { 'variant:customSection': { backgroundColor: 'transparent' } },'status-dot': { 'variant:customStatusDot': { backgroundColor: 'transparent' } },heading: { 'type:customHeading': { fontSize: '3rem' } },- text: { 'color:customTextColor': { color: 'currentColor' } },+ text: {+ 'color:customTextColor': { color: 'currentColor' },+ 'type:customTextType': { fontSize: '24px' },+ },token: { 'color:customTokenColor': { backgroundColor: 'transparent' } },},};@@ -491,7 +521,7 @@ describe('theme build custom-variant augmentations', () => {` <Section variant="customSection">Section</Section>\n` +` <StatusDot label="Status" variant="customStatusDot" />\n` +` <Heading level={2} type="customHeading">Heading</Heading>\n` +- ` <Text color="customTextColor">Text</Text>\n` ++ ` <Text color="customTextColor" type="customTextType">Text</Text>\n` +` <Token label="Token" color="customTokenColor" />\n` +` </>\n` +` );\n` +