backend-definition

Import

Import

import * as api from "@fungi.computer/agar/backend-definition";

Exports

Kind	Export	Description
Ttype alias	AppSendBudgetRefusal	A declined Session send, with how long to wait before retrying.
Ttype alias	MethodPolicy	A method’s schemas own both its TypeScript contract and JSON boundary.
Ttype alias	ResultRowCodec	Decodes and bounds result rows; see resultRows in @fungi.computer/agar/method-presentation.
Ttype alias	MethodPresentation	How a finished call reads to a person: a pure projection run in the App backend. rows is resultRows from @fungi.computer/agar/method-presentation; only a backend that presents imports it, so one without presentations carries no row decoder.
Ttype alias	AppBackendMethod	Prepared method export consumed by the backend and its build.
Ttype alias	AppBackendMethods	The prepared methods of one backend, keyed by their public names.
Ttype alias	AppBackendClass	Typed backend export shared by a build and its runtime method admission.
Ttype alias	AppBackendDefinition	A backend’s full generated API: its declared methods, the facet installer, and runtime dispatch by method name.
constconstant	appEventEmitResultSchema	EVENTS.emit acknowledges delivery with native void, not a JSON value.
constconstant	appSendBudgetRefusalSchema	App-originated Session send refusal; retry advice is a duration, not a timestamp.
constconstant	presentMethodName	Name of the generated, hidden read method that projects a finished call into its row.
fnfunction	defineAppMethod()	Define a typed method once; neither discovery nor builds execute its handler.
fnfunction	defineAppBackend()	Generate the API from the method exports; callers cannot supply a second catalog.

AppSendBudgetRefusalTtype alias

Signature

type AppSendBudgetRefusal = z.output<typeof appSendBudgetRefusalSchema>;

A declined Session send, with how long to wait before retrying.

---

MethodPolicyTtype alias

Signature

type MethodPolicy = Readonly<{
  description: string;
  effect: "read" | "write" | "external";
  requires: readonly AppCapabilityId[];
  hidden?: true;
  anonymous?: true;
  pending?: true;
  present?: Readonly<{
    verb: string;
  }>;
}>;

A method’s schemas own both its TypeScript contract and JSON boundary.

---

ResultRowCodecTtype alias

Signature

type ResultRowCodec = Readonly<{
  decode: (row) => ResultRow;
  schema: z.ZodType;
}>;

Decodes and bounds result rows; see resultRows in @fungi.computer/agar/method-presentation.

---

MethodPresentationTtype alias

Signature

type MethodPresentation<I, O> = Readonly<{
  verb: string;
  row: (call) => ResultRow;
  rows: ResultRowCodec;
}>;

How a finished call reads to a person: a pure projection run in the App backend. rows is resultRows from @fungi.computer/agar/method-presentation; only a backend that presents imports it, so one without presentations carries no row decoder.

Type Parameters

Type Parameter
I
O

---

AppBackendMethodTtype alias

Signature

type AppBackendMethod<Context> = Readonly<{
  policy: MethodPolicy;
  input: z.ZodType;
  output: z.ZodType;
  present?: (input, output) => ResultRow;
  presentRow?: z.ZodType;
  call: (input, context, caller) => Promise<WhistleJsonValue>;
}>;

Prepared method export consumed by the backend and its build.

Type Parameters

Type Parameter	Default type
Context	void

---

AppBackendMethodsTtype alias

Signature

type AppBackendMethods<Context> = Readonly<
  Record<string, AppBackendMethod<Context>>
>;

The prepared methods of one backend, keyed by their public names.

Type Parameters

Type Parameter	Default type
Context	void

---

AppBackendClassTtype alias

Signature

type AppBackendClass = (...args) => object & object;

Typed backend export shared by a build and its runtime method admission.

Type Declaration

Name	Type
prototype	object

---

AppBackendDefinitionTtype alias

Signature

type AppBackendDefinition<Context> = Readonly<{
  methods: Readonly<Record<string, AppBackendMethod<Context>>>;
  sync?: Readonly<{
    method: string;
  }>;
  gills?: readonly AppBackendGill[];
  gill: (input, context, caller) => Promise<GillReply>;
  toolFamily?: AppApi["toolFamily"];
  events?: Readonly<
    Record<
      string,
      Readonly<{
        description: string;
        payload: z.ZodType;
      }>
    >
  >;
  implement: <C>(implementation) => C;
  call: (method, input, context, caller) => Promise<WhistleJsonValue>;
}>;

A backend’s full generated API: its declared methods, the facet installer, and runtime dispatch by method name.

Type Parameters

Type Parameter	Default type
Context	void

appEventEmitResultSchemaconstconstant

Signature

const appEventEmitResultSchema: ZodUndefined;

EVENTS.emit acknowledges delivery with native void, not a JSON value.

---

appSendBudgetRefusalSchemaconstconstant

Signature

const appSendBudgetRefusalSchema: ZodLazy<
  ZodObject<
    {
      error: ZodLiteral<"send_budget_exceeded">;
      retryAfterMs: ZodNumber;
    },
    $strict
  >
>;

App-originated Session send refusal; retry advice is a duration, not a timestamp.

---

presentMethodNameconstconstant

Signature

const presentMethodName: "present" = "present";

Name of the generated, hidden read method that projects a finished call into its row.

defineAppMethod()fnfunction

Signature

function defineAppMethod<I, O, Context>(method): AppBackendMethod<Context>;

Define a typed method once; neither discovery nor builds execute its handler.

Type Parameters

Type Parameter	Default type
I extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>	-
O extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>	-
Context	void

Parameters

Parameter

Type

method

Omit<Readonly<{ description: string; effect: "external" | "read" | "write"; requires: readonly ( | "agent.list" | "agent.manage" | "agent.read" | "agent.send" | "computer.list" | "computer.readFile" | "computer.writeFile" | "computer.execute" | "agent.rename" | "agent.avatar" | "agent.toolPolicy" | "approvals" | "apps.open" | "apps.call" | "llm.generation" | "media.generation" | "games:servers" | "git.repository" | "app.storage" | "app.events.emit" | "team.workbenchHost" | "marketplace.browse" | "marketplace.purchase" | "workflow.run" | "workflow.publish" | "workflow.arm" | "world" | "channels.read" | "channels.personal.manage")[]; hidden?: true; anonymous?: true; pending?: true; present?: Readonly<{ verb: string; }>; }>, "present"> & { input: I; output: O; present?: Readonly<{ verb: string; row: (call: Readonly<{ input: output<I>; output: output<O>; }>) => { readonly id: string; readonly title: string; … 4 more …; readonly media?: { …; } | undefined; }; rows: Readonly<…>; }> | undefined; } & ({ …; } | { …; })

Returns

AppBackendMethod<Context>

---

defineAppBackend()fnfunction

Signature

function defineAppBackend<Context>(options): AppBackendDefinition<Context>;

Generate the API from the method exports; callers cannot supply a second catalog.

Type Parameters

Type Parameter	Default type
Context	void

Parameters

Parameter	Type
options	Readonly<{ methods: Readonly<Record<string, AppBackendMethod<Context>>>; events?: AppBackendDefinition<Context>["events"]; gills?: readonly AppBackendGill[]; sync?: AppBackendDefinition<Context>["sync"]; toolFamily?: AppBackendDefinition<Context>["toolFamily"]; }>

Returns

AppBackendDefinition<Context>

References

AppBackendGill

Re-exports AppBackendGill

---

pending

Re-exports pending

---

pendingSchema

Re-exports pendingSchema

---

Pending

Re-exports Pending