Go/JS Low-Code Engine

A lightweight, frictionless, and AI-friendly JavaScript engine for Go applications based on goja.

Features

Decoupled Architecture: Capability providers only need to depend on apigo.cc/go/jsmod.
Frictionless Bridging: Automatic type conversion using go/cast.
Host Object Fidelity: Go pointers and structs are preserved when passed back and forth between Go and JS.
Context Injection: Automatic context.Context propagation from js.Call.
Versioned Pool: Thread-safe VM pool with incremental code synchronization and version checking (CheckVersion).
Function Discovery: List all defined functions via FuncList().
Context Interruption: Safe execution with context.Context cancellation support.
AI-Ready: Generates TypeScript definitions (.d.ts) for AI to understand available capabilities.

Usage

1. Register Go Capability (in any module)

import "apigo.cc/go/jsmod"

func init() {
    jsmod.Register("db", map[string]any{
        "query": func(ctx context.Context, sql string) ([]map[string]any, error) {
            // ...
        },
    })
}

2. Execute JS with Version Checking

import "apigo.cc/go/js"

func main() {
    // Check if script needs update (e.g., from file mtime)
    if !js.CheckVersion("myTask.js", mtime) {
        js.Define(code, "myTask.js", mtime)
    }

    res, err := js.Call(ctx, "myTask", "star")
}

3. Discover Functions

funcs := js.FuncList()
// ["myTask", ...]

3. Generate AI Context

dts := js.Doc()
// Feed d.ts to LLM to provide coding context

The generated declarations are optimized for low-code editors:

bridged modules are exposed as top-level globals such as api, cast, db, service
injected logger values are typed as Logger
opaque runtime handles use stable names such as GoContext, GoHTTPRequest, GoHTTPResponse, GoURL
exposed standard-library structs use stable names such as GoTime

Example:

declare const service: Service_Module

interface Logger {
    Debug(message: string, ...extra: any[]): void
    Info(message: string, ...extra: any[]): void
    Warning(message: string, ...extra: any[]): void
    Error(message: string, ...extra: any[]): void
}

Internal Bridge Details

The engine uses goja's Host Object mechanism. When a Go struct/pointer is returned to JS, it remains a Go object. When passed back to a Go function, the original pointer is preserved, ensuring zero data loss and state consistency.

Types are automatically coerced:

JS string -> Go int (via go/cast)
JS Object -> Go Struct
Go error -> JS Exception

2.6 KiB Raw Permalink Blame History