@syncfusion/ej2-office-common 35.1.37

package/src/features/diagrams/smart-art-diagram.d.ts

@@ -0,0 +1,96 @@
+/**
+ * SmartArtDiagram — bound instance of data + layout + style + colors + optional drawing.
+ * Host detection via a:graphicData@uri + dgm:relIds (CT_RelIds).
+ *
+ * Citations:
+ * - dml-diagram.xsd CT_RelIds (r:dm, r:lo, r:qs, r:cs all REQUIRED)
+ * - Requirement §16.3 host embedding
+ * - [MS-ODRAWXML] optional diagramDrawing
+ */
+import { DIAGRAM_GRAPHIC_DATA_URI } from './constants';
+import { DiagramDataModel } from './diagram-data-model';
+import { DiagramColors, DiagramDrawing, DiagramLayout, DiagramQuickStyle } from './diagram-views';
+import { ElementNode } from './element-tree';
+declare const SMART_ART_BRAND: unique symbol;
+/**
+ * CT_RelIds relationship id quartet (all required on markup).
+ * Values are relationship Ids (e.g. rId1), not target URIs.
+ */
+export interface DiagramRelIds {
+    readonly dm: string;
+    readonly lo: string;
+    readonly qs: string;
+    readonly cs: string;
+}
+export interface SmartArtDiagramInit {
+    readonly relIds: DiagramRelIds;
+    readonly data: DiagramDataModel;
+    readonly layout: DiagramLayout;
+    readonly quickStyle: DiagramQuickStyle;
+    readonly colors: DiagramColors;
+    readonly drawing?: DiagramDrawing | null;
+    /**
+     * Optional relationship id of the MS drawing part when present.
+     * Source may be dataModel/extLst dsp:dataModelExt/@relId (Word-observed)
+     * or another package path — preserve as found.
+     */
+    readonly drawingRelId?: string | null;
+    readonly drawingRelSource?: 'dataModelExt' | 'package' | 'unknown' | null;
+}
+/**
+ * Read CT_RelIds from a `dgm:relIds` element.
+ * Attributes are in the relationships namespace: r:dm, r:lo, r:qs, r:cs.
+ */
+export declare function parseRelIds(el: ElementNode): DiagramRelIds;
+/**
+ * Detect whether an a:graphicData (or subtree) hosts a diagram.
+ * Returns relIds element when DIAGRAM_GRAPHIC_DATA_URI matches and dgm:relIds present.
+ */
+export declare function findDiagramRelIdsInGraphicData(graphicData: ElementNode): {
+    relIdsEl: ElementNode;
+    relIds: DiagramRelIds;
+} | undefined;
+/**
+ * Walk a host fragment (e.g. w:drawing) looking for diagram graphicData.
+ */
+export declare function detectSmartArtInTree(tree: ElementNode): {
+    graphicData: ElementNode;
+    relIds: DiagramRelIds;
+} | undefined;
+export declare function isSmartArtGraphicDataUri(uri: string | null | undefined): boolean;
+/**
+ * Bound SmartArt instance. `data()` returns DiagramDataModel (instanceof).
+ */
+export declare class SmartArtDiagram {
+    readonly [SMART_ART_BRAND]: true;
+    private _relIds;
+    private _data;
+    private _layout;
+    private _quickStyle;
+    private _colors;
+    private _drawing;
+    private _drawingRelId;
+    private _drawingRelSource;
+    constructor(init: SmartArtDiagramInit);
+    readonly relIds: DiagramRelIds;
+    /** Requirement contract: data() instanceof DiagramDataModel. */
+    data(): DiagramDataModel;
+    layout(): DiagramLayout;
+    quickStyle(): DiagramQuickStyle;
+    colors(): DiagramColors;
+    drawing(): DiagramDrawing | null;
+    readonly drawingRelId: string | null;
+    readonly drawingRelSource: 'dataModelExt' | 'package' | 'unknown' | null;
+    setDrawing(drawing: DiagramDrawing | null, relId?: string | null): void;
+    /**
+     * True when any bound part is dirty (needs serialize on apply).
+     */
+    isDirty(): boolean;
+    clone(): SmartArtDiagram;
+}
+/**
+ * @private
+ */
+export declare function isSmartArtDiagram(value: unknown): value is SmartArtDiagram;
+/** Public constant re-export convenience for hosts. */
+export { DIAGRAM_GRAPHIC_DATA_URI };

package/src/features/diagrams/smart-art-diagram.js

@@ -0,0 +1,258 @@
+/**
+ * SmartArtDiagram — bound instance of data + layout + style + colors + optional drawing.
+ * Host detection via a:graphicData@uri + dgm:relIds (CT_RelIds).
+ *
+ * Citations:
+ * - dml-diagram.xsd CT_RelIds (r:dm, r:lo, r:qs, r:cs all REQUIRED)
+ * - Requirement §16.3 host embedding
+ * - [MS-ODRAWXML] optional diagramDrawing
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __values = (this && this.__values) || function (o) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator], i = 0;
+    if (m) return m.call(o);
+    return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+};
+var _a;
+import { DIAGRAM_GRAPHIC_DATA_URI, isDiagramGraphicDataUri, isDgmNamespace, isRNamespace, R_NAMESPACE } from './constants';
+import { isDiagramDataModel } from './diagram-data-model';
+import { isDiagramColors, isDiagramDrawing, isDiagramLayout, isDiagramQuickStyle } from './diagram-views';
+import { findChild, findChildren, getAttr, getAttrNS } from './element-tree';
+import { DiagramError, DiagramParseError } from './errors';
+var SMART_ART_BRAND = Symbol.for('@syncfusion/ej2-office-common.SmartArtDiagram');
+function requireRelId(value, name) {
+    if (value == null || value === '') {
+        throw new DiagramParseError('invalid_rel_ids', "dgm:relIds missing required r:" + name + ".");
+    }
+    return value;
+}
+/**
+ * Read CT_RelIds from a `dgm:relIds` element.
+ * Attributes are in the relationships namespace: r:dm, r:lo, r:qs, r:cs.
+ */
+export function parseRelIds(el) {
+    if (!isDgmNamespace(el.namespaceUri) || el.localName !== 'relIds') {
+        throw new DiagramParseError('invalid_root', "Expected dgm:relIds, got {" + (el.namespaceUri != null ? el.namespaceUri : 'null') + "}" + el.localName + ".");
+    }
+    var read = function (local) {
+        // Prefer r: NS; fall back to unprefixed / any.
+        var nsVal = function () {
+            var _nc = function () {
+                var _nc = getAttrNS(el, local, R_NAMESPACE);
+                return _nc != null ? _nc : (function () {
+                    var e_1, _a;
+                    try {
+                        for (var _b = __values(el.attributes), _c = _b.next(); !_c.done; _c = _b.next()) {
+                            var a = _c.value;
+                            if (a.name === local && isRNamespace(a.namespaceUri != null ? a.namespaceUri : null))
+                                return a.value;
+                        }
+                    }
+                    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                    finally {
+                        try {
+                            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                    }
+                    return undefined;
+                })();
+            }();
+            return _nc != null ? _nc : getAttr(el, local);
+        }();
+        return requireRelId(nsVal, local);
+    };
+    return {
+        dm: read('dm'),
+        lo: read('lo'),
+        qs: read('qs'),
+        cs: read('cs')
+    };
+}
+/**
+ * Detect whether an a:graphicData (or subtree) hosts a diagram.
+ * Returns relIds element when DIAGRAM_GRAPHIC_DATA_URI matches and dgm:relIds present.
+ */
+export function findDiagramRelIdsInGraphicData(graphicData) {
+    var uri = getAttr(graphicData, 'uri');
+    if (!isDiagramGraphicDataUri(uri))
+        return undefined;
+    var relIdsEl = function () {
+        var _nc = findChild(graphicData, 'relIds', isDgmNamespace);
+        return _nc != null ? _nc : findChildren(graphicData, 'relIds').find(function (c) { return isDgmNamespace(c.namespaceUri); });
+    }();
+    if (!relIdsEl)
+        return undefined;
+    return {
+        relIdsEl: relIdsEl,
+        relIds: parseRelIds(relIdsEl)
+    };
+}
+/**
+ * Walk a host fragment (e.g. w:drawing) looking for diagram graphicData.
+ */
+export function detectSmartArtInTree(tree) {
+    var e_2, _a;
+    var stack = [tree];
+    while (stack.length > 0) {
+        var n = stack.pop();
+        if (n === undefined)
+            break;
+        if (n.localName === 'graphicData') {
+            var hit = findDiagramRelIdsInGraphicData(n);
+            if (hit)
+                return {
+                    graphicData: n,
+                    relIds: hit.relIds
+                };
+        }
+        try {
+            for (var _b = __values(n.children), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var c = _c.value;
+                if (c.kind === 'element')
+                    stack.push(c);
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+    }
+    return undefined;
+}
+export function isSmartArtGraphicDataUri(uri) {
+    return isDiagramGraphicDataUri(uri);
+}
+/**
+ * Bound SmartArt instance. `data()` returns DiagramDataModel (instanceof).
+ */
+var SmartArtDiagram = /** @class */ (function () {
+    function SmartArtDiagram(init) {
+        this[_a] = true;
+        if (!isDiagramDataModel(init.data)) {
+            throw new DiagramError('catalog_error', 'SmartArtDiagram.data must be DiagramDataModel.');
+        }
+        if (!isDiagramLayout(init.layout)) {
+            throw new DiagramError('catalog_error', 'SmartArtDiagram.layout must be DiagramLayout.');
+        }
+        if (!isDiagramQuickStyle(init.quickStyle)) {
+            throw new DiagramError('catalog_error', 'SmartArtDiagram.quickStyle must be DiagramQuickStyle.');
+        }
+        if (!isDiagramColors(init.colors)) {
+            throw new DiagramError('catalog_error', 'SmartArtDiagram.colors must be DiagramColors.');
+        }
+        if (init.drawing != null && !isDiagramDrawing(init.drawing)) {
+            throw new DiagramError('catalog_error', 'SmartArtDiagram.drawing must be DiagramDrawing or null.');
+        }
+        this._relIds = __assign({}, init.relIds);
+        this._data = init.data;
+        this._layout = init.layout;
+        this._quickStyle = init.quickStyle;
+        this._colors = init.colors;
+        this._drawing = init.drawing != null ? init.drawing : null;
+        this._drawingRelId = init.drawingRelId != null ? init.drawingRelId : null;
+        this._drawingRelSource = init.drawingRelSource != null ? init.drawingRelSource : null;
+    }
+    Object.defineProperty(SmartArtDiagram.prototype, "relIds", {
+        get: function () {
+            return this._relIds;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    /** Requirement contract: data() instanceof DiagramDataModel. */
+    SmartArtDiagram.prototype.data = function () {
+        return this._data;
+    };
+    SmartArtDiagram.prototype.layout = function () {
+        return this._layout;
+    };
+    SmartArtDiagram.prototype.quickStyle = function () {
+        return this._quickStyle;
+    };
+    SmartArtDiagram.prototype.colors = function () {
+        return this._colors;
+    };
+    SmartArtDiagram.prototype.drawing = function () {
+        return this._drawing;
+    };
+    Object.defineProperty(SmartArtDiagram.prototype, "drawingRelId", {
+        get: function () {
+            return this._drawingRelId;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(SmartArtDiagram.prototype, "drawingRelSource", {
+        get: function () {
+            return this._drawingRelSource;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    SmartArtDiagram.prototype.setDrawing = function (drawing, relId) {
+        this._drawing = drawing;
+        if (relId !== undefined)
+            this._drawingRelId = relId;
+    };
+    /**
+     * True when any bound part is dirty (needs serialize on apply).
+     */
+    SmartArtDiagram.prototype.isDirty = function () {
+        if (this._data.dirty)
+            return true;
+        if (this._layout.dirty)
+            return true;
+        if (this._quickStyle.dirty)
+            return true;
+        if (this._colors.dirty)
+            return true;
+        if (this._drawing == null ? void 0 : this._drawing.dirty)
+            return true;
+        return false;
+    };
+    SmartArtDiagram.prototype.clone = function () {
+        var drawingClone = this._drawing != null ? this._drawing.clone() : null;
+        return new SmartArtDiagram({
+            relIds: __assign({}, this._relIds),
+            data: this._data.clone({
+                copyDirty: true
+            }),
+            layout: this._layout.clone(),
+            quickStyle: this._quickStyle.clone(),
+            colors: this._colors.clone(),
+            drawing: drawingClone,
+            drawingRelId: this._drawingRelId,
+            drawingRelSource: this._drawingRelSource
+        });
+    };
+    return SmartArtDiagram;
+}());
+export { SmartArtDiagram };
+_a = SMART_ART_BRAND;
+/**
+ * @private
+ */
+export function isSmartArtDiagram(value) {
+    return value instanceof SmartArtDiagram;
+}
+/** Public constant re-export convenience for hosts. */
+export { DIAGRAM_GRAPHIC_DATA_URI };

package/src/features/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Optional feature modules for EJ2 Office common codecs.
+ *
+ * Root/`features` umbrella re-exports ink and mathml (same as `src/index.ts`
+ * feature surface). Diagrams and SmartArt stay on subpaths / `src/all.ts`
+ * because they share many public names and must not star-collide.
+ *
+ * @packageDocumentation
+ */
+export * from './ink/index';
+export * from './mathml/index';

package/src/features/index.js

@@ -0,0 +1,11 @@
+/**
+ * Optional feature modules for EJ2 Office common codecs.
+ *
+ * Root/`features` umbrella re-exports ink and mathml (same as `src/index.ts`
+ * feature surface). Diagrams and SmartArt stay on subpaths / `src/all.ts`
+ * because they share many public names and must not star-collide.
+ *
+ * @packageDocumentation
+ */
+export * from './ink/index';
+export * from './mathml/index';

package/src/features/ink/constants.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Cited InkML / Wordprocessing ink constants.
+ *
+ * Sources:
+ * - W3C InkML 1.0 §1 / namespace declaration
+ * - ECMA-376 Part 1 content types; [MS-ODRAWXML] §2.1.4 ink part
+ * - ECMA-376-1 §17.3.3.2 / [MS-ODRAWXML] §2.1.4 customXml relationship for ink source
+ * - [MS-ODRAWXML] §2.15 WordprocessingML 2010 namespace
+ * - [MS-ODRAWXML] §2.2.7.6 `wordprocessingInk` graphicData URI
+ */
+/**
+ * InkML namespace URI.
+ *
+ * Source: W3C InkML 1.0 (`http://www.w3.org/2003/InkML`).
+ *
+ * @public
+ */
+export declare const INKML_NAMESPACE = "http://www.w3.org/2003/InkML";
+/**
+ * Content type for an InkML part.
+ *
+ * Source: [MS-ODRAWXML] §2.1.4 / Office content-type vocabulary —
+ * `application/inkml+xml`.
+ *
+ * @public
+ */
+export declare const INK_CONTENT_TYPE = "application/inkml+xml";
+/**
+ * Relationship type used by Word documents to bind the ink source part.
+ *
+ * Source: ECMA-376-1 §17.3.3.2; [MS-ODRAWXML] §2.1.4 —
+ * `…/relationships/customXml` (internal target mode).
+ *
+ * @public
+ */
+export declare const INK_SOURCE_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml";
+/**
+ * WordprocessingML 2010 namespace (`w14:`).
+ *
+ * Source: [MS-ODRAWXML] §2.15 —
+ * `http://schemas.microsoft.com/office/word/2010/wordml`.
+ *
+ * @public
+ */
+export declare const WORDML_2010_NAMESPACE = "http://schemas.microsoft.com/office/word/2010/wordml";
+/**
+ * DrawingML `a:graphicData/@uri` value for wordprocessing ink content.
+ *
+ * Source: [MS-ODRAWXML] §2.2.7.6 —
+ * `http://schemas.microsoft.com/office/word/2010/wordprocessingInk`.
+ *
+ * @public
+ */
+export declare const WORDPROCESSING_INK_URI = "http://schemas.microsoft.com/office/word/2010/wordprocessingInk";

package/src/features/ink/constants.js

@@ -0,0 +1,54 @@
+/**
+ * Cited InkML / Wordprocessing ink constants.
+ *
+ * Sources:
+ * - W3C InkML 1.0 §1 / namespace declaration
+ * - ECMA-376 Part 1 content types; [MS-ODRAWXML] §2.1.4 ink part
+ * - ECMA-376-1 §17.3.3.2 / [MS-ODRAWXML] §2.1.4 customXml relationship for ink source
+ * - [MS-ODRAWXML] §2.15 WordprocessingML 2010 namespace
+ * - [MS-ODRAWXML] §2.2.7.6 `wordprocessingInk` graphicData URI
+ */
+/**
+ * InkML namespace URI.
+ *
+ * Source: W3C InkML 1.0 (`http://www.w3.org/2003/InkML`).
+ *
+ * @public
+ */
+export var INKML_NAMESPACE = 'http://www.w3.org/2003/InkML';
+/**
+ * Content type for an InkML part.
+ *
+ * Source: [MS-ODRAWXML] §2.1.4 / Office content-type vocabulary —
+ * `application/inkml+xml`.
+ *
+ * @public
+ */
+export var INK_CONTENT_TYPE = 'application/inkml+xml';
+/**
+ * Relationship type used by Word documents to bind the ink source part.
+ *
+ * Source: ECMA-376-1 §17.3.3.2; [MS-ODRAWXML] §2.1.4 —
+ * `…/relationships/customXml` (internal target mode).
+ *
+ * @public
+ */
+export var INK_SOURCE_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml';
+/**
+ * WordprocessingML 2010 namespace (`w14:`).
+ *
+ * Source: [MS-ODRAWXML] §2.15 —
+ * `http://schemas.microsoft.com/office/word/2010/wordml`.
+ *
+ * @public
+ */
+export var WORDML_2010_NAMESPACE = 'http://schemas.microsoft.com/office/word/2010/wordml';
+/**
+ * DrawingML `a:graphicData/@uri` value for wordprocessing ink content.
+ *
+ * Source: [MS-ODRAWXML] §2.2.7.6 —
+ * `http://schemas.microsoft.com/office/word/2010/wordprocessingInk`.
+ *
+ * @public
+ */
+export var WORDPROCESSING_INK_URI = 'http://schemas.microsoft.com/office/word/2010/wordprocessingInk';

package/src/features/ink/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Optional ink feature module (`@syncfusion/ej2-office-common/ink`).
+ *
+ * Provides the shared InkML DOM model, pure trace codec, authoring helpers,
+ * cited constants, effect→color table, and InkML parse/serialize (TASK-9003).
+ *
+ * @packageDocumentation
+ */
+export { INKML_NAMESPACE, INK_CONTENT_TYPE, INK_SOURCE_RELATIONSHIP_TYPE, WORDML_2010_NAMESPACE, WORDPROCESSING_INK_URI, } from './constants';
+export { INK_EFFECT_COLORS, inkEffectColor } from './ink-effects';
+export { InkBounds, InkExtent, InkPoint, TraceDecodeResult, TraceDecodeStats, } from './trace-codec';
+export { computeInkBounds, decodeTrace, encodeTrace, scalePointsStretch, scalePointsUniform, } from './trace-codec';
+export { InkBrush, InkChannel, InkContext, InkEffectType, InkTrace, OfficeInk, } from './ink-model';
+export { addInkTrace, cloneInk, createInk, inkPathPoints, isOfficeInk, setInkScaleMode, } from './ink-model';
+export { InkParseDiagnostic, InkParseDiagnostics } from './ink-parser';
+export { DIAG_INVALID_INK_TRACE, getLastInkParseDiagnostics, parseInkXml, } from './ink-parser';
+export { serializeInkXml } from './ink-serializer';
+export { EMUS_PER_POINT, formatUnitValue, pointsToUnit, unitValueToPoints } from './ink-units';

package/src/features/ink/index.js

@@ -0,0 +1,15 @@
+/**
+ * Optional ink feature module (`@syncfusion/ej2-office-common/ink`).
+ *
+ * Provides the shared InkML DOM model, pure trace codec, authoring helpers,
+ * cited constants, effect→color table, and InkML parse/serialize (TASK-9003).
+ *
+ * @packageDocumentation
+ */
+export { INKML_NAMESPACE, INK_CONTENT_TYPE, INK_SOURCE_RELATIONSHIP_TYPE, WORDML_2010_NAMESPACE, WORDPROCESSING_INK_URI, } from './constants';
+export { INK_EFFECT_COLORS, inkEffectColor } from './ink-effects';
+export { computeInkBounds, decodeTrace, encodeTrace, scalePointsStretch, scalePointsUniform, } from './trace-codec';
+export { addInkTrace, cloneInk, createInk, inkPathPoints, isOfficeInk, setInkScaleMode, } from './ink-model';
+export { DIAG_INVALID_INK_TRACE, getLastInkParseDiagnostics, parseInkXml, } from './ink-parser';
+export { serializeInkXml } from './ink-serializer';
+export { EMUS_PER_POINT, formatUnitValue, pointsToUnit, unitValueToPoints } from './ink-units';

package/src/features/ink/ink-effects.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Effect → characteristic color mapping used when serializing ink brushes.
+ *
+ * Values are cited from the approved cross-repo ink specification
+ * (`ej2-docx/docs/specs/ink-dom-parse-serialize.md`, Internal semantic model —
+ * Effects → color), cross-checked against [MS-ODRAWXML] ink effect tokens.
+ *
+ * `'none'` and `'pencil'` do not override stroke color.
+ */
+import { InkEffectType } from './ink-model';
+/**
+ * Characteristic colors for non-default ink visual effects.
+ *
+ * | Effect | Color | Notes |
+ * |---|---|---|
+ * | bronze | `#BB5B18` | cited characteristic color |
+ * | silver | `#B4C3DA` | cited characteristic color |
+ * | gold | `#CC912C` | cited characteristic color |
+ * | roseGold | `#EEB3A6` | cited characteristic color |
+ * | ocean | `#0B868D` | cited characteristic color |
+ * | lava | `#DA0C07` | cited characteristic color |
+ * | rainbow | `#FF4E00` | cited characteristic color |
+ * | galaxy | `#AE198D` | cited characteristic color |
+ *
+ * @public
+ */
+export declare const INK_EFFECT_COLORS: Readonly<Partial<Record<InkEffectType, string>>>;
+/**
+ * Resolve the characteristic color for an effect, if any.
+ *
+ * Returns `undefined` for `'none'` / `'pencil'` (no color override).
+ *
+ * @public
+ */
+export declare function inkEffectColor(effect: InkEffectType): string | undefined;

package/src/features/ink/ink-effects.js

@@ -0,0 +1,45 @@
+/**
+ * Effect → characteristic color mapping used when serializing ink brushes.
+ *
+ * Values are cited from the approved cross-repo ink specification
+ * (`ej2-docx/docs/specs/ink-dom-parse-serialize.md`, Internal semantic model —
+ * Effects → color), cross-checked against [MS-ODRAWXML] ink effect tokens.
+ *
+ * `'none'` and `'pencil'` do not override stroke color.
+ */
+/**
+ * Characteristic colors for non-default ink visual effects.
+ *
+ * | Effect | Color | Notes |
+ * |---|---|---|
+ * | bronze | `#BB5B18` | cited characteristic color |
+ * | silver | `#B4C3DA` | cited characteristic color |
+ * | gold | `#CC912C` | cited characteristic color |
+ * | roseGold | `#EEB3A6` | cited characteristic color |
+ * | ocean | `#0B868D` | cited characteristic color |
+ * | lava | `#DA0C07` | cited characteristic color |
+ * | rainbow | `#FF4E00` | cited characteristic color |
+ * | galaxy | `#AE198D` | cited characteristic color |
+ *
+ * @public
+ */
+export var INK_EFFECT_COLORS = Object.freeze({
+    bronze: '#BB5B18',
+    silver: '#B4C3DA',
+    gold: '#CC912C',
+    roseGold: '#EEB3A6',
+    ocean: '#0B868D',
+    lava: '#DA0C07',
+    rainbow: '#FF4E00',
+    galaxy: '#AE198D',
+});
+/**
+ * Resolve the characteristic color for an effect, if any.
+ *
+ * Returns `undefined` for `'none'` / `'pencil'` (no color override).
+ *
+ * @public
+ */
+export function inkEffectColor(effect) {
+    return INK_EFFECT_COLORS[effect];
+}