ts-visio 1.7.0 → 1.9.0

package/README.md

@@ -664,6 +664,34 @@ const styles = doc.getStyles();
 `StyleProps` supports: `fillColor`, `lineColor`, `lineWeight` (pt), `linePattern`, `fontColor`, `fontSize` (pt), `bold`, `italic`, `underline`, `strikethrough`, `fontFamily`, `horzAlign`, `verticalAlign`, `spaceBefore`, `spaceAfter`, `lineSpacing`, `textMarginTop/Bottom/Left/Right` (in).
 Local shape properties always override inherited stylesheet values.
 
+#### 30. Reading Connectors Back
+Enumerate connectors on a page — including those loaded from an existing `.vsdx` file — and inspect or delete them.
+
+```typescript
+import { VisioDocument } from 'ts-visio';
+
+const doc  = await VisioDocument.load(buffer);   // or VisioDocument.create()
+const page = doc.pages[0];
+
+// Read all connector shapes
+const connectors = page.getConnectors();
+
+for (const conn of connectors) {
+    console.log(`Connector ${conn.id}: ${conn.fromShapeId} → ${conn.toShapeId}`);
+    console.log('  fromPort:', conn.fromPort);     // 'center' | { name } | { index }
+    console.log('  toPort:',   conn.toPort);
+    console.log('  style:',    conn.style);        // lineColor, lineWeight, linePattern, routing
+    console.log('  arrows:',   conn.beginArrow, conn.endArrow);
+}
+
+// Delete a specific connector
+await connectors[0].delete();
+
+// After delete the connector is gone but the shapes remain
+console.log(page.getConnectors().length);  // 0
+console.log(page.getShapes().length);      // shapes still exist
+```
+
 ---
 
 ## Examples

package/dist/Connector.d.ts

@@ -0,0 +1,53 @@
+import { ConnectorStyle, ConnectionTarget } from './types/VisioTypes';
+import { ShapeModifier } from './ShapeModifier';
+/**
+ * Raw data extracted from the page XML for a single connector shape.
+ * Returned by `ShapeReader.readConnectors()` and wrapped by the `Connector` class.
+ */
+export interface ConnectorData {
+    /** Visio shape ID of the connector (1D shape). */
+    id: string;
+    /** ID of the shape at the connector's begin-point (BeginX). */
+    fromShapeId: string;
+    /** ID of the shape at the connector's end-point (EndX). */
+    toShapeId: string;
+    /** Connection point used on the from-shape. */
+    fromPort: ConnectionTarget;
+    /** Connection point used on the to-shape. */
+    toPort: ConnectionTarget;
+    /** Line style extracted from the connector's Line section. */
+    style: ConnectorStyle;
+    /** Begin-arrow head value (Visio ArrowHeads integer string). */
+    beginArrow: string;
+    /** End-arrow head value (Visio ArrowHeads integer string). */
+    endArrow: string;
+}
+/**
+ * A read/delete wrapper around a connector shape found on a page.
+ * Obtain instances via `page.getConnectors()`.
+ */
+export declare class Connector {
+    private readonly pageId;
+    private readonly modifier;
+    /** Visio shape ID of this connector. */
+    readonly id: string;
+    /** ID of the shape this connector starts from. */
+    readonly fromShapeId: string;
+    /** ID of the shape this connector ends at. */
+    readonly toShapeId: string;
+    /** Connection point used on the from-shape ('center', `{ name }`, or `{ index }`). */
+    readonly fromPort: ConnectionTarget;
+    /** Connection point used on the to-shape ('center', `{ name }`, or `{ index }`). */
+    readonly toPort: ConnectionTarget;
+    /** Line style (color, weight, pattern, routing) for this connector. */
+    readonly style: ConnectorStyle;
+    /** Begin-arrow head value string (e.g. `'0'` = none, `'1'` = standard). */
+    readonly beginArrow: string;
+    /** End-arrow head value string (e.g. `'0'` = none, `'1'` = standard). */
+    readonly endArrow: string;
+    constructor(data: ConnectorData, pageId: string, modifier: ShapeModifier);
+    /**
+     * Delete this connector from the page (removes the shape and its Connect entries).
+     */
+    delete(): Promise<void>;
+}

package/dist/Connector.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connector = void 0;
+/**
+ * A read/delete wrapper around a connector shape found on a page.
+ * Obtain instances via `page.getConnectors()`.
+ */
+class Connector {
+    constructor(data, pageId, modifier) {
+        this.pageId = pageId;
+        this.modifier = modifier;
+        this.id = data.id;
+        this.fromShapeId = data.fromShapeId;
+        this.toShapeId = data.toShapeId;
+        this.fromPort = data.fromPort;
+        this.toPort = data.toPort;
+        this.style = data.style;
+        this.beginArrow = data.beginArrow;
+        this.endArrow = data.endArrow;
+    }
+    /**
+     * Delete this connector from the page (removes the shape and its Connect entries).
+     */
+    async delete() {
+        await this.modifier.deleteShape(this.pageId, this.id);
+    }
+}
+exports.Connector = Connector;

package/dist/Page.d.ts

@@ -1,4 +1,5 @@
 import { VisioPage, ConnectorStyle, PageOrientation, PageSizeName, ConnectionTarget } from './types/VisioTypes';
+import { Connector } from './Connector';
 import { VisioPackage } from './VisioPackage';
 import { ShapeModifier } from './ShapeModifier';
 import { NewShapeProps } from './types/VisioTypes';
@@ -50,6 +51,12 @@ export declare class Page {
      */
     findShapes(predicate: (shape: Shape) => boolean): Shape[];
     addShape(props: NewShapeProps, parentId?: string): Promise<Shape>;
+    /**
+     * Return all connector shapes on the page.
+     * Each `Connector` exposes the from/to shape IDs, port targets, line style, arrows,
+     * and a `delete()` method to remove the connector.
+     */
+    getConnectors(): Connector[];
     connectShapes(fromShape: Shape, toShape: Shape, beginArrow?: string, endArrow?: string, style?: ConnectorStyle, fromPort?: ConnectionTarget, toPort?: ConnectionTarget): Promise<void>;
     addImage(data: Buffer, name: string, x: number, y: number, width: number, height: number): Promise<Shape>;
     addContainer(props: NewShapeProps): Promise<Shape>;

package/dist/Page.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Page = void 0;
 const VisioTypes_1 = require("./types/VisioTypes");
+const Connector_1 = require("./Connector");
 const ShapeReader_1 = require("./ShapeReader");
 const ShapeModifier_1 = require("./ShapeModifier");
 const Shape_1 = require("./Shape");
@@ -124,6 +125,22 @@ class Page {
         });
         return new Shape_1.Shape(internalStub, this.id, this.pkg, this.modifier);
     }
+    /**
+     * Return all connector shapes on the page.
+     * Each `Connector` exposes the from/to shape IDs, port targets, line style, arrows,
+     * and a `delete()` method to remove the connector.
+     */
+    getConnectors() {
+        const reader = new ShapeReader_1.ShapeReader(this.pkg);
+        try {
+            const data = reader.readConnectors(this.pagePath);
+            return data.map(d => new Connector_1.Connector(d, this.id, this.modifier));
+        }
+        catch (e) {
+            console.warn(`Could not read connectors for page ${this.id}:`, e);
+            return [];
+        }
+    }
     async connectShapes(fromShape, toShape, beginArrow, endArrow, style, fromPort, toPort) {
         await this.modifier.addConnector(this.id, fromShape.id, toShape.id, beginArrow, endArrow, style, fromPort, toPort);
     }

package/dist/ShapeModifier.d.ts

@@ -131,6 +131,12 @@ export declare class ShapeModifier {
 }
 export interface ShapeStyle {
     fillColor?: string;
+    /** Border/stroke colour as a CSS hex string (e.g. `'#cc0000'`). */
+    lineColor?: string;
+    /** Stroke weight in **points**. Stored internally as inches (pt / 72). */
+    lineWeight?: number;
+    /** Line pattern. 0 = none, 1 = solid (default), 2 = dash, 3 = dot, 4 = dash-dot. */
+    linePattern?: number;
     fontColor?: string;
     bold?: boolean;
     /** Italic text. */

package/dist/ShapeModifier.js

@@ -400,6 +400,18 @@ class ShapeModifier {
             shape.Section = shape.Section.filter((s) => s['@_N'] !== 'Fill');
             shape.Section.push((0, StyleHelpers_1.createFillSection)(style.fillColor));
         }
+        // Update/Add Line
+        const hasLineProps = style.lineColor !== undefined
+            || style.lineWeight !== undefined
+            || style.linePattern !== undefined;
+        if (hasLineProps) {
+            shape.Section = shape.Section.filter((s) => s['@_N'] !== 'Line');
+            shape.Section.push((0, StyleHelpers_1.createLineSection)({
+                color: style.lineColor,
+                weight: style.lineWeight !== undefined ? (style.lineWeight / 72).toString() : undefined,
+                pattern: style.linePattern !== undefined ? style.linePattern.toString() : undefined,
+            }));
+        }
         // Update/Add Character (Font/Text Style)
         const hasCharProps = style.fontColor !== undefined
             || style.bold !== undefined

package/dist/ShapeReader.d.ts

@@ -1,5 +1,6 @@
 import { VisioPackage } from './VisioPackage';
 import { VisioShape } from './types/VisioTypes';
+import { ConnectorData } from './Connector';
 export declare class ShapeReader {
     private pkg;
     private parser;
@@ -15,6 +16,14 @@ export declare class ShapeReader {
      * Returns undefined if not found.
      */
     readShapeById(path: string, shapeId: string): VisioShape | undefined;
+    /**
+     * Read all connector shapes from a page XML file.
+     * A shape is considered a connector if it has `ObjType=2` or a `BeginX` cell,
+     * and is referenced in the page's `<Connects>` section.
+     */
+    readConnectors(path: string): ConnectorData[];
+    /** Decode a Visio ToPart integer string to a ConnectionTarget. */
+    private decodeToPart;
     private gatherShapes;
     private findShapeById;
     private parseShape;

package/dist/ShapeReader.js

@@ -63,6 +63,125 @@ class ShapeReader {
             return undefined;
         return this.findShapeById((0, VisioParsers_1.asArray)(shapesData), shapeId);
     }
+    /**
+     * Read all connector shapes from a page XML file.
+     * A shape is considered a connector if it has `ObjType=2` or a `BeginX` cell,
+     * and is referenced in the page's `<Connects>` section.
+     */
+    readConnectors(path) {
+        let content;
+        try {
+            content = this.pkg.getFileText(path);
+        }
+        catch {
+            return [];
+        }
+        const parsed = this.parser.parse(content);
+        const shapesData = parsed.PageContents?.Shapes?.Shape;
+        if (!shapesData)
+            return [];
+        // Build a flat map of all shapes by ID (including nested)
+        const shapeMap = new Map();
+        const collectShapes = (list) => {
+            for (const s of list) {
+                shapeMap.set(s['@_ID'], s);
+                if (s.Shapes?.Shape)
+                    collectShapes((0, VisioParsers_1.asArray)(s.Shapes.Shape));
+            }
+        };
+        collectShapes((0, VisioParsers_1.asArray)(shapesData));
+        // Identify connector shapes by ObjType=2 or presence of BeginX cell
+        const connectorShapes = [];
+        for (const [, shape] of shapeMap) {
+            const cells = (0, VisioParsers_1.parseCells)(shape);
+            if (cells['ObjType']?.V === '2' || cells['BeginX'] !== undefined) {
+                connectorShapes.push(shape);
+            }
+        }
+        if (connectorShapes.length === 0)
+            return [];
+        // Group <Connect> elements by connector ID (FromSheet)
+        const connectsRaw = parsed.PageContents?.Connects?.Connect;
+        const connects = (0, VisioParsers_1.asArray)(connectsRaw);
+        const connectsByConnector = new Map();
+        for (const c of connects) {
+            const fromSheet = c['@_FromSheet'];
+            const fromCell = c['@_FromCell'];
+            if (!connectsByConnector.has(fromSheet)) {
+                connectsByConnector.set(fromSheet, {});
+            }
+            const entry = connectsByConnector.get(fromSheet);
+            if (fromCell === 'BeginX')
+                entry.beginConnect = c;
+            else if (fromCell === 'EndX')
+                entry.endConnect = c;
+        }
+        const ROUTING_BY_VALUE = {
+            '1': 'orthogonal',
+            '2': 'straight',
+            '16': 'curved',
+        };
+        const result = [];
+        for (const connShape of connectorShapes) {
+            const connId = connShape['@_ID'];
+            const entry = connectsByConnector.get(connId);
+            if (!entry?.beginConnect || !entry?.endConnect)
+                continue;
+            const { beginConnect, endConnect } = entry;
+            const fromShapeId = beginConnect['@_ToSheet'];
+            const toShapeId = endConnect['@_ToSheet'];
+            const fromPort = this.decodeToPart(beginConnect['@_ToPart']);
+            const toPort = this.decodeToPart(endConnect['@_ToPart']);
+            // Extract line style from the connector's Line section
+            const sections = (0, VisioParsers_1.asArray)(connShape.Section);
+            let lineColor;
+            let lineWeight;
+            let linePattern;
+            for (const sec of sections) {
+                if (sec['@_N'] === 'Line') {
+                    const lineCells = (0, VisioParsers_1.parseCells)(sec);
+                    if (lineCells['LineColor']?.V)
+                        lineColor = lineCells['LineColor'].V;
+                    if (lineCells['LineWeight']?.V)
+                        lineWeight = parseFloat(lineCells['LineWeight'].V) * 72; // in→pt
+                    if (lineCells['LinePattern']?.V)
+                        linePattern = parseInt(lineCells['LinePattern'].V, 10);
+                }
+            }
+            const cells = (0, VisioParsers_1.parseCells)(connShape);
+            const routeStyleVal = cells['ShapeRouteStyle']?.V;
+            const routing = routeStyleVal ? ROUTING_BY_VALUE[routeStyleVal] : undefined;
+            const style = {};
+            if (lineColor !== undefined)
+                style.lineColor = lineColor;
+            if (lineWeight !== undefined)
+                style.lineWeight = lineWeight;
+            if (linePattern !== undefined)
+                style.linePattern = linePattern;
+            if (routing !== undefined)
+                style.routing = routing;
+            result.push({
+                id: connId,
+                fromShapeId,
+                toShapeId,
+                fromPort,
+                toPort,
+                style,
+                beginArrow: cells['BeginArrow']?.V ?? '0',
+                endArrow: cells['EndArrow']?.V ?? '0',
+            });
+        }
+        return result;
+    }
+    /** Decode a Visio ToPart integer string to a ConnectionTarget. */
+    decodeToPart(toPart) {
+        const part = toPart !== undefined ? parseInt(toPart, 10) : 3;
+        if (isNaN(part) || part === 3)
+            return 'center';
+        if (part >= 100)
+            return { index: part - 100 };
+        return 'center';
+    }
     gatherShapes(rawShapes, result) {
         for (const s of rawShapes) {
             result.push(this.parseShape(s));

package/dist/index.d.ts

@@ -6,6 +6,8 @@ export { ShapeModifier } from './ShapeModifier';
 export { VisioDocument } from './VisioDocument';
 export { Page } from './Page';
 export { Shape } from './Shape';
+export { Connector } from './Connector';
+export type { ConnectorData } from './Connector';
 export type { ShapeData, ShapeHyperlink } from './Shape';
 export { Layer } from './Layer';
 export { SchemaDiagram } from './SchemaDiagram';

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.Shape = exports.Page = exports.VisioDocument = exports.ShapeModifier = exports.ShapeReader = exports.PageManager = exports.VisioPackage = void 0;
+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");
@@ -29,6 +29,8 @@ var Page_1 = require("./Page");
 Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return Page_1.Page; } });
 var Shape_1 = require("./Shape");
 Object.defineProperty(exports, "Shape", { enumerable: true, get: function () { return Shape_1.Shape; } });
+var Connector_1 = require("./Connector");
+Object.defineProperty(exports, "Connector", { enumerable: true, get: function () { return Connector_1.Connector; } });
 var Layer_1 = require("./Layer");
 Object.defineProperty(exports, "Layer", { enumerable: true, get: function () { return Layer_1.Layer; } });
 var SchemaDiagram_1 = require("./SchemaDiagram");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-visio",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {