commflow
  • English

      • Current Release Quick Start

      If this is your first time using commflow, start here. This page only shows APIs that exist in commflow@0.0.2.

      Install

      npm install commflow

      Runtime Requirement

      The package runtime is Node.js >=20.0.0.

      The documentation site uses Rspress and has its own build-time Node.js requirement. That requirement does not change the runtime requirement for applications that only install commflow.

      Read The Manifest

      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.

      What The Output Means

      The manifest describes the current project direction, not released runtime clients:

      • request: planned first runtime path for one-shot request/response orchestration.
      • sse: planned one-way streaming delivery.
      • rpc: planned procedure-style communication with typed contracts.
      • socket: planned long-lived duplex messaging.

      primaryIntegration is currently vextjs, which means VextJS is the first intended integration target. plannedReplacement is vext/app.fetch, which identifies the VextJS request path planned for replacement after a real request runtime exists.

      What This Does Not Include Yet

      commflow@0.0.2 does not yet provide a request runtime client. Do not use planned API names as production imports.

      Next Steps