@synergenius/flow-weaver 0.27.0 → 0.27.3

package/README.md

@@ -6,14 +6,61 @@
 [![Tests](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/moraispgsi/305430ef59a51d0a58eb61fefdfbe634/raw/flow-weaver-test-count.json&style=flat)](https://github.com/synergenius-fw/flow-weaver/actions/workflows/ci.yml)
 [![Coverage](https://img.shields.io/codecov/c/github/synergenius-fw/flow-weaver?style=flat)](https://codecov.io/gh/synergenius-fw/flow-weaver)
 [![License: Flow Weaver Library License](https://img.shields.io/badge/License-Flow%20Weaver%20Library-blue?style=flat)](./LICENSE)
-[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18-green?style=flat)](https://nodejs.org)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D22-green?style=flat)](https://nodejs.org)
 
 **Design agent workflows in conversation. The compiled output is yours.**
 
-[**flowweaver.ai**](https://flowweaver.ai) · [**Studio**](https://flowweaver.ai/studio) · [**Docs**](https://flowweaver.ai/docs) · [**Discord**](https://discord.gg/6Byh3ur2bk) · [**npm**](https://www.npmjs.com/package/@synergenius/flow-weaver)
+[**flowweaver.ai**](https://flowweaver.ai) · [**Studio**](https://flowweaver.ai/studio) · [**Features**](https://flowweaver.ai/features) · [**Discord**](https://discord.gg/6Byh3ur2bk) · [**npm**](https://www.npmjs.com/package/@synergenius/flow-weaver)
 
 ---
 
+Flow Weaver is a TypeScript workflow compiler. Define workflows with JSDoc annotations in your existing codebase, compile to standalone TypeScript functions with zero runtime dependencies, and deploy to any serverless target. The compiled output has no dependency on Flow Weaver. You own it.
+
+Build AI agent workflows, data pipelines, or automation scripts through natural language using MCP tools in Claude Code, Cursor, Windsurf, VS Code, JetBrains, Codex, or any MCP-compatible editor. Or write them by hand with annotations the same way you write JSDoc today.
+
+## Project Status
+
+Flow Weaver is in **active alpha**. The compiler, validator, CLI, and MCP tools are stable and thoroughly tested. The test suite covers thousands of cases across parsing, compilation, validation, diffing, and deployment. CI runs on every commit.
+
+This started as a curiosity by [Ricardo Morais](https://linkedin.com/in/moraispgsi) into why visual programming never took off and whether code-first and visual editing could actually coexist. It has grown into something real. It is actively maintained, with releases shipping regularly. If you run into issues or have questions, the [Discord](https://discord.gg/6Byh3ur2bk) is the best place to reach out. Every issue and question gets a response, usually within a day.
+
+**Flow Weaver Studio**, the browser-based visual IDE, is the next major milestone and is being actively built. Core editing (canvas, terminal, diagnostics) is live today. The visual debugger, AI chat assistant, version history, and deployment dashboard are in progress. You can follow development on Discord or in the [GitHub releases](https://github.com/synergenius-fw/flow-weaver/releases).
+
+Breaking changes may occur between minor versions during alpha. Pin your version in `package.json` if stability matters for your project.
+
+## Capabilities
+
+**Annotation-driven workflows:** Define node graphs directly in TypeScript using JSDoc annotations. No YAML, no JSON configs, no separate workflow files. Your workflows live in `.ts` files, version-controlled alongside your code.
+
+**Zero-dependency compiled output:** The compiler generates a self-contained TypeScript function. No runtime to install in production, no SDK to import, no vendor lock-in. Delete the package after compiling and the output still runs.
+
+**AI-native editing:** MCP tools expose the full compiler, validator, debugger, and diagram surface to any MCP-compatible editor. Scaffold a project, add nodes, wire connections, validate, compile, run, and diff through conversation.
+
+**Structural validation:** Type checking across port connections, graph topology analysis, agent safety rules, and breaking change detection. Runs in CI, on every save, or on demand. Errors include source locations, fix suggestions, and documentation links.
+
+**Step-through debugging:** Set breakpoints on nodes, step through execution node by node, inspect variables mid-run, and resume from checkpoints. Variable injection available through MCP tools.
+
+**Semantic diffing:** Compare workflow versions at the graph level instead of text diffs. Impact analysis categorizes every change as critical, breaking, minor, or cosmetic. Know exactly what changed and whether it matters.
+
+**Deploy anywhere:** Export to Inngest, AWS Lambda, Vercel, Cloudflare Workers, GitHub Actions, or GitLab CI. Or serve workflows over HTTP with built-in framework adapters for Next.js, Express, Hono, Fastify, and Remix.
+
+**Extensible pack system:** Node types, deploy targets, CLI commands, and MCP tools are contributed by npm packages. Install community packs or build and publish your own.
+
+## Quick Start
+
+```bash
+npm install @synergenius/flow-weaver
+npx flow-weaver init my-agent
+npx flow-weaver compile my-agent.ts
+npx flow-weaver run my-agent.ts
+```
+
+The CLI scaffolds a project, compiles annotations into a runnable workflow, and executes it. Run `fw --help` for the full command reference. The example below shows a more complete workflow built through conversation.
+
+## See It in Action
+
+The conversation below shows [Weaver](https://github.com/synergenius-fw/flow-weaver-pack-weaver), an optional AI bot that drives Flow Weaver through natural language. It handles scaffolding, modification, validation, compilation, execution, and deployment. Install it with `fw market install @synergenius/flow-weaver-pack-weaver`, or use the MCP tools directly from your editor without Weaver.
+
 > **You:** Build a support agent that classifies messages and either auto-replies or escalates.
 
 > **Weaver:** Created `support-agent.ts`. Four nodes, one workflow.
@@ -101,19 +148,156 @@
 > fw export support-agent.ts --target inngest
 > ```
 
----
+## How Workflows Are Defined
+
+Workflows are TypeScript functions annotated with JSDoc. You write plain functions for each node, and the annotations describe how they connect.
+
+The function signature is the source of truth. Input parameters become input ports, return object fields become output ports. Every function has an `execute` boolean that controls whether it runs or passes through, and returns `onSuccess`/`onFailure` for branching. Expression nodes (marked with `@expression`) skip the execute/branching pattern and map return fields directly to outputs.
+
+The `@flowWeaver workflow` block wires node instances together. `@node` creates an instance of a node type, `@connect` wires ports between nodes, and `@path` is shorthand for a linear route. `Start` and `Exit` are virtual nodes representing the workflow's inputs and outputs.
 
-## Install
+The compiler reads these annotations, builds the execution graph, and generates the body in place between markers. Everything outside the markers stays untouched. Node type functions are never modified.
+
+```typescript
+/**
+ * @flowWeaver nodeType
+ * @expression
+ * @input message - The support message
+ * @output context - Classified context
+ */
+function classifyIntent(message: string): { context: SupportContext } {
+  const intent = /refund|cancel/i.test(message) ? 'billing' : 'general';
+  return { context: { message, intent, priority: 'normal' } };
+}
+
+// routeAction, llmReply, and escalate are defined the same way:
+// plain functions with @flowWeaver nodeType annotations.
+
+/**
+ * @flowWeaver workflow
+ * @node classify classifyIntent
+ * @node route routeAction
+ * @node reply llmReply
+ * @node esc escalate
+ * @path Start -> classify -> route -> reply -> Exit
+ * @path route:fail -> esc -> Exit
+ * @connect Start.message -> classify.message
+ * @connect classify.context -> route.context
+ * @param message - The support message
+ * @returns reply - Generated reply
+ * @returns ticket - Escalation ticket
+ */
+export async function supportAgent(
+  execute: boolean,
+  params: { message: string },
+): Promise<{
+  onSuccess: boolean;
+  onFailure: boolean;
+  reply: string | null;
+  ticket: string | null;
+}> {
+  // @flow-weaver-body-start
+  // Generated by the compiler. Do not edit.
+  // @flow-weaver-body-end
+}
+```
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `fw init` | Scaffold a new project with presets and templates |
+| `fw compile` | Compile workflow files to standalone TypeScript |
+| `fw validate` | Validate workflows without compiling |
+| `fw run` | Execute a workflow with optional debug mode |
+| `fw watch` | Recompile on file changes |
+| `fw dev` | Watch + compile + run loop |
+| `fw describe` | Output workflow structure as JSON, text, Mermaid, ASCII, or paths |
+| `fw diagram` | Generate SVG, HTML, or ASCII diagrams |
+| `fw diff` | Semantic diff between two workflow versions |
+| `fw export` | Export to a deploy target (Inngest, Lambda, Vercel, Cloudflare, etc.) |
+| `fw serve` | Start an HTTP server exposing workflows as endpoints |
+| `fw modify` | Programmatic graph mutations (addNode, removeNode, connect, etc.) |
+| `fw mcp-server` | Start the MCP server for AI editor integration |
+| `fw mcp-setup` | Auto-configure MCP for Claude, Cursor, VS Code, Windsurf, or Codex |
+| `fw docs` | Browse bundled reference documentation |
+
+Run `fw --help` or `fw <command> --help` for full options.
+
+## Flow Weaver Studio (Early Beta)
+
+A browser-based visual IDE for building workflows. Canvas editor, integrated terminal, real-time diagnostics, and the full CLI available in the cloud.
+
+Studio is in early beta. Core editing is live. The visual debugger, AI chat assistant, version history, and deployment dashboard are being actively developed and will ship incrementally. The cloud platform is not yet production-ready, and paid plans are not available yet. Use it to explore and experiment, but expect rough edges.
+
+[Open Studio](https://flowweaver.ai/studio) · [Learn more](https://flowweaver.ai/features)
+
+## Weaver (Experimental)
+
+Weaver is an optional AI bot that automates the full workflow lifecycle. Give it a task in natural language and it plans, scaffolds, compiles, validates, and fixes issues in a loop until the workflow is correct. It connects to Anthropic, Claude CLI, or GitHub Copilot CLI.
+
+- `weaver bot "create a greeting workflow"` handles a task end-to-end with plan approval
+- `weaver run workflow.ts` executes a workflow with an AI agent channel attached
+- `weaver session` polls a task queue continuously for automated pipelines
+- `weaver swarm start` runs multiple bot instances in parallel, with an orchestrator dispatching tasks across them
+
+Weaver is itself built as a set of Flow Weaver workflows. Run `weaver eject` to get a local copy you can customize.
 
 ```bash
-npm install @synergenius/flow-weaver
-npx flow-weaver init
+fw market install @synergenius/flow-weaver-pack-weaver
 ```
 
-The CLI handles the rest.
+> **Weaver is experimental.** The bot, session, and swarm modes work and are being used internally, but the APIs and behavior may change between releases. Weaver is not required to use Flow Weaver. The compiler, CLI, and MCP tools are the stable foundation and work independently.
 
----
+## Documentation
+
+Reference documentation is bundled with the CLI. Run `fw docs` to browse topics, or `fw docs <topic>` to read a specific one:
+
+```bash
+fw docs list                    # List all topics
+fw docs tutorial                # Step-by-step first workflow guide
+fw docs concepts                # Core concepts
+fw docs jsdoc-grammar           # Annotation syntax reference
+fw docs cli-reference           # Full CLI command reference
+fw docs search <query>          # Search across all docs
+```
+
+**Online resources:**
+
+- [Features](https://flowweaver.ai/features)
+- [Compare with Alternatives](https://flowweaver.ai/compare)
+- [License](https://flowweaver.ai/license)
+
+## Community
+
+Flow Weaver is built and maintained by a solo developer. If you try it, find a bug, or just want to talk about workflows, the [Discord](https://discord.gg/6Byh3ur2bk) is open. Every message gets read and responded to, usually within a day.
+
+If something breaks, [open an issue](https://github.com/synergenius-fw/flow-weaver/issues). Bug reports with reproduction steps get prioritized. Feature requests are welcome too.
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
 
 ## License
 
-Licensed under the [Flow Weaver License](https://flowweaver.ai/license). See [LICENSE.md](./LICENSE.md).
+Licensed under the [Flow Weaver Library License](https://flowweaver.ai/license). See [LICENSE](./LICENSE).
+
+The license is designed to be generous for the vast majority of users while protecting the project's IP. Here is what it means in practice:
+
+**Use freely:**
+- Install, compile, validate, run, and deploy workflows in any project
+- All compiled output is fully yours with no restrictions or attribution required
+- Use in CI/CD pipelines and build systems
+- Host internally for organizations with 15 or fewer people
+- Include as a dependency in larger products where Flow Weaver is not the primary value
+
+**Requires a commercial license:**
+- Internal hosting for organizations with more than 15 people
+- Building a hosted or standalone workflow authoring product
+- Offering Flow Weaver capabilities as a managed service to third parties
+
+**Never permitted:**
+- Using source code, tests, documentation, or outputs as AI/ML training data to replicate the functionality
+- Extracting specifications to build competing software
+
+If you are unsure whether your use case needs a commercial license, reach out at support@synergenius.pt. The answer is probably "you're fine."

package/dist/cli/flow-weaver.mjs

@@ -5987,7 +5987,7 @@ var VERSION;
 var init_generated_version = __esm({
   "src/generated-version.ts"() {
     "use strict";
-    VERSION = "0.27.0";
+    VERSION = "0.27.3";
   }
 });
 
@@ -88468,7 +88468,7 @@ function parseIntStrict(value) {
 // src/cli/index.ts
 init_logger();
 init_error_utils();
-var version2 = true ? "0.27.0" : "0.0.0-dev";
+var version2 = true ? "0.27.3" : "0.0.0-dev";
 var program2 = new Command();
 program2.name("fw").description("Flow Weaver Annotations - Compile and validate workflow files").option("-v, --version", "Output the current version").option("--no-color", "Disable colors").option("--color", "Force colors").on("option:version", () => {
   logger.banner(version2);

package/dist/generated-version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.27.0";
+export declare const VERSION = "0.27.3";
 //# sourceMappingURL=generated-version.d.ts.map

package/dist/generated-version.js

@@ -1,3 +1,3 @@
 // Auto-generated by scripts/generate-version.ts — do not edit manually
-export const VERSION = '0.27.0';
+export const VERSION = '0.27.3';
 //# sourceMappingURL=generated-version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synergenius/flow-weaver",
-  "version": "0.27.0",
+  "version": "0.27.3",
   "description": "Deterministic workflow compiler for AI agents. Compiles to standalone TypeScript, no runtime dependencies.",
   "private": false,
   "type": "module",
@@ -149,6 +149,8 @@
   ],
   "author": "Ricardo José Horta Morais",
   "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://flowweaver.ai",
+  "bugs": "https://github.com/synergenius-fw/flow-weaver/issues",
   "repository": {
     "type": "git",
     "url": "https://github.com/synergenius-fw/flow-weaver.git"