Hyperflow Microservice Base

Shared TypeScript base class and contracts for Hyperflow microservices running on Cloudflare Workers.

Install

npm install hyperflow-microservice

Usage

import { BaseService, MicroserviceRole, WebflowWebhookEnvelope } from "hyperflow-microservice";
import { Env } from "./globals";
import { MODULE } from "./version";

export default class HyperflowLLMS extends BaseService<Env> {
  name = MODULE.name;
  version = MODULE.version;
  roles: MicroserviceRole[] = ["path"];

  async handles(req: Request) {
    const { pathname } = new URL(req.url);
    return pathname === "/llms.txt";
  }

  async fetch(req: Request) {
    // ...handle request
    return new Response("ok");
  }
}

Optional webhook role:

async handlesWebhook(envelope: WebflowWebhookEnvelope) {
  return envelope.eventType === "form_submission";
}

Contract highlights

• Roles: path, rewrite, webhook (implement only what you need).
• Standard headers for internal calls: X-HF-App, X-HF-Request-Id, X-HF-Phase, X-HF-Webhook (hint).
• Helpers: request-id stamping, isHandled, isServerError, withTimeout, and cloneWithHeaders.