cloudflare

Import

Import

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

Exports

Kind	Export	Description
Cclass	abstract ShiitakeOwner	Owns runtime opening, HTTP/ACP transport, inbox observation and alarm recovery.
Cclass	abstract ShiitakeDO	Native Cloudflare entry points; all runtime lifetime belongs to the owner.
Ttype alias	CloudflareShiitakeState	Native Durable Object capabilities used by the Cloudflare adapter.
Ttype alias	CloudflareShiitakeTools	Non-empty Mycelium capabilities supplied by a Cloudflare host.
Ttype alias	CloudflareHostWork	Durable host work that shares Shiitake’s one native alarm, such as a host-owned delivery outbox. Shiitake never interprets it.
Ttype alias	CloudflareHostJobs	Host jobs use a separate slot in Shiitake’s one Watchdog and native alarm.
Ttype alias	CloudflareShiitakeAcpServer	ACP’s maintained transport, supplied by the host without a package cycle.
Ttype alias	CloudflareShiitakeOptions	Cloudflare host inputs; the model owner resolves one frozen run selection.
Ttype alias	CloudflareShiitake	Cloudflare host lifecycle; alarm forwarding stays outside the neutral client.
Ttype alias	SessionInboxChanges	Revisioned Session inbox changes after one owner revision, oldest first.
fnfunction	deliverSessionGrantsToStorage()	Deliver one Session’s grants into a Cloudflare owner’s own storage, synchronously, whether or not its runtime is open; the very next tool call reads it. A plain function, not a Durable Object method, so no other Durable Object can call it over RPC: only code running inside the owner, holding its storage, delivers grants.
fnfunction	makeCloudflareShiitake()	Open Shiitake over one Durable Object’s storage. It resolves once the runtime is started and initialize has run; if initialize throws, the runtime is closed and the error is rethrown.

abstract ShiitakeOwnerCclass

Owns runtime opening, HTTP/ACP transport, inbox observation and alarm recovery.

Type Parameters

Type Parameter	Default type
Env	-
State extends CloudflareShiitakeState	CloudflareShiitakeState

Constructors

Constructor

Signature

new ShiitakeOwner<Env, State>(ctx, env): ShiitakeOwner<Env, State>;

Parameters

Parameter	Type
ctx	State
env	Env

Returns

ShiitakeOwner<Env, State>

Methods

shiitake()

Signature

shiitake(): Promise<CloudflareShiitake>;

Borrow this owner’s runtime directly; only the host owns its lifetime.

Returns

Promise<CloudflareShiitake>

abortActiveSessions()

Signature

abortActiveSessions(): Promise<void>;

Stop live execution without constructing a cold owner’s runtime.

Returns

Promise<void>

closeShiitake()

Signature

closeShiitake(): Promise<void>;

Close owned resources before storage erasure; a cold owner has none.

Returns

Promise<void>

hasStoredSession()

Signature

hasStoredSession(sessionId): Promise<boolean>;

Indexed owner-local existence check; corrupt stored Sessions remain unavailable.

Parameters

Parameter	Type
sessionId	string

Returns

Promise<boolean>

readInboxChanges()

Signature

readInboxChanges(after, limit): Promise<Readonly<{
  rows: readonly (
     | SessionSummaryRow
     | Readonly<{
     sessionId: string;
     deleted: true;
  }>)[];
  through: number;
  latest: number;
}>>;

Bounded strict-after read of this Agent’s changed inbox rows.

Parameters

Parameter	Type
after	number
limit	number

Returns

Promise<Readonly<{ rows: readonly ( | SessionSummaryRow | Readonly<{ sessionId: string; deleted: true; }>)[]; through: number; latest: number; }>>

readColdSessions()

Signature

readColdSessions(request): Promise<Readonly<{
  sessions: readonly Readonly<{
     sessionId: string;
     bytes: number;
     lastActivityAt: number;
     idle: boolean;
  }>[];
  next?: string;
}>>;

One bounded, read-only page of Sessions with stored bytes, last activity and an idle flag, coldest first. The store keeper’s only view of cold Sessions; it carries no SQL, transaction or write.

Parameters

Parameter	Type
request	ColdSessionPageRequest

Returns

Promise<Readonly<{ sessions: readonly Readonly<{ sessionId: string; bytes: number; lastActivityAt: number; idle: boolean; }>[]; next?: string; }>>

readInboxRevision()

Signature

readInboxRevision(): number;

Latest inbox revision; read only after the owner has opened.

Returns

number

pruneInboxTombstones()

Signature

pruneInboxTombstones(through): void;

Prune deletion deltas after every current member inbox has acknowledged them.

Parameters

Parameter	Type
through	number

Returns

void

wakeRuntime()

Signature

wakeRuntime(): Promise<void>;

Persist a wake and run one reconciliation pass, including host work.

Returns

Promise<void>

alarm()

Signature

alarm(): Promise<void>;

Native alarms reconstruct the owner without an incoming user request. A construction or wake failure must not strand the claimed work on platform alarm retries: it is caught, logged, and explicitly re-armed with bounded backoff instead.

Returns

Promise<void>

fetch()

Signature

fetch(request): Promise<Response>;

Serve one request through Shiitake’s whole HTTP surface.

Parameters

Parameter	Type
request	Request

Returns

Promise<Response>

---

abstract ShiitakeDOCclass

Native Cloudflare entry points; all runtime lifetime belongs to the owner.

Extends

• DurableObject<Env>

Type Parameters

Type Parameter
Env

Constructors

Constructor

Signature

new ShiitakeDO<Env>(ctx, env): ShiitakeDO<Env>;

Parameters

Parameter	Type
ctx	DurableObjectState
env	Env

Returns

ShiitakeDO<Env>

Inherited from

Signature

DurableObject<Env>.constructor

Methods

alarm()

Signature

alarm(): Promise<void>;

Reconcile due runtime and host work through the owner.

Returns

Promise<void>

Overrides

Signature

DurableObject.alarm;

fetch()

Signature

fetch(request): Promise<Response>;

Route an authenticated client request through the host’s routes, then the owner.

Parameters

Parameter	Type
request	Request

Returns

Promise<Response>

Overrides

Signature

DurableObject.fetch;

CloudflareShiitakeStateTtype alias

Signature

type CloudflareShiitakeState = Readonly<{
  storage: SqliteOwner &
    Pick<DurableObjectStorage, "getAlarm" | "setAlarm" | "deleteAlarm"> &
    object;
  waitUntil: (task) => void;
  id?: Readonly<{
    toString: () => string;
  }>;
}>;

Native Durable Object capabilities used by the Cloudflare adapter.

---

CloudflareShiitakeToolsTtype alias

Signature

type CloudflareShiitakeTools = Readonly<{
  modules?: readonly ModuleRegistration[];
  sources?: readonly CapabilitySource[];
  sandbox: Sandbox;
  access?: ToolAccess;
}>;

Non-empty Mycelium capabilities supplied by a Cloudflare host.

---

CloudflareHostWorkTtype alias

Signature

type CloudflareHostWork = Readonly<{
  pending: () => Readonly<{
    due: boolean;
    nextWakeAt: number | null;
  }>;
  run: () => Promise<void>;
}>;

Durable host work that shares Shiitake’s one native alarm, such as a host-owned delivery outbox. Shiitake never interprets it.

---

CloudflareHostJobsTtype alias

Signature

type CloudflareHostJobs = Readonly<{
  lane: string;
  open: (runtime) => Readonly<{
    execute: (job) => Promise<WatchdogExecutionDecision>;
  }>;
}>;

Host jobs use a separate slot in Shiitake’s one Watchdog and native alarm.

---

CloudflareShiitakeAcpServerTtype alias

Signature

type CloudflareShiitakeAcpServer = Readonly<{
  handleRequest: (request, meta) => Promise<Response>;
}>;

ACP’s maintained transport, supplied by the host without a package cycle.

---

CloudflareShiitakeOptionsTtype alias

Signature

type CloudflareShiitakeOptions = Readonly<{
  meta?: HostMetaOptions;
  model: ModelSource;
  instructions: InstructionSource;
  tools?: readonly [] | CloudflareShiitakeTools;
  storagePressure?: StoragePressureCheck;
  compaction?: CompactionOptions;
  extensions: ExtensionRosterV0;
  initialize?: (agent) => Promise<void>;
  hostWork?: readonly CloudflareHostWork[];
  hostJobs?: CloudflareHostJobs;
  mailRoom?: BirdDogEffect;
  acp?: (agent) => Promise<CloudflareShiitakeAcpServer>;
}>;

Cloudflare host inputs; the model owner resolves one frozen run selection.

---

CloudflareShiitakeTtype alias

Signature

type CloudflareShiitake = ShiitakeOwnerAgent &
  Readonly<{
    readSettlement: (
      sessionId,
      commandId,
    ) => Promise<CommandSettlement | undefined>;
    acceptMail: (
      mail,
      meta?,
      reply?,
      stageAcceptedNotice?,
      sessionGrantDelivery?,
    ) => Promise<Accepted>;
    alarm: () => Promise<void>;
    activeSessions: () => Promise<readonly string[]>;
    abortActive: () => Promise<void>;
  }>;

Cloudflare host lifecycle; alarm forwarding stays outside the neutral client.

---

SessionInboxChangesTtype alias

Signature

type SessionInboxChanges = Readonly<{
  rows: readonly (
    | SessionSummaryRow
    | Readonly<{
        sessionId: string;
        deleted: true;
      }>
  )[];
  through: number;
  latest: number;
}>;

Revisioned Session inbox changes after one owner revision, oldest first.

deliverSessionGrantsToStorage()fnfunction

Signature

function deliverSessionGrantsToStorage(
  storage,
  sessionId,
  delivery,
): GrantsDeliveryResult;

Deliver one Session’s grants into a Cloudflare owner’s own storage, synchronously, whether or not its runtime is open; the very next tool call reads it. A plain function, not a Durable Object method, so no other Durable Object can call it over RPC: only code running inside the owner, holding its storage, delivers grants.

Parameters

Parameter	Type
storage	SqliteOwner
sessionId	string
delivery	GrantsDelivery

Returns

GrantsDeliveryResult

---

makeCloudflareShiitake()fnfunction

Signature

function makeCloudflareShiitake(unnamed, options): Promise<CloudflareShiitake>;

Open Shiitake over one Durable Object’s storage. It resolves once the runtime is started and initialize has run; if initialize throws, the runtime is closed and the error is rethrown.

Parameters

Parameter	Type
unnamed	CloudflareShiitakeState
options	CloudflareShiitakeOptions

Returns

Promise<CloudflareShiitake>

References

ColdSessionPage

Re-exports ColdSessionPage

---

ColdSessionPageRequest

Re-exports ColdSessionPageRequest

---

ColdSessionRow

Re-exports ColdSessionRow

---

GrantsDelivery

Re-exports GrantsDelivery

---

GrantsDeliveryResult

Re-exports GrantsDeliveryResult

---

ShiitakeOwnerAgent

Re-exports ShiitakeOwnerAgent

---

ToolAccess

Re-exports ToolAccess