@ts-graphviz/ast 2.0.6 → 2.0.7-next-f8ba9a89f3ac9e916ded16f0a0618113a5eb4928

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ts-graphviz/ast
 
+## 2.0.7-next-f8ba9a89f3ac9e916ded16f0a0618113a5eb4928
+
+### Patch Changes
+
+- [#1318](https://github.com/ts-graphviz/ts-graphviz/pull/1318) [`c043ba9`](https://github.com/ts-graphviz/ts-graphviz/commit/c043ba9bcc5194a89b976df1609c4e9875300f1e) Thanks [@kamiazya](https://github.com/kamiazya)! - Improve error handling and documentation in the @ts-graphviz/ast package.
+
+  The most important changes include fixing an unexpected parsing error, updating the error class used in the parse function, and enhancing the documentation for the `DotSyntaxError` class.
+
 ## 2.0.6
 
 ### Patch Changes

package/LICENSE

@@ -1,7 +1,6 @@
-
 The MIT License (MIT)
 
-Copyright (c) 2019-2024 Yuki Yamazaki
+Copyright (c) 2019-2025 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

package/lib/ast.cjs

@@ -3106,12 +3106,16 @@ function parse(input, options) {
     return parse$1(input, options);
   } catch (e) {
     if (e instanceof PeggySyntaxError) {
-      throw new DotSyntaxError(e.message, e.expected, e.found, e.location);
+      throw new DotSyntaxError(e.message, {
+        cause: e
+      });
     }
-    throw e;
+    throw new Error("Unexpected parse error", {
+      cause: e
+    });
   }
 }
-class DotSyntaxError extends PeggySyntaxError {
+class DotSyntaxError extends SyntaxError {
   constructor(...args) {
     super(...args);
     this.name = "DotSyntaxError";

package/lib/ast.d.ts

@@ -8,10 +8,6 @@ import { NodeModel } from '@ts-graphviz/common';
 import { RootGraphModel } from '@ts-graphviz/common';
 import { SubgraphModel } from '@ts-graphviz/common';
 
-declare interface AnyExpectation {
-    type: "any";
-}
-
 /**
  * ASTBaseNode is an interface that serves as the base for all AST nodes.
  * It requires all leaf interfaces to specify a type property,
@@ -149,16 +145,6 @@ export declare interface BuilderOptions {
     locationFunction: () => FileRange;
 }
 
-declare interface ClassExpectation {
-    type: "class";
-    parts: ClassParts;
-    inverted: boolean;
-    ignoreCase: boolean;
-}
-
-declare interface ClassParts extends Array<string | ClassParts> {
-}
-
 /**
  * ClusterStatementASTNode is a type used to represent a statement in a cluster graph.
  * @group AST
@@ -394,10 +380,19 @@ export declare interface DotASTPropaties extends ASTCommonPropaties {
 }
 
 /**
+ * DotSyntaxError is a class that extends the SyntaxError class and provides additional information about the syntax error.
+ *
  * @group Convert DOT to AST
+ *
+ * @remarks
+ * This error is thrown when a parsing error occurs.
+ * The error provides additional information about the syntax error.
+ *
+ * This is in reference to the specification
+ * that the error thrown when a parse error occurs in the {@link !JSON.parse} function is {@link !SyntaxError}.
  */
-export declare class DotSyntaxError extends PeggySyntaxError {
-    constructor(...args: ConstructorParameters<typeof PeggySyntaxError>);
+export declare class DotSyntaxError extends SyntaxError {
+    constructor(...args: ConstructorParameters<typeof SyntaxError>);
 }
 
 /**
@@ -431,18 +426,12 @@ export declare interface EdgeASTPropaties extends ASTCommonPropaties {
  */
 export declare type EdgeTargetASTNode = NodeRefASTNode | NodeRefGroupASTNode;
 
-declare interface EndExpectation {
-    type: "end";
-}
-
 /**
  * This type represents the EndOfLine type which is used to determine the type of line ending to be used when writing to a file.
  * @group Convert AST to DOT
  */
 export declare type EndOfLine = 'lf' | 'crlf';
 
-declare type Expectation = LiteralExpectation | ClassExpectation | AnyExpectation | EndExpectation | OtherExpectation;
-
 /**
  * The FilePosition interface represents the position of a file in terms of its offset, line number, and column number.
  *
@@ -463,12 +452,6 @@ export declare interface FilePosition {
     column: number;
 }
 
-declare interface FilePosition_2 {
-    offset: number;
-    line: number;
-    column: number;
-}
-
 /**
  * FileRange interface represents a range of positions within a file.
  * @group AST
@@ -484,12 +467,6 @@ export declare interface FileRange {
     end: FilePosition;
 }
 
-declare interface FileRange_2 {
-    start: FilePosition_2;
-    end: FilePosition_2;
-    source: string;
-}
-
 /**
  * A function used to convert a DotObjectModel into an AST.
  *
@@ -579,12 +556,6 @@ export declare interface LiteralASTPropaties<T extends string = string> extends
     quoted: boolean | 'html';
 }
 
-declare interface LiteralExpectation {
-    type: "literal";
-    text: string;
-    ignoreCase: boolean;
-}
-
 /**
  *  ModelOf is a type that determines the type of model to use depending on the value of T.
  * @group AST
@@ -660,11 +631,6 @@ export declare interface NodeRefGroupASTNode extends ASTBaseParentNode<NodeRefAS
 export declare interface NodeRefGroupASTPropaties extends ASTCommonPropaties {
 }
 
-declare interface OtherExpectation {
-    type: "other";
-    description: string;
-}
-
 /**
  * parse is a function that takes a string input and optional parse options and
  * returns an ASTNode or an array of ClusterStatementASTNodes.
@@ -682,7 +648,7 @@ declare interface OtherExpectation {
  * - {@link SubgraphASTNode}
  * - {@link ClusterStatementASTNode}
  *
- * @throws {@link SyntaxError}
+ * @throws {@link DotSyntaxError}
      * @group Convert DOT to AST
      */
  export declare function parse(input: string): DotASTNode;
@@ -714,24 +680,6 @@ declare interface OtherExpectation {
      startRule?: T;
  }
 
- declare const PeggySyntaxError: typeof _PeggySyntaxError;
-
- declare type PeggySyntaxError = _PeggySyntaxError;
-
- declare class _PeggySyntaxError extends Error {
-     static buildMessage(expected: Expectation[], found: string | null): string;
-     message: string;
-     expected: Expectation[];
-     found: string | null;
-     location: FileRange_2;
-     name: string;
-     constructor(message: string, expected: Expectation[], found: string | null, location: FileRange_2);
-     format(sources: {
-         source?: any;
-         text: string;
-     }[]): string;
- }
-
  /**
   * PrintContext interface provides an interface for printing an ASTNode with a set of options.
   * @group Convert AST to DOT

package/lib/ast.js

@@ -3104,12 +3104,16 @@ function parse(input, options) {
     return parse$1(input, options);
   } catch (e) {
     if (e instanceof PeggySyntaxError) {
-      throw new DotSyntaxError(e.message, e.expected, e.found, e.location);
+      throw new DotSyntaxError(e.message, {
+        cause: e
+      });
     }
-    throw e;
+    throw new Error("Unexpected parse error", {
+      cause: e
+    });
   }
 }
-class DotSyntaxError extends PeggySyntaxError {
+class DotSyntaxError extends SyntaxError {
   constructor(...args) {
     super(...args);
     this.name = "DotSyntaxError";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-graphviz/ast",
-  "version": "2.0.6",
+  "version": "2.0.7-next-f8ba9a89f3ac9e916ded16f0a0618113a5eb4928",
   "description": "Graphviz AST(Abstract Syntax Tree) Utilities",
   "keywords": [],
   "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",