API reference

delegation

Import

import * as api from "@fungi.computer/shiitake/delegation";

Exports

Kind	Export	Description
class	AgentDelegation	Host-owned identity and admission around BirdDog’s ordinary envelope.
class	AgentDisclosureRefused	A current correspondent no longer has disclosure authority.
class	AgentMail	Recipient-owned replies and receipt-bearing submissions over the host’s one Post lane.
type alias	DelegationIdentity	Shiitake host-pack identity; core consumes OysterAgents, never this engine.
type alias	AgentReplySettlement	Undefined is an explicit disclosure refusal; missing facts and read errors must fail.
type alias	AgentMailPost	The host’s one Post lane, as Agent mail borrows it.
constant	machineAgentCodecs	The Agent wire decoders a host lends Oyster’s machine-link client, so the device link routes Agent work without owning Shiitake’s grammar.
function	agentMailRoute()	Current disclosure admission runs at every transport attempt, including frozen retries.
function	machineAgentReservations()	Machine-homed Agent identities in the ordinary directory over the enrollment’s own store: one Team identity per enrollment receipt, reserved without opening a hosted Agent. The enrolling member is the grant actor.

AgentDelegationclass

Host-owned identity and admission around BirdDog’s ordinary envelope.

Constructors

Constructor

new AgentDelegation(deps): AgentDelegation;

Parameters

Parameter	Type
`deps`	`Readonly<{ storage: WatchdogSqliteOwner; expiresAt: () => number; identity: () => \| DelegationIdentity \| null \| Promise<DelegationIdentity \| null>; directory: () => AgentControlDirectory; deliver: (mail) => Promise<DelegationReceipt>; prepare: (mail) => Promise<void>; stageAcceptedNotice: (mail, scopeId) => void; accept: (mail, reply, stageAcceptedNotice) => Promise<Accepted>; }>`

Returns

AgentDelegation

Methods

settlement()

settlement(
   sender,
   sessionId,
   commandId,
   host
): Promise<
  | Readonly<{
  acceptedSender: string | null;
  terminal: SessionTerminal;
  content: string;
  usage: readonly Pick<AssistantMessage, "model" | "provider" | "usage">[];
  toolCalls: number;
}>
| undefined>;

Recipient-local disclosure through the public host, never another Agent’s RPC.

Parameters

Parameter	Type
`sender`	`DelegationIdentity`
`sessionId`	`string`
`commandId`	`string`
`host`	`Pick<ShiitakeHost, "readSettlement">`

Returns

Promise< | Readonly<{ acceptedSender: string | null; terminal: SessionTerminal; content: string; usage: readonly Pick<AssistantMessage, "model" | "provider" | "usage">[]; toolCalls: number; }> | undefined>

send()

send(
   input,
   sourceSessionId,
   signal,
   invocation?
): Promise<DelegationReceipt>;

Delegate work to an in-scope Agent: steer its Session, or start fleet correspondence.

Parameters

Parameter	Type
`input`	`AgentDelegationInput`
`sourceSessionId`	`string`
`signal`	`AbortSignal`
`invocation?`	`Readonly<{ toolCallId: string; sendIndex: number; commandId?: string; meta?: Json; toolCallCode?: string; }>`

Returns

Promise<DelegationReceipt>

recall()

recall(
   input,
   sourceSessionId,
   signal
): Promise<CancelResult>;

Resolve this sender’s exact request, then let the recipient guard pending work.

Parameters

Parameter	Type
`input`	`AgentRecallInput`
`sourceSessionId`	`string`
`signal`	`AbortSignal`

Returns

Promise<CancelResult>

receive()

receive(raw): Promise<PostDeliveryResult>;

Admit one addressed Agent mail for this Agent, or refuse it.

Parameters

Parameter	Type
`raw`	`{ key: string; kind: string; address: unknown; event: unknown; }`
`raw.key`	`string`
`raw.kind`	`string`
`raw.address`	`unknown`
`raw.event`	`unknown`

Returns

Promise<PostDeliveryResult>

localUndeliverable()

localUndeliverable(original): Promise<PostDeliveryResult>;

Admit local outbox exhaustion through the same Fleet/system reply gate.

Parameters

Parameter	Type
`original`	`BirdDogMail`

Returns

Promise<PostDeliveryResult>

AgentDisclosureRefusedclass

A current correspondent no longer has disclosure authority.

Extends

Error

Constructors

Constructor

new AgentDisclosureRefused(): AgentDisclosureRefused;

Returns

AgentDisclosureRefused

Overrides

Error.constructor;

AgentMailclass

Recipient-owned replies and receipt-bearing submissions over the host’s one Post lane.

Constructors

Constructor

new AgentMail(deps): AgentMail;

Parameters

Parameter	Type
`deps`	`Readonly<{ storage: WatchdogSqliteOwner; post: () => AgentMailPost; identity: () => \| DelegationIdentity \| null \| Promise<DelegationIdentity \| null>; replySettlement: AgentReplySettlement; onUndeliverable: (original, reply) => Promise<PostDeliveryResult>; drain: () => Promise<void>; wake: () => Promise<void>; }>`

Returns

AgentMail

Methods

send()

send(mail): Promise<DelegationReceipt>;

Submit one mail and return recipient acceptance or relay-held custody.

Parameters

Parameter	Type
`mail`	`BirdDogMail`

Returns

Promise<DelegationReceipt>

stageUndeliverableReplies()

stageUndeliverableReplies(): Promise<void>;

Reconcile exhausted original outbox mail into one local system reply.

Returns

Promise<void>

stageAcceptedNotice()

stageAcceptedNotice(mail, scopeId): void;

Stage the acceptance reply through this Post owner without leaving the transaction.

Parameters

Parameter	Type
`mail`	`BirdDogMail`
`scopeId`	`string`

Returns

void

mailRoom()

mailRoom(): Readonly<{
  fanOut: (settlement) => Effect<void, BirdDogError>;
  postMail?: (mail) => Effect<void, BirdDogError>;
  drainOutbox: () => Effect<void, BirdDogError>;
  nextWakeAt: () => Effect<number | undefined, BirdDogError>;
}> & object;

BirdDog’s mail room: disclosed settlement replies fan out over Post.

Returns

DelegationIdentitytype alias

type DelegationIdentity = Readonly<{
  scopeId: string;
  agentId: string;
}>;

Shiitake host-pack identity; core consumes OysterAgents, never this engine.

AgentReplySettlementtype alias

type AgentReplySettlement = (mail) => Promise<CommandSettlement | undefined>;

Undefined is an explicit disclosure refusal; missing facts and read errors must fail.

Parameters

Parameter	Type
`mail`	`BirdDogMail`

Returns

Promise<CommandSettlement | undefined>

AgentMailPosttype alias

type AgentMailPost = Pick<
  PostRuntime<{
    agentMail: ReturnType<typeof agentMailRoute>;
  }>,
  "send" | "read" | "nextWake" | "deadLetters"
>;

The host’s one Post lane, as Agent mail borrows it.

machineAgentCodecsconstant

const machineAgentCodecs: object;

The Agent wire decoders a host lends Oyster’s machine-link client, so the device link routes Agent work without owning Shiitake’s grammar.

Type Declaration

Name	Type	Description
`sessionCreation()`	`(body) => \| Readonly<{ requestId: string; }> \| null`	The Session-creation intent, or null when the body is not one.
`settlement()`	`(encoded) => CommandSettlement`	One serialized settlement from a hosted or machine-homed Agent.
`accepted()`	`(receipt) => void`	Throws unless an acknowledgment carries a valid acceptance or Held result.

agentMailRoute()function

function agentMailRoute(namespace, replySettlement): PostRoute<AgentMailAddress,
  | {
  from: {
     kind: "agent";
     agentId: string;
     sessionId: string;
  };
  reply?:   | {
     commandId: string;
     outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown";
     diagnostic?: string;
   }
     | {
     outcome: "accepted";
     commandId: string;
   }
     | {
     outcome: "undeliverable";
     reason: "recipient_left";
   };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}
  | {
  from: {
     kind: "system";
     systemId: "hub";
  };
  reply: {
     outcome: "undeliverable";
     reason: "recipient_offline";
  };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
},
  | {
  from: {
     kind: "agent";
     agentId: string;
     sessionId: string;
  };
  reply?:   | {
     commandId: string;
     outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown";
     diagnostic?: string;
   }
     | {
     outcome: "accepted";
     commandId: string;
   }
     | {
     outcome: "undeliverable";
     reason: "recipient_left";
   };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}
  | {
  from: {
     kind: "system";
     systemId: "hub";
  };
  reply: {
     outcome: "undeliverable";
     reason: "recipient_offline";
  };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}, AgentMailAddress,
  | {
  from: {
     kind: "agent";
     agentId: string;
     sessionId: string;
  };
  reply?:   | {
     commandId: string;
     outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown";
     diagnostic?: string;
   }
     | {
     outcome: "accepted";
     commandId: string;
   }
     | {
     outcome: "undeliverable";
     reason: "recipient_left";
   };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}
  | {
  from: {
     kind: "system";
     systemId: "hub";
  };
  reply: {
     outcome: "undeliverable";
     reason: "recipient_offline";
  };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
},
  | {
  from: {
     kind: "agent";
     agentId: string;
     sessionId: string;
  };
  reply?:   | {
     commandId: string;
     outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown";
     diagnostic?: string;
   }
     | {
     outcome: "accepted";
     commandId: string;
   }
     | {
     outcome: "undeliverable";
     reason: "recipient_left";
   };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}
  | {
  from: {
     kind: "system";
     systemId: "hub";
  };
  reply: {
     outcome: "undeliverable";
     reason: "recipient_offline";
  };
  key: string;
  to: {
     kind: "agent";
     agentId: string;
     sessionId?: string;
  };
  replyTo: readonly object[];
  content: string;
  createdAt: number;
  meta?: Json | undefined;
}> & Omit<Readonly<{
  addressKind: string;
  deadlineMs?: number;
  address: Codec<unknown, unknown>;
  event: Codec<unknown, unknown>;
  encodeEnvelope: (envelope) => object;
  parseDelivery: (envelope) => object;
  prepareEnvelope?: (envelope, signal) => Promise<{
     key: string;
     kind: string;
     address: unknown;
     event: unknown;
  }>;
  recordDelivered?: (envelope) => void;
  nameOf: (envelope) => string;
  namespace: Readonly<{
     getByName: (name) => Readonly<{
        deliver: (envelope) => Promise<...>;
     }>;
  }>;
  recordCursor?: (envelope, cursor) => void;
  recordRefused?: (envelope) => void;
}>, "event" | "address">;

Current disclosure admission runs at every transport attempt, including frozen retries.

Parameters

Parameter	Type
`namespace`	`Readonly<{ getByName: (name) => Readonly<{ deliver: (envelope) => Promise<PostDeliveryResult>; }>; }>`
`replySettlement`	`AgentReplySettlement`

Returns

PostRoute<AgentMailAddress, | { from: { kind: "agent"; agentId: string; sessionId: string; }; reply?: | { commandId: string; outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown"; diagnostic?: string; } | { outcome: "accepted"; commandId: string; } | { outcome: "undeliverable"; reason: "recipient_left"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; } | { from: { kind: "system"; systemId: "hub"; }; reply: { outcome: "undeliverable"; reason: "recipient_offline"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; }, | { from: { kind: "agent"; agentId: string; sessionId: string; }; reply?: | { commandId: string; outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown"; diagnostic?: string; } | { outcome: "accepted"; commandId: string; } | { outcome: "undeliverable"; reason: "recipient_left"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; } | { from: { kind: "system"; systemId: "hub"; }; reply: { outcome: "undeliverable"; reason: "recipient_offline"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; }, AgentMailAddress, | { from: { kind: "agent"; agentId: string; sessionId: string; }; reply?: | { commandId: string; outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown"; diagnostic?: string; } | { outcome: "accepted"; commandId: string; } | { outcome: "undeliverable"; reason: "recipient_left"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; } | { from: { kind: "system"; systemId: "hub"; }; reply: { outcome: "undeliverable"; reason: "recipient_offline"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; }, | { from: { kind: "agent"; agentId: string; sessionId: string; }; reply?: | { commandId: string; outcome: "completed" | "failed" | "cancelled" | "interrupted" | "outcome_unknown"; diagnostic?: string; } | { outcome: "accepted"; commandId: string; } | { outcome: "undeliverable"; reason: "recipient_left"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; } | { from: { kind: "system"; systemId: "hub"; }; reply: { outcome: "undeliverable"; reason: "recipient_offline"; }; key: string; to: { kind: "agent"; agentId: string; sessionId?: string; }; replyTo: readonly object[]; content: string; createdAt: number; meta?: Json | undefined; }> & Omit<Readonly<{ addressKind: string; deadlineMs?: number; address: Codec<unknown, unknown>; event: Codec<unknown, unknown>; encodeEnvelope: (envelope) => object; parseDelivery: (envelope) => object; prepareEnvelope?: (envelope, signal) => Promise<{ key: string; kind: string; address: unknown; event: unknown; }>; recordDelivered?: (envelope) => void; nameOf: (envelope) => string; namespace: Readonly<{ getByName: (name) => Readonly<{ deliver: (envelope) => Promise<…>; }>; }>; recordCursor?: (envelope, cursor) => void; recordRefused?: (envelope) => void; }>, "event" | "address">

machineAgentReservations()function

function machineAgentReservations(sql): (reservation) => object;

Machine-homed Agent identities in the ordinary directory over the enrollment’s own store: one Team identity per enrollment receipt, reserved without opening a hosted Agent. The enrolling member is the grant actor.

Parameters

Parameter	Type
`sql`	`Readonly<{ exec: (statement, …bindings) => WatchdogSqliteCursor; }>`

Returns

(reservation) => object

delegation

Import

Exports

AgentDelegationCclass

Constructors

Constructor

Parameters

Returns

Methods

settlement()

Parameters

Returns

send()

Parameters

Returns

recall()

Parameters

Returns

receive()

Parameters

Returns

localUndeliverable()

Parameters

Returns

AgentDisclosureRefusedCclass

Extends

Constructors

Constructor

Returns

Overrides

AgentMailCclass

Constructors

Constructor

Parameters

Returns

Methods

send()

Parameters

Returns

stageUndeliverableReplies()

Returns

stageAcceptedNotice()

Parameters

Returns

mailRoom()

Returns

DelegationIdentityTtype alias

AgentReplySettlementTtype alias

Parameters

Returns

AgentMailPostTtype alias

machineAgentCodecsconstconstant

Type Declaration

agentMailRoute()fnfunction

Parameters

Returns

machineAgentReservations()fnfunction

Parameters

Returns

AgentDelegationclass

AgentDisclosureRefusedclass

AgentMailclass

DelegationIdentitytype alias

AgentReplySettlementtype alias

AgentMailPosttype alias

machineAgentCodecsconstant

agentMailRoute()function

machineAgentReservations()function