@globalpayments/vega 2.87.0 → 2.89.0

package/dist/types/vega-color-token-contrast-checker/src/check/search.d.ts

@@ -0,0 +1,58 @@
+import { RgbColor } from './color-math';
+import { ContextSurface, TokenCheckConfig } from './token-checks';
+/**
+ * Search engine for finding perceptually-closest feasible colors in OKLCH space and
+ * resolving minimum-alpha / RGB-shift fixes for WCAG contrast requirements.
+ *
+ * The constructor takes the static `fixedSurfaces` table and the `bg-primary` RGB used
+ * as the underlying composite surface for semi-transparent paint. Both come from the
+ * design-token map supplied by the consumer.
+ */
+export declare class ColorSearchEngine {
+  private readonly fixedSurfaces;
+  private readonly lightBgPrimary;
+  constructor(fixedSurfaces: Readonly<Record<string, ContextSurface>>);
+  /** Binary-search iterations on L axis; 10 → ~0.001 precision. */
+  private static readonly SUGGESTION_SEARCH_ITERATIONS;
+  /** Hue offsets (degrees) sampled during search; ±5° preserves brand hue family. */
+  private static readonly SUGGESTION_HUE_OFFSETS_DEG;
+  /** Chroma multipliers sampled during search; allows modest saturation drift. */
+  private static readonly SUGGESTION_CHROMA_SCALES;
+  /** Chroma below which the origin is treated as achromatic (hue/chroma grid skipped). */
+  private static readonly ACHROMATIC_CHROMA_EPSILON;
+  /** Uniform L-axis steps for linear scan; 100 → 0.01 precision, enough for narrow bands. */
+  private static readonly L_SCAN_STEPS;
+  /** 2⁻⁷ ≈ 0.008 precision; matches 2-decimal output rounding. */
+  private static readonly ALPHA_ASCENT_ITERATIONS;
+  /**
+   * Find the closest feasible color (by OKLab ΔE) within a (hue ± 5°, chroma × 0.6–1.4) grid.
+   *
+   * @param {RgbColor} origin - Starting RGB color to search from.
+   * @param {Function} isFeasible - Predicate returning true if a candidate RGB meets constraints.
+   * @param {boolean} assumeMonotone - `true`: binary search on L (fast, monotone predicate required);
+   *   `false`: linear scan on L (handles internal-band feasibility).
+   * @returns {RgbColor | undefined} Closest feasible RGB, or `undefined` if none found in envelope.
+   */
+  searchClosestFeasibleInOklch(origin: RgbColor, isFeasible: (rgb: RgbColor) => boolean, assumeMonotone?: boolean): RgbColor | undefined;
+  /**
+   * Binary-search for the minimum alpha that makes composite contrast ≥ threshold.
+   * Result is ceil-rounded to 2 decimals. Returns `undefined` if α=1.0 still fails.
+   *
+   * @param {RgbColor} rgb - Token's base RGB color.
+   * @param {number} currentAlpha - Current alpha (lower bound for search).
+   * @param {TokenCheckConfig} checkConfig - Token check configuration (pairing, type, compositedOn).
+   * @param {number} threshold - Required WCAG contrast ratio.
+   * @param {Map<string, string>} tokenMap - Resolved token map for surface lookups.
+   * @returns {number | undefined} Minimum alpha (ceil-rounded), or `undefined` if infeasible.
+   */
+  findMinimumAlphaForContrast(rgb: RgbColor, currentAlpha: number, checkConfig: TokenCheckConfig, threshold: number, tokenMap: Map<string, string>): number | undefined;
+  /**
+   * Find the closest opaque RGB (by OKLab ΔE) satisfying WCAG threshold against all configs.
+   *
+   * @param {RgbColor} originalRgb - Starting RGB color.
+   * @param {TokenCheckConfig[]} configs - Token check configs (one per paired surface).
+   * @param {Map<string, string>} tokenMap - Resolved token map for surface lookups.
+   * @returns {RgbColor | undefined} Closest feasible RGB, or `undefined` if none found.
+   */
+  findRgbPatchForContrastAll(originalRgb: RgbColor, configs: TokenCheckConfig[], tokenMap: Map<string, string>): RgbColor | undefined;
+}

package/dist/types/vega-color-token-contrast-checker/src/check/token-checks.d.ts

@@ -0,0 +1,122 @@
+import { RgbColor } from './color-math';
+/**
+ * A paired-with surface — the color value the token's rendered output is compared
+ * against. Carries an alpha because some tokens (e.g. v2-new-brand `text-on-action` =
+ * `252,252,254,0.9`) are themselves semi-transparent and must be composited onto their
+ * own background before contrast is measured.
+ */
+export declare type ContextSurface = {
+  rgb: RgbColor;
+  a: number;
+};
+/** Static token catalogue entry — produced by the build-time generator. */
+export declare type TokenCheckConfig = {
+  tokenName: string;
+  /**
+   * Name of the token whose rendered surface this check is measured against. Resolved
+   * by {@link resolvePairedSurface} — actionColor-derived tokens are looked up in
+   * `tokenMap`; static design tokens fall through to the `fixedSurfaces` table.
+   */
+  pairedWith: string;
+  /**
+   * Contrast check category — determines which {@link ContrastCheckStrategy} handles the
+   * fg/bg computation and which WCAG AA threshold applies:
+   *  - `'bg-text'`: token is a background; paired text sits on top (4.5:1).
+   *  - `'text-bg'`: token is foreground text; paired surface is behind (4.5:1).
+   *  - `'non-text-contrast'`: token is a border/ring/UI element (3:1).
+   */
+  type: 'bg-text' | 'text-bg' | 'non-text-contrast';
+  /**
+   * Override the surface the token is alpha-composited onto when computing its rendered
+   * color. Normally a semi-transparent `non-text-contrast` token is composited onto its
+   * `pairedWith` surface. For box-shadow rings that paint *outside* an element (on the
+   * page background) but are compared against the element's fill, set this to
+   * `'bg-primary'` so the composite matches what the browser actually renders.
+   */
+  compositedOn?: string;
+};
+/** Detail type for failing tokens — used by the validator's public result. */
+export declare type ColorContrastDetail = {
+  tokenName: string;
+  contrastRatio: number;
+  requiredRatio: number;
+};
+/** Contrast computation result including rendered colors. */
+export declare type ContrastResult = {
+  fg: RgbColor;
+  bg: RgbColor;
+  contrastRatio: number;
+};
+/** Per-check fixability record. */
+export declare type FixabilityRecord = {
+  fixable: boolean;
+  maxContrast: number;
+};
+/**
+ * Names of the static design tokens that have no `overrideGetter` — the surfaces every
+ * actionColor-derived token may be paired with. Source-of-truth for which static tokens
+ * the checker must know about. Kept here (not in the consumer) so adding new pair targets
+ * is a one-line change in this package.
+ *
+ * Each entry's real SCSS consumer is documented in the catalogue's inline comment.
+ * `bg-action-tertiary` is α=0 (fully transparent) — composites collapse to `bg-primary`.
+ */
+export declare const FIXED_PAIRED_SURFACE_TOKENS: readonly string[];
+/**
+ * Parse the comma-separated `r, g, b, a` shape used by the generated `*-color-tokens.ts` files.
+ *
+ * @param {string} value - Comma-separated string in `"r, g, b, a"` format (e.g. `"252, 252, 254, 0.9"`).
+ * @returns {ContextSurface} Parsed {@link ContextSurface} with `rgb` and `a` fields.
+ * @throws {Error} If the string has fewer than 4 parts or contains non-numeric values.
+ */
+export declare function parseCommaTokenValue(value: string): ContextSurface;
+/**
+ * Build the fixed paired-surface table from the consumer's static design-token map.
+ *
+ * @param {Record<string, string>} designTokens - Source design tokens (token name → "r, g, b, a").
+ * @returns {Readonly<Record<string, ContextSurface>>} Frozen table for the checker.
+ */
+export declare function buildFixedPairedSurfaces(designTokens: Record<string, string>): Readonly<Record<string, ContextSurface>>;
+/**
+ * Resolve a `pairedWith` name to its rendered {@link ContextSurface}.
+ *
+ * Lookup order:
+ *  1. **`tokenMap` (actionColor-derived)** — covers every token that has an
+ *     `overrideGetter` and therefore depends on `actionColor`.
+ *  2. **`fixedSurfaces`** — covers the static design tokens that have no `overrideGetter`.
+ *
+ * @param {string} pairedWith - Token name to resolve.
+ * @param {Map<string, string>} tokenMap - Resolved token map for dynamic lookups.
+ * @param {Readonly<Record<string, ContextSurface>>} fixedSurfaces - Static surface table.
+ * @returns {ContextSurface | undefined} Resolved surface, or undefined if not found.
+ */
+export declare function resolvePairedSurface(pairedWith: string, tokenMap: Map<string, string>, fixedSurfaces: Readonly<Record<string, ContextSurface>>): ContextSurface | undefined;
+/**
+ * Resolve a paired surface to its rendered foreground RGB when it sits on top of `bg`.
+ * For opaque surfaces this is a no-op; for `text-on-action` (α<1) it performs the alpha
+ * composite the browser does at paint time, so the contrast ratio we compute matches
+ * what axe / Chrome DevTools see.
+ *
+ * @param {ContextSurface} surface - Surface to resolve.
+ * @param {RgbColor} bg - Background color for alpha compositing.
+ * @returns {RgbColor} Effective foreground RGB.
+ */
+export declare function effectiveFgRgb(surface: ContextSurface, bg: RgbColor): RgbColor;
+/**
+ * Return the WCAG AA required contrast ratio for a check type.
+ *
+ * @param {TokenCheckConfig['type']} type - Check type.
+ * @returns {number} Required contrast ratio.
+ */
+export declare function requiredRatioFor(type: TokenCheckConfig['type']): number;
+/**
+ * Compute the contrast ratio + rendered colors for a single token check under a given
+ * `actionColor`. Returns null when the token has no override value, the value can't be
+ * parsed, or the paired surface fails to resolve (catalogue typo).
+ *
+ * @param {TokenCheckConfig} checkConfig - Token check configuration.
+ * @param {Map<string, string>} tokenMap - Resolved token map for surface lookups.
+ * @param {Readonly<Record<string, ContextSurface>>} fixedSurfaces - Static surface table.
+ * @returns {ContrastResult | null} Contrast result or null.
+ */
+export declare function computeTokenContrast(checkConfig: TokenCheckConfig, tokenMap: Map<string, string>, fixedSurfaces: Readonly<Record<string, ContextSurface>>): ContrastResult | null;

package/dist/types/vega-color-token-contrast-checker/src/check/token-checks.generated.d.ts

@@ -0,0 +1,2 @@
+import type { TokenCheckConfig } from './token-checks';
+export declare const ACTION_COLOR_CHECKS: readonly TokenCheckConfig[];

package/dist/types/vega-color-token-contrast-checker/src/index.d.ts

@@ -0,0 +1,2 @@
+export { VegaColorTokenContrastChecker, ContrastCheckResult } from './check/checker';
+export { ColorContrastDetail } from './check/token-checks';

package/dist/vega/index.esm.js

@@ -1 +1 @@
-export{g as getCurrentBreakpoint}from"./p-49a2e141.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-6e1ab235.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-19adf714.js";export{c as camelToDashCase}from"./p-02841589.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-78ba7ca9.js";export{B as Breakpoints}from"./p-ed45b3b6.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{b as Typography,a as TypographyKeys,T as TypographyUrls}from"./p-d884c644.js";export{d as BoxDisplay,e as BreakpointKeys,C as CssStates,F as FlexDirections}from"./p-d4ea8e22.js";export{F as FrameworkEnum,v as VegaEnvManager}from"./p-5f377954.js";export{A as ActionHandlerInterceptor,I as InsertNodeToNearestRootAction,o as RTELanguageToolbarButtonRenderer,m as RTETokenNode,n as RTETokenNodeRenderer,R as RTETokenToolbarButtonRenderer,b as VegaEventManager,V as VegaLoader,a as VegaNotify,j as VegaRTEExtension,k as VegaRTEExtensionRenderer,h as VegaRTEFunctionExtension,g as VegaRTELanguageExtension,i as VegaRTETableExtension,f as VegaRTETokenExtension,l as VegaRTEToolbarButtonRenderer,d as VegaSkeletonLoader,e as VegaTranslation,c as VegaZIndexManager,w as waitForVega}from"./p-32a0f887.js";export{F as FeatureFlag}from"./p-dcf162e9.js";export{V as VegaThemeManager}from"./p-0d97dcb9.js";export{V as VegaDialog}from"./p-b6be1f33.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-4dd02704.js";export{V as VegaIconManager}from"./p-1704ff25.js";export{V as ValidCreditCardNumberRule}from"./p-858ec529.js";import"./p-ec2a1d4c.js";export{s as VegaTranslationResourceEN}from"./p-0a261b66.js";export{s as setVegaNonce}from"./p-4866e390.js";export{g as ActionHandleStrategy,h as AppendChildrenAction,ab as CodeLanguage,o as CustomAttributeAnnotation,D as CustomClassAnnotation,z as CustomStyleAnnotation,I as InsertChildrenAfterAction,j as InsertChildrenBeforeAction,M as ModifyContentAction,l as ModifyContentActionType,f as RTEAnnotationStyle,d as RTEBlock,G as RTEDecoratorNode,p as RTEFilterStylesStrategy,i as RTENode,e as RTETextBlock,c as RTETextNode,n as RemoveChildrenAction,ac as VegaRTEDefaultTextStyleItems,V as VegaRTEPresetToolbarItems}from"./p-a2b8d49d.js";export{B as BlockToRTEBlockStrategyAbstract,a as ElementToDTOStrategy,I as InsertNewParagraphAction,b as RTEImageBlock,f as RTEImageNode,e as RTEListBlock,d as RTEListItemBlock,U as UpdateCursorPositionAction,V as VegaRTEContent,h as htmlElementToAnnotationGenerator}from"./p-e8ea3b16.js";export{G as GridColumns,a as GridRows}from"./p-b02b985d.js";export{C as CheckBoxRequiredRule}from"./p-590fd123.js";export{D as DateRequiredRule}from"./p-189d36ec.js";export{I as InputPhoneNumberRequiredRule}from"./p-07c2725a.js";export{I as InputRangeRequiredRule}from"./p-f396c69a.js";export{R as RequiredFieldRule}from"./p-280cbcdb.js";export{R as RichTextEditorRequiredRule}from"./p-042933f1.js";export{T as TimeRangeRequiredRule,a as TimeRequiredRule}from"./p-a0dd08b1.js";export{T as ToggleSwitchRequiredRule}from"./p-7c0b4c36.js";export{F as FileUploaderRequiredRule}from"./p-0bb860cc.js";export{R as RTERange}from"./p-72e2a587.js";import"./p-281fa1e0.js";import"./p-8b5d3a52.js";import"./p-9a6bd32c.js";import"./p-6a334573.js";import"./p-781fd6e0.js";import"./p-262ec334.js";import"./p-81dd00d0.js";import"./p-b75ee3ba.js";import"./p-b6c3ce6d.js";import"./p-a7b5f497.js";import"./p-724df1f5.js";import"./p-11e2dcf5.js";import"./p-2d0d575f.js";import"./p-331a62d5.js";import"./p-2927b7a1.js";import"./p-3a93730e.js";import"./p-77e64f26.js";import"./p-8aee6b74.js";import"./p-a528714c.js";import"./p-fb5ea4b2.js";import"./p-f0e828d8.js";import"./p-0c667d6a.js";import"./p-a841cf13.js";import"./p-1bc5b3bc.js";import"./p-982747ef.js";import"./p-abd7aeaa.js";import"./p-d27ae9ff.js";const r=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{r as Rings}
+export{g as getCurrentBreakpoint}from"./p-49a2e141.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-6e1ab235.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-ad89f499.js";export{c as camelToDashCase}from"./p-02841589.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-b2488adb.js";export{B as Breakpoints}from"./p-ed45b3b6.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{b as Typography,a as TypographyKeys,T as TypographyUrls}from"./p-d884c644.js";export{d as BoxDisplay,e as BreakpointKeys,C as CssStates,F as FlexDirections}from"./p-d4ea8e22.js";export{F as FrameworkEnum,v as VegaEnvManager}from"./p-5f377954.js";export{A as ActionHandlerInterceptor,I as InsertNodeToNearestRootAction,z as RTELanguageToolbarButtonRenderer,x as RTETokenNode,y as RTETokenNodeRenderer,R as RTETokenToolbarButtonRenderer,b as VegaEventManager,V as VegaLoader,a as VegaNotify,h as VegaRTEDefaultLineHeightOptions,t as VegaRTEExtension,u as VegaRTEExtensionRenderer,i as VegaRTEFunctionExtension,k as VegaRTEHorizontalLineExtension,g as VegaRTELanguageExtension,s as VegaRTELineHeightExtension,p as VegaRTESpecialCharactersArrows,q as VegaRTESpecialCharactersCurrency,m as VegaRTESpecialCharactersEssentials,l as VegaRTESpecialCharactersExtension,n as VegaRTESpecialCharactersLatin,o as VegaRTESpecialCharactersMathematical,r as VegaRTESpecialCharactersText,j as VegaRTETableExtension,f as VegaRTETokenExtension,v as VegaRTEToolbarButtonRenderer,d as VegaSkeletonLoader,e as VegaTranslation,c as VegaZIndexManager,w as waitForVega}from"./p-89947a43.js";export{F as FeatureFlag}from"./p-dcf162e9.js";export{V as VegaThemeManager}from"./p-5f09aba8.js";export{V as VegaDialog}from"./p-b6be1f33.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-46cab60a.js";export{V as VegaIconManager}from"./p-1704ff25.js";export{V as ValidCreditCardNumberRule}from"./p-2abdca42.js";import"./p-528748fa.js";export{s as VegaTranslationResourceEN}from"./p-091fbc35.js";export{s as setVegaNonce}from"./p-4866e390.js";export{g as ActionHandleStrategy,h as AppendChildrenAction,ab as CodeLanguage,o as CustomAttributeAnnotation,G as CustomClassAnnotation,t as CustomStyleAnnotation,I as InsertChildrenAfterAction,j as InsertChildrenBeforeAction,M as ModifyContentAction,l as ModifyContentActionType,f as RTEAnnotationStyle,d as RTEBlock,q as RTEDecoratorNode,p as RTEFilterStylesStrategy,i as RTENode,e as RTETextBlock,c as RTETextNode,n as RemoveChildrenAction,ac as VegaRTEDefaultTextStyleItems,V as VegaRTEPresetToolbarItems}from"./p-50e7020c.js";export{B as BlockToRTEBlockStrategyAbstract,a as ElementToDTOStrategy,I as InsertNewParagraphAction,b as RTEImageBlock,f as RTEImageNode,e as RTEListBlock,d as RTEListItemBlock,U as UpdateCursorPositionAction,V as VegaRTEContent,h as htmlElementToAnnotationGenerator}from"./p-a18d280f.js";export{G as GridColumns,a as GridRows}from"./p-94a064a3.js";export{C as CheckBoxRequiredRule}from"./p-590fd123.js";export{D as DateRequiredRule}from"./p-be6c1415.js";export{I as InputPhoneNumberRequiredRule}from"./p-07c2725a.js";export{I as InputRangeRequiredRule}from"./p-f396c69a.js";export{R as RequiredFieldRule}from"./p-280cbcdb.js";export{R as RichTextEditorRequiredRule}from"./p-fae4d64e.js";export{T as TimeRangeRequiredRule,a as TimeRequiredRule}from"./p-1ab4c08d.js";export{T as ToggleSwitchRequiredRule}from"./p-7c0b4c36.js";export{F as FileUploaderRequiredRule}from"./p-0bb860cc.js";export{R as RTERange}from"./p-f7e8081e.js";import"./p-3390bb20.js";import"./p-8b5d3a52.js";import"./p-9a6bd32c.js";import"./p-6a334573.js";import"./p-781fd6e0.js";import"./p-262ec334.js";import"./p-81dd00d0.js";import"./p-b75ee3ba.js";import"./p-b6c3ce6d.js";import"./p-a7b5f497.js";import"./p-724df1f5.js";import"./p-526e3634.js";import"./p-2d0d575f.js";import"./p-331a62d5.js";import"./p-fcefb62c.js";import"./p-3a93730e.js";import"./p-77e64f26.js";import"./p-3e09aeed.js";import"./p-cb378636.js";import"./p-fb5ea4b2.js";import"./p-f0e828d8.js";import"./p-0c667d6a.js";import"./p-a841cf13.js";import"./p-1bc5b3bc.js";import"./p-2e86aee5.js";import"./p-982747ef.js";import"./p-abd7aeaa.js";import"./p-d27ae9ff.js";const E=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{E as Rings}