Skip to content
Puffball
API reference

app-backend-binding-vocabulary

Exports

Section titled “Exports”
Kind Export Description
type alias BindingOperationDefinition Shared broker class, permission and effect metadata for a binding operation.
type alias AppBackendBindingName A registered backend binding kind.
type alias AppBackendBinding One author-selected binding; its operation names are checked by the registry decoder.
type alias AppBackendBindingMethod RPC method names exposed by the registered kinds.
type alias AppBackendBindingOperation The required permissions, effect and broker class of a registered operation.
constant appBackendBindingKinds The runtime-neutral registry shared by declarations, admission and Exec.

BindingOperationDefinitiontype alias

Section titled “BindingOperationDefinition”
Signature
type BindingOperationDefinition = Readonly<{
  cap: string;
  requires: readonly AppCapabilityId[];
  effect: "read" | "write";
}>;

Shared broker class, permission and effect metadata for a binding operation.

AppBackendBindingNametype alias

Section titled “AppBackendBindingName”
Signature
type AppBackendBindingName = keyof typeof appBackendBindingKinds;

A registered backend binding kind.

AppBackendBindingtype alias

Section titled “AppBackendBinding”
Signature
type AppBackendBinding = Readonly<{
  name: AppBackendBindingName;
  operations: readonly string[];
}>;

One author-selected binding; its operation names are checked by the registry decoder.

AppBackendBindingMethodtype alias

Section titled “AppBackendBindingMethod”
Signature
type AppBackendBindingMethod = {
  [
    Kind in AppBackendBindingName
  ]: keyof (typeof appBackendBindingKinds)[Kind]["operations"];
}[AppBackendBindingName];

RPC method names exposed by the registered kinds.

AppBackendBindingOperationtype alias

Section titled “AppBackendBindingOperation”
Signature
type AppBackendBindingOperation = {
  [
    Kind in AppBackendBindingName
  ]: (typeof appBackendBindingKinds)[Kind]["operations"][keyof (typeof appBackendBindingKinds)[Kind]["operations"]];
}[AppBackendBindingName];

The required permissions, effect and broker class of a registered operation.

appBackendBindingKindsconstant

Section titled “appBackendBindingKinds”
Signature
const appBackendBindingKinds: object;

The runtime-neutral registry shared by declarations, admission and Exec.

Type Declaration

Section titled “Type Declaration”
Name Type Default value
APPS object -
APPS.name "APPS" "APPS"
APPS.operations object -
APPS.operations.catalog object -
APPS.operations.catalog.cap "app.catalog.read" "app.catalog.read"
APPS.operations.catalog.requires readonly ["team.workbenchHost"] -
APPS.operations.catalog.effect "read" "read"
WORKFLOWS object -
WORKFLOWS.name "WORKFLOWS" "WORKFLOWS"
WORKFLOWS.operations object -
WORKFLOWS.operations.inspect object -
WORKFLOWS.operations.inspect.cap "app.workflow.read" "app.workflow.read"
WORKFLOWS.operations.inspect.requires readonly ["workflow.run"] -
WORKFLOWS.operations.inspect.effect "read" "read"
WORKFLOWS.operations.startStoryboard object -
WORKFLOWS.operations.startStoryboard.cap "app.workflow.run" "app.workflow.run"
WORKFLOWS.operations.startStoryboard.requires readonly ["workflow.run", "media.generation", "computer.writeFile"] -
WORKFLOWS.operations.startStoryboard.effect "write" "write"
APP_STORAGE object -
APP_STORAGE.name "APP_STORAGE" "APP_STORAGE"
APP_STORAGE.operations object -
APP_STORAGE.operations.read object -
APP_STORAGE.operations.read.cap "app.storage.read" "app.storage.read"
APP_STORAGE.operations.read.requires readonly ["app.storage"] -
APP_STORAGE.operations.read.effect "read" "read"
APP_STORAGE.operations.write object -
APP_STORAGE.operations.write.cap "app.storage.write" "app.storage.write"
APP_STORAGE.operations.write.requires readonly ["app.storage"] -
APP_STORAGE.operations.write.effect "write" "write"
APP_STORAGE.operations.reset object -
APP_STORAGE.operations.reset.cap "app.storage.write" "app.storage.write"
APP_STORAGE.operations.reset.requires readonly ["app.storage"] -
APP_STORAGE.operations.reset.effect "write" "write"
MEDIA object -
MEDIA.name "MEDIA" "MEDIA"
MEDIA.operations object -
MEDIA.operations.models object -
MEDIA.operations.models.cap "app.media.read" "app.media.read"
MEDIA.operations.models.requires readonly ["media.generation"] -
MEDIA.operations.models.effect "read" "read"
MEDIA.operations.generate object -
MEDIA.operations.generate.cap "app.media.generate" "app.media.generate"
MEDIA.operations.generate.requires readonly ["media.generation", "computer.writeFile"] -
MEDIA.operations.generate.effect "write" "write"
COMPUTER object -
COMPUTER.name "COMPUTER" "COMPUTER"
COMPUTER.operations object -
COMPUTER.operations.list object -
COMPUTER.operations.list.cap "app.computer.read" "app.computer.read"
COMPUTER.operations.list.requires readonly ["computer.list"] -
COMPUTER.operations.list.effect "read" "read"
COMPUTER.operations.read object -
COMPUTER.operations.read.cap "app.computer.read" "app.computer.read"
COMPUTER.operations.read.requires readonly ["computer.readFile"] -
COMPUTER.operations.read.effect "read" "read"
COMPUTER.operations.ports object -
COMPUTER.operations.ports.cap "app.computer.read" "app.computer.read"
COMPUTER.operations.ports.requires readonly ["computer.execute"] -
COMPUTER.operations.ports.effect "read" "read"
COMPUTER.operations.processes object -
COMPUTER.operations.processes.cap "app.computer.read" "app.computer.read"
COMPUTER.operations.processes.requires readonly ["computer.execute"] -
COMPUTER.operations.processes.effect "read" "read"
COMPUTER.operations.write object -
COMPUTER.operations.write.cap "app.computer.write" "app.computer.write"
COMPUTER.operations.write.requires readonly ["computer.writeFile"] -
COMPUTER.operations.write.effect "write" "write"
COMPUTER.operations.exec object -
COMPUTER.operations.exec.cap "app.computer.exec" "app.computer.exec"
COMPUTER.operations.exec.requires readonly ["computer.execute"] -
COMPUTER.operations.exec.effect "write" "write"
INBOX object -
INBOX.name "INBOX" "INBOX"
INBOX.operations object -
INBOX.operations.page object -
INBOX.operations.page.cap "inbox.read" "inbox.read"
INBOX.operations.page.requires readonly ["agent.read"] -
INBOX.operations.page.effect "read" "read"
INBOX.operations.visit object -
INBOX.operations.visit.cap "inbox.visit" "inbox.visit"
INBOX.operations.visit.requires readonly ["agent.read"] -
INBOX.operations.visit.effect "write" "write"
AGENTS object -
AGENTS.name "AGENTS" "AGENTS"
AGENTS.operations object -
AGENTS.operations.list object -
AGENTS.operations.list.cap "agent.list" "agent.list"
AGENTS.operations.list.requires readonly ["agent.list"] -
AGENTS.operations.list.effect "read" "read"
AGENTS.operations.send object -
AGENTS.operations.send.cap "agent.send" "agent.send"
AGENTS.operations.send.requires readonly ["agent.send"] -
AGENTS.operations.send.effect "write" "write"