remote

Import

Import

import * as api from "@fungi.computer/mycelium/remote";

Exports

Kind	Export	Description
Ttype alias	RemoteOperationDescriptor	One operation’s model-facing contract with its schemas as JSON Schema.
Ttype alias	RemoteModuleDescriptor	A module’s operations keyed by their dotted path below the module, for a host that runs the module in another isolate. Identity, alias and placement stay the host’s decision; this carries only what the model may call.
fnfunction	describeModule()	Project one module’s callable surface; unrepresentable schemas throw.
fnfunction	invokeModuleOperation()	Run one described operation through its own input and output schemas.
fnfunction	remoteModule()	Rebuild a described module on the host side. Each operation parses its input and output against the described JSON Schema, then forwards to invoke.

RemoteOperationDescriptorTtype alias

Signature

type RemoteOperationDescriptor = Readonly<{
  replay: "safe" | "unsafe";
  description?: string;
  input: MyceliumJsonValue;
  output: MyceliumJsonValue | null;
}>;

One operation’s model-facing contract with its schemas as JSON Schema.

---

RemoteModuleDescriptorTtype alias

Signature

type RemoteModuleDescriptor = Readonly<{
  description?: string;
  operations: Readonly<Record<string, RemoteOperationDescriptor>>;
}>;

A module’s operations keyed by their dotted path below the module, for a host that runs the module in another isolate. Identity, alias and placement stay the host’s decision; this carries only what the model may call.

describeModule()fnfunction

Signature

function describeModule(registration): RemoteModuleDescriptor;

Project one module’s callable surface; unrepresentable schemas throw.

Parameters

Parameter	Type
registration	ModuleRegistration

Returns

RemoteModuleDescriptor

---

invokeModuleOperation()fnfunction

Signature

function invokeModuleOperation(
  registration,
  path,
  input,
  context,
): Promise<JSONType>;

Run one described operation through its own input and output schemas.

Parameters

Parameter	Type
registration	ModuleRegistration
path	string
input	unknown
context	InvocationContext

Returns

Promise<JSONType>

---

remoteModule()fnfunction

Signature

function remoteModule(options): ModuleRegistration;

Rebuild a described module on the host side. Each operation parses its input and output against the described JSON Schema, then forwards to invoke.

Parameters

Parameter	Type
options	Readonly<{ id: string; name: string; descriptor: RemoteModuleDescriptor; invoke: (path, input, context) => Promise<MyceliumJsonValue>; }>

Returns

ModuleRegistration