flowchart.ts - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

dist/flowchart.d.ts

@@ -1,3 +0,55 @@
-import { RaphaelElement, RaphaelSet, RaphaelPath, RaphaelPaper } from 'raphael';
+import { RaphaelElement, RaphaelPath, RaphaelSet, RaphaelPaper } from 'raphael';
 
+interface Position {
+    x: number;
+    y: number;
+}
+
+declare class FlowChartSymbol {
+    chart: FlowChart;
+    text: RaphaelElement<"SVG" | "VML", Element | SVGTextElement>;
+    params: Record<string, string>;
+    connectedTo: FlowChartSymbol[];
+    leftLines: RaphaelPath<"SVG" | "VML">[];
+    rightLines: RaphaelPath<"SVG" | "VML">[];
+    topLines: RaphaelPath<"SVG" | "VML">[];
+    bottomLines: RaphaelPath<"SVG" | "VML">[];
+    group: RaphaelSet<"SVG" | "VML">;
+    symbol?: RaphaelElement<"SVG" | "VML", Element | SVGRectElement>;
+    symbolType?: SymbolType;
+    flowstate: string;
+    key: string;
+    lineStyle: Record<string, any>;
+    bottomStart?: boolean;
+    next?: FlowChartSymbol;
+    next_direction: Direction | undefined;
+    isPositioned?: boolean;
+    width: number;
+    height: number;
+    topStart?: boolean;
+    topEnd?: boolean;
+    rightStart?: boolean;
+    leftStart?: boolean;
+    leftEnd?: boolean;
+    rightEnd?: boolean;
+    pathOk?: boolean;
+    constructor(chart: FlowChart, options: Partial<SymbolOptions>, symbol?: RaphaelElement<"SVG" | "VML", Element | SVGRectElement>);
+    getAttr<T>(attName: string): T | undefined;
+    initialize(): void;
+    getCenter(): Position;
+    getX(): number;
+    getY(): number;
+    shiftX(x: number): void;
+    setX(x: number): void;
+    shiftY(y: number): void;
+    setY(y: number): void;
+    getTop(): Position;
+    getBottom(): Position;
+    getLeft(): Position;
+    getRight(): Position;
+    render(): void;
+    renderLines(): void;
+    drawLineTo(symbol: FlowChartSymbol, text: string, direction?: Direction): void;
+}
+
 type SymbolType = "start" | "end" | "operation" | "inputoutput" | "subroutine" | "condition" | "parallel";
@@ -26,2 +78,4 @@ interface SVGOptions {
 interface DrawOptions extends Partial<SVGOptions> {
+    width?: number;
+    height?: number;
     /** Symbol Styles */
@@ -33,2 +87,4 @@ symbols?: Record<string, Partial<SVGOptions>>;
 interface ParsedDrawOptions extends Partial<SVGOptions> {
+    width?: number;
+    height?: number;
     /** Stymbol Styles */
@@ -59,52 +115,2 @@ symbols: Record<string, Partial<SVGOptions>>;
 
-interface Position {
-    x: number;
-    y: number;
-}
-declare class FlowChartSymbol {
-    chart: FlowChart;
-    text: RaphaelElement<"SVG" | "VML", Element | SVGTextElement>;
-    connectedTo: FlowChartSymbol[];
-    group: RaphaelSet<"SVG" | "VML">;
-    symbol?: RaphaelElement<"SVG" | "VML", Element | SVGRectElement>;
-    symbolType?: SymbolType;
-    flowstate: string;
-    key: string;
-    lineStyle: Record<string, any>;
-    leftLines: RaphaelPath<"SVG" | "VML">[];
-    rightLines: RaphaelPath<"SVG" | "VML">[];
-    topLines: RaphaelPath<"SVG" | "VML">[];
-    bottomLines: RaphaelPath<"SVG" | "VML">[];
-    bottomStart?: boolean;
-    next?: FlowChartSymbol;
-    next_direction: Direction | undefined;
-    isPositioned?: boolean;
-    width: number;
-    height: number;
-    topStart?: boolean;
-    topEnd?: boolean;
-    rightStart?: boolean;
-    leftStart?: boolean;
-    leftEnd?: boolean;
-    rightEnd?: boolean;
-    pathOk?: boolean;
-    constructor(chart: FlowChart, options: Partial<SymbolOptions>, symbol?: RaphaelElement<"SVG" | "VML", Element | SVGRectElement>);
-    getAttr<T>(attName: string): T | undefined;
-    initialize(): void;
-    getCenter(): Position;
-    getX(): number;
-    getY(): number;
-    shiftX(x: number): void;
-    setX(x: number): void;
-    shiftY(y: number): void;
-    setY(y: number): void;
-    getTop(): Position;
-    getBottom(): Position;
-    getLeft(): Position;
-    getRight(): Position;
-    render(): void;
-    renderLines(): void;
-    drawLineTo(symbol: FlowChartSymbol, text: string, direction?: Direction): void;
-}
-
 declare class FlowChart {
@@ -118,3 +124,3 @@ options: ParsedDrawOptions;
     maxXFromLine: number;
-    constructor(container: string | HTMLElement, options: ParsedDrawOptions);
+    constructor(container: string | HTMLElement, options?: ParsedDrawOptions);
     handle(symbol: FlowChartSymbol): FlowChartSymbol;
@@ -121,0 +127,0 @@ startWith(symbol: FlowChartSymbol): FlowChartSymbol;

package.json

 {
   "name": "flowchart.ts",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "author": "Mister-Hope",
@@ -38,18 +38,19 @@ "description": "Flowchart support",
     "@rollup/plugin-node-resolve": "15.0.2",
-    "@types/node": "18.16.2",
-    "@typescript-eslint/eslint-plugin": "5.59.1",
-    "@typescript-eslint/parser": "5.59.1",
+    "@types/node": "20.1.2",
+    "@typescript-eslint/eslint-plugin": "5.59.5",
+    "@typescript-eslint/parser": "5.59.5",
     "esbuild": "0.17.18",
-    "eslint": "8.39.0",
+    "eslint": "8.40.0",
     "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
     "prettier": "2.8.8",
     "rimraf": "5.0.0",
-    "rollup": "3.21.0",
+    "rollup": "3.21.6",
     "rollup-plugin-dts": "5.3.0",
     "rollup-plugin-esbuild": "5.0.0",
     "typescript": "5.0.4",
-    "vite": "4.3.3"
+    "vite": "4.3.5"
   },
-  "packageManager": "pnpm@8.3.1",
+  "packageManager": "pnpm@8.5.0",
   "scripts": {
@@ -59,6 +60,6 @@ "build": "rollup -c rollup.config.ts --configPlugin esbuild",
     "dev": "vite dev",
-    "lint": "prettier --check --write . && eslint . --ext .ts,.js --fix",
-    "lint:check": "prettier --check . && eslint . --ext .ts,.js",
+    "lint": "prettier --check --write . && eslint . --ext .ts --fix",
+    "lint:check": "prettier --check . && eslint . --ext .ts",
     "prepublish": "pnpm clean && pnpm build"
   }
 }

README.md

@@ -1,7 +0,5 @@
-[![JS.ORG](https://img.shields.io/badge/js.org-flowchart-ffb400.svg?style=flat-square)](http://js.org)
+# flowchart.ts
 
-# [flowchart.js](http://flowchart.js.org)
+flowchart.ts is modern version of flowchart.js, a flowchart DSL and SVG render that runs in the browser.
 
-flowchart.js is a flowchart DSL and SVG render that runs in the browser and [terminal](https://github.com/francoislaberge/diagrams/#flowchart).
-
 Nodes and connections are defined separately so that nodes can be reused and connections can be quickly changed.
@@ -31,14 +29,2 @@ Fine grain changes to node and connection style can also be made right in the DSL.
 
-## CLI
-
-See [francoislaberge/diagrams](https://github.com/francoislaberge/diagrams/#flowchart) on how to flowchart.js in the terminal.
-
-## Browser Usage
-
-flowchart.js is on [CDNJS](https://cdnjs.com/libraries/flowchart), feel free to use it.
-
-You will also need [Raphaël](http://www.raphaeljs.com/), which is also on [CDNJS](https://cdnjs.cloudflare.com/ajax/libs/raphael/2.3.0/raphael.min.js).
-
-The demo html page is at [example/index.html](example/index.html).
-
 ## Node Syntax
@@ -271,9 +257,1 @@
 </details>
-
-## Contributors
-
-via [GitHub](https://github.com/adrai/flowchart.js/graphs/contributors)
-
-## Thanks
-
-Many thanks to [js-sequence-diagrams](http://bramp.github.io/js-sequence-diagrams/) which greatly inspired this project, and forms the basis for the syntax.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1099500

increased by0.32%

Lines of code

1578

increased by0.51%

Worsened metrics

Dev dependency count

17

increased by6.25%

Number of lines in readme file

256

decreased by-7.91%

No dependency changes