index
@fungi.computer/shiitake / index
Classes
Section titled “Classes”ShiitakeError
Section titled “ShiitakeError”Sanitized failure from a parsed Shiitake boundary.
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShiitakeError(
boundary,cause,message,requestId?):ShiitakeError
Construct a sanitized boundary failure.
Parameters
Section titled “Parameters”boundary
Section titled “boundary”"contract" | "extensions" | "instructions" | "model" | "runtime"
| "store" | "tools"
Boundary that rejected the operation.
"unavailable" | "invalid" | "conflict" | "closed" | "rejected"
Safe category describing why it was rejected.
message
Section titled “message”string
Human-readable message safe for callers to display.
requestId?
Section titled “requestId?”string
Request identity recoverable when a send may have reached the owner.
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”
readonly_tag:"ShiitakeError"
Stable runtime tag for typed Shiitake failures.
boundary
Section titled “boundary”
readonlyboundary:"contract"|"extensions"|"instructions"|"model"|"runtime"|"store"|"tools"
Boundary that rejected the operation.
readonlycause:"unavailable"|"invalid"|"conflict"|"closed"|"rejected"
Safe category describing why it was rejected.
Inherited from
Section titled “Inherited from”Error.cause
requestId?
Section titled “requestId?”
readonlyoptionalrequestId?:string
Request identity recoverable when a send may have reached the owner.
Type Aliases
Section titled “Type Aliases”ShiitakeErrorBoundary
Section titled “ShiitakeErrorBoundary”ShiitakeErrorBoundary =
Schema.Schema.Type<typeofShiitakeErrorBoundarySchema>>
Stable boundary that rejected a Shiitake operation.
ShiitakeErrorCause
Section titled “ShiitakeErrorCause”ShiitakeErrorCause =
Schema.Schema.Type<typeofShiitakeErrorCauseSchema>>
Safe failure category exposed by both Shiitake facades.
ShiitakeApi
Section titled “ShiitakeApi”ShiitakeApi =
Readonly<{make: (options) =>Promise<ShiitakeAgent>>; }>
Public construction namespace for the Promise-facing durable harness.
ShiitakeHost
Section titled “ShiitakeHost”ShiitakeHost =
Readonly<{agent:ShiitakeAgent;acceptMail: (Promise<Accepted>>; }>
Promise-facing host composition with addressed mail kept off Session.
PromptDelivery
Section titled “PromptDelivery”PromptDelivery =
"steer"|"followUp"
Delivery policy for input accepted while a Session run is active.
SessionCommand
Section titled “SessionCommand”SessionCommand =
Schema.Schema.Type<typeofSessionCommandSchema>>
Public Session command inferred from its one runtime parser.
PromptCommand
Section titled “PromptCommand”PromptCommand =
Schema.Schema.Type<typeofPromptCommandSchema>>
Public prompt command accepted as durable Session work.
AbortCommand
Section titled “AbortCommand”AbortCommand =
Schema.Schema.Type<typeofAbortCommandSchema>>
Public fast-path command that aborts the active Session run.
CancelCommand
Section titled “CancelCommand”CancelCommand =
Schema.Schema.Type<typeofCancelCommandSchema>>
Public command that cancels exactly one accepted request.
BranchCommand
Section titled “BranchCommand”BranchCommand =
Extract<SessionCommand,Readonly<{type:"branch"; }>>
Public command that selects one complete entry as the active lineage leaf.
ForkCommand
Section titled “ForkCommand”ForkCommand =
Extract<SessionCommand,Readonly<{type:"fork"; }>>
Public command that creates a new Session from one complete entry lineage.
SqliteValue
Section titled “SqliteValue”SqliteValue =
ArrayBuffer|string|number|null
Values accepted by the native SQLite owner binding.
SqliteCursor
Section titled “SqliteCursor”SqliteCursor<
Row> > =Readonly<{toArray: () => readonlyRow[];one: () =>Row; }>
Small structural projection of a native SQLite result cursor.
Type Parameters
Section titled “Type Parameters”Row extends Record<string, SqliteValue> =
Record<string, SqliteValue>
SqliteOwner
Section titled “SqliteOwner”SqliteOwner =
Readonly<{sql:Readonly<{exec: <Row>>(statement, …bindings) =>SqliteCursor<Row>>; }>;transactionSync: <A>>(closure) =>A; }>
Native owner capability adapted once by private Woodstock.
The callback is deliberately synchronous: Durable Object transactionSync is
the only transaction authority for this package.
ModelAcquisition
Section titled “ModelAcquisition”ModelAcquisition =
Readonly<{model:Model<Api>>;stream?:MuleStreamFunction;release: () =>Promise<void>>; }>
Acquired Pi model and optional explicit Pi stream function.
ModelSource
Section titled “ModelSource”ModelSource =
Readonly<{acquire: (input) =>Promise<ModelAcquisition>>; }>
Deterministic host seam for model selection and ready egress.
InstructionSnapshot
Section titled “InstructionSnapshot”InstructionSnapshot =
Readonly<{revision:string;text:string;modules?: readonlyModuleRegistration[];release?: () =>void; }>
Immutable instruction snapshot captured for one run.
InstructionSource
Section titled “InstructionSource”InstructionSource =
Readonly<{load: (input) =>Promise<InstructionSnapshot>>; }>
Host seam for one bounded instruction snapshot.
ToolSource
Section titled “ToolSource”ToolSource =
Readonly<{fileTools?: readonlyMuleTool[];modules?: readonlyModuleRegistration[];sources?: readonlyCapabilitySource[];sandbox:Sandbox; }>
Mycelium construction inputs captured by the Shiitake-owned run scope.
RuntimePendingWork
Section titled “RuntimePendingWork”RuntimePendingWork =
Readonly<{pending:boolean;nextWakeAt:number|null; }>
Promise host for scheduling the opaque durable reconciler.
RuntimeHost
Section titled “RuntimeHost”RuntimeHost =
Readonly<{bind: (input) =>Promise<Readonly<{commit: <A>>(mutation) =>Promise<A>>;requestWake: () =>Promise<void>>;close: () =>Promise<void>>; }>>; }>
Promise host for scheduling the opaque durable reconciler.
ShiitakeOptions
Section titled “ShiitakeOptions”ShiitakeOptions =
Readonly<{store:SqliteOwner;runtime:RuntimeHost;model:ModelSource;instructions:InstructionSource;tools?:ToolSource;extensions:ExtensionRosterV1; }>
Validated immutable construction bag for the durable harness.
ModelPreference
Section titled “ModelPreference”ModelPreference =
Schema.Schema.Type<typeofModelPreferenceSchema>>
Null at the Session boundary means inherit the Agent default.
Variables
Section titled “Variables”Shiitake
Section titled “Shiitake”
constShiitake:ShiitakeApi
Construct the Promise facade over the canonical Effect program.
Functions
Section titled “Functions”parseForkedSession()
Section titled “parseForkedSession()”parseForkedSession(
value):ForkedSession
Parse one serialized fork result using Shiitake’s public client grammar.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”parseSessionSnapshot()
Section titled “parseSessionSnapshot()”parseSessionSnapshot(
value):SessionSnapshot
Parse one serialized snapshot using Shiitake’s public client grammar.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”parseSessionFrame()
Section titled “parseSessionFrame()”parseSessionFrame(
value):SessionFrame
Parse one serialized frame using Shiitake’s public client grammar.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”makeHost()
Section titled “makeHost()”makeHost(
options,mailRoom):Promise<Readonly<{agent:ShiitakeAgent;acceptMail: (Promise<Readonly<{status:"accepted";commandId:string; }>>; }>>
Construct the host-only Promise facade over the canonical Effect program.
Parameters
Section titled “Parameters”options
Section titled “options”mailRoom
Section titled “mailRoom”BirdDogEffect
Returns
Section titled “Returns”Promise<Readonly<{ agent: ShiitakeAgent;
acceptMail: (mail) => Promise<Readonly<{ status: "accepted";
commandId: string; }>>; }>>
References
Section titled “References”AgentExtensionControls
Section titled “AgentExtensionControls”Re-exports AgentExtensionControls
Accepted
Section titled “Accepted”Re-exports Accepted
ForkedSession
Section titled “ForkedSession”Re-exports ForkedSession
SendOptions
Section titled “SendOptions”Re-exports SendOptions
ReadOptions
Section titled “ReadOptions”Re-exports ReadOptions
SessionCommandHandler
Section titled “SessionCommandHandler”Re-exports SessionCommandHandler
SessionExtensionControls
Section titled “SessionExtensionControls”Re-exports SessionExtensionControls
SessionExtensionSlots
Section titled “SessionExtensionSlots”Re-exports SessionExtensionSlots
SessionFrame
Section titled “SessionFrame”Re-exports SessionFrame
SessionMessage
Section titled “SessionMessage”Re-exports SessionMessage
SessionProgress
Section titled “SessionProgress”Re-exports SessionProgress
SessionSnapshot
Section titled “SessionSnapshot”Re-exports SessionSnapshot
SessionSummary
Section titled “SessionSummary”Re-exports SessionSummary
SessionSummaryPage
Section titled “SessionSummaryPage”Re-exports SessionSummaryPage
SessionSummaryRow
Section titled “SessionSummaryRow”Re-exports SessionSummaryRow
SessionStatus
Section titled “SessionStatus”Re-exports SessionStatus
SessionTerminal
Section titled “SessionTerminal”Re-exports SessionTerminal
ShiitakeEventSourceConstructor
Section titled “ShiitakeEventSourceConstructor”Re-exports ShiitakeEventSourceConstructor
SessionWatch
Section titled “SessionWatch”Re-exports SessionWatch
ShiitakeAgent
Section titled “ShiitakeAgent”Re-exports ShiitakeAgent
ShiitakeSession
Section titled “ShiitakeSession”Re-exports ShiitakeSession
SubscribeOptions
Section titled “SubscribeOptions”Re-exports SubscribeOptions
WatchOptions
Section titled “WatchOptions”Re-exports WatchOptions
BorrowedCompactionViewV1
Section titled “BorrowedCompactionViewV1”Re-exports BorrowedCompactionViewV1
CompactionHandoffErrorV1
Section titled “CompactionHandoffErrorV1”Re-exports CompactionHandoffErrorV1
CompactionHandoffResultV1
Section titled “CompactionHandoffResultV1”Re-exports CompactionHandoffResultV1
CompactionHandoffV1
Section titled “CompactionHandoffV1”Re-exports CompactionHandoffV1
ExtensionCapabilityV1
Section titled “ExtensionCapabilityV1”Re-exports ExtensionCapabilityV1
ExtensionGrantV1
Section titled “ExtensionGrantV1”Re-exports ExtensionGrantV1
ExtensionRosterV1
Section titled “ExtensionRosterV1”Re-exports ExtensionRosterV1
ExtensionSlotV1
Section titled “ExtensionSlotV1”Re-exports ExtensionSlotV1
ExtensionStatusV1
Section titled “ExtensionStatusV1”Re-exports ExtensionStatusV1
RosteredExtensionV1
Section titled “RosteredExtensionV1”Re-exports RosteredExtensionV1