@nxds/core 0.12.0 → 0.14.0

package/dist/runtime/catalogue.d.cts

@@ -1,5 +1,5 @@
-import { N as NxdsPresetField, a as NxdsAppearancePrefs, b as NxdsAppearanceState } from './surface-ladder-tv7B_RKy.cjs';
-export { D as DARK_SURFACE_LADDER, L as LIGHT_SURFACE_LADDER, S as SURFACE_TOKENS, c as ShadeAnchor } from './surface-ladder-tv7B_RKy.cjs';
+import { N as NxdsColorAppearance, a as NxdsUiScale, b as NxdsTextSize, c as NxdsAppearancePrefs, d as NxdsPresetField } from './surface-ladder-DQ9Yfwie.cjs';
+export { D as DARK_SURFACE_LADDER, L as LIGHT_SURFACE_LADDER, S as SURFACE_TOKENS, e as ShadeAnchor } from './surface-ladder-DQ9Yfwie.cjs';
 import { M as Mode } from './palette-BKTIQ0WC.cjs';
 
 /** An authored DTCG `$value`: a scalar, a reference string, or a composite. */
@@ -11,8 +11,18 @@ type TokenValue = string | number | boolean | null | readonly TokenValue[] | {
 type DeepReadonly<T> = T extends object ? {
     readonly [Key in keyof T]: DeepReadonly<T[Key]>;
 } : T;
+/**
+ * The appearance fields the catalogue derives values from: runtime colours
+ * from the brand colour, surface tone and contrasts, sizes from the UI scale,
+ * type sizes from the text size too, and the code size from `codeFontSize`.
+ */
+type CatalogueAppearance = NxdsColorAppearance & {
+    readonly uiScale: NxdsUiScale;
+    readonly textSize: NxdsTextSize;
+    readonly prefs: Pick<NxdsAppearancePrefs, 'codeFontSize'>;
+};
 /** Token families the catalogue covers. */
-type CatalogueFamily = 'borderwidth' | 'breakpoint' | 'color' | 'motion' | 'radius' | 'shadow' | 'spacing' | 'typography' | 'z-index';
+type CatalogueFamily = 'borderwidth' | 'breakpoint' | 'color' | 'icon' | 'motion' | 'radius' | 'shadow' | 'spacing' | 'typography' | 'ui-scale' | 'width' | 'z-index';
 /**
  * Canonical identity: an identifier in the `--nx-*` custom property scheme.
  * Most tokens declare it in the generated CSS. Typography styles and
@@ -61,10 +71,15 @@ interface CatalogueVariant {
      * file.
      */
     readonly preset: string | null;
-    /** The authored leaf, or `null` for a colour the engine derives. */
+    /**
+     * The authored leaf, or `null` for a colour the engine derives and for the
+     * UI scale factor and page widths.
+     */
     readonly source: CatalogueSource | null;
-    /** The full appearance config a derived colour was computed from. */
-    readonly appearance: DeepReadonly<NxdsAppearanceState> | null;
+    /** The appearance fields a derived colour was computed from, and its mode. */
+    readonly appearance: DeepReadonly<NxdsColorAppearance & {
+        readonly mode: Mode;
+    }> | null;
     readonly authoredValue: TokenValue | null;
     /**
      * What the generated CSS declares: one custom property for a scalar or a
@@ -76,12 +91,16 @@ interface CatalogueVariant {
     readonly references: readonly CatalogueReference[];
 }
 /**
- * The appearance setting that writes a token at runtime: a preset field that
- * picks one of its moded values, or a preference the provider computes it from.
+ * An appearance setting that writes a token at runtime: a preset field that
+ * picks one of its moded values, the UI scale or text size that scales its
+ * value, or a preference the provider computes it from.
  */
 type CatalogueControl = {
     readonly kind: 'preset';
     readonly field: NxdsPresetField;
+} | {
+    readonly kind: 'scale';
+    readonly field: 'uiScale' | 'textSize';
 } | {
     readonly kind: 'pref';
     readonly field: keyof NxdsAppearancePrefs;
@@ -91,25 +110,30 @@ interface CatalogueToken {
     readonly family: CatalogueFamily;
     /**
      * The registry category for a derived colour, the first path key for a
-     * nested leaf (`green`, `size`, `container`), or the family for a flat file.
+     * nested leaf (`green`, `size`, `container`), or the family for a flat file
+     * and for a token no file authors.
      */
     readonly group: string;
     /** The DTCG `$type`. */
     readonly type: string;
     readonly description: string | null;
     readonly aliases: readonly CatalogueAlias[];
-    /** The appearance setting that writes it, or `null` when nothing does. */
-    readonly control: CatalogueControl | null;
+    /** The appearance settings that write it. Empty when nothing does. */
+    readonly controls: readonly CatalogueControl[];
     readonly variants: readonly CatalogueVariant[];
 }
 
 /**
  * Every nxds token, identified by its `--nx-*` name: primitives, runtime
- * colours, spacing, z-index, breakpoints, and typography and shadow styles.
+ * colours, spacing, z-index, breakpoints, typography and shadow styles, and
+ * the UI scale factor and page widths.
  * Shadow layer primitives only compose the shadow styles.
- * Runtime colours are computed from `DEFAULT_NXDS_APPEARANCE` in explicit
- * light and dark modes; each variant records the appearance it used.
+ * Runtime colours are computed from `appearance` in explicit light and dark
+ * modes; each variant records the colour fields and mode it used. Sizes
+ * follow its UI scale, type sizes its text size too, and the code size its
+ * code font size. Every preset's variants are listed, and the appearance only
+ * says which one is in use.
  */
-declare function createTokenCatalogue(): readonly CatalogueToken[];
+declare function createTokenCatalogue(appearance?: CatalogueAppearance): readonly CatalogueToken[];
 
-export { type CatalogueAlias, type CatalogueControl, type CatalogueDeclaration, type CatalogueFamily, type CatalogueReference, type CatalogueSource, type CatalogueToken, type CatalogueTokenName, type CatalogueVariant, type TokenValue, createTokenCatalogue };
+export { type CatalogueAlias, type CatalogueAppearance, type CatalogueControl, type CatalogueDeclaration, type CatalogueFamily, type CatalogueReference, type CatalogueSource, type CatalogueToken, type CatalogueTokenName, type CatalogueVariant, type TokenValue, createTokenCatalogue };

package/dist/runtime/catalogue.d.ts

@@ -1,5 +1,5 @@
-import { N as NxdsPresetField, a as NxdsAppearancePrefs, b as NxdsAppearanceState } from './surface-ladder-CAjRqzCx.js';
-export { D as DARK_SURFACE_LADDER, L as LIGHT_SURFACE_LADDER, S as SURFACE_TOKENS, c as ShadeAnchor } from './surface-ladder-CAjRqzCx.js';
+import { N as NxdsColorAppearance, a as NxdsUiScale, b as NxdsTextSize, c as NxdsAppearancePrefs, d as NxdsPresetField } from './surface-ladder-B8LyPHC_.js';
+export { D as DARK_SURFACE_LADDER, L as LIGHT_SURFACE_LADDER, S as SURFACE_TOKENS, e as ShadeAnchor } from './surface-ladder-B8LyPHC_.js';
 import { M as Mode } from './palette-BKTIQ0WC.js';
 
 /** An authored DTCG `$value`: a scalar, a reference string, or a composite. */
@@ -11,8 +11,18 @@ type TokenValue = string | number | boolean | null | readonly TokenValue[] | {
 type DeepReadonly<T> = T extends object ? {
     readonly [Key in keyof T]: DeepReadonly<T[Key]>;
 } : T;
+/**
+ * The appearance fields the catalogue derives values from: runtime colours
+ * from the brand colour, surface tone and contrasts, sizes from the UI scale,
+ * type sizes from the text size too, and the code size from `codeFontSize`.
+ */
+type CatalogueAppearance = NxdsColorAppearance & {
+    readonly uiScale: NxdsUiScale;
+    readonly textSize: NxdsTextSize;
+    readonly prefs: Pick<NxdsAppearancePrefs, 'codeFontSize'>;
+};
 /** Token families the catalogue covers. */
-type CatalogueFamily = 'borderwidth' | 'breakpoint' | 'color' | 'motion' | 'radius' | 'shadow' | 'spacing' | 'typography' | 'z-index';
+type CatalogueFamily = 'borderwidth' | 'breakpoint' | 'color' | 'icon' | 'motion' | 'radius' | 'shadow' | 'spacing' | 'typography' | 'ui-scale' | 'width' | 'z-index';
 /**
  * Canonical identity: an identifier in the `--nx-*` custom property scheme.
  * Most tokens declare it in the generated CSS. Typography styles and
@@ -61,10 +71,15 @@ interface CatalogueVariant {
      * file.
      */
     readonly preset: string | null;
-    /** The authored leaf, or `null` for a colour the engine derives. */
+    /**
+     * The authored leaf, or `null` for a colour the engine derives and for the
+     * UI scale factor and page widths.
+     */
     readonly source: CatalogueSource | null;
-    /** The full appearance config a derived colour was computed from. */
-    readonly appearance: DeepReadonly<NxdsAppearanceState> | null;
+    /** The appearance fields a derived colour was computed from, and its mode. */
+    readonly appearance: DeepReadonly<NxdsColorAppearance & {
+        readonly mode: Mode;
+    }> | null;
     readonly authoredValue: TokenValue | null;
     /**
      * What the generated CSS declares: one custom property for a scalar or a
@@ -76,12 +91,16 @@ interface CatalogueVariant {
     readonly references: readonly CatalogueReference[];
 }
 /**
- * The appearance setting that writes a token at runtime: a preset field that
- * picks one of its moded values, or a preference the provider computes it from.
+ * An appearance setting that writes a token at runtime: a preset field that
+ * picks one of its moded values, the UI scale or text size that scales its
+ * value, or a preference the provider computes it from.
  */
 type CatalogueControl = {
     readonly kind: 'preset';
     readonly field: NxdsPresetField;
+} | {
+    readonly kind: 'scale';
+    readonly field: 'uiScale' | 'textSize';
 } | {
     readonly kind: 'pref';
     readonly field: keyof NxdsAppearancePrefs;
@@ -91,25 +110,30 @@ interface CatalogueToken {
     readonly family: CatalogueFamily;
     /**
      * The registry category for a derived colour, the first path key for a
-     * nested leaf (`green`, `size`, `container`), or the family for a flat file.
+     * nested leaf (`green`, `size`, `container`), or the family for a flat file
+     * and for a token no file authors.
      */
     readonly group: string;
     /** The DTCG `$type`. */
     readonly type: string;
     readonly description: string | null;
     readonly aliases: readonly CatalogueAlias[];
-    /** The appearance setting that writes it, or `null` when nothing does. */
-    readonly control: CatalogueControl | null;
+    /** The appearance settings that write it. Empty when nothing does. */
+    readonly controls: readonly CatalogueControl[];
     readonly variants: readonly CatalogueVariant[];
 }
 
 /**
  * Every nxds token, identified by its `--nx-*` name: primitives, runtime
- * colours, spacing, z-index, breakpoints, and typography and shadow styles.
+ * colours, spacing, z-index, breakpoints, typography and shadow styles, and
+ * the UI scale factor and page widths.
  * Shadow layer primitives only compose the shadow styles.
- * Runtime colours are computed from `DEFAULT_NXDS_APPEARANCE` in explicit
- * light and dark modes; each variant records the appearance it used.
+ * Runtime colours are computed from `appearance` in explicit light and dark
+ * modes; each variant records the colour fields and mode it used. Sizes
+ * follow its UI scale, type sizes its text size too, and the code size its
+ * code font size. Every preset's variants are listed, and the appearance only
+ * says which one is in use.
  */
-declare function createTokenCatalogue(): readonly CatalogueToken[];
+declare function createTokenCatalogue(appearance?: CatalogueAppearance): readonly CatalogueToken[];
 
-export { type CatalogueAlias, type CatalogueControl, type CatalogueDeclaration, type CatalogueFamily, type CatalogueReference, type CatalogueSource, type CatalogueToken, type CatalogueTokenName, type CatalogueVariant, type TokenValue, createTokenCatalogue };
+export { type CatalogueAlias, type CatalogueAppearance, type CatalogueControl, type CatalogueDeclaration, type CatalogueFamily, type CatalogueReference, type CatalogueSource, type CatalogueToken, type CatalogueTokenName, type CatalogueVariant, type TokenValue, createTokenCatalogue };