gills

Import

Import

import * as api from "@fungi.computer/agar/gills";

Exports

Kind	Export	Description
Ttype alias	AppBackendGill	App-owned projection; methods keep their ordinary domain-shaped output.
fnfunction	decodeGillRefusal()	Decode the App host’s strict isolation refusal into its permanent Gill state.
fnfunction	defineAppGill()	Define a compact view of one of this App’s declared read methods.

AppBackendGillTtype alias

Signature

type AppBackendGill = Readonly<{
  declaration: AppDeclaredGill;
  limit: number;
  input: (selection) => Readonly<{
    [key: string]: WhistleJsonValue;
    limit: number;
  }>;
  parseCall: (raw) => GillCall;
  call: (selection, read) => Promise<GillReply>;
  rows: (output, context) => GillResponse;
}>;

App-owned projection; methods keep their ordinary domain-shaped output.

decodeGillRefusal()fnfunction

Signature

function decodeGillRefusal(
  raw,
  declaration,
):
  | {
      viewId: string;
      title: string;
      state: "empty";
      rows: readonly [];
      next?: string;
    }
  | {
      viewId: string;
      title: string;
      state: "error";
      rows: readonly [];
      reason?: "exec_isolation_required" | "params_required";
      error: string;
      recovery?:
        | {
            kind: "configure";
            param: string;
          }
        | {
            kind: "open";
          };
    }
  | {
      viewId: string;
      title: string;
      state: "full";
      rows: readonly object[];
      next?: string;
    }
  | undefined;

Decode the App host’s strict isolation refusal into its permanent Gill state.

Parameters

Parameter	Type
raw	unknown
declaration	Readonly<{ id: string; title: string; }>

Returns

Type Literal

Signature

{
  viewId: string;
  title: string;
  state: "empty";
  rows: readonly [];
  next?: string;
}

---

Type Literal

Signature

{
  viewId: string;
  title: string;
  state: "error";
  rows: readonly [];
  reason?: "exec_isolation_required" | "params_required";
  error: string;
  recovery?:   | {
     kind: "configure";
     param: string;
   }
     | {
     kind: "open";
   };
}

Name	Type	Description
viewId	string	-
title	string	-
state	"error"	-
rows	readonly []	-
reason?	"exec_isolation_required" | "params_required"	Host-owned permanent execution refusal; an ordinary error may still be refreshed.
error	string	-
recovery?	| { kind: "configure"; param: string; } | { kind: "open"; }	The host supplies the same-placement picker and this App’s launch.

---

Type Literal

Signature

{
  viewId: string;
  title: string;
  state: "full";
  rows: readonly object[];
  next?: string;
}

---

undefined

---

defineAppGill()fnfunction

Signature

function defineAppGill(options): AppBackendGill;

Define a compact view of one of this App’s declared read methods.

Parameters

Parameter	Type
options	Readonly<{ id: string; title: string; source: string; limit: number; sizes?: readonly AppGillDesktopSize[]; params?: readonly AppGillParam[]; watch?: AppGillWatch; input: AppBackendGill["input"]; rows: AppBackendGill["rows"]; }>

Returns

AppBackendGill