@dskripchenko/flow 0.0.0-stage → 1.0.0

package/package.json

@@ -1,6 +1,124 @@
 {
   "name": "@dskripchenko/flow",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Process and state-machine graphs: a zero-dependency TypeScript core (model, validation, layered layout, monitoring state, polling, undoable editing commands) and Vue components on @dskripchenko/ui — viewer, live monitoring overlay, drill-down and a visual editor",
+  "keywords": [
+    "flow",
+    "state-machine",
+    "workflow",
+    "process",
+    "bpm",
+    "graph",
+    "diagram-editor",
+    "node-editor",
+    "monitoring",
+    "sugiyama",
+    "svg",
+    "vue",
+    "zero-dependency"
+  ],
+  "homepage": "https://github.com/dskripchenko/flow#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dskripchenko/flow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dskripchenko/flow/issues"
+  },
+  "license": "MIT",
+  "author": "Denis Skripchenko (https://github.com/dskripchenko)",
+  "engines": {
+    "node": ">=20"
+  },
+  "packageManager": "pnpm@10.28.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./mermaid": {
+      "types": "./dist/mermaid.d.ts",
+      "import": "./dist/mermaid.mjs",
+      "require": "./dist/mermaid.cjs"
+    },
+    "./vue": {
+      "types": "./dist/vue.d.ts",
+      "import": "./dist/vue.mjs",
+      "require": "./dist/vue.cjs"
+    },
+    "./style.css": "./dist/style.css",
+    "./standalone": "./dist/standalone.js",
+    "./standalone.css": "./dist/standalone.css",
+    "./schema/graph.schema.json": "./schema/graph.schema.json",
+    "./schema/snapshot.schema.json": "./schema/snapshot.schema.json",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": [
+    "*.css",
+    "./dist/standalone.js"
+  ],
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "schema",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc --noEmit -p tsconfig.build.json && vue-tsc --noEmit -p tsconfig.vue.json && vite build && vite build -c vite.standalone.config.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src tests scripts",
+    "typecheck": "tsc --noEmit && vue-tsc --noEmit -p tsconfig.vue.json",
+    "changeset": "changeset",
+    "release": "pnpm build && changeset publish",
+    "check:browser": "node scripts/browser-check.mjs",
+    "dev": "vite --config playground/vite.config.ts",
+    "prepublishOnly": "pnpm build"
+  },
+  "peerDependencies": {
+    "@dskripchenko/diagrams": "^1.1.0",
+    "@dskripchenko/ui": "^1.14.0",
+    "vue": "^3.4.0"
+  },
+  "peerDependenciesMeta": {
+    "@dskripchenko/diagrams": {
+      "optional": true
+    },
+    "@dskripchenko/ui": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@changesets/cli": "^3.0.3",
+    "@dskripchenko/diagrams": "^1.1.0",
+    "@dskripchenko/ui": "^1.14.0",
+    "@eslint/js": "^10.0.1",
+    "@microsoft/api-extractor": "^7.59.4",
+    "@types/node": "^22.20.5",
+    "@vitejs/plugin-vue": "^6.0.10",
+    "@vue/test-utils": "^2.5.1",
+    "eslint": "^10.13.0",
+    "eslint-plugin-vue": "^10.11.1",
+    "jsdom": "^29.1.1",
+    "playwright": "1.64.1",
+    "prettier": "^3.9.10",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.0",
+    "vite": "^8.3.5",
+    "vite-plugin-dts": "^5.1.2",
+    "vitest": "^5.0.5",
+    "vue": "^3.5.44",
+    "vue-tsc": "^3.3.13"
+  }
+}

package/schema/graph.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/@dskripchenko/flow/schema/graph.schema.json",
+  "title": "@dskripchenko/flow model, version 1",
+  "description": "A process or state machine: nodes, edges and groups. Positions are optional (nodes without one are laid out automatically). Ids are unique across nodes, edges and groups.",
+  "type": "object",
+  "required": ["nodes"],
+  "properties": {
+    "version": { "const": 1, "description": "The model format; 1 when missing." },
+    "nodes": { "type": "array", "items": { "$ref": "#/$defs/node" } },
+    "edges": { "type": "array", "items": { "$ref": "#/$defs/edge" }, "default": [] },
+    "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+    "meta": {
+      "type": "object",
+      "properties": {
+        "title": { "type": "string" },
+        "direction": { "enum": ["TB", "LR"], "description": "Auto-layout direction; follows the screen shape when missing." }
+      },
+      "additionalProperties": { "$ref": "#/$defs/value" }
+    }
+  },
+  "$defs": {
+    "id": { "type": "string", "minLength": 1 },
+    "point": {
+      "type": "object",
+      "required": ["x", "y"],
+      "properties": { "x": { "type": "number" }, "y": { "type": "number" } },
+      "description": "The node's centre in graph units."
+    },
+    "value": {
+      "description": "Any JSON value.",
+      "type": ["string", "number", "boolean", "null", "array", "object"]
+    },
+    "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/value" } },
+    "port": {
+      "type": "object",
+      "required": ["id", "side"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "side": { "enum": ["top", "right", "bottom", "left"] },
+        "offset": { "type": "number", "minimum": 0, "maximum": 1, "default": 0.5 },
+        "kind": { "enum": ["in", "out", "both"], "default": "both" },
+        "label": { "type": "string" }
+      }
+    },
+    "node": {
+      "type": "object",
+      "required": ["id"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "type": {
+          "type": "string",
+          "default": "state",
+          "description": "Built in: start, end, state, task, decision, subprocess, note; any other name is a host-registered type."
+        },
+        "label": { "type": "string" },
+        "description": { "type": "string" },
+        "position": { "$ref": "#/$defs/point" },
+        "group": { "$ref": "#/$defs/id" },
+        "data": { "$ref": "#/$defs/data" },
+        "enabled": { "type": "boolean", "default": true },
+        "subgraph": {
+          "description": "An inline graph, or a reference the host resolves (FlowView's `subgraphs` / `loadSubgraph`).",
+          "oneOf": [{ "type": "string" }, { "$ref": "#" }]
+        },
+        "ports": { "type": "array", "items": { "$ref": "#/$defs/port" } }
+      }
+    },
+    "edge": {
+      "type": "object",
+      "required": ["id", "from", "to"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "from": { "$ref": "#/$defs/id" },
+        "to": { "$ref": "#/$defs/id" },
+        "fromPort": { "$ref": "#/$defs/id" },
+        "toPort": { "$ref": "#/$defs/id" },
+        "label": { "type": "string" },
+        "condition": { "type": "string" },
+        "enabled": { "type": "boolean", "default": true },
+        "kind": { "enum": ["transition", "association"], "default": "transition" },
+        "data": { "$ref": "#/$defs/data" }
+      }
+    },
+    "group": {
+      "type": "object",
+      "required": ["id"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "label": { "type": "string" },
+        "parent": { "$ref": "#/$defs/id" }
+      }
+    }
+  }
+}

package/schema/snapshot.schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/@dskripchenko/flow/schema/snapshot.schema.json",
+  "title": "@dskripchenko/flow monitoring snapshot",
+  "description": "What a monitoring endpoint returns for the graph on screen. Every field is optional; ids refer to the graph's nodes and edges.",
+  "type": "object",
+  "properties": {
+    "nodes": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "status": { "type": "string", "description": "active, done, error, waiting, skipped, or a host status (drawn neutral unless mapped by statusTones)." },
+          "count": { "type": "number", "description": "Instances in or through the node." },
+          "badge": { "type": ["string", "number"], "description": "A short corner badge, e.g. an error count." },
+          "message": { "type": "string", "description": "Shown in the details panel." },
+          "updatedAt": { "type": ["string", "number"], "description": "ISO 8601 or epoch milliseconds." }
+        }
+      }
+    },
+    "edges": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "count": { "type": "number" },
+          "traversed": { "type": "boolean" }
+        }
+      }
+    },
+    "path": { "type": "array", "items": { "type": "string" }, "description": "The current instance's node ids in visiting order." },
+    "current": { "type": "array", "items": { "type": "string" }, "description": "Nodes the current instance is in now." },
+    "updatedAt": { "type": ["string", "number"], "description": "When the host produced the snapshot." }
+  }
+}