effect

Generated

This page is generated from the source of @fungi.computer/bird-dog. It is for developers writing code against the package.

@fungi.computer/bird-dog

---

@fungi.computer/bird-dog / effect

effect

Classes

BirdDogError

BirdDog could not complete one owned store or transport operation.

Extends

• Error

Constructors

Constructor

new BirdDogError(message): BirdDogError

Parameters

message

string

Returns

BirdDogError

Overrides

Error.constructor

Properties

_tag

readonly _tag: "BirdDogError"

Stable discriminator for BirdDog-owned effect failures.

Type Aliases

EffectBirdDogOptions

EffectBirdDogOptions = Readonly<{ outbox: Readonly<{ put: (key, value) => Effect.Effect<void, BirdDogError>>; read: (key) => Effect.Effect<string | undefined, BirdDogError>>; list: (limit, afterKey?) => Effect.Effect<readonly Readonly<{ key: string; value: string; }>[], BirdDogError>>; delete: (key) => Effect.Effect<void, BirdDogError>>; }>; post: (mail) => Effect.Effect<boolean, BirdDogError>>; scheduleWake: (at) => Effect.Effect<void, BirdDogError>>; now: () => number; }>

Effect host ports for the durable mail room.

---

BirdDogEffect

BirdDogEffect = Readonly<{ fanOut: (settlement) => Effect.Effect<void, BirdDogError>>; drainOutbox: () => Effect.Effect<void, BirdDogError>>; }>

Effect-native durable reply delivery.

Variables

BirdDogAgentReferenceSchema

const BirdDogAgentReferenceSchema: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>

Parser for an ordinary agent Session address.

---

BirdDogMailSchema

const BirdDogMailSchema: Struct<{ key: filter<filter<typeof String$>>>>; to: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; from: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; replyTo: Array$<Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>>; content: typeof String$; createdAt: typeof NonNegative; }>

Parser for addressed agent correspondence.

---

BirdDogAgentWorkSchema

const BirdDogAgentWorkSchema: Struct<{ jobId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; commandFactId: filter<filter<typeof String$>>>>; recovery: optional<Struct<{ maxRecoveries: filter<typeof Int>>; }>>; }>

Parser for accepted Session work.

---

BirdDogAgentJobPayloadSchema

const BirdDogAgentJobPayloadSchema: Struct<{ work: Struct<{ sessionId: filter<filter<typeof String$>>>>; commandFactId: filter<filter<typeof String$>>>>; }>; mail: optional<Struct<{ key: filter<filter<typeof String$>>>>; to: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; from: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; replyTo: Array$<Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>>; content: typeof String$; createdAt: typeof NonNegative; }>>; }>

Parser for the payload that Watchdog stores without interpretation.

---

BirdDogAgentJobInputSchema

const BirdDogAgentJobInputSchema: Struct<{ work: Struct<{ jobId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; commandFactId: filter<filter<typeof String$>>>>; recovery: optional<Struct<{ maxRecoveries: filter<typeof Int>>; }>>; }>; mail: optional<Struct<{ key: filter<filter<typeof String$>>>>; to: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; from: Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>; replyTo: Array$<Struct<{ kind: Literal<["agent"]>; agentId: filter<filter<typeof String$>>>>; sessionId: filter<filter<typeof String$>>>>; }>>; content: typeof String$; createdAt: typeof NonNegative; }>>; }>

Parser for accepted work entering BirdDog’s transactional projection.

Functions

agentJobFromInput()

agentJobFromInput(input): object

Validate and translate agent work into Watchdog’s opaque job grammar.

Parameters

input

BirdDogAgentJobInput

Returns

object

state

readonly state: "queued"

jobId

readonly jobId: string

queue

readonly queue: string

lane

readonly lane: string

priority

readonly priority: number

payload

readonly payload: unknown

recovery?

readonly optional recovery?: object

recovery.maxRecoveries

readonly maxRecoveries: number

---

decodeAgentJob()

decodeAgentJob(job): BirdDogAgentJobPayload

Decode the opaque payload at BirdDog’s side of the Watchdog seam.

Parameters

job

{ state: "queued"; jobId: string; queue: string; lane: string; priority: number; payload: unknown; recovery?: { maxRecoveries: number; }; } | { state: "running"; jobId: string; queue: string; lane: string; priority: number; payload: unknown; recovery?: { maxRecoveries: number; }; } | { state: "settled"; outcome: "completed" | "failed" | "cancelled" | "outcome_unknown" | "interrupted"; jobId: string; queue: string; lane: string; priority: number; payload: unknown; recovery?: { maxRecoveries: number; }; }

Returns

BirdDogAgentJobPayload

---

make()

make(options): Effect<Readonly<{ fanOut: (settlement) => Effect<void, BirdDogError>>; drainOutbox: () => Effect<void, BirdDogError>>; }>>

Construct BirdDog’s Effect-native durable mail room.

Parameters

options

EffectBirdDogOptions

Returns

Effect<Readonly<{ fanOut: (settlement) => Effect<void, BirdDogError>; drainOutbox: () => Effect<void, BirdDogError>; }>>