Skip to content
Puffball0.2.0
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 Description
BACKGROUND object - -
BACKGROUND.name "BACKGROUND" "BACKGROUND" -
BACKGROUND.operations object - -
BACKGROUND.operations.admit object - -
BACKGROUND.operations.admit.cap "app.background.admit" "app.background.admit" -
BACKGROUND.operations.admit.requires readonly [] [] -
BACKGROUND.operations.admit.effect "read" "read" -
GIT object - -
GIT.name "GIT" "GIT" -
GIT.operations object - -
GIT.operations.create object - -
GIT.operations.create.cap "app.git.create" "app.git.create" -
GIT.operations.create.requires readonly ["git.repository"] - -
GIT.operations.create.effect "write" "write" -
GIT.operations.fork object - -
GIT.operations.fork.cap "app.git.fork" "app.git.fork" -
GIT.operations.fork.requires readonly ["git.repository"] - -
GIT.operations.fork.effect "write" "write" -
GIT.operations.read object - -
GIT.operations.read.cap "app.git.read" "app.git.read" -
GIT.operations.read.requires readonly ["git.repository"] - -
GIT.operations.read.effect "read" "read" -
GIT.operations.write object - -
GIT.operations.write.cap "app.git.write" "app.git.write" -
GIT.operations.write.requires readonly ["git.repository"] - -
GIT.operations.write.effect "write" "write" -
GIT.operations.exchange object - -
GIT.operations.exchange.cap "app.git.exchange" "app.git.exchange" -
GIT.operations.exchange.requires readonly ["git.repository"] - -
GIT.operations.exchange.effect "write" "write" -
EVENTS object - -
EVENTS.name "EVENTS" "EVENTS" -
EVENTS.operations object - -
EVENTS.operations.emit object - -
EVENTS.operations.emit.cap "app.events.emit" "app.events.emit" -
EVENTS.operations.emit.requires readonly ["app.events.emit"] - -
EVENTS.operations.emit.effect "write" "write" -
APPS object - -
APPS.name "APPS" "APPS" -
APPS.operations object - -
APPS.operations.register object - Register the calling installation’s repository as an App from its exact main manifest. No Computer execution or installation is implied.
APPS.operations.register.cap "app.register" "app.register" -
APPS.operations.register.requires readonly ["git.repository"] - -
APPS.operations.register.effect "write" "write" -
APPS.operations.repository object - Read the captured installation’s registered repository identity.
APPS.operations.repository.cap "app.catalog.read" "app.catalog.read" -
APPS.operations.repository.requires readonly ["git.repository"] - -
APPS.operations.repository.effect "read" "read" -
APPS.operations.build object - -
APPS.operations.build.cap "app.build" "app.build" -
APPS.operations.build.requires readonly ["git.repository", "computer.execute"] - -
APPS.operations.build.effect "write" "write" -
APPS.operations.buildStatus object - Read one build job’s current status; the host re-checks the caller is the owner. An operation is granted only through approved capabilities, so it needs the ones its build was admitted with.
APPS.operations.buildStatus.cap "app.build" "app.build" -
APPS.operations.buildStatus.requires readonly ["git.repository", "computer.execute"] - -
APPS.operations.buildStatus.effect "read" "read" -
APPS.operations.select object - Install a Release at an installation id, or switch a live one onto it; the host re-checks the caller is the owner. It completes the build-and-install loop, under the capabilities a build needs.
APPS.operations.select.cap "app.select" "app.select" -
APPS.operations.select.requires readonly ["git.repository", "computer.execute"] - -
APPS.operations.select.effect "write" "write" -
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" -
APPS.operations.fork object - Fork a platform App’s published source into its own Team-owned App, as a repository in the calling installation’s Git.
APPS.operations.fork.cap "app.fork" "app.fork" -
APPS.operations.fork.requires readonly ["git.repository"] - -
APPS.operations.fork.effect "write" "write" -
WORKFLOWS object - -
WORKFLOWS.name "WORKFLOWS" "WORKFLOWS" -
WORKFLOWS.operations object - -
WORKFLOWS.operations.catalog object - The member’s callable App methods, for an editor’s palette.
WORKFLOWS.operations.catalog.cap "app.workflow.read" "app.workflow.read" -
WORKFLOWS.operations.catalog.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.catalog.effect "read" "read" -
WORKFLOWS.operations.runGraph object - Compile and start a definition as the member on the pinned Computer.
WORKFLOWS.operations.runGraph.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.runGraph.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.runGraph.effect "write" "write" -
WORKFLOWS.operations.armSchedule object - -
WORKFLOWS.operations.armSchedule.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.armSchedule.requires readonly ["workflow.run", "workflow.arm"] - -
WORKFLOWS.operations.armSchedule.effect "write" "write" -
WORKFLOWS.operations.disarmSchedule object - -
WORKFLOWS.operations.disarmSchedule.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.disarmSchedule.requires readonly ["workflow.run", "workflow.arm"] - -
WORKFLOWS.operations.disarmSchedule.effect "write" "write" -
WORKFLOWS.operations.schedules object - -
WORKFLOWS.operations.schedules.cap "app.workflow.read" "app.workflow.read" -
WORKFLOWS.operations.schedules.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.schedules.effect "read" "read" -
WORKFLOWS.operations.armEventTrigger object - -
WORKFLOWS.operations.armEventTrigger.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.armEventTrigger.requires readonly ["workflow.run", "workflow.arm"] - -
WORKFLOWS.operations.armEventTrigger.effect "write" "write" -
WORKFLOWS.operations.disarmEventTrigger object - -
WORKFLOWS.operations.disarmEventTrigger.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.disarmEventTrigger.requires readonly ["workflow.run", "workflow.arm"] - -
WORKFLOWS.operations.disarmEventTrigger.effect "write" "write" -
WORKFLOWS.operations.eventTriggers object - -
WORKFLOWS.operations.eventTriggers.cap "app.workflow.read" "app.workflow.read" -
WORKFLOWS.operations.eventTriggers.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.eventTriggers.effect "read" "read" -
WORKFLOWS.operations.cancel object - A person’s answer to one of a run’s reviews; Agents never answer.
WORKFLOWS.operations.cancel.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.cancel.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.cancel.effect "write" "write" -
WORKFLOWS.operations.answerReview object - -
WORKFLOWS.operations.answerReview.cap "app.workflow.run" "app.workflow.run" -
WORKFLOWS.operations.answerReview.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.answerReview.effect "write" "write" -
WORKFLOWS.operations.graphStatus object - One of the member’s runs: node events, reviews and engine status.
WORKFLOWS.operations.graphStatus.cap "app.workflow.read" "app.workflow.read" -
WORKFLOWS.operations.graphStatus.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.graphStatus.effect "read" "read" -
WORKFLOWS.operations.runs object - Up to 50 runs of this library, newest first; source and initiator included.
WORKFLOWS.operations.runs.cap "app.workflow.read" "app.workflow.read" -
WORKFLOWS.operations.runs.requires readonly ["workflow.run"] - -
WORKFLOWS.operations.runs.effect "read" "read" -
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.preview object - -
COMPUTER.operations.preview.cap "app.computer.exec" "app.computer.exec" -
COMPUTER.operations.preview.requires readonly ["computer.execute"] - -
COMPUTER.operations.preview.effect "write" "write" -
COMPUTER.operations.processKill object - -
COMPUTER.operations.processKill.cap "app.computer.exec" "app.computer.exec" -
COMPUTER.operations.processKill.requires readonly ["computer.execute"] - -
COMPUTER.operations.processKill.effect "write" "write" -
COMPUTER.operations.processStart object - -
COMPUTER.operations.processStart.cap "app.computer.exec" "app.computer.exec" -
COMPUTER.operations.processStart.requires readonly ["computer.execute"] - -
COMPUTER.operations.processStart.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" -