@stocksharp/diagram 1.1.0 → 1.2.0

package/dist/types/headless.d.ts

@@ -0,0 +1,24 @@
+import { type DiagramScreenshotOptions } from './canvas-renderer.js';
+/**
+ * Drawing a diagram where there is no browser -- a server producing a picture for a chat message, an
+ * e-mail or a report. The renderer itself never needed one: it draws through a surface, and the SVG
+ * surface builds a string. What needed a browser was the control around it, which creates a canvas and
+ * listens for pointers; so the few things it reaches for are stood in for here, for the length of one
+ * drawing, and taken away again.
+ *
+ * Text is measured by the SVG surface's own estimate rather than by a real font, so a label's box can sit
+ * a pixel or two off where a browser would put it. The alternative is a native canvas dependency on every
+ * machine that renders, which is a steep price for that.
+ */
+export interface HeadlessRenderOptions extends DiagramScreenshotOptions {
+    /** Width of the frame the drawing is laid out in, in CSS pixels. Defaults to 1200. */
+    hostWidth?: number;
+    /** Height of that frame. Defaults to 800. */
+    hostHeight?: number;
+}
+/**
+ * Draws a saved diagram and returns the SVG for it. The source is the document as text or as an object;
+ * the frame follows the content by default, since a picture made without a viewport has none to crop to.
+ */
+export declare function renderDiagramSvg(source: string | unknown, options?: HeadlessRenderOptions): string;
+//# sourceMappingURL=headless.d.ts.map

package/dist/types/headless.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headless.d.ts","sourceRoot":"","sources":["../../src/headless.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAG9E;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACnE,sFAAsF;IACtF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AA6FD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,GAAE,qBAA0B,GAAG,MAAM,CAsBtG"}

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
 export { DiagramDocumentError, cloneDiagramDocument, createDiagramDocument, parseDiagramDocument, serializeDiagramDocument, } from './core/document.js';
+export { renderDiagramSvg } from './headless.js';
+export type { HeadlessRenderOptions } from './headless.js';
 export { DiagramActionRegistry } from './core/action-registry.js';
 export type { DiagramAction, DiagramActionState, } from './core/action-registry.js';
 export { DiagramCommandHistory } from './core/history.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,GAC3B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EACR,aAAa,EACb,kBAAkB,GACrB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,YAAY,EACR,cAAc,EACd,sBAAsB,EACtB,mBAAmB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,YAAY,EACR,eAAe,EACf,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,aAAa,EACb,SAAS,EACT,eAAe,GAClB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,gCAAgC,EAChC,6BAA6B,EAC7B,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,gCAAgC,GACnC,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,0BAA0B,EAC1B,qBAAqB,EACrB,8BAA8B,EAC9B,qBAAqB,EACrB,yBAAyB,GAC5B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,sBAAsB,EACtB,6BAA6B,EAC7B,oBAAoB,EACpB,iBAAiB,EACjB,2BAA2B,EAC3B,uBAAuB,EACvB,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,GACnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,iBAAiB,GACpB,MAAM,iCAAiC,CAAC;AAKzC,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,YAAY,EACR,cAAc,EACd,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,GACtB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,YAAY,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACH,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACR,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,8BAA8B,GACjC,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,WAAW,EACX,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,QAAQ,GACX,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACR,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,UAAU,EACV,YAAY,GACf,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACH,sBAAsB,EACtB,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACf,MAAM,YAAY,CAAC;AAEpB,YAAY,EACR,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,GACzB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,GAC3B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EACR,aAAa,EACb,kBAAkB,GACrB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,YAAY,EACR,cAAc,EACd,sBAAsB,EACtB,mBAAmB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,YAAY,EACR,eAAe,EACf,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,aAAa,EACb,SAAS,EACT,eAAe,GAClB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,gCAAgC,EAChC,6BAA6B,EAC7B,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,gCAAgC,GACnC,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,0BAA0B,EAC1B,qBAAqB,EACrB,8BAA8B,EAC9B,qBAAqB,EACrB,yBAAyB,GAC5B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,sBAAsB,EACtB,6BAA6B,EAC7B,oBAAoB,EACpB,iBAAiB,EACjB,2BAA2B,EAC3B,uBAAuB,EACvB,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,GACnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,iBAAiB,GACpB,MAAM,iCAAiC,CAAC;AAKzC,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,YAAY,EACR,cAAc,EACd,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,GACtB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,YAAY,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACH,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACR,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,8BAA8B,GACjC,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,WAAW,EACX,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,QAAQ,GACX,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACR,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,UAAU,EACV,YAAY,GACf,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACH,sBAAsB,EACtB,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACf,MAAM,YAAY,CAAC;AAEpB,YAAY,EACR,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,GACzB,MAAM,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stocksharp/diagram",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Browser strategy-diagram editor for StockSharp with typed ports, palette, canvas rendering, persistence, and a TypeScript API.",
   "license": "SEE LICENSE IN LICENSE",
   "author": {

package/src/headless.ts

@@ -0,0 +1,139 @@
+import { Diagram, type DiagramScreenshotOptions } from './canvas-renderer.js';
+import { parseDiagramDocument } from './core/document.js';
+
+/**
+ * Drawing a diagram where there is no browser -- a server producing a picture for a chat message, an
+ * e-mail or a report. The renderer itself never needed one: it draws through a surface, and the SVG
+ * surface builds a string. What needed a browser was the control around it, which creates a canvas and
+ * listens for pointers; so the few things it reaches for are stood in for here, for the length of one
+ * drawing, and taken away again.
+ *
+ * Text is measured by the SVG surface's own estimate rather than by a real font, so a label's box can sit
+ * a pixel or two off where a browser would put it. The alternative is a native canvas dependency on every
+ * machine that renders, which is a steep price for that.
+ */
+export interface HeadlessRenderOptions extends DiagramScreenshotOptions {
+    /** Width of the frame the drawing is laid out in, in CSS pixels. Defaults to 1200. */
+    hostWidth?: number;
+    /** Height of that frame. Defaults to 800. */
+    hostHeight?: number;
+}
+
+/** A 2D context that answers every call and remembers nothing: the drawing goes to the SVG surface. */
+function createContext(): CanvasRenderingContext2D {
+    const own = {
+        globalAlpha: 1,
+        measureText: (text: string) => ({ width: text.length * 7 }),
+    };
+
+    return new Proxy(own, {
+        get: (target, property) => property in target ? target[property as keyof typeof own] : () => undefined,
+        set: (target, property, value) => {
+            (target as Record<PropertyKey, unknown>)[property] = value;
+            return true;
+        },
+    }) as unknown as CanvasRenderingContext2D;
+}
+
+class StubElement {
+    style: Record<string, string> = {};
+    className = '';
+    tabIndex = 0;
+    width = 0;
+    height = 0;
+    textContent = '';
+    readonly children: StubElement[] = [];
+    readonly classList = { toggle: () => false, add: () => undefined, remove: () => undefined };
+
+    private readonly context = createContext();
+
+    appendChild<T extends StubElement>(child: T): T {
+        this.children.push(child);
+        return child;
+    }
+
+    removeChild(child: StubElement): StubElement {
+        const at = this.children.indexOf(child);
+        if (at >= 0) this.children.splice(at, 1);
+        return child;
+    }
+
+    remove(): void { /* detached already */ }
+    setAttribute(): void { /* nothing reads it here */ }
+    focus(): void { /* no focus without a browser */ }
+    addEventListener(): void { /* nothing to fire the events */ }
+    removeEventListener(): void { /* see above */ }
+    getContext(): CanvasRenderingContext2D { return this.context; }
+
+    getBoundingClientRect(): DOMRect {
+        return { left: 0, top: 0, right: this.width, bottom: this.height, width: this.width, height: this.height, x: 0, y: 0, toJSON: () => ({}) } as DOMRect;
+    }
+
+    get clientWidth(): number { return this.width; }
+    get clientHeight(): number { return this.height; }
+}
+
+const GLOBAL_KEYS = ['window', 'document', 'requestAnimationFrame', 'cancelAnimationFrame', 'Image', 'getComputedStyle', 'performance'] as const;
+
+/** Puts the stubs in place, and hands back the function that removes exactly what it added. */
+function installGlobals(): () => void {
+    const target = globalThis as Record<string, unknown>;
+
+    if (target.document !== undefined)
+        return () => undefined;
+
+    const before = new Map<string, unknown>();
+    for (const key of GLOBAL_KEYS) before.set(key, target[key]);
+
+    const stubDocument = Object.assign(new StubElement(), {
+        documentElement: new StubElement(),
+        createElement: () => new StubElement(),
+    });
+
+    Object.assign(target, {
+        window: Object.assign(new StubElement(), { devicePixelRatio: 1 }),
+        document: stubDocument,
+        requestAnimationFrame: () => 1,
+        cancelAnimationFrame: () => undefined,
+        Image: class { },
+        getComputedStyle: () => ({ getPropertyValue: () => '' }),
+        // A host without a browser may have no clock either -- an embedded JS engine has none. The drawing
+        // reads it for animation, and a still picture has no animation to advance.
+        performance: (globalThis as { performance?: { now(): number } }).performance ?? { now: () => 0 },
+    });
+
+    return () => {
+        for (const [key, value] of before) {
+            if (value === undefined) delete target[key];
+            else target[key] = value;
+        }
+    };
+}
+
+/**
+ * Draws a saved diagram and returns the SVG for it. The source is the document as text or as an object;
+ * the frame follows the content by default, since a picture made without a viewport has none to crop to.
+ */
+export function renderDiagramSvg(source: string | unknown, options: HeadlessRenderOptions = {}): string {
+    const { hostWidth = 1200, hostHeight = 800, ...screenshot } = options;
+    const restore = installGlobals();
+
+    try {
+        const host = new StubElement();
+        host.width = hostWidth;
+        host.height = hostHeight;
+
+        const diagram = new Diagram({ host: host as unknown as HTMLElement });
+
+        try {
+            // Whatever shape it arrived in -- text off the wire, an object already in hand -- the library's
+            // own reader decides what a document is.
+            diagram.loadDocument(parseDiagramDocument(source));
+            return diagram.takeSvg({ scope: 'content', ...screenshot });
+        } finally {
+            diagram.destroy();
+        }
+    } finally {
+        restore();
+    }
+}

package/src/index.ts

@@ -6,6 +6,9 @@ export {
     serializeDiagramDocument,
 } from './core/document.js';
 
+export { renderDiagramSvg } from './headless.js';
+export type { HeadlessRenderOptions } from './headless.js';
+
 export { DiagramActionRegistry } from './core/action-registry.js';
 export type {
     DiagramAction,