@honua/sdk-js
    Preparing search index...

    Module nl-map-controlExperimental

    Natural-language map control: compile NL instructions into serializable, inspectable plans over the agent-tools surface, and execute reviewed plans only.

    The layer is plan-first per the north-star ADR: propose() turns an instruction into a typed NlMapPlan (query-planner IR for data operations plus ordered agent-tool invocations for map operations) and never executes anything. execute() is the only execution path and accepts plans only — never raw natural language. Read-only plans may auto-execute under policy; anything mutating or viewport-changing requires a signed agent-safety approval envelope. Every execution emits a receipt.

    The LLM transport is a caller-provided callback; this module depends on no model-vendor SDK. Recorded request/response exchanges replay deterministically through createRecordedNlLlm.

    This entrypoint is not yet covered by the SDK's semver contract — the surface may change in any minor release prior to 1.0.0.

    Classes

    HonuaAskMapClarification
    HonuaNlMapControlError

    Interfaces

    ApproveNlMapPlanOptions
    AskMapControlOptions
    AskMapReview
    AskMapSession
    AskMapSessionOptions
    AskMapState
    CreateNlMapControlOptions
    NlAgentSafetyPlanOptions
    NlCompletionMessage
    NlCompletionRequest
    NlCompletionResponse
    NlCompletionToolCall
    NlExecuteOptions
    NlMapControl
    NlMapControlPolicy
    NlMapControlToolDefinition
    NlMapControlToolDefinitionsOptions
    NlMapControlToolsOptions
    NlMapPlan
    NlMapPlanApproval
    NlMapPlanExecution
    NlMapPlanReceipt
    NlMapPlanReceiptStep
    NlMapPlanStep
    NlMapRuntimeBindingOptions
    NlPlanIssue
    NlProposeOptions
    NlRecordedExchange
    NlRecordedRequest
    NlSelfCorrection

    Type Aliases

    AskMapPhase
    NlLlmCallback
    NlMapControlErrorCode
    NlMapControlToolName
    NlMapPlanEffect
    NlPlanIssueCode

    Variables

    DEFAULT_NL_MAP_CONTROL_MAX_PLAN_STEPS
    DEFAULT_NL_MAP_CONTROL_MAX_SELF_CORRECTIONS
    DEFAULT_NL_STEP_LIMITS
    NL_MAP_CONTROL_TOOL_DEFINITIONS
    NL_MAP_CONTROL_TOOL_NAMES
    NL_MAP_CONTROL_VERSION
    NL_MAP_PLAN_KIND
    NL_MAP_PLAN_RECEIPT_KIND
    NL_MAP_RUNTIME_BINDING_ID

    Functions

    agentEffectForNlEffect
    approveNlMapPlan
    createAskMapSession
    createNlMapControl
    createRecordedNlLlm
    hashNlMapPlan
    mountAskMapControl
    nlAgentSafetyPolicyFor
    nlMapControlToolDefinitions
    nlMapRuntimeBinding
    toAgentSafetyPlan
    toNlMapControlMcpToolDefinitions
    toNlMapControlOpenAiToolDefinitions