@diagrampilot/render-svg 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DiagramPilot contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { type DiagramSpec, type SvgArtifactProvenance } from "@diagrampilot/core";
+export declare const RENDER_SVG_PACKAGE_NAME = "@diagrampilot/render-svg";
+export declare const SVG_RENDERER_NAME = "@terrastruct/d2";
+export declare const SVG_RENDERER_VERSION = "0.1.33";
+export type SvgRendererProvenance = SvgArtifactProvenance;
+export interface CreateSvgRendererProvenanceOptions {
+    sourcePath: string;
+    sourceContent: string | Uint8Array;
+}
+export interface RenderDiagramSpecToSvgOptions {
+    provenance?: SvgRendererProvenance;
+}
+export declare function createSvgRendererProvenance(options: CreateSvgRendererProvenanceOptions): SvgRendererProvenance;
+export declare function addSvgProvenanceMetadata(svg: string, provenance: SvgRendererProvenance): string;
+export declare function renderDiagramSpecToSvg(spec: DiagramSpec, options?: RenderDiagramSpecToSvgOptions): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC3B,MAAM,oBAAoB,CAAC;AAI5B,eAAO,MAAM,uBAAuB,6BAA6B,CAAC;AAClE,eAAO,MAAM,iBAAiB,oBAAoB,CAAC;AACnD,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAE7C,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAC;AAE1D,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,GAAG,UAAU,CAAC;CACpC;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAkBD,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,kCAAkC,GAC1C,qBAAqB,CASvB;AAED,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,qBAAqB,GAChC,MAAM,CAeR;AAED,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,WAAW,EACjB,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,MAAM,CAAC,CAgBjB"}

package/dist/index.js

@@ -0,0 +1,48 @@
+import { createSvgArtifactProvenance, } from "@diagrampilot/core";
+import { exportDiagramSpecToD2 } from "@diagrampilot/export-d2";
+import { D2 } from "@terrastruct/d2";
+export const RENDER_SVG_PACKAGE_NAME = "@diagrampilot/render-svg";
+export const SVG_RENDERER_NAME = "@terrastruct/d2";
+export const SVG_RENDERER_VERSION = "0.1.33";
+async function terminateD2Worker(d2) {
+    const worker = d2.worker;
+    if (worker === undefined) {
+        return;
+    }
+    await worker.terminate();
+}
+export function createSvgRendererProvenance(options) {
+    return createSvgArtifactProvenance({
+        sourcePath: options.sourcePath,
+        sourceContent: options.sourceContent,
+        renderer: {
+            name: SVG_RENDERER_NAME,
+            version: SVG_RENDERER_VERSION,
+        },
+    });
+}
+export function addSvgProvenanceMetadata(svg, provenance) {
+    const openingSvgTag = /<svg\b[^>]*>/i.exec(svg);
+    if (openingSvgTag === null) {
+        return svg;
+    }
+    const insertionIndex = openingSvgTag.index + openingSvgTag[0].length;
+    const metadata = `<metadata id="diagrampilot-provenance">${JSON.stringify(provenance)}</metadata>`;
+    return `${svg.slice(0, insertionIndex)}${metadata}${svg.slice(insertionIndex)}`;
+}
+export async function renderDiagramSpecToSvg(spec, options = {}) {
+    const d2 = new D2();
+    try {
+        const d2Text = exportDiagramSpecToD2(spec);
+        const result = await d2.compile(d2Text);
+        const renderedSvg = await d2.render(result.diagram, result.renderOptions);
+        if (options.provenance === undefined) {
+            return renderedSvg;
+        }
+        return addSvgProvenanceMetadata(renderedSvg, options.provenance);
+    }
+    finally {
+        await terminateD2Worker(d2);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,GAG5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAC;AAErC,MAAM,CAAC,MAAM,uBAAuB,GAAG,0BAA0B,CAAC;AAClE,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AACnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAmB7C,KAAK,UAAU,iBAAiB,CAAC,EAAM;IACrC,MAAM,MAAM,GAAI,EAAoB,CAAC,MAAM,CAAC;IAE5C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,OAA2C;IAE3C,OAAO,2BAA2B,CAAC;QACjC,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,QAAQ,EAAE;YACR,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,oBAAoB;SAC9B;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,GAAW,EACX,UAAiC;IAEjC,MAAM,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhD,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACrE,MAAM,QAAQ,GAAG,0CAA0C,IAAI,CAAC,SAAS,CACvE,UAAU,CACX,aAAa,CAAC;IAEf,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,QAAQ,GAAG,GAAG,CAAC,KAAK,CAC3D,cAAc,CACf,EAAE,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,IAAiB,EACjB,UAAyC,EAAE;IAE3C,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;IAEpB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAE1E,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,OAAO,wBAAwB,CAAC,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;YAAS,CAAC;QACT,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@diagrampilot/render-svg",
+  "version": "0.1.5",
+  "description": "SVG rendering adapter for DiagramPilot.",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StiensWout/DiagramPilot.git",
+    "directory": "packages/render-svg"
+  },
+  "homepage": "https://diagrampilot.com",
+  "bugs": {
+    "url": "https://github.com/StiensWout/DiagramPilot/issues"
+  },
+  "keywords": [
+    "diagrampilot",
+    "diagramspec",
+    "diagram",
+    "architecture",
+    "svg"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b"
+  },
+  "dependencies": {
+    "@diagrampilot/core": "0.1.5",
+    "@diagrampilot/export-d2": "0.1.5",
+    "@terrastruct/d2": "0.1.33"
+  }
+}