effect

Type Aliases

ShiitakeEffectHost

ShiitakeEffectHost = Readonly<{ agent: ShiitakeEffectAgent; acceptMail: (mail) => Effect.Effect<Accepted, ShiitakeError>>; }>

Effect-native host composition with addressed mail kept off Session.

ModelAcquisitionEffect

ModelAcquisitionEffect = Readonly<{ model: Model<Api>>; stream?: MuleStreamFunction; retryAfterMs?: (message) => number | undefined; release: Effect.Effect<void, ShiitakeError>>; }>

Effect-native acquired Pi model and finalizer.

ModelSourceEffect

ModelSourceEffect = Readonly<{ acquire: (input) => Effect.Effect<ModelAcquisitionEffect, ShiitakeError>>; }>

Effect-native model acquisition owner.

InstructionSourceEffect

InstructionSourceEffect = Readonly<{ load: (input) => Effect.Effect<InstructionSnapshot, ShiitakeError, Scope.Scope>>; }>

Effect-native instruction snapshot owner.

ToolSourceEffect

ToolSourceEffect = Readonly<{ execution?: ExecutionOptions; modules: readonly ModuleRegistration[]; sources: readonly CapabilitySource[]; sandbox: Sandbox; }>

Effect-native Mycelium construction inputs.

RuntimeHostEffect

RuntimeHostEffect = Readonly<{ bind: (input) => Effect.Effect<Readonly<{ commit: <A>>(mutation) => Effect.Effect<A, ShiitakeError>>; requestWake: Effect.Effect<void, ShiitakeError>>; close: Effect.Effect<void, ShiitakeError>>; }>, ShiitakeError>>; }>

Effect-native owner for scheduling the opaque durable reconciler.

ShiitakeEffectOptions

ShiitakeEffectOptions = Readonly<{ store: SqliteOwner; hostJobs?: Readonly<{ lane: string; open: (runtime) => Readonly<{ execute: (job) => Effect.Effect<WatchdogExecutionDecision, WatchdogError>>; }>; }>; model: ModelSourceEffect; instructions: InstructionSourceEffect; tools?: ToolSourceEffect; files?: FilesSurface; gateTool?: (input) => OperationGate; runtime: RuntimeHostEffect; extensions: ExtensionRosterV0; retry?: RetryPolicy; modelStreamIdleTimeoutMs?: number; }>

Validated construction bag for owned Effect composition.

ShiitakeEffectWatch

ShiitakeEffectWatch = Readonly<{ snapshot: SessionSnapshot; changes: Stream.Stream<SessionFrame, ShiitakeError>>; close: Effect.Effect<void, ShiitakeError>>; }>

Effect-native race-safe watch result.

ShiitakeEffectCommandHandler

ShiitakeEffectCommandHandler = {(input): Effect<Readonly<{ status: "accepted"; commandId: string; }>, ShiitakeError>>; (input): Effect<CancelResult, ShiitakeError>>; (input): Effect<undefined, ShiitakeError>>; (input): Effect<Readonly<{ sessionId: string; }>, ShiitakeError>>; (input): Effect<CancelResult | Readonly<{ sessionId: string; }> | undefined, ShiitakeError>>; }

Effect-native addressable Session handle.

Call Signature

(input): Effect<Readonly<{ status: "accepted"; commandId: string; }>, ShiitakeError>>

Accept one durable prompt command.

Parameters

input

delivery

"followUp" | "steer" = PromptDeliverySchema

requestId

string = boundedId

type

"prompt" = ...

text

string = PromptTextSchema

Returns

Effect<Readonly<{ status: "accepted"; commandId: string; }>, ShiitakeError>

Call Signature

(input): Effect<CancelResult, ShiitakeError>>

Cancel one accepted command, or report that it is too late.

Parameters

input

commandId

string = boundedId

onlyIfPending?

boolean = ...

type

"cancel" = ...

Returns

Effect<CancelResult, ShiitakeError>

Call Signature

(input): Effect<undefined, ShiitakeError>>

Abort the active run, select a lineage leaf, or record an operator line.

Parameters

input

{ type: "abort"; } | { type: "branch"; entryId: string; } | { type: "operator"; requestId: string; author: "operator" | "party"; text: string; }

Returns

Effect<undefined, ShiitakeError>

Call Signature

(input): Effect<Readonly<{ sessionId: string; }>, ShiitakeError>>

Fork one complete entry lineage into a new Session.

Parameters

input

type

"fork" = ...

entryId

string = boundedId

Returns

Effect<Readonly<{ sessionId: string; }>, ShiitakeError>

Call Signature

(input): Effect<CancelResult | Readonly<{ sessionId: string; }> | undefined, ShiitakeError>>

Execute an already-decoded command union.

Parameters

input

{ delivery: "followUp" | "steer"; requestId: string; type: "prompt"; text: string; } | { type: "abort"; } | { commandId: string; onlyIfPending?: boolean; type: "cancel"; } | { type: "branch"; entryId: string; } | { type: "fork"; entryId: string; } | { type: "operator"; requestId: string; author: "operator" | "party"; text: string; }

Returns

Effect<CancelResult | Readonly<{ sessionId: string; }> | undefined, ShiitakeError>

ShiitakeEffectSendOptions

ShiitakeEffectSendOptions = Readonly<{ delivery?: PromptDelivery; requestId?: string; }>

Delivery intent and an optional private retry key for Effect-native sending.

ShiitakeEffectSession

ShiitakeEffectSession = Readonly<{ command: ShiitakeEffectCommandHandler; abort: Effect.Effect<void, ShiitakeError>>; send: (text, options?) => Effect.Effect<Accepted, ShiitakeError>>; cancel: (input) => Effect.Effect<CancelResult, ShiitakeError>>; extension: (extensionId) => ShiitakeEffectSessionExtension; modelPreference: Readonly<{ read: Effect.Effect<ModelPreference | null, ShiitakeError>>; set: (preference) => Effect.Effect<void, ShiitakeError>>; }>; read: (input?) => Effect.Effect<SessionSnapshot, ShiitakeError>>; subscribe: (input) => Stream.Stream<SessionFrame, ShiitakeError>>; watch: (input?) => Effect.Effect<ShiitakeEffectWatch, ShiitakeError>>; }>

Effect-native addressable Session handle.

ShiitakeEffectSessionExtension

ShiitakeEffectSessionExtension = Readonly<{ call: (command, input) => Effect.Effect<Json, ShiitakeError>>; }>

Effect-native Session-scope extension commands.

ShiitakeEffectAgentExtensions

ShiitakeEffectAgentExtensions = Readonly<{ list: Effect.Effect<readonly ExtensionStatusV0[], ShiitakeError>>; resume: (extensionId) => Effect.Effect<ExtensionStatusV0, ShiitakeError>>; call: (extensionId, command, input) => Effect.Effect<Json, ShiitakeError>>; }>

Effect-native Agent-scope extension controls.

ShiitakeEffectAgent

ShiitakeEffectAgent = Readonly<{ createSession: (requestId) => Effect.Effect<string, ShiitakeError>>; deleteSession: (sessionId) => Effect.Effect<boolean, ShiitakeError>>; listSessions: (after?) => Effect.Effect<SessionSummaryPage, ShiitakeError>>; extensions: ShiitakeEffectAgentExtensions; session: (sessionId) => ShiitakeEffectSession; close: Effect.Effect<void, ShiitakeError>>; }>

Effect-native durable harness.

StoredSessionSummary

StoredSessionSummary = Readonly<{ createdAt: number; updatedAt: number; title: string; }>

Persisted conversation facts; run status belongs to the Session’s owner.

StoredSessionSummaryRow

StoredSessionSummaryRow = StoredSessionSummary & Readonly<{ kind: "session"; sessionId: string; }> | Readonly<{ kind: "unavailable"; sessionId: string; }>

One persisted conversation’s stored facts, or a row that could not be read.

StoredSessionSummaryPage

StoredSessionSummaryPage = Readonly<{ sessions: readonly StoredSessionSummaryRow[]; next: string | undefined; }>

One page of stored conversation facts, in stable Session identity order.

Functions

make()

make(options): Effect<Readonly<{ createSession: (requestId) => Effect<string, ShiitakeError>>; deleteSession: (sessionId) => Effect<boolean, ShiitakeError>>; listSessions: (after?) => Effect<Readonly<{ sessions: readonly SessionSummaryRow[]; next: string | undefined; }>, ShiitakeError>>; extensions: ShiitakeEffectAgentExtensions; session: (sessionId) => ShiitakeEffectSession; close: Effect<void, ShiitakeError>>; }>, ShiitakeError>>

Construct the canonical Effect-native Shiitake scaffold.

Parameters

options

ShiitakeEffectOptions

Returns

Effect<Readonly<{ createSession: (requestId) => Effect<string, ShiitakeError>; deleteSession: (sessionId) => Effect<boolean, ShiitakeError>; listSessions: (after?) => Effect<Readonly<{ sessions: readonly SessionSummaryRow[]; next: string | undefined; }>, ShiitakeError>; extensions: ShiitakeEffectAgentExtensions; session: (sessionId) => ShiitakeEffectSession; close: Effect<void, ShiitakeError>; }>, ShiitakeError>

openHost()

openHost(options, mailRoom): Effect<Readonly<{ agent: ShiitakeEffectAgent; acceptMail: (mail) => Effect<Readonly<{ status: "accepted"; commandId: string; }>, ShiitakeError>>; }>, ShiitakeError>>

Open the Effect-native host composition with addressed mail.

Parameters

options

ShiitakeEffectOptions

mailRoom

BirdDogEffect

Returns

Effect<Readonly<{ agent: ShiitakeEffectAgent; acceptMail: (mail) => Effect<Readonly<{ status: "accepted"; commandId: string; }>, ShiitakeError>; }>, ShiitakeError>

readSessionSummaries()

readSessionSummaries(owner, after?): Effect<Readonly<{ sessions: readonly StoredSessionSummaryRow[]; next: string | undefined; }>, ShiitakeError, never>>

Enumerate saved conversations’ stored facts in bounded pages, for readers that hold only the store. Run status is not stored; use the Agent’s listSessions for it. An unreadable Session is its own unavailable row.