flowink 0.1.0

package/dist/layout.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Lay out a parsed flow graph on an integer character grid.
+ *
+ * ELK does the global compound graph layout and orthogonal routing.  The
+ * conversion at the end deliberately keeps every edge (including invisible
+ * edges) in the result; the rasterizer decides which strokes to draw.
+ *
+ * @param {FlowGraph} graph
+ * @returns {Promise<LayoutGraph>}
+ */
+export function layout(graph: FlowGraph): Promise<LayoutGraph>;
+export type FlowGraph = import("./types.js").FlowGraph;
+export type LayoutGraph = import("./types.js").LayoutGraph;

package/dist/parse.d.ts

@@ -0,0 +1,3 @@
+/** @param {string} source @returns {import('./types.js').FlowGraph} */
+export function parse(source: string): import("./types.js").FlowGraph;
+export default parse;

package/dist/parser/generated.d.ts

@@ -0,0 +1,3 @@
+export default generatedParser;
+/** @type {any} */
+declare const generatedParser: any;

package/dist/parser/preprocess.d.ts

@@ -0,0 +1,11 @@
+export function preprocess(source: any): {
+    text: any;
+    metadata: {
+        frontmatter: any;
+        title: string;
+        config: any;
+        displayMode: string;
+        directives: any[];
+    };
+    lineOffset: number;
+};

package/dist/parser/semantic.d.ts

@@ -0,0 +1,76 @@
+export function parserError(error: any, source: any): FlowInkError;
+export class FlowSemanticDB {
+    constructor(source: any);
+    source: any;
+    direction: string;
+    vertices: Map<any, any>;
+    edges: any[];
+    classes: Map<any, any>;
+    classTextStyles: Map<any, any>;
+    subGraphs: any[];
+    subGraphLookup: Map<any, any>;
+    tooltips: Map<any, any>;
+    interactions: Map<any, any>;
+    defaultStyles: any[];
+    defaultInterpolate: string;
+    vertexCounter: number;
+    firstGraphFlag: boolean;
+    lex: {
+        firstGraph: () => boolean;
+    };
+    title: string;
+    description: string;
+    firstGraph(): boolean;
+    clear(): void;
+    setDirection(direction: any): void;
+    addVertex(id: any, textObj: any, type: any, styles: any, classes: any, dir: any, props: any, rawShapeData: any): void;
+    addSingleLink(start: any, end: any, type: {}, id: any): void;
+    addLink(starts: any, ends: any, linkData?: {}): void;
+    destructLink(value: any, startValue: any): {
+        type: string;
+        stroke: string;
+        length?: undefined;
+    } | {
+        type: string;
+        stroke: string;
+        length: number;
+    };
+    addSubGraph(idObj: any, list: any, titleObj: any): {
+        styles: any[];
+        classes: any[];
+        metadata: {
+            labelType: any;
+        };
+        direction?: any;
+        id: any;
+        label: string;
+        nodeIds: any[];
+    };
+    addClass(ids: any, styles: any): void;
+    setClass(ids: any, className: any): void;
+    updateLink(positions: any, styles: any): void;
+    updateLinkInterpolate(positions: any, value: any): void;
+    setTooltip(ids: any, tooltip: any): void;
+    setLink(ids: any, link: any, target: any): void;
+    setClickEvent(ids: any, callback: any, args: any): void;
+    setAccTitle(value: any): void;
+    setAccDescription(value: any): void;
+    finalize(): {
+        source: any;
+        direction: string;
+        nodes: any[];
+        edges: any[];
+        subgraphs: any[];
+        classes: any;
+        metadata: {
+            title: string;
+            description: string;
+            accessibilityTitle: string;
+            accessibilityDescription: string;
+            defaultStyle: any[];
+            defaultInterpolate: string;
+            classTextStyles: any;
+        };
+    };
+}
+import { FlowInkError } from '../errors.js';

package/dist/place-labels.d.ts

@@ -0,0 +1,15 @@
+/** @typedef {import('./types.js').LayoutGraph} LayoutGraph */
+/**
+ * Reposition every edge label around its own orthogonal route.
+ *
+ * The input graph is updated in place and returned for convenient piping.
+ * Boxes and routes are never rerouted.  If a label (or supplied geometry)
+ * reaches a negative coordinate, the complete graph is translated and the
+ * advertised canvas is expanded accordingly.
+ *
+ * @param {LayoutGraph} layout
+ * @returns {LayoutGraph}
+ */
+export function placeLabels(layout: LayoutGraph): LayoutGraph;
+export default placeLabels;
+export type LayoutGraph = import("./types.js").LayoutGraph;

package/dist/rasterize.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Turn an integer, orthogonally-routed layout into a terminal drawing.
+ *
+ * The rasterizer deliberately keeps a cell model until the very last step.
+ * This is what lets a wide character reserve its second cell and lets us
+ * detect a route that would otherwise disappear behind a node.
+ *
+ * @param {import('./types.js').LayoutGraph} layout
+ * @param {import('./types.js').RenderOptions} [options]
+ * @returns {string}
+ */
+export function rasterize(layout: import("./types.js").LayoutGraph, options?: import("./types.js").RenderOptions): string;
+/** @param {import('./types.js').LayoutGraph} layout */
+export function validateLayout(layout: import("./types.js").LayoutGraph): {
+    boxes: {
+        shape: string;
+        id: string;
+        kind: "node" | "subgraph";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        lines: string[];
+        parentId?: string;
+    }[];
+    edges: {
+        points: {
+            x: number;
+            y: number;
+        }[];
+        arrowStart: import("./types.js").Arrow;
+        arrowEnd: import("./types.js").Arrow;
+        stroke: string;
+        id: string;
+        label?: {
+            x: number;
+            y: number;
+            lines: string[];
+            width: number;
+            height: number;
+        };
+    }[];
+    labels: any[];
+    width: number;
+    height: number;
+};
+export default rasterize;

package/dist/text.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Return the number of terminal character cells occupied by a string.
+ *
+ * `string-width` counts grapheme clusters and East Asian wide characters,
+ * which is the same unit used by the text rasterizer.  A label can contain
+ * newlines, so this function returns the width of its widest line.
+ *
+ * @param {unknown} value
+ * @returns {number}
+ */
+export function displayWidth(value: unknown): number;
+/**
+ * Convert a Mermaid label to plain, displayable lines. Markdown and HTML are
+ * parsed with marked only; no generated markup is inserted into a DOM or
+ * otherwise executed.
+ *
+ * @param {unknown} label
+ * @param {unknown} [labelType]
+ * @returns {string[]}
+ */
+export function labelLines(label: unknown, labelType?: unknown): string[];
+/**
+ * Prepare a graph node for character-cell layout.
+ *
+ * @param {import('./types.js').FlowNode|Record<string, any>} node
+ * @returns {{lines:string[],shape:string,width:number,height:number,metadata:Record<string, any>,originalShape:string}}
+ */
+export function prepareNode(node?: import("./types.js").FlowNode | Record<string, any>): {
+    lines: string[];
+    shape: string;
+    width: number;
+    height: number;
+    metadata: Record<string, any>;
+    originalShape: string;
+};
+export const SHAPE_ALIASES: Map<string, string>;

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+export type Direction = "TB" | "BT" | "LR" | "RL";
+export type Arrow = "none" | "point" | "circle" | "cross";
+export type FlowNode = {
+    id: string;
+    label: string;
+    labelType: string;
+    shape: string;
+    parentId?: string;
+    styles: string[];
+    classes: string[];
+    metadata: Record<string, any>;
+};
+export type FlowEdge = {
+    id: string;
+    source: string;
+    target: string;
+    label: string;
+    labelType: string;
+    arrowStart: Arrow;
+    arrowEnd: Arrow;
+    stroke: "normal" | "thick" | "dotted" | "invisible";
+    length: number;
+    styles: string[];
+    classes: string[];
+    animate?: boolean;
+    animation?: string;
+    curve?: string;
+    interpolate?: string;
+    isUserDefinedId?: boolean;
+    metadata: Record<string, any>;
+};
+export type FlowSubgraph = {
+    id: string;
+    label: string;
+    nodeIds: string[];
+    parentId?: string;
+    direction?: Direction;
+    styles: string[];
+    classes: string[];
+    metadata: Record<string, any>;
+};
+export type FlowGraph = {
+    source: string;
+    direction: Direction;
+    nodes: FlowNode[];
+    edges: FlowEdge[];
+    subgraphs: FlowSubgraph[];
+    classes: Record<string, string[]>;
+    metadata: Record<string, any>;
+};
+export type RenderOptions = {
+    charset?: "ascii" | "unicode";
+};
+export type Point = {
+    x: number;
+    y: number;
+};
+export type LayoutBox = {
+    id: string;
+    kind: "node" | "subgraph";
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    lines: string[];
+    shape: string;
+    parentId?: string;
+};
+export type LayoutEdge = {
+    id: string;
+    points: Point[];
+    arrowStart: Arrow;
+    arrowEnd: Arrow;
+    stroke: string;
+    label?: {
+        x: number;
+        y: number;
+        lines: string[];
+        width: number;
+        height: number;
+    };
+};
+export type LayoutGraph = {
+    boxes: LayoutBox[];
+    edges: LayoutEdge[];
+    width: number;
+    height: number;
+};

package/examples/basic.mmd

@@ -0,0 +1,4 @@
+flowchart LR
+  A[Start] --> B{Ready?}
+  B -->|yes| C[Work]
+  B -->|no| D[Wait]

package/examples/chinese.mmd

@@ -0,0 +1,2 @@
+flowchart LR
+  A["開始"] -->|確認| B["完成<br/>下一步"]

package/examples/cycle.mmd

@@ -0,0 +1,2 @@
+flowchart TB
+  A[Plan] --> B[Build] --> C[Review] --> A

package/examples/decision.mmd

@@ -0,0 +1,4 @@
+flowchart TB
+  A[Start] --> B{Ready?}
+  B -->|yes| C[Ship]
+  B -->|no| D[Wait]

package/examples/hero.mmd

@@ -0,0 +1,2 @@
+flowchart LR
+  A[Mermaid] --> B[Plain text]

package/examples/subgraph.mmd

@@ -0,0 +1,5 @@
+flowchart TB
+  subgraph Build
+    A[Parse] --> B[Layout]
+  end
+  B --> C[Text]

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "flowink",
+  "version": "0.1.0",
+  "description": "Render Mermaid flowcharts as ASCII and Unicode diagrams in Node.js and browsers",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "examples",
+    "vendor/mermaid",
+    "LICENSE",
+    "NOTICE.md",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "generate": "node scripts/generate-parser.js",
+    "build": "npm run generate && node scripts/build.js",
+    "test": "node --test test/*.test.js",
+    "prepack": "npm run build",
+    "test:browser:build": "npm run build && node scripts/browser-smoke.js",
+    "test:types": "tsc --noEmit --skipLibCheck --module NodeNext --moduleResolution NodeNext --target ES2022 test/types.mts",
+    "test:package": "npm run build && node scripts/package-smoke.js"
+  },
+  "dependencies": {
+    "elkjs": "0.12.0",
+    "entities": "^6.0.1",
+    "js-yaml": "^4.1.0",
+    "marked": "^16.3.0",
+    "string-width": "^7.2.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.0",
+    "jison": "0.4.18",
+    "jsdom": "^26.1.0",
+    "mermaid": "12.0.0",
+    "typescript": "^5.9.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/william1010121/flowink.git"
+  },
+  "homepage": "https://github.com/william1010121/flowink#readme",
+  "bugs": {
+    "url": "https://github.com/william1010121/flowink/issues"
+  },
+  "keywords": [
+    "mermaid",
+    "flowchart",
+    "ascii",
+    "unicode",
+    "diagram",
+    "text"
+  ]
+}

package/vendor/mermaid/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 - 2022 Knut Sveidqvist
+
+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/vendor/mermaid/README.md

@@ -0,0 +1,16 @@
+# Mermaid flowchart provenance
+
+FlowInk vendors the Mermaid flowchart grammar from Mermaid `12.0.0`, commit
+`98a0945418c76238f15df2afaddbba4272656c3b`. The exact upstream grammar is
+`flow.jison`; its SHA-256 is recorded in [provenance.json](./provenance.json).
+
+The accompanying `flowDb.ts` and `flowParser.ts` files are upstream reference
+sources for semantic and parser behavior. FlowInk's pure JavaScript adapter is
+`src/parser/semantic.js`; it retains the parser-facing FlowDB operations while
+omitting Mermaid's DOM and rendering dependencies. Mermaid's MIT license is
+included in `LICENSE`.
+
+Upstream sources:
+
+- https://github.com/mermaid-js/mermaid/tree/98a0945418c76238f15df2afaddbba4272656c3b/packages/mermaid/src/diagrams/flowchart
+- https://github.com/mermaid-js/mermaid/blob/98a0945418c76238f15df2afaddbba4272656c3b/LICENSE