62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
# 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.
|
|
- **AI-Ready**: Generates TypeScript definitions (`.d.ts`) for AI to understand available capabilities.
|
|
|
|
## Usage
|
|
|
|
### 1. Register Go Capability (in any module)
|
|
|
|
```go
|
|
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
|
|
|
|
```go
|
|
import "apigo.cc/go/js"
|
|
|
|
func main() {
|
|
js.Define(`
|
|
function myTask(name) {
|
|
let data = go.db.query("SELECT * FROM users WHERE name = ?", [name]);
|
|
return data;
|
|
}
|
|
`)
|
|
|
|
res, err := js.Call(ctx, "myTask", "star")
|
|
}
|
|
```
|
|
|
|
### 3. Generate AI Context
|
|
|
|
```go
|
|
dts := js.Doc()
|
|
// Feed d.ts to LLM to provide coding context
|
|
```
|
|
|
|
## 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`
|