@voltro/plugin-webhooks 0.84.0 → 0.85.0

package/dist/errors.d.ts

@@ -1,4 +1,5 @@
 import { Schema } from 'effect';
+import { YieldableError } from 'effect/Cause';
 
 /**
  * Thrown by `WebhooksService.replay` when no delivery row exists for the
@@ -8,12 +9,10 @@ import { Schema } from 'effect';
 export declare class WebhookDeliveryNotFound extends WebhookDeliveryNotFound_base {
 }
 
-declare const WebhookDeliveryNotFound_base: Schema.TaggedErrorClass<WebhookDeliveryNotFound, "WebhookDeliveryNotFound", {
-    readonly _tag: Schema.tag<"WebhookDeliveryNotFound">;
-} & {
+declare const WebhookDeliveryNotFound_base: Schema.Class<WebhookDeliveryNotFound, Schema.TaggedStruct<"WebhookDeliveryNotFound", {
     /** The delivery id that did not resolve to a row. */
-    deliveryId: typeof Schema.String;
-}>;
+    readonly deliveryId: Schema.String;
+}>, YieldableError>;
 
 /**
  * Thrown by `WebhooksService.emit` when the payload does not decode
@@ -25,14 +24,12 @@ declare const WebhookDeliveryNotFound_base: Schema.TaggedErrorClass<WebhookDeliv
 export declare class WebhookPayloadInvalid extends WebhookPayloadInvalid_base {
 }
 
-declare const WebhookPayloadInvalid_base: Schema.TaggedErrorClass<WebhookPayloadInvalid, "WebhookPayloadInvalid", {
-    readonly _tag: Schema.tag<"WebhookPayloadInvalid">;
-} & {
+declare const WebhookPayloadInvalid_base: Schema.Class<WebhookPayloadInvalid, Schema.TaggedStruct<"WebhookPayloadInvalid", {
     /** The outgoing event id the payload was emitted for. */
-    event: typeof Schema.String;
+    readonly event: Schema.String;
     /** Tree-formatted schema decode issues (one line per violation). */
-    issues: typeof Schema.String;
-}>;
+    readonly issues: Schema.String;
+}>, YieldableError>;
 
 /**
  * Raised by the delivery workflow's wire-encoder when the target's
@@ -47,14 +44,12 @@ declare const WebhookPayloadInvalid_base: Schema.TaggedErrorClass<WebhookPayload
 export declare class WebhookPayloadUnrepresentable extends WebhookPayloadUnrepresentable_base {
 }
 
-declare const WebhookPayloadUnrepresentable_base: Schema.TaggedErrorClass<WebhookPayloadUnrepresentable, "WebhookPayloadUnrepresentable", {
-    readonly _tag: Schema.tag<"WebhookPayloadUnrepresentable">;
-} & {
+declare const WebhookPayloadUnrepresentable_base: Schema.Class<WebhookPayloadUnrepresentable, Schema.TaggedStruct<"WebhookPayloadUnrepresentable", {
     /** The wire format that could not represent the payload. */
-    format: Schema.Literal<["json", "form", "xml"]>;
+    readonly format: Schema.Literals<readonly ["json", "form", "xml"]>;
     /** Human-readable detail — which shape/key defeated the encoder. */
-    reason: typeof Schema.String;
-}>;
+    readonly reason: Schema.String;
+}>, YieldableError>;
 
 /**
  * Thrown by `WebhooksService.updateTargetPayloadVersion` when the
@@ -63,12 +58,10 @@ declare const WebhookPayloadUnrepresentable_base: Schema.TaggedErrorClass<Webhoo
 export declare class WebhookPayloadVersionInvalid extends WebhookPayloadVersionInvalid_base {
 }
 
-declare const WebhookPayloadVersionInvalid_base: Schema.TaggedErrorClass<WebhookPayloadVersionInvalid, "WebhookPayloadVersionInvalid", {
-    readonly _tag: Schema.tag<"WebhookPayloadVersionInvalid">;
-} & {
+declare const WebhookPayloadVersionInvalid_base: Schema.Class<WebhookPayloadVersionInvalid, Schema.TaggedStruct<"WebhookPayloadVersionInvalid", {
     /** The rejected version value (as supplied by the caller). */
-    version: typeof Schema.Number;
-}>;
+    readonly version: Schema.Number;
+}>, YieldableError>;
 
 /**
  * Thrown by `WebhooksService.subscribe` (via `validateSubscribe`) when
@@ -78,26 +71,23 @@ declare const WebhookPayloadVersionInvalid_base: Schema.TaggedErrorClass<Webhook
  * `reason` is the human-readable detail (carries the offending value).
  */
 export declare class WebhookSubscribeInvalid extends WebhookSubscribeInvalid_base {
+    get message(): string;
 }
 
-declare const WebhookSubscribeInvalid_base: Schema.TaggedErrorClass<WebhookSubscribeInvalid, "WebhookSubscribeInvalid", {
-    readonly _tag: Schema.tag<"WebhookSubscribeInvalid">;
-} & {
+declare const WebhookSubscribeInvalid_base: Schema.Class<WebhookSubscribeInvalid, Schema.TaggedStruct<"WebhookSubscribeInvalid", {
     /** The offending subscribe-input field: `'url'` | `'event'` |
      *  `'secret'` | `'retry'` | `'rateLimitPerMinute'`. */
-    field: typeof Schema.String;
+    readonly field: Schema.String;
     /** Human-readable detail, including the offending value. */
-    reason: typeof Schema.String;
-}>;
+    readonly reason: Schema.String;
+}>, YieldableError>;
 
 /** A target selected for management no longer exists. */
 export declare class WebhookTargetNotFound extends WebhookTargetNotFound_base {
 }
 
-declare const WebhookTargetNotFound_base: Schema.TaggedErrorClass<WebhookTargetNotFound, "WebhookTargetNotFound", {
-    readonly _tag: Schema.tag<"WebhookTargetNotFound">;
-} & {
-    targetId: typeof Schema.String;
-}>;
+declare const WebhookTargetNotFound_base: Schema.Class<WebhookTargetNotFound, Schema.TaggedStruct<"WebhookTargetNotFound", {
+    readonly targetId: Schema.String;
+}>, YieldableError>;
 
 export { }

package/dist/errors.js

@@ -3,11 +3,19 @@ import { Schema as e } from "effect";
 var t = class extends e.TaggedError()("WebhookSubscribeInvalid", {
 	field: e.String,
 	reason: e.String
-}) {}, n = class extends e.TaggedError()("WebhookDeliveryNotFound", { deliveryId: e.String }) {}, r = class extends e.TaggedError()("WebhookTargetNotFound", { targetId: e.String }) {}, i = class extends e.TaggedError()("WebhookPayloadVersionInvalid", { version: e.Number }) {}, a = class extends e.TaggedError()("WebhookPayloadInvalid", {
+}) {
+	get message() {
+		return `${this.field}: ${this.reason}`;
+	}
+}, n = class extends e.TaggedError()("WebhookDeliveryNotFound", { deliveryId: e.String }) {}, r = class extends e.TaggedError()("WebhookTargetNotFound", { targetId: e.String }) {}, i = class extends e.TaggedError()("WebhookPayloadVersionInvalid", { version: e.Number }) {}, a = class extends e.TaggedError()("WebhookPayloadInvalid", {
 	event: e.String,
 	issues: e.String
 }) {}, o = class extends e.TaggedError()("WebhookPayloadUnrepresentable", {
-	format: e.Literal("json", "form", "xml"),
+	format: e.Literals([
+		"json",
+		"form",
+		"xml"
+	]),
 	reason: e.String
 }) {};
 //#endregion

package/dist/index.d.ts

@@ -13,10 +13,11 @@ import { PluginPermission } from '@voltro/protocol';
 import { Schema } from 'effect';
 import { Table } from '@voltro/database';
 import { VoltroPlugin } from '@voltro/protocol';
-import { Workflow } from '@effect/workflow';
-import { WorkflowEngine } from '@effect/workflow/WorkflowEngine';
-import { WorkflowInstance } from '@effect/workflow/WorkflowEngine';
+import { Workflow } from 'effect/workflow';
+import { WorkflowEngine } from 'effect/workflow/WorkflowEngine';
+import { WorkflowInstance } from 'effect/workflow/WorkflowEngine';
 import { WorkflowRunHandle } from '@voltro/protocol';
+import { YieldableError } from 'effect/Cause';
 
 /**
  * Acquire one slot in EVERY scope for the window containing `now`
@@ -166,22 +167,20 @@ declare interface DeliverInput {
     readonly event: string;
     readonly eventId: string;
     readonly payloadJson: string;
-    readonly attemptEpoch?: number;
+    readonly attemptEpoch?: number | undefined;
 }
 
 export declare const deliverWebhookWorkflow: Workflow.Workflow<"voltro.deliverWebhook", Schema.Struct<{
-    deliveryId: typeof Schema.String;
-    targetId: typeof Schema.String;
-    event: typeof Schema.String;
-    eventId: typeof Schema.String;
-    payloadJson: typeof Schema.String;
-    attemptEpoch: Schema.optionalWith<typeof Schema.Number, {
-        default: () => number;
-    }>;
+    deliveryId: Schema.String;
+    targetId: Schema.String;
+    event: Schema.String;
+    eventId: Schema.String;
+    payloadJson: Schema.String;
+    attemptEpoch: Schema.optional<Schema.Number>;
 }>, Schema.Struct<{
-    finalStatus: Schema.Literal<["succeeded", "failed", "deferred"]>;
-    attempts: typeof Schema.Number;
-}>, typeof Schema.Never>;
+    readonly finalStatus: Schema.Literals<readonly ["succeeded", "failed", "deferred"]>;
+    readonly attempts: Schema.Number;
+}>, Schema.Never>;
 
 declare interface DeliverWorkflowOptions {
     /** Discovered outgoing events (declared events with a `webhook:` block,
@@ -255,6 +254,14 @@ export declare type DurationLiteral = `${number}${'ms' | 's' | 'm' | 'h' | 'd'}`
 export declare interface EmitOptions {
     /** Only deliver to targets of this tenant. Absent ⇒ every target. */
     readonly tenantId?: string | null;
+    /**
+     * The event's id, as every delivery of it records it (`eventId`, sent as
+     * `x-voltro-event-id`). Absent ⇒ a fresh one. A
+     * deferred emit passes its outbox row id, so a retried delivery of the same
+     * intent keeps one id and a trace links the request, the outbox row and
+     * every delivery.
+     */
+    readonly eventId?: string;
     /**
      * Dispatch NOW instead of after the enclosing transaction commits.
      *
@@ -1489,12 +1496,10 @@ export declare const WEBHOOK_VERIFICATION_PROPERTY: "voltroWebhookVerification";
 export declare class WebhookDeliveryNotFound extends WebhookDeliveryNotFound_base {
 }
 
-declare const WebhookDeliveryNotFound_base: Schema.TaggedErrorClass<WebhookDeliveryNotFound, "WebhookDeliveryNotFound", {
-    readonly _tag: Schema.tag<"WebhookDeliveryNotFound">;
-} & {
+declare const WebhookDeliveryNotFound_base: Schema.Class<WebhookDeliveryNotFound, Schema.TaggedStruct<"WebhookDeliveryNotFound", {
     /** The delivery id that did not resolve to a row. */
-    deliveryId: typeof Schema.String;
-}>;
+    readonly deliveryId: Schema.String;
+}>, YieldableError>;
 
 export declare type WebhookDescriptor = OutgoingEventDescriptor<unknown> | IncomingWebhookDescriptor<unknown> | WebhookProviderDescriptor;
 
@@ -1531,14 +1536,12 @@ export declare type WebhookId = string;
 export declare class WebhookPayloadInvalid extends WebhookPayloadInvalid_base {
 }
 
-declare const WebhookPayloadInvalid_base: Schema.TaggedErrorClass<WebhookPayloadInvalid, "WebhookPayloadInvalid", {
-    readonly _tag: Schema.tag<"WebhookPayloadInvalid">;
-} & {
+declare const WebhookPayloadInvalid_base: Schema.Class<WebhookPayloadInvalid, Schema.TaggedStruct<"WebhookPayloadInvalid", {
     /** The outgoing event id the payload was emitted for. */
-    event: typeof Schema.String;
+    readonly event: Schema.String;
     /** Tree-formatted schema decode issues (one line per violation). */
-    issues: typeof Schema.String;
-}>;
+    readonly issues: Schema.String;
+}>, YieldableError>;
 
 /**
  * Raised by the delivery workflow's wire-encoder when the target's
@@ -1553,14 +1556,12 @@ declare const WebhookPayloadInvalid_base: Schema.TaggedErrorClass<WebhookPayload
 export declare class WebhookPayloadUnrepresentable extends WebhookPayloadUnrepresentable_base {
 }
 
-declare const WebhookPayloadUnrepresentable_base: Schema.TaggedErrorClass<WebhookPayloadUnrepresentable, "WebhookPayloadUnrepresentable", {
-    readonly _tag: Schema.tag<"WebhookPayloadUnrepresentable">;
-} & {
+declare const WebhookPayloadUnrepresentable_base: Schema.Class<WebhookPayloadUnrepresentable, Schema.TaggedStruct<"WebhookPayloadUnrepresentable", {
     /** The wire format that could not represent the payload. */
-    format: Schema.Literal<["json", "form", "xml"]>;
+    readonly format: Schema.Literals<readonly ["json", "form", "xml"]>;
     /** Human-readable detail — which shape/key defeated the encoder. */
-    reason: typeof Schema.String;
-}>;
+    readonly reason: Schema.String;
+}>, YieldableError>;
 
 /**
  * Thrown by `WebhooksService.updateTargetPayloadVersion` when the
@@ -1569,12 +1570,10 @@ declare const WebhookPayloadUnrepresentable_base: Schema.TaggedErrorClass<Webhoo
 export declare class WebhookPayloadVersionInvalid extends WebhookPayloadVersionInvalid_base {
 }
 
-declare const WebhookPayloadVersionInvalid_base: Schema.TaggedErrorClass<WebhookPayloadVersionInvalid, "WebhookPayloadVersionInvalid", {
-    readonly _tag: Schema.tag<"WebhookPayloadVersionInvalid">;
-} & {
+declare const WebhookPayloadVersionInvalid_base: Schema.Class<WebhookPayloadVersionInvalid, Schema.TaggedStruct<"WebhookPayloadVersionInvalid", {
     /** The rejected version value (as supplied by the caller). */
-    version: typeof Schema.Number;
-}>;
+    readonly version: Schema.Number;
+}>, YieldableError>;
 
 export declare interface WebhookProviderDescriptor {
     readonly _tag: 'webhookProvider';
@@ -1640,7 +1639,7 @@ export declare interface WebhooksPluginOptions {
 export declare class WebhooksService extends WebhooksService_base {
 }
 
-declare const WebhooksService_base: Context.TagClass<WebhooksService, "@voltro/webhooks/WebhooksService", WebhooksServiceShape>;
+declare const WebhooksService_base: Context.ServiceClass<WebhooksService, "@voltro/webhooks/WebhooksService", WebhooksServiceShape>;
 
 export declare interface WebhooksServiceOptions {
     /** Discovered outgoing events (projected from declared events). When present,
@@ -1770,17 +1769,16 @@ export declare interface WebhooksServiceShape {
  * `reason` is the human-readable detail (carries the offending value).
  */
 export declare class WebhookSubscribeInvalid extends WebhookSubscribeInvalid_base {
+    get message(): string;
 }
 
-declare const WebhookSubscribeInvalid_base: Schema.TaggedErrorClass<WebhookSubscribeInvalid, "WebhookSubscribeInvalid", {
-    readonly _tag: Schema.tag<"WebhookSubscribeInvalid">;
-} & {
+declare const WebhookSubscribeInvalid_base: Schema.Class<WebhookSubscribeInvalid, Schema.TaggedStruct<"WebhookSubscribeInvalid", {
     /** The offending subscribe-input field: `'url'` | `'event'` |
      *  `'secret'` | `'retry'` | `'rateLimitPerMinute'`. */
-    field: typeof Schema.String;
+    readonly field: Schema.String;
     /** Human-readable detail, including the offending value. */
-    reason: typeof Schema.String;
-}>;
+    readonly reason: Schema.String;
+}>, YieldableError>;
 
 /**
  * The three bookkeeping tables, as a TUPLE rather than a plain array.
@@ -1987,11 +1985,9 @@ export declare const webhookTables: () => readonly [ Table<"_voltro_webhook_targ
 export declare class WebhookTargetNotFound extends WebhookTargetNotFound_base {
 }
 
-declare const WebhookTargetNotFound_base: Schema.TaggedErrorClass<WebhookTargetNotFound, "WebhookTargetNotFound", {
-    readonly _tag: Schema.tag<"WebhookTargetNotFound">;
-} & {
-    targetId: typeof Schema.String;
-}>;
+declare const WebhookTargetNotFound_base: Schema.Class<WebhookTargetNotFound, Schema.TaggedStruct<"WebhookTargetNotFound", {
+    readonly targetId: Schema.String;
+}>, YieldableError>;
 
 export declare type WireFormat = 'json' | 'form' | 'xml';