@ts-graphviz/common 0.0.0-pr956-20240225073457

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ts-graphviz/common
+
+## 0.0.0-pr956-20240225073457
+
+### Major Changes
+
+- [`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24) Thanks [@kamiazya](https://github.com/kamiazya)! - Release v2.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2019-2024 Yuki Yamazaki
+
+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/README.md

@@ -0,0 +1,47 @@
+# @ts-graphviz/common
+
+This package contains type information, constants, and utility functions related to the DOT language attributes, attribute values, and models for ts-graphviz.
+
+It is part of the ts-graphviz library, which is split into modular packages to improve maintainability, flexibility, and ease of use.
+
+## Features
+
+- Type definitions for DOT language elements, such as attributes and attribute values
+- Constants representing common attribute names and values
+- Utility functions for working with DOT language elements
+
+## Usage
+
+Import the necessary types, constants, or utility functions from the `@ts-graphviz/common` package:
+
+```ts
+import { NodeAttributesObject, EdgeAttributesObject } from '@ts-graphviz/common';
+```
+
+Use the imported items in your project to work with the DOT language elements:
+
+
+```ts
+const nodeAttr: NodeAttributesObject = {
+  label: 'Node label',
+  shape: 'ellipse',
+};
+
+const edgeAttr: EdgeAttributesObject = {
+  label: 'Edge label',
+  color: 'red',
+};
+```
+
+For more examples and usage details, please refer to the ts-graphviz documentation.
+
+
+## Contributing
+
+Contributions to the ts-graphviz project are welcome.
+
+Please refer to the main ts-graphviz repository for guidelines on how to contribute.
+
+## License
+
+This package is released under the MIT License.

package/lib/common.cjs

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function _pipe(...args) {
+  const [o1, ...operations] = args;
+  return (...t) => operations.reduce((acc, f) => f(acc), o1(...t));
+}
+function pipe(o1, ...operations) {
+  return _pipe(o1, ...operations);
+}
+const defer = (fn) => (...args) => (src) => fn(src, ...args);
+const toIterable = (f) => ({
+  [Symbol.iterator]: f
+});
+const map = defer(
+  (src, selector) => Array.from(
+    toIterable(function* () {
+      for (const v of src) {
+        yield selector(v);
+      }
+    })
+  )
+);
+const filter = defer(
+  (src, pred) => Array.from(
+    toIterable(function* () {
+      for (const x of src) {
+        if (pred(x)) {
+          yield x;
+        }
+      }
+    })
+  )
+);
+const RootModelsContext = Object.seal({
+  // NOTE: RootModelsContext is also initialized after the model class is declared in the 'core/index.js' module.
+  Graph: null,
+  Digraph: null,
+  Subgraph: null,
+  Node: null,
+  Edge: null
+});
+function createModelsContext(models) {
+  return Object.assign(
+    Object.seal(Object.assign({}, RootModelsContext)),
+    models
+  );
+}
+function isForwardRefNode(object) {
+  return typeof object === "object" && object !== null && typeof object.id === "string";
+}
+function isNodeModel(object) {
+  return typeof object === "object" && object !== null && object.$$type === "Node" && typeof object.id === "string";
+}
+function isNodeRef(node) {
+  return isNodeModel(node) || isForwardRefNode(node);
+}
+function isNodeRefLike(node) {
+  return typeof node === "string" || isNodeRef(node);
+}
+function isNodeRefGroupLike(target) {
+  return Array.isArray(target) && target.every(isNodeRefLike);
+}
+function isCompass(c) {
+  return ["n", "ne", "e", "se", "s", "sw", "w", "nw", "c"].includes(c);
+}
+function toNodeRef(target) {
+  if (isNodeRef(target)) {
+    return target;
+  }
+  const [id, port, compass] = target.split(":");
+  if (isCompass(compass)) {
+    return { id, port, compass };
+  }
+  return { id, port };
+}
+function toNodeRefGroup(targets) {
+  if (targets.length < 2 && (isNodeRefLike(targets[0]) && isNodeRefLike(targets[1])) === false) {
+    throw Error("EdgeTargets must have at least 2 elements.");
+  }
+  return targets.map((t) => toNodeRef(t));
+}
+exports.RootModelsContext = RootModelsContext;
+exports.createModelsContext = createModelsContext;
+exports.filter = filter;
+exports.isCompass = isCompass;
+exports.isForwardRefNode = isForwardRefNode;
+exports.isNodeModel = isNodeModel;
+exports.isNodeRef = isNodeRef;
+exports.isNodeRefGroupLike = isNodeRefGroupLike;
+exports.isNodeRefLike = isNodeRefLike;
+exports.map = map;
+exports.pipe = pipe;
+exports.toNodeRef = toNodeRef;
+exports.toNodeRefGroup = toNodeRefGroup;