Failpath SDK: Instrument Your Backend in TypeScript

import { createTypedFailpathClient, failpathFlows } from "../.failpath/sdk";

// Create a single client instance for your project
const failpath = createTypedFailpathClient({
  projectKey: process.env.FAILPATH_PROJECT_KEY!,
  defaultMetadata: { env: "production" },
});

export async function handleCheckout(requestId: string) {
  // Start a run — reuse one runId for every step in the same request
  const run = failpath.run(failpathFlows.checkout.slug, {
    runId: requestId,
    metadata: { route: "/checkout" },
  });

  // Wrap each business operation with step()
  const cart = await run.step(failpathFlows.checkout.steps.validateCart, async () => {
    return validateCart();
  });

  await run.step(failpathFlows.checkout.steps.chargeCard, async () => {
    return chargeCard(cart);
  });

  // Explicitly skip an optional step
  await run.skip(failpathFlows.checkout.steps.sendReceiptEmail);

  // Drain queued telemetry before the request or process ends
  await failpath.flush();
}