@ts-graphviz/adapter 3.0.7 → 3.0.8

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @ts-graphviz/adapter
 
+## 3.0.8
+
+### Patch Changes
+
+- [#1763](https://github.com/ts-graphviz/ts-graphviz/pull/1763) [`24cc46e`](https://github.com/ts-graphviz/ts-graphviz/commit/24cc46ebf0078440fa498f89b21e7224725c16b6) Thanks [@kamiazya](https://github.com/kamiazya)! - Options are read from their own properties only, and values are always written as DOT text:
+
+  - `toStream` / `toFile`, `parse`, `stringify`, `fromModel` / `toModel`, `fromDot` and `toDot` read only the options their caller set. `toStream` / `toFile` also pass Node.js only the options and environment they set.
+  - Attribute keys and values, IDs, ports, compass points and comments are written so that DOT reads them back as the same text. A string of the form `<…>` is written as an HTML-like label only when it is well-formed; otherwise it is written as a quoted string.
+  - Writing attribute values and reading block comments are faster on large inputs.
+
 ## 3.0.7
 
 ### Patch Changes

package/README.md

@@ -22,7 +22,7 @@ Cross-platform interfaces for executing Graphviz DOT commands in various JavaScr
 
 [![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=GitHub&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
 [![npm](https://img.shields.io/badge/-npm-CB3837?logo=npm&style=flat)](https://www.npmjs.com/package/ts-graphviz)
-[![Reference](https://img.shields.io/badge/-API_Reference-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
+[![Reference](https://img.shields.io/badge/-API_Reference-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/api/)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ts-graphviz/ts-graphviz)
 
 [![Sponsor](https://img.shields.io/badge/-GitHub%20Sponsor-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/ts-graphviz)
@@ -249,6 +249,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="http://www.walterra.dev"><img src="https://avatars.githubusercontent.com/u/230104?v=4?s=100" width="100px;" alt="Walter Rafelsberger"/><br /><sub><b>Walter Rafelsberger</b></sub></a><br /><a href="#question-walterra" title="Answering Questions">💬</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/grsjst"><img src="https://avatars.githubusercontent.com/u/4739018?v=4?s=100" width="100px;" alt="grsjst"/><br /><sub><b>grsjst</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Agrsjst" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/stephenirven"><img src="https://avatars.githubusercontent.com/u/4293560?v=4?s=100" width="100px;" alt="Steve"/><br /><sub><b>Steve</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Astephenirven" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/btomaj"><img src="https://avatars.githubusercontent.com/u/2638986?v=4?s=100" width="100px;" alt="poetry by"/><br /><sub><b>poetry by</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Abtomaj" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

package/lib/create-command-and-args.js

@@ -1,3 +1,14 @@
+function ownOptions(options) {
+  const own = /* @__PURE__ */ Object.create(null);
+  if (options != null) {
+    const descriptors = Object.getOwnPropertyDescriptors(options);
+    for (const key of Object.getOwnPropertyNames(descriptors)) {
+      const descriptor = descriptors[key];
+      own[key] = "value" in descriptor ? descriptor.value : descriptor.get?.call(options);
+    }
+  }
+  return own;
+}
 function escapeValue(value) {
   if (value !== true) {
     if (typeof value === "string" && /\s/g.test(value)) {
@@ -8,39 +19,45 @@ function escapeValue(value) {
   return "";
 }
 function* createCommandArgs(options) {
+  const own = ownOptions(options);
   const {
     suppressWarnings = true,
     format = "svg",
-    attributes = {},
+    attributes,
     library = [],
     y = false,
     scale
-  } = options;
+  } = own;
   if (suppressWarnings) yield "-q";
   yield `-T${format}`;
-  if (attributes.graph) {
-    for (const [key, value] of Object.entries(attributes.graph)) {
+  const { graph, node, edge } = ownOptions(attributes);
+  if (graph) {
+    for (const [key, value] of Object.entries(graph)) {
       yield `-G${key}${escapeValue(value)}`;
     }
   }
-  if (attributes.node) {
-    for (const [key, value] of Object.entries(attributes.node)) {
+  if (node) {
+    for (const [key, value] of Object.entries(node)) {
       yield `-N${key}${escapeValue(value)}`;
     }
   }
-  if (attributes.edge) {
-    for (const [key, value] of Object.entries(attributes.edge)) {
+  if (edge) {
+    for (const [key, value] of Object.entries(edge)) {
       yield `-E${key}${escapeValue(value)}`;
     }
   }
   if (typeof scale === "number" && !Number.isNaN(scale)) yield `-s${scale}`;
-  if (Array.isArray(library)) for (const lib of library) yield `-l${lib}`;
+  if (Array.isArray(library)) {
+    for (let i = 0; i < library.length; i++) {
+      if (Object.hasOwn(library, i)) yield `-l${library[i]}`;
+    }
+  }
   if (y === true) yield "-y";
-  if (typeof options.layout === "string") {
-    yield `-K${options.layout}`;
-    switch (options.layout) {
+  if (typeof own.layout === "string") {
+    yield `-K${own.layout}`;
+    switch (own.layout) {
       case "neato": {
-        const { reduce, noop } = options;
+        const { reduce, noop } = own;
         if (reduce === true) yield "-x";
         if (typeof noop === "number") yield `-n${noop}`;
         break;
@@ -53,7 +70,7 @@ function* createCommandArgs(options) {
           unscaledFactor,
           overlapExpansionFactor,
           temperature
-        } = options;
+        } = own;
         yield ["-L", grid ? "" : "g", oldAttractive ? "O" : ""].join("");
         if (typeof iterations === "number") yield `-Ln${iterations}`;
         if (typeof unscaledFactor === "number") yield `-LU${unscaledFactor}`;
@@ -66,7 +83,8 @@ function* createCommandArgs(options) {
   }
 }
 function createCommandAndArgs(options) {
-  return [options.dotCommand ?? "dot", Array.from(createCommandArgs(options))];
+  const own = ownOptions(options);
+  return [own.dotCommand ?? "dot", Array.from(createCommandArgs(own))];
 }
 export {
   createCommandAndArgs

package/lib/deno.js

@@ -2,6 +2,7 @@ import { createCommandAndArgs } from "./create-command-and-args.js";
 async function toStream(dot, options) {
   const [command, args] = createCommandAndArgs(options ?? {});
   const cp = new Deno.Command(command, {
+    __proto__: null,
     args,
     stdin: "piped",
     stdout: "piped"
@@ -13,10 +14,10 @@ async function toStream(dot, options) {
 }
 function open(path) {
   try {
-    return Deno.open(path, { write: true });
+    return Deno.open(path, { __proto__: null, write: true });
   } catch (e) {
     if (e instanceof Deno.errors.NotFound) {
-      return Deno.open(path, { createNew: true, write: true });
+      return Deno.open(path, { __proto__: null, createNew: true, write: true });
     }
     throw e;
   }

package/lib/node.js

@@ -6,7 +6,12 @@ import { createCommandAndArgs } from "./create-command-and-args.js";
 async function toStream(dot, options) {
   const [command, args] = createCommandAndArgs(options ?? {});
   return new Promise(function toStreamInternal(resolve, reject) {
-    const p = spawn(command, args, { stdio: "pipe" });
+    const p = spawn(command, args, {
+      __proto__: null,
+      stdio: "pipe",
+      shell: false,
+      env: ownEnv()
+    });
     p.on("error", (e) => {
       reject(
         new Error(`Command "${command}" failed.
@@ -40,9 +45,22 @@ MESSAGE: ${message}`
     pipeline(Readable.from([dot]), p.stdin);
   });
 }
+function ownEnv() {
+  const env = /* @__PURE__ */ Object.create(null);
+  for (const key of Object.keys(process.env)) {
+    env[key] = process.env[key];
+  }
+  return env;
+}
 async function toFile(dot, path, options) {
   const stream = await toStream(dot, options);
-  await pipeline(stream, createWriteStream(path));
+  await pipeline(
+    stream,
+    createWriteStream(path, {
+      __proto__: null,
+      flags: "w"
+    })
+  );
 }
 export {
   toFile,

package/lib/own-options.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The own properties of an options object, in an object without a
+ * prototype, so that a property inherited from `Object.prototype` is never
+ * read as an option.
+ *
+ * The property descriptors are taken in one step before any value is read,
+ * so an accessor cannot remove another property and expose an inherited one.
+ *
+ * @internal
+ */
+export declare function ownOptions<T extends object>(options: T | undefined): T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-graphviz/adapter",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "Graphviz Runtime adapters for Cross Platform",
   "keywords": [
     "graphviz",