Qu Query

luaApiSurface

Topics: Scripting

Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.

Returns

[LuaApiEntry!]!

Arguments

Which scripting surface to describe

Possible values (4)
NORMAL

Every platform capability. Runs playground and stored scripts, workflow script nodes, custom workflow actions, incoming webhooks, custom app server functions, workspace handlers, portal handlers, MCP tools, archive jobs, quote price tuning, plugin seeds and integration extensions.

INTEGRATION

The Normal functions except ctx.twin., with devices, templates and scripts reached only through the instance's bindings, cache, config, protobuf and store belonging to the instance, plus ctx.integration. metadata. Runs integration lifecycle hooks, integration handler scripts, integration server functions, integration workflow actions, integration API client setup and integration upgrade scripts.

PURE

The language only, with no ctx and no modules. Runs data pipeline stages, report preparation scripts, portal component exports, plugin middleware hooks, plugin event handlers, scheduler penalty functions, product template resolvers and JDF and JMF templates.

EDGE_APP

Edge app bundle handlers on the bridge: the bridge.* global, SwiftLua-in-Go runtime, no ctx.

Exact field SDL
"""
Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.
"""
luaApiSurface(
  """Which scripting surface to describe"""
  role: LuaScriptRole!
): [LuaApiEntry!]! @topic(names: ["scripting"])

Declared on Query. Access is checked by the platform for each operation.