sandbox-boundary

Import

Import

import * as api from "@fungi.computer/mycelium/sandbox-boundary";

Exports

Kind	Export	Description
Ttype alias	SandboxBindingInput	JSON argument or the SDK’s explicit absence of an argument.
Ttype alias	SandboxOperationBindings	Host operation callbacks after decoding JSON or an absent RPC argument.
fnfunction	isSandboxFailure()	Admit only errors constructed by the sandbox owner, using the maintained decoder.
fnfunction	sandboxFailure()	Foreign throws stay private until an owner admits a diagnostic.
fnfunction	sandboxValueKind()	Label a rejected JSON value without caller-owned reflection.
fnfunction	sandboxBindingInput()	Decode the RPC argument before any capability callback observes it.
fnfunction	sandboxOperatorValue()	Full operator representation, including nested errors, aggregates and cycles.
fnfunction	sandboxGuestFailure()	Decode the engine’s guest-owned diagnostic once; renderers receive typed fields.
fnfunction	sandboxTransportMessage()	Error.message is the SDK’s wire carrier; only this safe, bounded envelope crosses it.
fnfunction	recoverSandboxFailure()	Recovery uses the decoded identity, never a match against diagnostic text.
fnfunction	sandboxExecutorFailure()	Decode Codemode’s documented error carrier before adapters choose a failure.
fnfunction	sandboxTransportErrno()	Decode a transport-owned errno without reflecting on a foreign throw in adapters.
fnfunction	sandboxSourceError()	Admit Acorn’s documented offset from a syntax exception at this boundary.
fnfunction	sandboxCapabilityFailure()	Capability owners supply an admission schema; decoding and foreign fallback stay here.
fnfunction	sandboxBindingBoundary()	One boundary owns RPC decoding, safe transport and invocation-scoped recovery.

SandboxBindingInputTtype alias

Signature

type SandboxBindingInput = MyceliumJsonValue | undefined;

JSON argument or the SDK’s explicit absence of an argument.

---

SandboxOperationBindingsTtype alias

Signature

type SandboxOperationBindings = Readonly<
  Record<
    string,
    Readonly<Record<string, (input) => Promise<MyceliumJsonValue>>>
  >
>;

Host operation callbacks after decoding JSON or an absent RPC argument.

isSandboxFailure()fnfunction

Signature

function isSandboxFailure(cause): cause is SandboxFailure;

Admit only errors constructed by the sandbox owner, using the maintained decoder.

Parameters

Parameter	Type
cause	unknown

Returns

cause is SandboxFailure

---

sandboxFailure()fnfunction

Signature

function sandboxFailure(cause): SandboxFailure;

Foreign throws stay private until an owner admits a diagnostic.

Parameters

Parameter	Type
cause	unknown

Returns

SandboxFailure

---

sandboxValueKind()fnfunction

Signature

function sandboxValueKind(value): string;

Label a rejected JSON value without caller-owned reflection.

Parameters

Parameter	Type
value	unknown

Returns

string

---

sandboxBindingInput()fnfunction

Signature

function sandboxBindingInput(value): SandboxBindingInput;

Decode the RPC argument before any capability callback observes it.

Parameters

Parameter	Type
value	unknown

Returns

SandboxBindingInput

---

sandboxOperatorValue()fnfunction

Signature

function sandboxOperatorValue(cause): JSONType;

Full operator representation, including nested errors, aggregates and cycles.

Parameters

Parameter	Type
cause	unknown

Returns

JSONType

---

sandboxGuestFailure()fnfunction

Signature

function sandboxGuestFailure(cause, bindings?): GuestThrew;

Decode the engine’s guest-owned diagnostic once; renderers receive typed fields.

Parameters

Parameter	Type
cause	unknown
bindings	Readonly<Record<string, Readonly<Record<string, SandboxBinding>>>>

Returns

GuestThrew

---

sandboxTransportMessage()fnfunction

Signature

function sandboxTransportMessage(failure, ref): string;

Error.message is the SDK’s wire carrier; only this safe, bounded envelope crosses it.

Parameters

Parameter	Type
failure	SandboxFailure
ref	string

Returns

string

---

recoverSandboxFailure()fnfunction

Signature

function recoverSandboxFailure(failure, failures): SandboxFailure;

Recovery uses the decoded identity, never a match against diagnostic text.

Parameters

Parameter	Type
failure	SandboxFailure
failures	ReadonlyMap<string, SandboxFailure>

Returns

SandboxFailure

---

sandboxExecutorFailure()fnfunction

Signature

function sandboxExecutorFailure(cause, limitMs, elapsedMs): SandboxFailure;

Decode Codemode’s documented error carrier before adapters choose a failure.

Parameters

Parameter	Type
cause	unknown
limitMs	number
elapsedMs	number

Returns

SandboxFailure

---

sandboxTransportErrno()fnfunction

Signature

function sandboxTransportErrno(cause): string | undefined;

Decode a transport-owned errno without reflecting on a foreign throw in adapters.

Parameters

Parameter	Type
cause	unknown

Returns

string | undefined

---

sandboxSourceError()fnfunction

Signature

function sandboxSourceError(cause):
  | Readonly<{
      pos: number;
    }>
  | undefined;

Admit Acorn’s documented offset from a syntax exception at this boundary.

Parameters

Parameter	Type
cause	unknown

Returns

| Readonly<{ pos: number; }> | undefined

---

sandboxCapabilityFailure()fnfunction

Signature

function sandboxCapabilityFailure(
  cause,
  namespace,
  operation,
  admitted?,
): SandboxFailure;

Capability owners supply an admission schema; decoding and foreign fallback stay here.

Parameters

Parameter	Type
cause	unknown
namespace	string
operation	string
admitted	ZodType<Readonly<{ kind: "Files" | "Forage" | "InvalidInput" | "Unavailable" | "OperationFailed"; message: string; }>>

Returns

SandboxFailure

---

sandboxBindingBoundary()fnfunction

Signature

function sandboxBindingBoundary(bindings): Readonly<{
  bindings: SandboxRequest["bindings"];
  capture: (failure) => string;
  recover: (failure) => SandboxFailure;
  returnedFailure: (value) => SandboxFailure | undefined;
}>;

One boundary owns RPC decoding, safe transport and invocation-scoped recovery.

Parameters

Parameter	Type
bindings	SandboxOperationBindings

Returns

Readonly<{ bindings: SandboxRequest["bindings"]; capture: (failure) => string; recover: (failure) => SandboxFailure; returnedFailure: (value) => SandboxFailure | undefined; }>