Skip to content
Puffball0.2.0
API reference

app-backend-bindings

Exports

Section titled “Exports”
Kind Export Description
constant appBackendBindingsSchema Author declarations select named operations from registered binding kinds.
constant appBackendShardBindingsSchema Signed shard bindings pair each operation with its exact broker class.
function appBackendBindingOperation() Look up an operation within its declared kind; unknown names have no authority.
function scopeOperationToMethod() Keep only operations required by the verified method and allowed by its write ceiling. Without a method, installation-scoped calls still respect the captured ceiling.

appBackendBindingsSchemaconstant

Section titled “appBackendBindingsSchema”
Signature
const appBackendBindingsSchema: $Array<
  Union<
    Struct<{
      name: Literal<
        | "BACKGROUND"
        | "GIT"
        | "EVENTS"
        | "APPS"
        | "WORKFLOWS"
        | "APP_STORAGE"
        | "MEDIA"
        | "COMPUTER"
        | "INBOX"
        | "AGENTS"
      >;
      operations: $Array<Literals<string[]>>;
    }>[]
  >
>;

Author declarations select named operations from registered binding kinds.

appBackendShardBindingsSchemaconstant

Section titled “appBackendShardBindingsSchema”
Signature
const appBackendShardBindingsSchema: $Array<Union<Struct<{
  name: Literal<
     | "BACKGROUND"
     | "GIT"
     | "EVENTS"
     | "APPS"
     | "WORKFLOWS"
     | "APP_STORAGE"
     | "MEDIA"
     | "COMPUTER"
     | "INBOX"
    | "AGENTS">;
  operations: $Array<Union<Struct<{
     name: Literal<...>;
     cap: Literal<...>;
  }>[]>>;
}>[]>>;

Signed shard bindings pair each operation with its exact broker class.

appBackendBindingOperation()function

Section titled “appBackendBindingOperation()”
Signature
function appBackendBindingOperation(
  name,
  operation,
): AppBackendBindingOperation | undefined;

Look up an operation within its declared kind; unknown names have no authority.

Parameters

Section titled “Parameters”
Parameter Type
name | "BACKGROUND" | "GIT" | "EVENTS" | "APPS" | "WORKFLOWS" | "APP_STORAGE" | "MEDIA" | "COMPUTER" | "INBOX" | "AGENTS"
operation string

Returns

Section titled “Returns”

| AppBackendBindingOperation | undefined

scopeOperationToMethod()function

Section titled “scopeOperationToMethod()”
Signature
function scopeOperationToMethod(operation, method, ceiling): boolean;

Keep only operations required by the verified method and allowed by its write ceiling. Without a method, installation-scoped calls still respect the captured ceiling.

Parameters

Section titled “Parameters”
Parameter Type
operation AppBackendBindingOperation
method | Pick<Readonly<{ description: string; input: object; output: object; effect: "write" | "external" | "read"; requires: readonly ( | "approvals" | "agent.list" | "agent.manage" | "agent.rename" | "agent.avatar" | "agent.toolPolicy" | "agent.read" | "agent.send" | "computer.list" | "computer.readFile" | "computer.writeFile" | "computer.execute" | "llm.generation" | "media.generation" | "games:servers" | "git.repository" | "apps.open" | "apps.call" | "app.storage" | "app.events.emit" | "team.workbenchHost" | "marketplace.browse" | "marketplace.purchase" | "workflow.run" | "workflow.publish" | "workflow.arm" | "world" | "channels.read" | "channels.personal.manage")[]; pending?: true; hidden?: true; anonymous?: true; present?: Readonly<{ verb: string; }>; }>, "requires" | "effect"> | undefined
ceiling "write" | "read"

Returns

Section titled “Returns”

boolean

References

Section titled “References”

appBackendBindingKinds

Section titled “appBackendBindingKinds”

Re-exports appBackendBindingKinds

AppBackendBindingName

Section titled “AppBackendBindingName”

Re-exports AppBackendBindingName

AppBackendBindingMethod

Section titled “AppBackendBindingMethod”

Re-exports AppBackendBindingMethod

AppBackendBindingOperation

Section titled “AppBackendBindingOperation”

Re-exports AppBackendBindingOperation