Skip to content
Shiitake
API reference

rows

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/shiitake/rows";

Exports

Section titled “Exports”
Kind Export Description
type alias RowActionV1 A receiving host’s advertised command intent.
type alias RowV1 One shared, bounded data row; the host owns navigation and execution.
constant rowLabelSchemaV1 Nonempty display text, bounded to 4,096 characters.
constant rowIdentitySchemaV1 Producer-owned row identity, bounded to 513 characters.
constant rowActionSchemaV1 A text action whose receiving host authorizes its command.
constant rowSchemaV1 A bounded text row; each receiving host authorizes its open target.
constant rowPageSchemaV1 A page containing at most 200 shared rows.

RowActionV1type alias

Section titled “RowActionV1”
Signature
type RowActionV1 = Schema.Schema.Type<typeof rowActionSchemaV1>;

A receiving host’s advertised command intent.

RowV1type alias

Section titled “RowV1”
Signature
type RowV1 = Schema.Schema.Type<typeof rowSchemaV1>;

One shared, bounded data row; the host owns navigation and execution.

rowLabelSchemaV1constant

Section titled “rowLabelSchemaV1”
Signature
const rowLabelSchemaV1: String;

Nonempty display text, bounded to 4,096 characters.

rowIdentitySchemaV1constant

Section titled “rowIdentitySchemaV1”
Signature
const rowIdentitySchemaV1: String;

Producer-owned row identity, bounded to 513 characters.

rowActionSchemaV1constant

Section titled “rowActionSchemaV1”
Signature
const rowActionSchemaV1: Struct<{
  id: String;
  label: String;
  input: optional<Codec<Json, Json, never, never>>;
}>;

A text action whose receiving host authorizes its command.

rowSchemaV1constant

Section titled “rowSchemaV1”
Signature
const rowSchemaV1: Struct<{
  id: String;
  title: String;
  detail: optional<String>;
  tone: optional<
    Literals<readonly ["attention", "running", "error", "settled", "muted"]>
  >;
  open: optional<
    Struct<{
      kind: Literal<"session">;
      agentId: String;
      sessionId: String;
    }>
  >;
  actions: optional<
    $Array<
      Struct<{
        id: String;
        label: String;
        input: optional<Codec<Json, Json, never, never>>;
      }>
    >
  >;
}>;

A bounded text row; each receiving host authorizes its open target.

rowPageSchemaV1constant

Section titled “rowPageSchemaV1”
Signature
const rowPageSchemaV1: $Array<
  Struct<{
    id: String;
    title: String;
    detail: optional<String>;
    tone: optional<
      Literals<readonly ["attention", "running", "error", "settled", "muted"]>
    >;
    open: optional<
      Struct<{
        kind: Literal<"session">;
        agentId: String;
        sessionId: String;
      }>
    >;
    actions: optional<
      $Array<
        Struct<{
          id: String;
          label: String;
          input: optional<Codec<Json, Json, never, never>>;
        }>
      >
    >;
  }>
>;

A page containing at most 200 shared rows.