@ts-graphviz/core 0.0.0-pr956-20240225073457 → 0.0.0-pr956-20240225091623

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @ts-graphviz/core
 
-## 0.0.0-pr956-20240225073457
+## 0.0.0-pr956-20240225091623
 
 ### Major Changes
 
@@ -9,5 +9,5 @@
 ### Patch Changes
 
 - Updated dependencies [[`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24)]:
-  - @ts-graphviz/common@0.0.0-pr956-20240225073457
-  - @ts-graphviz/ast@0.0.0-pr956-20240225073457
+  - @ts-graphviz/common@0.0.0-pr956-20240225091623
+  - @ts-graphviz/ast@0.0.0-pr956-20240225091623

package/package.json

@@ -1,36 +1,59 @@
 {
   "name": "@ts-graphviz/core",
-  "version": "0.0.0-pr956-20240225073457",
+  "version": "0.0.0-pr956-20240225091623",
   "description": "",
-  "type": "module",
-  "main": "lib/core.cjs",
-  "module": "lib/core.js",
-  "types": "lib/core.d.ts",
+  "keywords": [
+    "graphviz",
+    "dot"
+  ],
+  "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",
+  "bugs": {
+    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ts-graphviz/ts-graphviz.git",
     "directory": "packages/core"
   },
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "author": "Yuki Yamazaki <yuki@kamiazya.tech>",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ts-graphviz"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/ts-graphviz"
+    }
+  ],
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
-  },
-  "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",
+  "author": "Yuki Yamazaki <yuki@kamiazya.tech>",
   "sideEffects": true,
+  "type": "module",
+  "main": "lib/core.cjs",
+  "module": "lib/core.js",
+  "types": "lib/core.d.ts",
+  "files": [
+    "lib",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
   "dependencies": {
-    "@ts-graphviz/ast": "^0.0.0-pr956-20240225073457",
-    "@ts-graphviz/common": "^0.0.0-pr956-20240225073457"
+    "@ts-graphviz/ast": "^0.0.0-pr956-20240225091623",
+    "@ts-graphviz/common": "^0.0.0-pr956-20240225091623"
   },
   "devDependencies": {
     "typescript": "^5.3.3",
     "vite": "^5.1.3",
     "vite-plugin-dts": "^3.7.2"
   },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "build": "vite build"
   }

package/src/attribute.ts

@@ -1,18 +0,0 @@
-import { Attribute } from '@ts-graphviz/common';
-
-/**
- * @group Attribute
- *
- * @deprecated Use {@link Attribute.keys} instead.
- */
-export type AttributeKeyDict = Attribute.keys;
-
-/**
- * @group Attribute
- */
-export const attribute: Attribute.keys = new Proxy(
-  Object.freeze({}) as Attribute.keys,
-  {
-    get: (_, key: string) => key,
-  },
-);

package/src/core.ts

@@ -1,5 +0,0 @@
-export * from './attribute.js';
-export * from './models/index.js';
-export * from './model-factory/index.js';
-export * from './to-dot.js';
-export * from './from-dot.js';

package/src/from-dot.ts

@@ -1,73 +0,0 @@
-import {
-  ConvertToModelOptions,
-  ParseOptions,
-  parse,
-  toModel,
-} from '@ts-graphviz/ast';
-import {
-  EdgeModel,
-  NodeModel,
-  RootGraphModel,
-  SubgraphModel,
-} from '@ts-graphviz/common';
-
-/**
- * This interface provides options for converting DOT to a model.
- * @group Convert DOT to Model
- */
-export interface FromDotOptions<
-  T extends 'Dot' | 'Graph' | 'Node' | 'Edge' | 'Subgraph',
-> {
-  /**
-   * Options for parsing DOT.
-   */
-  parse?: ParseOptions<T>;
-  /**
-   * Options for converting the parsed DOT to a model.
-   */
-  convert?: ConvertToModelOptions;
-}
-
-/**
- * fromDot is a function that converts a DOT string to a model.
- *
- * @group Convert DOT to Model
- *
- * @param dot The DOT string to convert.
- * @param options Options for converting the DOT string to a model.
- * @returns A model of type {@link RootGraphModel}, {@link NodeModel}, {@link EdgeModel}, or {@link SubgraphModel},
- * depending on the type specified in the options.
- */
-export function fromDot(
-  dot: string,
-  options?: FromDotOptions<'Dot' | 'Graph'>,
-): RootGraphModel;
-export function fromDot(
-  dot: string,
-  options?: FromDotOptions<'Node'>,
-): NodeModel;
-export function fromDot(
-  dot: string,
-  options?: FromDotOptions<'Edge'>,
-): EdgeModel;
-export function fromDot(
-  dot: string,
-  options?: FromDotOptions<'Subgraph'>,
-): SubgraphModel;
-export function fromDot<
-  T extends 'Dot' | 'Graph' | 'Node' | 'Edge' | 'Subgraph',
->(dot: string, options?: FromDotOptions<T>) {
-  const ast = parse(dot, options?.parse);
-  if (
-    Array.isArray(ast) ||
-    ast.type === 'Attribute' ||
-    ast.type === 'AttributeList' ||
-    ast.type === 'Comment' ||
-    ast.type === 'NodeRef' ||
-    ast.type === 'NodeRefGroup' ||
-    ast.type === 'Literal'
-  ) {
-    throw new Error();
-  }
-  return toModel(ast, options?.convert);
-}

package/src/model-factory/index.ts

@@ -1,2 +0,0 @@
-export * from './types.js';
-export * from './model-factory.js';

package/src/model-factory/model-factory-builder.test.ts

@@ -1,79 +0,0 @@
-import { describe, expect, test, vi } from 'vitest';
-
-import { RootModelsContext } from '@ts-graphviz/common';
-import { attribute as _ } from '../attribute.js';
-import '../models/registerModelContext.js';
-import { ModelFactoryBuilder } from './model-factory-builder.js';
-
-describe.each([
-  { directed: true, strict: true },
-  { directed: false, strict: true },
-  { directed: false, strict: false },
-  { directed: true, strict: false },
-])('strict: %s, directed: %s', ({ strict, directed }) => {
-  const factory = ModelFactoryBuilder.call(RootModelsContext, directed, strict);
-
-  test('no arguments', () => {
-    const g = factory();
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is id', () => {
-    const g = factory('foo');
-    expect(g.id).toStrictEqual('foo');
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is callback', () => {
-    const callback = vi.fn();
-    const g = factory(callback);
-    expect(g.id).toBeUndefined();
-    expect(callback).toHaveBeenCalledWith(g);
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is attribute object', () => {
-    const g = factory({ [_.label]: 'Test label' });
-    expect(g.id).toBeUndefined();
-    expect(g.values).toStrictEqual([[_.label, 'Test label']]);
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is attribute object, seccond argument is callback', () => {
-    const callback = vi.fn();
-    const g = factory({ [_.label]: 'Test label' }, callback);
-    expect(g.id).toBeUndefined();
-    expect(g.values).toStrictEqual([[_.label, 'Test label']]);
-    expect(callback).toHaveBeenCalledWith(g);
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is id, seccond argument is attribute object', () => {
-    const g = factory('foo', { [_.label]: 'Test label' });
-    expect(g.id).toStrictEqual('foo');
-    expect(g.values).toStrictEqual([[_.label, 'Test label']]);
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-
-  test('first argument is id, seccond argument is attribute object, third arguments is callback', () => {
-    const callback = vi.fn();
-    const g = factory('foo', { [_.label]: 'Test label' }, callback);
-    expect(g.id).toStrictEqual('foo');
-    expect(g.values).toStrictEqual([[_.label, 'Test label']]);
-    expect(callback).toHaveBeenCalledWith(g);
-
-    expect(g.directed).toStrictEqual(directed);
-    expect(g.strict).toStrictEqual(strict);
-  });
-});

package/src/model-factory/model-factory-builder.ts

@@ -1,55 +0,0 @@
-import {
-  GraphAttributesObject,
-  ModelsContext,
-  RootGraphModel,
-  RootModelsContext,
-} from '@ts-graphviz/common';
-import { ModelFactory } from './types.js';
-
-/**
- * ModelFactoryBuilder is a function that takes two parameters, directed and strictMode, and returns a ModelFactory.
- *
- * @param directed A boolean value indicating whether the graph should be directed or not.
- * @param strictMode A boolean value indicating whether the graph should be in strict mode or not.
- * @returns A ModelFactory that takes an array of unknowns as parameters and returns a RootGraphModel.
- * @hidden
- */
-export function ModelFactoryBuilder(
-  this: ModelsContext,
-  directed: boolean,
-  strictMode: boolean,
-): ModelFactory {
-  return (...args: unknown[]) => {
-    const G = directed ? this.Digraph : this.Graph;
-    const id = args.find((arg): arg is string => typeof arg === 'string');
-    const attributes = args.find(
-      (arg): arg is GraphAttributesObject => typeof arg === 'object',
-    );
-    const callback = args.find(
-      (arg): arg is (g: RootGraphModel) => void => typeof arg === 'function',
-    );
-    const g = new G(id, strictMode, attributes);
-    g.with(this);
-    if (typeof callback === 'function') {
-      callback(g);
-    }
-    return g;
-  };
-}
-
-/**
- * createModelFactories is a function that takes a boolean value, strict, and an optional ModelsContext parameter, context, and returns an object containing two ModelFactories.
- *
- * @param strict A boolean value indicating whether the graph should be in strict mode or not.
- * @param context An optional ModelsContext parameter.
- * @returns An object containing two ModelFactories, one for directed graphs and one for undirected graphs.
- */
-export function createModelFactories(
-  strict: boolean,
-  context: ModelsContext = RootModelsContext,
-) {
-  return Object.freeze({
-    digraph: ModelFactoryBuilder.call(context, true, strict),
-    graph: ModelFactoryBuilder.call(context, false, strict),
-  });
-}

package/src/model-factory/model-factory.test.ts

@@ -1,61 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { Digraph, Graph } from '../models/index.js';
-import { digraph, graph, strict, withContext } from './model-factory.js';
-
-test('digraph function returns an object of Digraph, and the strict property is false', () => {
-  const g = digraph();
-  expect(g).toBeInstanceOf(Digraph);
-  expect(g.strict).toStrictEqual(false);
-});
-
-test('graph function returns an object of Graph, and the strict property is false', () => {
-  const g = graph();
-  expect(g).toBeInstanceOf(Graph);
-  expect(g.strict).toStrictEqual(false);
-});
-
-test('strict.digraph function returns an object of Digraph', () => {
-  const g = strict.digraph();
-  expect(g).toBeInstanceOf(Digraph);
-  expect(g.strict).toStrictEqual(true);
-});
-
-test('strict.graph function returns an object of Graph', () => {
-  const g = strict.graph();
-  expect(g).toBeInstanceOf(Graph);
-  expect(g.strict).toStrictEqual(true);
-});
-
-describe('withContext function allows the class RootGraph to be generated with a custom class.', () => {
-  class TestDigraph extends Digraph {}
-  class TestGraph extends Graph {}
-
-  const { digraph, graph, strict } = withContext({
-    Digraph: TestDigraph,
-    Graph: TestGraph,
-  });
-
-  test('digraph function returns an object of TestDigraph, and the strict property is false', () => {
-    const g = digraph();
-    expect(g).toBeInstanceOf(TestDigraph);
-    expect(g.strict).toStrictEqual(false);
-  });
-
-  test('graph function returns an object of TestGraph, and the strict property is false', () => {
-    const g = graph();
-    expect(g).toBeInstanceOf(TestGraph);
-    expect(g.strict).toStrictEqual(false);
-  });
-
-  test('strict.digraph function returns an object of TestDigraph', () => {
-    const g = strict.digraph();
-    expect(g).toBeInstanceOf(TestDigraph);
-    expect(g.strict).toStrictEqual(true);
-  });
-
-  test('strict.graph function returns an object of TestGraph', () => {
-    const g = strict.graph();
-    expect(g).toBeInstanceOf(TestGraph);
-    expect(g.strict).toStrictEqual(true);
-  });
-});

package/src/model-factory/model-factory.ts

@@ -1,40 +0,0 @@
-import { ModelsContext, createModelsContext } from '@ts-graphviz/common';
-import { createModelFactories } from './model-factory-builder.js';
-import { ModelFactories, ModelFactoriesWithStrict } from './types.js';
-
-const noStrict: ModelFactories = createModelFactories(false);
-
-/**
- *  digraph is a factory for creating Digraph objects.
- * @group Model Factory
- */
-export const digraph = noStrict.digraph;
-
-/**
- * graph is a factory for creating Graph objects.
- * @group Model Factory
- */
-export const graph = noStrict.graph;
-
-/**
- * Provides a strict mode API.
- * @group Model Factory
- */
-export const strict: ModelFactories = createModelFactories(true);
-
-/**
- * withContext creates a {@link ModelFactoriesWithStrict} object with the given context.
- *
- * @param models - An object containing the models to be used in the context.
- *
- * @returns A ModelFactoriesWithStrict object containing the factories. * @group Model Factory
- */
-export function withContext(
-  models: Partial<ModelsContext>,
-): ModelFactoriesWithStrict {
-  const context = createModelsContext(models);
-  return Object.freeze({
-    ...createModelFactories(false, context),
-    strict: createModelFactories(true, context),
-  });
-}

package/src/model-factory/types.ts

@@ -1,46 +0,0 @@
-import { GraphAttributesObject, RootGraphModel } from '@ts-graphviz/common';
-
-/**
- * ModelFactory is an interface that provides a way to create a {@link RootGraphModel} object.
- *
- * @param id - Optional string parameter that specifies the id of the {@link RootGraphModel} object.
- * @param attributes - Optional GraphAttributesObject parameter that specifies the attributes of the {@link RootGraphModel} object.
- * @param callback - Optional callback function that takes a {@link RootGraphModel} object as a parameter.
- *
- * @returns {@link RootGraphModel} - Returns a {@link RootGraphModel} object.
- * @group Model Factory
- */
-export interface ModelFactory {
-  (
-    id?: string,
-    attributes?: GraphAttributesObject,
-    callback?: (g: RootGraphModel) => void,
-  ): RootGraphModel;
-  (
-    attributes?: GraphAttributesObject,
-    callback?: (g: RootGraphModel) => void,
-  ): RootGraphModel;
-  (id?: string, callback?: (g: RootGraphModel) => void): RootGraphModel;
-  (callback?: (g: RootGraphModel) => void): RootGraphModel;
-}
-
-/**
- * @group Model Factory
- */
-export interface ModelFactories {
-  /**
-   * API for creating directional graph objects.
-   */
-  digraph: ModelFactory;
-  /**
-   * API for creating omnidirectional graph objects.
-   */
-  graph: ModelFactory;
-}
-
-/**
- * @group Model Factory
- */
-export interface ModelFactoriesWithStrict extends ModelFactories {
-  strict: ModelFactories;
-}

package/src/models/AttributeList.spec.ts

@@ -1,58 +0,0 @@
-import { AttributeListKind } from '@ts-graphviz/common';
-import { beforeEach, describe, expect, it, test } from 'vitest';
-import { attribute as _ } from '../attribute.js';
-import { AttributeList } from './AttributeList.js';
-import { AttributesBase } from './AttributesBase.js';
-import { DotObject } from './DotObject.js';
-
-let attrs: AttributeList<AttributeListKind>;
-beforeEach(() => {
-  attrs = new AttributeList('Node');
-});
-
-describe('object', () => {
-  it('should be instance of AttributeList/AttributesBase/DotObject', () => {
-    expect(attrs).toBeInstanceOf(AttributeList);
-    expect(attrs).toBeInstanceOf(AttributesBase);
-    expect(attrs).toBeInstanceOf(DotObject);
-  });
-
-  it('size should be 0 by default', () => {
-    expect(attrs.size).toBe(0);
-  });
-
-  it('$$type property should returns "AttributeList"', () => {
-    expect(attrs.$$type).toStrictEqual('AttributeList');
-  });
-});
-
-describe('constructor', () => {
-  describe('1st argument is kind of AttributeList', () => {
-    test.each(['Node', 'Edge', 'Graph'] as AttributeListKind[])(
-      'AttributeList kind is %s',
-      (kind) => {
-        attrs = new AttributeList(kind);
-        expect(attrs.$$kind).toStrictEqual(kind);
-      },
-    );
-  });
-
-  test('2nd argument is attribute object', () => {
-    attrs = new AttributeList('Node', {
-      [_.label]: 'Label',
-    });
-    expect(attrs.size).toBe(1);
-    expect(attrs.get(_.label)).toBe('Label');
-  });
-});
-
-describe('comment', () => {
-  test('default value to be undefined', () => {
-    expect(attrs.comment).toBeUndefined();
-  });
-
-  test('comment can be set', () => {
-    attrs.comment = 'test';
-    expect(attrs.comment).toStrictEqual('test');
-  });
-});

package/src/models/AttributeList.ts

@@ -1,32 +0,0 @@
-import {
-  AttributeKey,
-  AttributeListKind,
-  AttributeListModel,
-  AttributesObject,
-} from '@ts-graphviz/common';
-import { AttributesBase } from './AttributesBase.js';
-
-/**
- * A set of attribute values for any object.
- * @group Models
- */
-export class AttributeList<
-    K extends AttributeListKind,
-    T extends AttributeKey = AttributeKey,
-  >
-  extends AttributesBase<T>
-  implements AttributeListModel<K, T>
-{
-  public get $$type(): 'AttributeList' {
-    return 'AttributeList';
-  }
-
-  public comment?: string;
-
-  constructor(
-    public readonly $$kind: K,
-    attributes?: AttributesObject<T>,
-  ) {
-    super(attributes);
-  }
-}

package/src/models/AttributesBase.spec.ts

@@ -1,79 +0,0 @@
-import { Attributes } from '@ts-graphviz/common';
-import { beforeEach, describe, expect, it, test } from 'vitest';
-import { attribute as _ } from '../attribute.js';
-import { AttributesBase } from './AttributesBase.js';
-import { DotObject } from './DotObject.js';
-
-class TestAttributes extends AttributesBase<any> {}
-
-let attrs: Attributes<any>;
-beforeEach(() => {
-  attrs = new TestAttributes();
-});
-
-describe('object', () => {
-  it('should be instance of AttributesBase/DotObject', () => {
-    expect(attrs).toBeInstanceOf(DotObject);
-    expect(attrs).toBeInstanceOf(AttributesBase);
-  });
-
-  it('size should be 0 by default', () => {
-    expect(attrs.size).toBe(0);
-  });
-});
-
-describe('constructor', () => {
-  test('with no attribute object', () => {
-    attrs = new TestAttributes();
-    expect(attrs.size).toBe(0);
-    expect(attrs.get(_.label)).toBeUndefined();
-  });
-
-  test('with attribute object', () => {
-    attrs = new TestAttributes({
-      [_.label]: 'Label',
-    });
-    expect(attrs.size).toBe(1);
-    expect(attrs.get(_.label)).toBe('Label');
-  });
-});
-
-describe('apply method', () => {
-  test('with attributes object', () => {
-    attrs.apply({
-      [_.label]: 'this is test',
-      [_.color]: 'red',
-      [_.fontsize]: 16,
-    });
-    expect(attrs.size).toBe(3);
-  });
-
-  test('with attributes entities', () => {
-    attrs.apply([
-      [_.label, 'this is test'],
-      [_.color, 'red'],
-      [_.fontsize, 16],
-    ]);
-    expect(attrs.size).toBe(3);
-  });
-});
-
-test('clear method', () => {
-  attrs = new TestAttributes({
-    [_.label]: 'this is test',
-    [_.color]: 'red',
-    [_.fontsize]: 16,
-  });
-
-  expect(attrs.size).toBe(3);
-  attrs.clear();
-  expect(attrs.size).toBe(0);
-});
-
-test('set/get/delete methods', () => {
-  const id = 'test';
-  attrs.set('label', id);
-  expect(attrs.get('label')).toBe(id);
-  attrs.delete('label');
-  expect(attrs.get('label')).toBeUndefined();
-});