ts-visio 1.9.0 → 1.10.0

package/README.md

@@ -27,6 +27,7 @@ Built using specific schema-level abstractions to handle the complex internal st
 - **Document Metadata**: Read and write document properties (title, author, description, keywords, company, dates) via `doc.getMetadata()` / `doc.setMetadata()`.
 - **Named Connection Points**: Define specific ports on shapes (`Top`, `Right`, etc.) and connect to them precisely using `fromPort`/`toPort` on any connector API.
 - **StyleSheets**: Create document-level named styles with fill, line, and text properties via `doc.createStyle()` and apply them to shapes at creation time (`styleId`) or post-creation (`shape.applyStyle()`).
+- **Color Palette**: Register named colors in the document's color table via `doc.addColor()` and look them up by index or hex value with `doc.getColors()` / `doc.getColorIndex()`.
 
 Feature gaps are being tracked in [FEATURES.md](./FEATURES.md).
 
@@ -153,7 +154,7 @@ await shape1.setStyle({ fillColor: '#00FF00' })
 Use specific arrowheads (Crow's Foot, etc.)
 
 ```typescript
-import { ArrowHeads } from 'ts-visio/utils/StyleHelpers';
+import { ArrowHeads } from 'ts-visio';
 
 await page.connectShapes(shape1, shape2, ArrowHeads.One, ArrowHeads.CrowsFoot);
 // OR
@@ -449,7 +450,7 @@ Supported values: `'rectangle'` (default), `'ellipse'`, `'diamond'`, `'rounded-r
 Control line appearance and routing algorithm on any connector.
 
 ```typescript
-import { ArrowHeads } from 'ts-visio/utils/StyleHelpers';
+import { ArrowHeads } from 'ts-visio';
 
 // Styled connector with crow's foot arrow and custom line
 await shape1.connectTo(shape2, ArrowHeads.One, ArrowHeads.CrowsFoot, {
@@ -692,6 +693,39 @@ console.log(page.getConnectors().length);  // 0
 console.log(page.getShapes().length);      // shapes still exist
 ```
 
+#### 31. Color Palette
+Register colors in the document's indexed color table (`<Colors>` in `document.xml`). Colors are identified by an integer IX that you can reference anywhere a hex color is accepted.
+
+```typescript
+// Register colors — returns the integer index (IX)
+const blueIx  = doc.addColor('#4472C4');  // → 2 (first user color)
+const redIx   = doc.addColor('#FF0000');  // → 3
+const greenIx = doc.addColor('#00B050');  // → 4
+
+// De-duplication: adding the same color returns the existing index
+doc.addColor('#4472C4');  // → 2 (no duplicate created)
+
+// Shorthand, missing #, and case variations are all normalised
+doc.addColor('#FFF');        // same as #FFFFFF → returns 1 (built-in white)
+doc.addColor('4472c4');      // same as #4472C4 → returns 2
+
+// Read the full palette (sorted by index)
+const palette = doc.getColors();
+// [
+//   { index: 0, rgb: '#000000' },  // built-in black
+//   { index: 1, rgb: '#FFFFFF' },  // built-in white
+//   { index: 2, rgb: '#4472C4' },
+//   { index: 3, rgb: '#FF0000' },
+//   { index: 4, rgb: '#00B050' },
+// ]
+
+// Look up an index by hex value
+doc.getColorIndex('#4472C4');  // → 2
+doc.getColorIndex('#123456');  // → undefined (not registered)
+```
+
+Built-in colors: IX 0 = `#000000` (black), IX 1 = `#FFFFFF` (white). User colors start at IX 2 and increment sequentially.
+
 ---
 
 ## Examples

package/dist/VisioDocument.d.ts

@@ -1,5 +1,5 @@
 import { Page } from './Page';
-import { DocumentMetadata, StyleProps, StyleRecord } from './types/VisioTypes';
+import { DocumentMetadata, StyleProps, StyleRecord, ColorEntry } from './types/VisioTypes';
 export declare class VisioDocument {
     private pkg;
     private pageManager;
@@ -7,6 +7,7 @@ export declare class VisioDocument {
     private mediaManager;
     private metadataManager;
     private styleSheetManager;
+    private colorManager;
     private constructor();
     static create(): Promise<VisioDocument>;
     static load(pathOrBuffer: string | Buffer | ArrayBuffer | Uint8Array): Promise<VisioDocument>;
@@ -56,5 +57,43 @@ export declare class VisioDocument {
      * Return all stylesheets defined in the document (including built-in styles).
      */
     getStyles(): StyleRecord[];
+    /**
+     * Add a color to the document-level color palette and return its integer index (IX).
+     *
+     * If the color is already registered the existing index is returned without
+     * creating a duplicate. The two built-in colors are always present:
+     *   - index 0  →  `#000000`  (black)
+     *   - index 1  →  `#FFFFFF`  (white)
+     *
+     * User colors receive indices starting at 2.
+     *
+     * @param hex  CSS hex string — `'#4472C4'`, `'#ABC'`, or `'4472c4'` are all accepted.
+     * @returns    Integer IX that uniquely identifies this color in the palette.
+     *
+     * @example
+     * const blueIx = doc.addColor('#4472C4');  // → 2
+     * const redIx  = doc.addColor('#FF0000');  // → 3
+     * doc.addColor('#4472C4');                 // → 2 (de-duplicated)
+     */
+    addColor(hex: string): number;
+    /**
+     * Return all color entries in the document palette, ordered by index.
+     *
+     * @example
+     * doc.addColor('#4472C4');
+     * doc.getColors();
+     * // → [{ index: 0, rgb: '#000000' }, { index: 1, rgb: '#FFFFFF' }, { index: 2, rgb: '#4472C4' }]
+     */
+    getColors(): ColorEntry[];
+    /**
+     * Look up the palette index of a color by its hex value.
+     * Returns `undefined` if the color has not been added to the palette.
+     *
+     * @example
+     * doc.addColor('#4472C4');
+     * doc.getColorIndex('#4472C4');  // → 2
+     * doc.getColorIndex('#FF0000');  // → undefined
+     */
+    getColorIndex(hex: string): number | undefined;
     save(filename?: string): Promise<Buffer>;
 }

package/dist/VisioDocument.js

@@ -40,6 +40,7 @@ const Page_1 = require("./Page");
 const MediaManager_1 = require("./core/MediaManager");
 const MetadataManager_1 = require("./core/MetadataManager");
 const StyleSheetManager_1 = require("./core/StyleSheetManager");
+const ColorManager_1 = require("./core/ColorManager");
 class VisioDocument {
     constructor(pkg) {
         this.pkg = pkg;
@@ -48,6 +49,7 @@ class VisioDocument {
         this.mediaManager = new MediaManager_1.MediaManager(pkg);
         this.metadataManager = new MetadataManager_1.MetadataManager(pkg);
         this.styleSheetManager = new StyleSheetManager_1.StyleSheetManager(pkg);
+        this.colorManager = new ColorManager_1.ColorManager(pkg);
     }
     static async create() {
         const pkg = await VisioPackage_1.VisioPackage.create();
@@ -169,6 +171,50 @@ class VisioDocument {
     getStyles() {
         return this.styleSheetManager.getStyles();
     }
+    /**
+     * Add a color to the document-level color palette and return its integer index (IX).
+     *
+     * If the color is already registered the existing index is returned without
+     * creating a duplicate. The two built-in colors are always present:
+     *   - index 0  →  `#000000`  (black)
+     *   - index 1  →  `#FFFFFF`  (white)
+     *
+     * User colors receive indices starting at 2.
+     *
+     * @param hex  CSS hex string — `'#4472C4'`, `'#ABC'`, or `'4472c4'` are all accepted.
+     * @returns    Integer IX that uniquely identifies this color in the palette.
+     *
+     * @example
+     * const blueIx = doc.addColor('#4472C4');  // → 2
+     * const redIx  = doc.addColor('#FF0000');  // → 3
+     * doc.addColor('#4472C4');                 // → 2 (de-duplicated)
+     */
+    addColor(hex) {
+        return this.colorManager.addColor(hex);
+    }
+    /**
+     * Return all color entries in the document palette, ordered by index.
+     *
+     * @example
+     * doc.addColor('#4472C4');
+     * doc.getColors();
+     * // → [{ index: 0, rgb: '#000000' }, { index: 1, rgb: '#FFFFFF' }, { index: 2, rgb: '#4472C4' }]
+     */
+    getColors() {
+        return this.colorManager.getColors();
+    }
+    /**
+     * Look up the palette index of a color by its hex value.
+     * Returns `undefined` if the color has not been added to the palette.
+     *
+     * @example
+     * doc.addColor('#4472C4');
+     * doc.getColorIndex('#4472C4');  // → 2
+     * doc.getColorIndex('#FF0000');  // → undefined
+     */
+    getColorIndex(hex) {
+        return this.colorManager.getColorIndex(hex);
+    }
     async save(filename) {
         return this.pkg.save(filename);
     }

package/dist/core/ColorManager.d.ts

@@ -0,0 +1,57 @@
+import { VisioPackage } from '../VisioPackage';
+import { ColorEntry } from '../types/VisioTypes';
+/**
+ * Manages the document-level color palette stored in `<Colors>` inside
+ * `visio/document.xml`.
+ *
+ * The palette is a simple indexed table — Visio identifies colors by their
+ * zero-based integer index (IX) as well as by their hex RGB value.
+ *
+ * Built-in entries (always present):
+ *   - IX 0  →  #000000  (black)
+ *   - IX 1  →  #FFFFFF  (white)
+ *
+ * User-added colors receive sequential indices starting at 2.
+ */
+export declare class ColorManager {
+    private pkg;
+    private parser;
+    private builder;
+    constructor(pkg: VisioPackage);
+    /**
+     * Add a color to the document palette and return its integer index (IX).
+     *
+     * If the color is already in the palette the existing index is returned
+     * without creating a duplicate. Built-in colors (black = 0, white = 1)
+     * are returned directly.
+     *
+     * @param hex  CSS hex string — `'#4472C4'`, `'#abc'`, `'4472c4'` all accepted.
+     * @returns    Integer IX that can be used as a color reference.
+     *
+     * @example
+     * const ix = doc.addColor('#4472C4');  // → 2 (first user color)
+     * await page.addShape({ text: 'Hi', fillColor: '#4472C4', ... });
+     */
+    addColor(hex: string): number;
+    /**
+     * Return all color entries currently in the document palette,
+     * ordered by index ascending.
+     */
+    getColors(): ColorEntry[];
+    /**
+     * Look up the index of a color in the palette by its hex value.
+     * Returns `undefined` if the color has not been registered.
+     *
+     * @example
+     * const ix = doc.getColorIndex('#4472C4');  // 2, or undefined if not added
+     */
+    getColorIndex(hex: string): number | undefined;
+    private getParsedDoc;
+    private saveParsedDoc;
+    /** Ensure `<Colors>` exists and contains the two built-in entries. */
+    private ensureColors;
+    /** Next IX = max existing index + 1, always at least 2. */
+    private nextIndex;
+    /** Minimal built-in palette returned when <Colors> is absent. */
+    private builtIns;
+}

package/dist/core/ColorManager.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColorManager = void 0;
+const XmlHelper_1 = require("../utils/XmlHelper");
+/**
+ * Manages the document-level color palette stored in `<Colors>` inside
+ * `visio/document.xml`.
+ *
+ * The palette is a simple indexed table — Visio identifies colors by their
+ * zero-based integer index (IX) as well as by their hex RGB value.
+ *
+ * Built-in entries (always present):
+ *   - IX 0  →  #000000  (black)
+ *   - IX 1  →  #FFFFFF  (white)
+ *
+ * User-added colors receive sequential indices starting at 2.
+ */
+class ColorManager {
+    constructor(pkg) {
+        this.pkg = pkg;
+        this.parser = (0, XmlHelper_1.createXmlParser)();
+        this.builder = (0, XmlHelper_1.createXmlBuilder)();
+    }
+    // ── Public API ────────────────────────────────────────────────────────────
+    /**
+     * Add a color to the document palette and return its integer index (IX).
+     *
+     * If the color is already in the palette the existing index is returned
+     * without creating a duplicate. Built-in colors (black = 0, white = 1)
+     * are returned directly.
+     *
+     * @param hex  CSS hex string — `'#4472C4'`, `'#abc'`, `'4472c4'` all accepted.
+     * @returns    Integer IX that can be used as a color reference.
+     *
+     * @example
+     * const ix = doc.addColor('#4472C4');  // → 2 (first user color)
+     * await page.addShape({ text: 'Hi', fillColor: '#4472C4', ... });
+     */
+    addColor(hex) {
+        const normalized = normalizeHex(hex);
+        const parsed = this.getParsedDoc();
+        const doc = parsed['VisioDocument'];
+        this.ensureColors(doc);
+        const colors = doc['Colors'];
+        const entries = toArray(colors['ColorEntry']);
+        // De-duplicate: return existing index if the color is already registered
+        const existing = entries.find((e) => normalizeHex(e['@_RGB']) === normalized);
+        if (existing)
+            return parseInt(existing['@_IX'], 10);
+        // Append at the next sequential index
+        const nextIX = this.nextIndex(entries);
+        entries.push({ '@_IX': nextIX.toString(), '@_RGB': normalized });
+        colors['ColorEntry'] = entries;
+        this.saveParsedDoc(parsed);
+        return nextIX;
+    }
+    /**
+     * Return all color entries currently in the document palette,
+     * ordered by index ascending.
+     */
+    getColors() {
+        const parsed = this.getParsedDoc();
+        const doc = parsed['VisioDocument'];
+        const colors = doc?.['Colors'];
+        if (!colors)
+            return this.builtIns();
+        return toArray(colors['ColorEntry'])
+            .map((e) => ({
+            index: parseInt(e['@_IX'], 10),
+            rgb: normalizeHex(e['@_RGB']),
+        }))
+            .sort((a, b) => a.index - b.index);
+    }
+    /**
+     * Look up the index of a color in the palette by its hex value.
+     * Returns `undefined` if the color has not been registered.
+     *
+     * @example
+     * const ix = doc.getColorIndex('#4472C4');  // 2, or undefined if not added
+     */
+    getColorIndex(hex) {
+        const normalized = normalizeHex(hex);
+        return this.getColors().find(e => e.rgb === normalized)?.index;
+    }
+    // ── Private helpers ───────────────────────────────────────────────────────
+    getParsedDoc() {
+        const xml = this.pkg.getFileText('visio/document.xml');
+        return this.parser.parse(xml);
+    }
+    saveParsedDoc(parsed) {
+        this.pkg.updateFile('visio/document.xml', (0, XmlHelper_1.buildXml)(this.builder, parsed));
+    }
+    /** Ensure `<Colors>` exists and contains the two built-in entries. */
+    ensureColors(doc) {
+        if (!doc['Colors'])
+            doc['Colors'] = {};
+        const colors = doc['Colors'];
+        const entries = toArray(colors['ColorEntry']);
+        if (!entries.some((e) => e['@_IX'] === '0')) {
+            entries.unshift({ '@_IX': '0', '@_RGB': '#000000' });
+        }
+        if (!entries.some((e) => e['@_IX'] === '1')) {
+            const blackPos = entries.findIndex((e) => e['@_IX'] === '0');
+            entries.splice(blackPos + 1, 0, { '@_IX': '1', '@_RGB': '#FFFFFF' });
+        }
+        colors['ColorEntry'] = entries;
+    }
+    /** Next IX = max existing index + 1, always at least 2. */
+    nextIndex(entries) {
+        const max = entries.reduce((m, e) => {
+            const ix = parseInt(e['@_IX'], 10);
+            return isNaN(ix) ? m : Math.max(m, ix);
+        }, 1);
+        return max + 1;
+    }
+    /** Minimal built-in palette returned when <Colors> is absent. */
+    builtIns() {
+        return [
+            { index: 0, rgb: '#000000' },
+            { index: 1, rgb: '#FFFFFF' },
+        ];
+    }
+}
+exports.ColorManager = ColorManager;
+// ── Module-level helpers ──────────────────────────────────────────────────────
+/** Normalise any hex string to uppercase `#RRGGBB`. */
+function normalizeHex(hex) {
+    let h = hex.startsWith('#') ? hex.slice(1) : hex;
+    if (h.length === 3)
+        h = h[0] + h[0] + h[1] + h[1] + h[2] + h[2];
+    return '#' + h.toUpperCase();
+}
+function toArray(val) {
+    if (!val)
+        return [];
+    return Array.isArray(val) ? val : [val];
+}

package/dist/index.d.ts

@@ -13,3 +13,5 @@ export { Layer } from './Layer';
 export { SchemaDiagram } from './SchemaDiagram';
 export { VisioValidator } from './core/VisioValidator';
 export * from './types/VisioTypes';
+export { ArrowHeads, hexToRgb } from './utils/StyleHelpers';
+export type { ShapeStyle } from './ShapeModifier';

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VisioValidator = exports.SchemaDiagram = exports.Layer = exports.Connector = exports.Shape = exports.Page = exports.VisioDocument = exports.ShapeModifier = exports.ShapeReader = exports.PageManager = exports.VisioPackage = void 0;
+exports.hexToRgb = exports.ArrowHeads = exports.VisioValidator = exports.SchemaDiagram = exports.Layer = exports.Connector = exports.Shape = exports.Page = exports.VisioDocument = exports.ShapeModifier = exports.ShapeReader = exports.PageManager = exports.VisioPackage = void 0;
 var VisioPackage_1 = require("./VisioPackage");
 Object.defineProperty(exports, "VisioPackage", { enumerable: true, get: function () { return VisioPackage_1.VisioPackage; } });
 var PageManager_1 = require("./core/PageManager");
@@ -38,3 +38,6 @@ Object.defineProperty(exports, "SchemaDiagram", { enumerable: true, get: functio
 var VisioValidator_1 = require("./core/VisioValidator");
 Object.defineProperty(exports, "VisioValidator", { enumerable: true, get: function () { return VisioValidator_1.VisioValidator; } });
 __exportStar(require("./types/VisioTypes"), exports);
+var StyleHelpers_1 = require("./utils/StyleHelpers");
+Object.defineProperty(exports, "ArrowHeads", { enumerable: true, get: function () { return StyleHelpers_1.ArrowHeads; } });
+Object.defineProperty(exports, "hexToRgb", { enumerable: true, get: function () { return StyleHelpers_1.hexToRgb; } });

package/dist/types/VisioTypes.d.ts

@@ -146,6 +146,19 @@ export interface ConnectorStyle {
 }
 /** Non-rectangular geometry variants supported by ShapeBuilder. */
 export type ShapeGeometry = 'rectangle' | 'ellipse' | 'diamond' | 'rounded-rectangle' | 'triangle' | 'parallelogram';
+/**
+ * A single entry in the document-level color palette (`<Colors>` in `document.xml`).
+ * Returned by `doc.getColors()` and created via `doc.addColor()`.
+ */
+export interface ColorEntry {
+    /**
+     * Zero-based integer index (IX). Can be passed as a color reference
+     * anywhere a hex string is accepted (e.g. `fillColor`, `lineColor`).
+     */
+    index: number;
+    /** Normalized CSS hex string, always uppercase `#RRGGBB`. */
+    rgb: string;
+}
 /** A reference to a document-level stylesheet, returned by `doc.createStyle()`. */
 export interface StyleRecord {
     /** Zero-based integer ID used as `LineStyle` / `FillStyle` / `TextStyle` on shapes. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-visio",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -25,6 +25,7 @@
   },
   "devDependencies": {
     "@types/node": "^25.0.9",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.17"
   }