@viasat/beam-tokens 2.89.0 → 2.91.0

package/types/lib/native/types.d.ts

@@ -0,0 +1,58 @@
+import { Accent, BaseColorTheme, BaseShapeTheme } from '../../utils/constants/theme.js';
+import { BeamTokensTree } from './token-tree.generated.js';
+export type { Accent };
+/** Per-locale font-family overlay */
+export type { TypographyOverlay } from './i18n/typography-overlay.js';
+/** Locales the overlay covers */
+export type { SupportedLanguages } from '../../utils/constants/theme.js';
+/** Every accent the token build emits a theme module for. Guarded by the drift spec. */
+export { BASE_ACCENTS as ACCENTS } from '../../utils/constants/theme.js';
+export type Mode = BaseColorTheme;
+export type ProductType = BaseShapeTheme;
+/**
+ * The full resolved token tree for one mode — a shape-only interface generated
+ * from the default `teal-enterprise` theme (`token-tree.generated.ts`).
+ */
+export type BeamTokens = BeamTokensTree;
+/** The public slice app consumers read */
+export type Tokens = {
+    sem: BeamTokens['sem'];
+    expressive: BeamTokens['expressive'];
+    dataviz: BeamTokens['dataviz'];
+};
+/** The nine expressive micro-theme palettes */
+export type Expressive = BeamTokens['expressive'];
+/** The name of an expressive palette (`accent`, `blue`, …). */
+export type ExpressivePaletteKey = keyof Expressive;
+/** One expressive palette's slots. */
+export type ExpressivePalette = Expressive[ExpressivePaletteKey];
+/**
+ * A theme module, typed with the modes it ships.
+ * - `TokenThemes<'light' | 'dark'>` ships both modes; `TokenThemes<'light'>` ships light only.
+ * - Bare `TokenThemes` means any theme (at least one mode). The provider and `setTheme` take this;
+ *   use it to store or collect themes: `useState<TokenThemes>(…)`, `Record<string, TokenThemes>`.
+ */
+export type TokenThemes<M extends Mode = never> = {
+    accent: Accent;
+    productType: ProductType;
+} & ([M] extends [never] ? {
+    light: BeamTokens;
+    dark?: BeamTokens;
+} | {
+    light?: BeamTokens;
+    dark: BeamTokens;
+} : {
+    [K in M]: BeamTokens;
+});
+/**
+ * Identifies the active combo.
+ *
+ * Mirrors `BeamTheme` in @viasat/beam-shared (src/lib/utils/constants.ts) — see
+ * `BASE_ACCENTS` in utils/constants/theme.ts for why these are duplicated rather
+ * than imported. Keep in sync.
+ */
+export type BeamTheme = {
+    mode: Mode;
+    accent: Accent;
+    productType: ProductType;
+};

package/types/utils/build-tokens-native.d.ts

@@ -0,0 +1 @@
+export {};

package/types/utils/constants/class-names.d.ts

@@ -1,4 +1,4 @@
-import { ClassName } from './types';
+import { ClassName } from './types.js';
 export declare const DEFAULT_BRAND = "beam";
 export declare const BEAM_PREFIX = "bm";
 export declare const BEAM_LIGHT_THEME = "bm-light";

package/types/utils/constants/index.d.ts

@@ -1,7 +1,7 @@
-export * from './class-names';
-export * from './math';
-export * from './paths';
-export * from './token-types';
-export * from './theme';
-export * from './types';
-export * from './typography';
+export * from './class-names.js';
+export * from './math.js';
+export * from './paths.js';
+export * from './token-types.js';
+export * from './theme.js';
+export * from './types.js';
+export * from './typography.js';

package/types/utils/constants/theme.d.ts

@@ -5,6 +5,7 @@ export declare const BASE_COLOR_THEMES: {
     readonly light: "light";
     readonly dark: "dark";
 };
+export type BaseColorTheme = typeof BASE_COLOR_THEMES[keyof typeof BASE_COLOR_THEMES];
 /**
  * Shapes themes we support
  */
@@ -12,6 +13,24 @@ export declare const BASE_SHAPE_THEMES: {
     readonly consumer: "consumer";
     readonly enterprise: "enterprise";
 };
+export type BaseShapeTheme = typeof BASE_SHAPE_THEMES[keyof typeof BASE_SHAPE_THEMES];
+/**
+ * Accents the token build emits a theme for.
+ *
+ * Mirrors `ACCENT` in @viasat/beam-shared (src/lib/utils/constants.ts).
+ * Deliberately duplicated: @viasat/beam-tokens publishes with zero dependencies
+ * and shouldn't take one on @viasat/beam-shared for a seven-item list.
+ * Keep the two in sync. Drift against the emitted native themes is caught by
+ * `native.accents-guard.spec.ts`.
+ */
+export declare const BASE_ACCENTS: readonly ["blue", "green", "neutral", "orange", "pink", "teal", "violet"];
+/** One of the accent families the build emits. */
+export type Accent = typeof BASE_ACCENTS[number];
+/**
+ * The base ramp. Has no accent override directory of its own, and its enterprise
+ * light tree defines the public `BeamTokens` shape (`token-tree.generated.ts`).
+ */
+export declare const DEFAULT_ACCENT = "teal";
 /**
  * Language that are supported. Update this list as needed
  */
@@ -23,3 +42,4 @@ export declare const SUPPORTED_LANGUAGE_CODES: {
     readonly zh: "zh";
 };
 export declare const SUPPORT_LANGUAGES: ("ar" | "he" | "ja" | "th" | "zh")[];
+export type SupportedLanguages = typeof SUPPORTED_LANGUAGE_CODES[keyof typeof SUPPORTED_LANGUAGE_CODES];

package/types/utils/constants/token-types.d.ts

@@ -1,4 +1,4 @@
-import { TOKEN_CATEGORY } from './types';
+import { TOKEN_CATEGORY } from './types.js';
 export declare const TOKEN_CATEGORIES_SEM: {
     readonly sem: "sem";
     readonly alias: "alias";

package/types/utils/constants/types.d.ts

@@ -1,16 +1,11 @@
 import { Config, Format, Named, Platform, Transform, TransformGroup, File, TransformedToken } from 'style-dictionary';
-import { TOKEN_FILE_NAMES } from './paths';
-import { EXPRESSIVE_THEMES, SUPPORTED_TOKEN_TYPES, TOKEN_CATEGORIES } from './token-types';
-import { BASE_COLOR_THEMES, BASE_SHAPE_THEMES, SUPPORTED_LANGUAGE_CODES } from './theme';
+import { TOKEN_FILE_NAMES } from './paths.js';
+import { EXPRESSIVE_THEMES, SUPPORTED_TOKEN_TYPES, TOKEN_CATEGORIES } from './token-types.js';
+import { BaseColorTheme, BaseShapeTheme, SupportedLanguages } from './theme.js';
 export type TOKEN_FILE_NAME_KEYS = keyof typeof TOKEN_FILE_NAMES;
 export type VALID_TOKEN_TYPES = keyof typeof SUPPORTED_TOKEN_TYPES;
 export type TOKEN_CATEGORY = keyof typeof TOKEN_CATEGORIES;
-/**
- * Theming
- */
-export type BaseColorTheme = typeof BASE_COLOR_THEMES[keyof typeof BASE_COLOR_THEMES];
-export type BaseShapeTheme = typeof BASE_SHAPE_THEMES[keyof typeof BASE_SHAPE_THEMES];
-export type SupportedLanguages = typeof SUPPORTED_LANGUAGE_CODES[keyof typeof SUPPORTED_LANGUAGE_CODES];
+export type { SupportedLanguages };
 export type ComponentTokenPaths = typeof TOKEN_FILE_NAMES[Extract<TOKEN_CATEGORY, 'comp'>];
 export type PrimitiveAndCompTokenCategories = Extract<TOKEN_CATEGORY, 'primitive' | 'comp'>;
 export type TokenOutputPaths = Record<TOKEN_FILE_NAME_KEYS | PrimitiveAndCompTokenCategories | BaseColorTheme, string | ComponentTokenPaths | TOKEN_FILE_NAME_KEYS[]>;

package/types/utils/files/cleanup.d.ts

@@ -1,5 +1,5 @@
 /**
- * Cleans directories in the library folder except for index.ts
+ * Cleans directories in the library folder except for index.ts and native/
  * @param dirPath - Directory path to clean
  */
 export declare const cleanLibsDir: (dirPath: string) => Promise<void>;

package/types/utils/files/index.d.ts

@@ -1,5 +1,5 @@
-export * from './cleanup';
-export * from './merge';
-export * from './paths';
-export * from './scan';
-export * from './validate';
+export * from './cleanup.js';
+export * from './merge.js';
+export * from './paths.js';
+export * from './scan.js';
+export * from './validate.js';

package/types/utils/files/merge.d.ts

@@ -1,5 +1,5 @@
 import { BuiltInParserName, CustomParser, LiteralUnion } from 'prettier';
-import { BuildConfig, VALID_TOKEN_TYPES } from '../constants/types';
+import { BuildConfig, VALID_TOKEN_TYPES } from '../constants/types.js';
 /**
  * Merges multiple files into a single output file
  * @param outputPaths - Array of paths to input files

package/types/utils/files/paths.d.ts

@@ -1,5 +1,5 @@
 import { Config } from 'style-dictionary';
-import { OutPutFilesPaths, BuildConfig, ThemeConfig, OrganizedThemes } from '../constants/types';
+import { OutPutFilesPaths, BuildConfig, ThemeConfig, OrganizedThemes } from '../constants/types.js';
 /**
  * Generates a list of output file paths from Style Dictionary configs
  * @param configs - Array of Style Dictionary configurations

package/types/utils/formatters/className.d.ts

@@ -1,4 +1,4 @@
-import { BaseColorTheme, ClassName } from '../../utils/constants';
+import { BaseColorTheme, ClassName } from '../../utils/constants/index.js';
 /**
  * Creates a theme class name object.
  */

package/types/utils/formatters/format.css.d.ts

@@ -1,5 +1,5 @@
 import { TransformedToken, Dictionary, Options } from 'style-dictionary';
-import { TOKEN_CATEGORIES, TOKEN_CATEGORY } from '../constants';
+import { TOKEN_CATEGORIES, TOKEN_CATEGORY } from '../constants/index.js';
 /**
  * Generates CSS variables for a given set of tokens.
  * @param dictionary - The list of transformed tokens.

package/types/utils/formatters/format.scss.d.ts

@@ -1,5 +1,5 @@
 import { Format, Named, TransformedToken } from 'style-dictionary';
-import { CssVarsFormatters } from '../constants/types';
+import { CssVarsFormatters } from '../constants/types.js';
 export declare const createScssVariables: ({ dictionary, }: {
     dictionary: TransformedToken[];
 }) => string;

package/types/utils/formatters/index.d.ts

@@ -1,4 +1,4 @@
-export * from './className';
-export * from './format.css';
-export * from './format.scss';
-export * from './token.utils.css';
+export * from './className.js';
+export * from './format.css.js';
+export * from './format.scss.js';
+export * from './token.utils.css.js';

package/types/utils/index.d.ts

@@ -1,8 +1,8 @@
-export * from './constants';
-export * from './files';
-export * from './formatters';
-export * from './functions';
-export * from './occurrences';
-export * from './tokens';
-export * from './transformers';
-export * from './dataviz';
+export * from './constants/index.js';
+export * from './files/index.js';
+export * from './formatters/index.js';
+export * from './functions.js';
+export * from './occurrences.js';
+export * from './tokens.js';
+export * from './transformers.js';
+export * from './dataviz.js';

package/types/utils/occurrences.d.ts

@@ -1,4 +1,4 @@
-import { OccurrenceCounts } from './constants';
+import { OccurrenceCounts } from './constants/index.js';
 /**
  * Counts the number of occurrences of a string in another string.
  * Uses word boundaries to ensure we match complete token segments, not substrings.

package/types/utils/tokens.d.ts

@@ -1,5 +1,5 @@
 import { TransformedToken } from 'style-dictionary';
-import { TOKEN_CATEGORY, TokenType } from './constants';
+import { TOKEN_CATEGORY, TokenType } from './constants/index.js';
 /**
  * Checks if a token belongs to a specific category.
  */