commflow
  • English

      • Manifest API

      commflow@0.0.2 currently exposes a manifest API. The manifest describes the planned communication surface, but it is not a request, SSE, RPC, or socket runtime client.

      Import

      import {
  COMMFLOW_CHANNELS,
  createCommflowManifest
} from 'commflow';

const manifest = createCommflowManifest();

      Exports

      ExportTypeMeaning
      COMMFLOW_CHANNELSreadonly channel arrayThe four planned communication families: request, sse, rpc, and socket.
      createCommflowManifest()functionReturns a fresh manifest object that describes the current package direction.
      defaultfunctionThe same function as createCommflowManifest().
      CommflowChannelTypeScript typeUnion of the channel names in COMMFLOW_CHANNELS.
      CommflowChannelDescriptorTypeScript interfaceField shape for each channel descriptor.
      CommflowManifestTypeScript interfaceField shape for the full manifest object.

      Manifest Fields

      FieldCurrent valueMeaning
      namecommflowPackage identity.
      focusframework-agnosticCore package direction: avoid binding the core to one framework.
      primaryIntegrationvextjsFirst intended integration target.
      plannedReplacementvext/app.fetchPlanned VextJS request path to replace after a real request runtime exists.
      channels['request', 'sse', 'rpc', 'socket']Stable channel names exposed by the manifest.
      descriptorschannel descriptor arrayHuman-readable metadata for each planned communication family.

      Treat the manifest as descriptive metadata. It is useful for documentation, probes, demos, and early integration planning.

      Channel Descriptor Fields

      FieldTypeMeaning
      nameCommflowChannelChannel name.
      streamingbooleanWhether the channel family is expected to involve a stream or long-running message flow.
      bidirectionalbooleanWhether the planned channel can send messages in both directions.
      primaryUsestringA short description of the planned use case.

      Current Descriptor Values

      ChannelstreamingbidirectionalPrimary use
      requestfalsefalseOutbound HTTP request orchestration with timeout, retry, tracing, and proxy hooks.
      ssetruefalseServer-sent event streams for one-way realtime delivery with shared lifecycle control.
      rpctruetrueProcedure-style service-to-service communication with typed contracts and transport adapters.
      sockettruetrueLong-lived duplex channels for event-driven coordination and session-aware message exchange.

      What This API Does Not Do

      commflow@0.0.2 does not yet ship runtime clients. That means there is currently no supported import for:

      • request execution
      • timeout or retry policies
      • proxy selection
      • lifecycle hooks
      • SSE, RPC, or socket adapters

      If you need the planned request runtime, read Request Preview as design direction only. Do not use preview names as production imports until a release note marks them as released.