API reference

home/contract

Import

import * as api from "@fungi.computer/shiitake-extensions/home";

Kind	Export	Description
type alias	Home	Persisted Home selection for one Agent.
constant	Home	The Agent’s recorded choice survives the chosen attachment being detached.
constant	homeContract	Human selection changes Agent state; no model operation exposes this command.

type Home = Schema.Schema.Type<typeof Home>;

Persisted Home selection for one Agent.

const Home: Struct<{
  attachmentId: NullOr<String>;
}>;

The Agent’s recorded choice survives the chosen attachment being detached.

const homeContract: object;

Human selection changes Agent state; no model operation exposes this command.

Name	Type	Default value	Description
`id`	`string & Brand<"ExtensionId">`	-	Stable extension identity.
`commands`	`object`	-	Human selection and initial seeding operations.
`commands.home`	`object`	-	Open Home controls or select an attachment by name.
`commands.home.scope`	`"session"`	`"session"`	Human controls are opened from a Session.
`commands.home.input`	`Struct<{ name: optionalKey<String>; }>`	-	Decode an optional attachment name.
`commands.home.output`	`declare<WhistleCatalogStepV1, WhistleCatalogStepV1>`	`CatalogStep`	Return the server-owned conversation step.
`commands.seed`	`object`	-	Seed the Agent’s initial recorded Home choice.
`commands.seed.scope`	`"agent"`	`"agent"`	Home selection belongs to the Agent.
`commands.seed.input`	`Struct<{ attachmentId: NullOr<String>; }>`	`Home`	Decode the initial selection.
`commands.seed.output`	`Struct<{ seeded: Boolean; }>`	-	Report whether seeding changed the recorded choice.
`projection`	`object`	-	Recorded selection visible to clients, or no seeded state.
`projection.schema`	`NullOr<Struct<{ attachmentId: NullOr<String>; }>>`	-	Decoder for the optional Home state.