@effect/workflow 0.1.1 → 0.1.3

package/dist/esm/WorkflowProxyServer.js

@@ -0,0 +1,52 @@
+import * as HttpApiBuilder from "@effect/platform/HttpApiBuilder";
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+/**
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layerHttpApi = (api, name, workflows) => HttpApiBuilder.group(api, name, Effect.fnUntraced(function* (handlers_) {
+  let handlers = handlers_;
+  for (const workflow_ of workflows) {
+    const workflow = workflow_;
+    handlers = handlers.handle(workflow.name, ({
+      payload
+    }) => workflow.execute(payload)).handle(workflow.name + "Discard", ({
+      payload
+    }) => workflow.execute(payload, {
+      discard: true
+    }));
+  }
+  return handlers;
+}));
+/**
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layerRpcHandlers = (workflows, options) => Layer.effectContext(Effect.gen(function* () {
+  const context = yield* Effect.context();
+  const prefix = options?.prefix ?? "";
+  const handlers = new Map();
+  for (const workflow_ of workflows) {
+    const workflow = workflow_;
+    const tag = `${prefix}${workflow.name}`;
+    const tagDiscard = `${tag}Discard`;
+    const key = `@effect/rpc/Rpc/${tag}`;
+    const keyDiscard = `${key}Discard`;
+    handlers.set(key, {
+      context,
+      tag,
+      handler: payload => workflow.execute(payload)
+    });
+    handlers.set(keyDiscard, {
+      context,
+      tag: tagDiscard,
+      handler: payload => workflow.execute(payload, {
+        discard: true
+      })
+    });
+  }
+  return Context.unsafeMake(handlers);
+}));
+//# sourceMappingURL=WorkflowProxyServer.js.map

package/dist/esm/WorkflowProxyServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkflowProxyServer.js","names":["HttpApiBuilder","Context","Effect","Layer","layerHttpApi","api","name","workflows","group","fnUntraced","handlers_","handlers","workflow_","workflow","handle","payload","execute","discard","layerRpcHandlers","options","effectContext","gen","context","prefix","Map","tag","tagDiscard","key","keyDiscard","set","handler","unsafeMake"],"sources":["../../src/WorkflowProxyServer.ts"],"sourcesContent":[null],"mappings":"AAIA,OAAO,KAAKA,cAAc,MAAM,iCAAiC;AAIjE,OAAO,KAAKC,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AAIrC;;;;AAIA,OAAO,MAAMC,YAAY,GAAGA,CAQ1BC,GAA+C,EAC/CC,IAAU,EACVC,SAAoB,KAMpBP,cAAc,CAACQ,KAAK,CAClBH,GAAG,EACHC,IAAI,EACJJ,MAAM,CAACO,UAAU,CAAC,WAAUC,SAAS;EACnC,IAAIC,QAAQ,GAAGD,SAAgB;EAC/B,KAAK,MAAME,SAAS,IAAIL,SAAS,EAAE;IACjC,MAAMM,QAAQ,GAAGD,SAAqD;IACtED,QAAQ,GAAGA,QAAQ,CAChBG,MAAM,CACLD,QAAQ,CAACP,IAAW,EACpB,CAAC;MAAES;IAAO,CAAoB,KAAKF,QAAQ,CAACG,OAAO,CAACD,OAAO,CAAC,CAC7D,CACAD,MAAM,CACLD,QAAQ,CAACP,IAAI,GAAG,SAAgB,EAChC,CAAC;MAAES;IAAO,CAAoB,KAAKF,QAAQ,CAACG,OAAO,CAACD,OAAO,EAAE;MAAEE,OAAO,EAAE;IAAI,CAAS,CAAC,CACvF;EACL;EACA,OAAON,QAAwD;AACjE,CAAC,CAAC,CACH;AAEH;;;;AAIA,OAAO,MAAMO,gBAAgB,GAAGA,CAG9BX,SAAoB,EAAEY,OAEvB,KAKChB,KAAK,CAACiB,aAAa,CAAClB,MAAM,CAACmB,GAAG,CAAC,aAAS;EACtC,MAAMC,OAAO,GAAG,OAAOpB,MAAM,CAACoB,OAAO,EAAS;EAC9C,MAAMC,MAAM,GAAGJ,OAAO,EAAEI,MAAM,IAAI,EAAE;EACpC,MAAMZ,QAAQ,GAAG,IAAIa,GAAG,EAA+B;EACvD,KAAK,MAAMZ,SAAS,IAAIL,SAAS,EAAE;IACjC,MAAMM,QAAQ,GAAGD,SAAqD;IACtE,MAAMa,GAAG,GAAG,GAAGF,MAAM,GAAGV,QAAQ,CAACP,IAAI,EAAE;IACvC,MAAMoB,UAAU,GAAG,GAAGD,GAAG,SAAS;IAClC,MAAME,GAAG,GAAG,mBAAmBF,GAAG,EAAE;IACpC,MAAMG,UAAU,GAAG,GAAGD,GAAG,SAAS;IAClChB,QAAQ,CAACkB,GAAG,CAACF,GAAG,EAAE;MAChBL,OAAO;MACPG,GAAG;MACHK,OAAO,EAAGf,OAAY,IAAKF,QAAQ,CAACG,OAAO,CAACD,OAAO;KAC7C,CAAC;IACTJ,QAAQ,CAACkB,GAAG,CAACD,UAAU,EAAE;MACvBN,OAAO;MACPG,GAAG,EAAEC,UAAU;MACfI,OAAO,EAAGf,OAAY,IAAKF,QAAQ,CAACG,OAAO,CAACD,OAAO,EAAE;QAAEE,OAAO,EAAE;MAAI,CAAS;KACvE,CAAC;EACX;EACA,OAAOhB,OAAO,CAAC8B,UAAU,CAACpB,QAAQ,CAAC;AACrC,CAAC,CAAC,CAAC","ignoreList":[]}

package/dist/esm/index.js

@@ -18,4 +18,12 @@ export * as Workflow from "./Workflow.js";
  * @since 1.0.0
  */
 export * as WorkflowEngine from "./WorkflowEngine.js";
+/**
+ * @since 1.0.0
+ */
+export * as WorkflowProxy from "./WorkflowProxy.js";
+/**
+ * @since 1.0.0
+ */
+export * as WorkflowProxyServer from "./WorkflowProxyServer.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Activity","DurableClock","DurableDeferred","Workflow","WorkflowEngine"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Activity","DurableClock","DurableDeferred","Workflow","WorkflowEngine","WorkflowProxy","WorkflowProxyServer"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/workflow",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Durable workflows for Effect",
   "license": "MIT",
   "repository": {
@@ -11,7 +11,9 @@
   "sideEffects": [],
   "homepage": "https://effect.website",
   "peerDependencies": {
-    "effect": "^3.16.3"
+    "@effect/platform": "^0.84.6",
+    "effect": "^3.16.3",
+    "@effect/rpc": "^0.61.6"
   },
   "publishConfig": {
     "provenance": true
@@ -50,6 +52,16 @@
       "types": "./dist/dts/WorkflowEngine.d.ts",
       "import": "./dist/esm/WorkflowEngine.js",
       "default": "./dist/cjs/WorkflowEngine.js"
+    },
+    "./WorkflowProxy": {
+      "types": "./dist/dts/WorkflowProxy.d.ts",
+      "import": "./dist/esm/WorkflowProxy.js",
+      "default": "./dist/cjs/WorkflowProxy.js"
+    },
+    "./WorkflowProxyServer": {
+      "types": "./dist/dts/WorkflowProxyServer.d.ts",
+      "import": "./dist/esm/WorkflowProxyServer.js",
+      "default": "./dist/cjs/WorkflowProxyServer.js"
     }
   },
   "typesVersions": {
@@ -68,6 +80,12 @@
       ],
       "WorkflowEngine": [
         "./dist/dts/WorkflowEngine.d.ts"
+      ],
+      "WorkflowProxy": [
+        "./dist/dts/WorkflowProxy.d.ts"
+      ],
+      "WorkflowProxyServer": [
+        "./dist/dts/WorkflowProxyServer.d.ts"
       ]
     }
   }

package/src/Activity.ts

@@ -1,7 +1,6 @@
 /**
  * @since 1.0.0
  */
-import type * as Cause from "effect/Cause"
 import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
 import * as Effectable from "effect/Effectable"
@@ -47,6 +46,11 @@ export interface Activity<
     Exit.Exit<Success["Encoded"], Error["Encoded"]>,
     Success["Context"] | Error["Context"]
   >
+  readonly execute: Effect.Effect<
+    Success["Type"],
+    Error["Type"],
+    Success["Context"] | Error["Context"] | R | WorkflowEngine | WorkflowInstance
+  >
   readonly executeEncoded: Effect.Effect<
     Success["Encoded"],
     Error["Encoded"],
@@ -95,6 +99,7 @@ export const make = <
       failure: errorSchema,
       defect: Schema.Defect
     }),
+    execute: options.execute,
     executeEncoded: Effect.matchEffect(options.execute, {
       onFailure: (error) => Effect.flatMap(Effect.orDie(Schema.encode(self.errorSchema as any)(error)), Effect.fail),
       onSuccess: (value) => Effect.orDie(Schema.encode(self.successSchema)(value))
@@ -122,39 +127,6 @@ export const retry: typeof Effect.retry = dual(
     })
 )
 
-/**
- * @since 1.0.0
- * @category Error handling
- */
-export const onError: {
-  /**
-   * @since 1.0.0
-   * @category Error handling
-   */
-  <Error extends Schema.Schema.All, R2>(
-    onError: (cause: Cause.Cause<Error["Type"]>) => Effect.Effect<void, never, R2>
-  ): <Success extends Schema.Schema.Any, R>(
-    self: Activity<Success, Error, R>
-  ) => Activity<Success, Error, R | Exclude<R2, WorkflowEngine | WorkflowInstance>>
-  /**
-   * @since 1.0.0
-   * @category Error handling
-   */
-  <Success extends Schema.Schema.Any, Error extends Schema.Schema.All, R, R2>(
-    self: Activity<Success, Error, R>,
-    onError: (cause: Cause.Cause<Error["Type"]>) => Effect.Effect<void, never, R2>
-  ): Activity<Success, Error, R | Exclude<R2, WorkflowEngine | WorkflowInstance>>
-} = dual(2, <Success extends Schema.Schema.Any, Error extends Schema.Schema.All, R, R2>(
-  self: Activity<Success, Error, R>,
-  onError: (cause: Cause.Cause<Error["Type"]>) => Effect.Effect<void, never, R2>
-): Activity<Success, Error, R | Exclude<R2, WorkflowEngine | WorkflowInstance>> =>
-  make({
-    name: `${self.name}/onError`,
-    success: self.successSchema,
-    error: self.errorSchema,
-    execute: Effect.onError(self, onError)
-  }))
-
 /**
  * @since 1.0.0
  * @category Attempts

package/src/Workflow.ts

@@ -1,10 +1,12 @@
 /**
  * @since 1.0.0
  */
+import type * as Cause from "effect/Cause"
 import * as Context from "effect/Context"
 import * as Data from "effect/Data"
 import * as Effect from "effect/Effect"
 import * as Exit from "effect/Exit"
+import { dual } from "effect/Function"
 import * as Layer from "effect/Layer"
 import type { Pipeable } from "effect/Pipeable"
 import * as Predicate from "effect/Predicate"
@@ -12,6 +14,7 @@ import * as PrimaryKey from "effect/PrimaryKey"
 import * as Schedule from "effect/Schedule"
 import * as Schema from "effect/Schema"
 import type * as AST from "effect/SchemaAST"
+import type * as Scope from "effect/Scope"
 import { makeHashDigest } from "./internal/crypto.js"
 import type { WorkflowEngine, WorkflowInstance } from "./WorkflowEngine.js"
 
@@ -42,6 +45,27 @@ export interface Workflow<
   readonly payloadSchema: Payload
   readonly successSchema: Success
   readonly errorSchema: Error
+  readonly annotations: Context.Context<never>
+
+  /**
+   * Add an annotation to the workflow.
+   */
+  annotate<I, S>(tag: Context.Tag<I, S>, value: S): Workflow<
+    Name,
+    Payload,
+    Success,
+    Error
+  >
+
+  /**
+   * Add the annotations from a Context object to the workflow.
+   */
+  annotateContext<I>(context: Context.Context<I>): Workflow<
+    Name,
+    Payload,
+    Success,
+    Error
+  >
 
   /**
    * Execute the workflow with the given payload.
@@ -76,7 +100,7 @@ export interface Workflow<
     Registration<Name> | WorkflowEngine,
     never,
     | WorkflowEngine
-    | Exclude<R, WorkflowEngine | WorkflowInstance>
+    | Exclude<R, WorkflowEngine | WorkflowInstance | Execution<Name> | Scope.Scope>
     | Payload["Context"]
     | Success["Context"]
     | Error["Context"]
@@ -88,6 +112,26 @@ export interface Workflow<
   readonly executionId: (
     payload: Schema.Simplify<Schema.Struct.Constructor<Payload["fields"]>>
   ) => Effect.Effect<string>
+
+  /**
+   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
+   * called if the entire workflow fails, allowing you to perform cleanup or
+   * other actions based on the success value and the cause of the workflow failure.
+   *
+   * NOTE: Compensation will not work for nested activities. Compensation
+   * finalizers are only registered for top-level effects in the workflow.
+   */
+  readonly withCompensation: {
+    <A, R2>(
+      compensation: (value: A, cause: Cause.Cause<Error["Type"]>) => Effect.Effect<void, never, R2>
+    ): <E, R>(
+      effect: Effect.Effect<A, E, R>
+    ) => Effect.Effect<A, E, R | R2 | WorkflowInstance | Execution<Name> | Scope.Scope>
+    <A, E, R, R2>(
+      effect: Effect.Effect<A, E, R>,
+      compensation: (value: A, cause: Cause.Cause<Error["Type"]>) => Effect.Effect<void, never, R2>
+    ): Effect.Effect<A, E, R | R2 | WorkflowInstance | Execution<Name> | Scope.Scope>
+  }
 }
 
 /**
@@ -124,6 +168,15 @@ export interface Registration<Name extends string> {
   readonly name: Name
 }
 
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export interface Execution<Name extends string> {
+  readonly _: unique symbol
+  readonly name: Name
+}
+
 /**
  * @since 1.0.0
  * @category Models
@@ -134,9 +187,34 @@ export interface Any {
   readonly payloadSchema: AnyStructSchema
   readonly successSchema: Schema.Schema.Any
   readonly errorSchema: Schema.Schema.All
+  readonly annotations: Context.Context<never>
   readonly executionId: (payload: any) => Effect.Effect<string>
 }
 
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type Registrations<Workflows extends Any> = Workflows extends Workflow<
+  infer _Name,
+  infer _Payload,
+  infer _Success,
+  infer _Error
+> ? Registration<_Name> :
+  never
+
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export type Requirements<Workflows extends Any> = Workflows extends Workflow<
+  infer _Name,
+  infer _Payload,
+  infer _Success,
+  infer _Error
+> ? _Payload["Context"] | _Success["Context"] | _Error["Context"] :
+  never
+
 const EngineTag = Context.GenericTag<WorkflowEngine, WorkflowEngine["Type"]>(
   "@effect/workflow/WorkflowEngine" satisfies typeof WorkflowEngine.key
 )
@@ -164,6 +242,7 @@ export const make = <
     readonly success?: Success
     readonly error?: Error
     readonly suspendedRetrySchedule?: Schedule.Schedule<any, unknown> | undefined
+    readonly annotations?: Context.Context<never>
   }
 ): Workflow<Name, Payload extends Schema.Struct.Fields ? Schema.Struct<Payload> : Payload, Success, Error> => {
   const suspendedRetrySchedule = options.suspendedRetrySchedule ?? defaultRetrySchedule
@@ -174,6 +253,19 @@ export const make = <
     payloadSchema: Schema.isSchema(options.payload) ? options.payload : Schema.Struct(options.payload as any),
     successSchema: options.success ?? Schema.Void as any,
     errorSchema: options.error ?? Schema.Never as any,
+    annotations: options.annotations ?? Context.empty(),
+    annotate(tag, value) {
+      return make({
+        ...options,
+        annotations: Context.add(self.annotations, tag, value)
+      })
+    },
+    annotateContext(context) {
+      return make({
+        ...options,
+        annotations: Context.merge(self.annotations, context)
+      })
+    },
     execute: Effect.fnUntraced(
       function*(fields: any, opts) {
         const payload = self.payloadSchema.make(fields)
@@ -229,7 +321,8 @@ export const make = <
           ) as any)
         return EngineTag.context(engine)
       })) as any,
-    executionId: (payload) => makeExecutionId(self.payloadSchema.make(payload))
+    executionId: (payload) => makeExecutionId(self.payloadSchema.make(payload)),
+    withCompensation
   }
 
   return self
@@ -399,3 +492,63 @@ export const intoResult = <A, E, R>(
       })
     )
   )
+
+/**
+ * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
+ * called if the entire workflow fails, allowing you to perform cleanup or
+ * other actions based on the success value and the cause of the workflow failure.
+ *
+ * NOTE: Compensation will not work for nested activities. Compensation
+ * finalizers are only registered for top-level effects in the workflow.
+ *
+ * @since 1.0.0
+ * @category Compensation
+ */
+export const withCompensation: {
+  /**
+   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
+   * called if the entire workflow fails, allowing you to perform cleanup or
+   * other actions based on the success value and the cause of the workflow failure.
+   *
+   * NOTE: Compensation will not work for nested activities. Compensation
+   * finalizers are only registered for top-level effects in the workflow.
+   *
+   * @since 1.0.0
+   * @category Compensation
+   */
+  <A, R2>(
+    compensation: (value: A, cause: Cause.Cause<unknown>) => Effect.Effect<void, never, R2>
+  ): <E, R>(
+    effect: Effect.Effect<A, E, R>
+  ) => Effect.Effect<A, E, R | R2 | WorkflowInstance | Scope.Scope>
+  /**
+   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
+   * called if the entire workflow fails, allowing you to perform cleanup or
+   * other actions based on the success value and the cause of the workflow failure.
+   *
+   * NOTE: Compensation will not work for nested activities. Compensation
+   * finalizers are only registered for top-level effects in the workflow.
+   *
+   * @since 1.0.0
+   * @category Compensation
+   */
+  <A, E, R, R2>(
+    effect: Effect.Effect<A, E, R>,
+    compensation: (value: A, cause: Cause.Cause<unknown>) => Effect.Effect<void, never, R2>
+  ): Effect.Effect<A, E, R | R2 | WorkflowInstance | Scope.Scope>
+} = dual(2, <A, E, R, R2>(
+  effect: Effect.Effect<A, E, R>,
+  compensation: (value: A, cause: Cause.Cause<unknown>) => Effect.Effect<void, never, R2>
+): Effect.Effect<A, E, R | R2 | WorkflowInstance | Scope.Scope> =>
+  Effect.uninterruptibleMask((restore) =>
+    Effect.contextWithEffect((context: Context.Context<WorkflowInstance>) => {
+      const instance = Context.get(context, InstanceTag)
+      return Effect.tap(restore(effect), (value) =>
+        Effect.addFinalizer((exit) => {
+          if (Exit.isSuccess(exit) || instance.suspended) {
+            return Effect.void
+          }
+          return compensation(value, exit.cause)
+        }))
+    })
+  ))

package/src/WorkflowProxy.ts

@@ -0,0 +1,178 @@
+/**
+ * @since 1.0.0
+ */
+import * as HttpApiEndpoint from "@effect/platform/HttpApiEndpoint"
+import * as HttpApiGroup from "@effect/platform/HttpApiGroup"
+import * as Rpc from "@effect/rpc/Rpc"
+import * as RpcGroup from "@effect/rpc/RpcGroup"
+import type { NonEmptyReadonlyArray } from "effect/Array"
+import type * as Workflow from "./Workflow.js"
+
+/**
+ * Derives an `RpcGroup` from a list of workflows.
+ *
+ * ```ts
+ * import { RpcServer } from "@effect/rpc"
+ * import { Workflow, WorkflowProxy, WorkflowProxyServer } from "@effect/workflow"
+ * import { Layer, Schema } from "effect"
+ *
+ * const EmailWorkflow = Workflow.make({
+ *   name: "EmailWorkflow",
+ *   payload: {
+ *     id: Schema.String,
+ *     to: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const myWorkflows = [EmailWorkflow] as const
+ *
+ * // Use WorkflowProxy.toRpcGroup to create a `RpcGroup` from the
+ * // workflows
+ * class MyRpcs extends WorkflowProxy.toRpcGroup(myWorkflows) {}
+ *
+ * // Use WorkflowProxyServer.layerRpcHandlers to create a layer that implements
+ * // the rpc handlers
+ * const ApiLayer = RpcServer.layer(MyRpcs).pipe(
+ *   Layer.provide(WorkflowProxyServer.layerRpcHandlers(myWorkflows))
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const toRpcGroup = <
+  const Workflows extends NonEmptyReadonlyArray<Workflow.Any>,
+  const Prefix extends string = ""
+>(
+  workflows: Workflows,
+  options?: {
+    readonly prefix?: Prefix | undefined
+  }
+): RpcGroup.RpcGroup<ConvertRpcs<Workflows[number], Prefix>> => {
+  const prefix = options?.prefix ?? ""
+  const rpcs: Array<Rpc.Any> = []
+  for (const workflow of workflows) {
+    rpcs.push(
+      Rpc.make(`${prefix}${workflow.name}`, {
+        payload: workflow.payloadSchema,
+        error: workflow.errorSchema,
+        success: workflow.successSchema
+      }).annotateContext(workflow.annotations),
+      Rpc.make(`${prefix}${workflow.name}Discard`, {
+        payload: workflow.payloadSchema
+      }).annotateContext(workflow.annotations)
+    )
+  }
+  return RpcGroup.make(...rpcs) as any
+}
+
+/**
+ * @since 1.0.0
+ */
+export type ConvertRpcs<Workflows extends Workflow.Any, Prefix extends string> = Workflows extends Workflow.Workflow<
+  infer _Name,
+  infer _Payload,
+  infer _Success,
+  infer _Error
+> ?
+    | Rpc.Rpc<`${Prefix}${_Name}`, _Payload, _Success, _Error>
+    | Rpc.Rpc<`${Prefix}${_Name}Discard`, _Payload>
+  : never
+
+/**
+ * Derives an `HttpApiGroup` from a list of workflows.
+ *
+ * ```ts
+ * import { HttpApi, HttpApiBuilder } from "@effect/platform"
+ * import { Workflow, WorkflowProxy, WorkflowProxyServer } from "@effect/workflow"
+ * import { Layer, Schema } from "effect"
+ *
+ * const EmailWorkflow = Workflow.make({
+ *   name: "EmailWorkflow",
+ *   payload: {
+ *     id: Schema.String,
+ *     to: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const myWorkflows = [EmailWorkflow] as const
+ *
+ * // Use WorkflowProxy.toHttpApiGroup to create a `HttpApiGroup` from the
+ * // workflows
+ * class MyApi extends HttpApi.make("api")
+ *   .add(WorkflowProxy.toHttpApiGroup("workflows", myWorkflows))
+ * {}
+ *
+ * // Use WorkflowProxyServer.layerHttpApi to create a layer that implements the
+ * // workflows HttpApiGroup
+ * const ApiLayer = HttpApiBuilder.api(MyApi).pipe(
+ *   Layer.provide(WorkflowProxyServer.layerHttpApi(MyApi, "workflows", myWorkflows))
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const toHttpApiGroup = <const Name extends string, const Workflows extends NonEmptyReadonlyArray<Workflow.Any>>(
+  name: Name,
+  workflows: Workflows
+): HttpApiGroup.HttpApiGroup<Name, ConvertHttpApi<Workflows[number]>> => {
+  let group = HttpApiGroup.make(name)
+  for (const workflow of workflows) {
+    const path = `/${tagToPath(workflow.name)}` as const
+    group = group.add(
+      HttpApiEndpoint.post(workflow.name, path)
+        .setPayload(workflow.payloadSchema)
+        .addSuccess(workflow.successSchema)
+        .addError(workflow.errorSchema as any)
+        .annotateContext(workflow.annotations)
+    ).add(
+      HttpApiEndpoint.post(workflow.name + "Discard", `${path}/discard`)
+        .setPayload(workflow.payloadSchema)
+        .annotateContext(workflow.annotations)
+    ) as any
+  }
+  return group as any
+}
+
+const tagToPath = (tag: string): string =>
+  tag
+    .replace(/[^a-zA-Z0-9]+/g, "-") // Replace non-alphanumeric characters with hyphen
+    .replace(/([a-z])([A-Z])/g, "$1-$2") // Insert hyphen before uppercase letters
+    .toLowerCase()
+
+/**
+ * @since 1.0.0
+ */
+export type ConvertHttpApi<Workflows extends Workflow.Any> = Workflows extends Workflow.Workflow<
+  infer _Name,
+  infer _Payload,
+  infer _Success,
+  infer _Error
+> ?
+    | HttpApiEndpoint.HttpApiEndpoint<
+      _Name,
+      "POST",
+      never,
+      never,
+      _Payload["Type"],
+      never,
+      _Success["Type"],
+      _Error["Type"],
+      _Payload["Context"] | _Success["Context"],
+      _Error["Context"]
+    >
+    | HttpApiEndpoint.HttpApiEndpoint<
+      `${_Name}Discard`,
+      "POST",
+      never,
+      never,
+      _Payload["Type"],
+      never,
+      void,
+      never,
+      _Payload["Context"]
+    > :
+  never