commflow

Framework-agnostic communication orchestration for Node.js request, SSE, RPC, and socket flows, designed with VextJS-first integration in mind.

Choose Your Path

• Use the published package: follow the Current Version Quick Start for APIs available in [email protected].
• Explore the complete communication model: open the User Guide or 中文用户手册 for request, SSE, RPC, socket, configuration, reliability, and VextJS adoption.

The current npm release exposes the manifest API. The user guide documents the complete commflow contract separately so current availability and the full product model are never mixed.

Install

npm install commflow

Current Version Quick Check

The code below verifies the current published package only. It is not the final request / SSE / RPC / socket usage path.

Create quick-start.mjs:

import {
  COMMFLOW_CHANNELS,
  createCommflowManifest
} from 'commflow';

const manifest = createCommflowManifest();

console.log(JSON.stringify({
  channels: COMMFLOW_CHANNELS,
  primaryIntegration: manifest.primaryIntegration,
  plannedReplacement: manifest.plannedReplacement,
  descriptors: manifest.descriptors.map((item) => ({
    name: item.name,
    streaming: item.streaming,
    bidirectional: item.bidirectional
  }))
}, null, 2));

Run it:

node quick-start.mjs

Expected output:

{
  "channels": [
    "request",
    "sse",
    "rpc",
    "socket"
  ],
  "primaryIntegration": "vextjs",
  "plannedReplacement": "vext/app.fetch",
  "descriptors": [
    {
      "name": "request",
      "streaming": false,
      "bidirectional": false
    },
    {
      "name": "sse",
      "streaming": true,
      "bidirectional": false
    },
    {
      "name": "rpc",
      "streaming": true,
      "bidirectional": true
    },
    {
      "name": "socket",
      "streaming": true,
      "bidirectional": true
    }
  ]
}

If you see this output, the package is installed correctly and the released manifest API is working.

Complete User Guide

• Documentation site: devcodex-labs.github.io/commflow
• User guide: English / 中文
• Feature overview: English / 中文
• Request: English / 中文
• SSE: English / 中文
• RPC: English / 中文
• Socket: English / 中文
• Configuration: English / 中文
• Errors and retries: English / 中文
• Documentation map: English / 中文
• Manifest API reference: English / 中文
• Troubleshooting: English / 中文

The guide is split by user task rather than project internals. Current release details live under Current Version 0.0.1; unsettled API sketches live under Design Preview.

Current Status

[email protected] is a published skeleton package. It currently exposes a manifest API that describes the planned communication surface. Runtime clients for request, SSE, RPC, and socket flows are not released yet.

Runtime Boundary

• Package runtime: Node.js >=20.0.0
• Documentation site build runtime: Node.js >=20.19.0 || >=22.12.0
• Current released API: COMMFLOW_CHANNELS, createCommflowManifest(), and related manifest types
• Complete user contract: request, SSE, RPC, socket, shared configuration, reliability, and VextJS adoption
• Design preview: unsettled request API sketches that are not production imports

Troubleshooting

• There is no request client export in [email protected]; this is expected.
• No runtime configuration is required yet because runtime clients have not shipped.
• If ESM import fails, use a .mjs file or set "type": "module" in your application package.
• Package users only need Node.js >=20.0.0.