Add sqlite plugin

Add plugin scripts to asset server
Add InjectJS support in plugins

.gitignore

@@ -34,3 +34,4 @@ v2/cmd/wails/internal/commands/initialise/templates/testtemplates/
 
 /v3/.task
 /v3/examples/build/bin/testapp
+/websitev3/site/

scripts/sync-translated-documents.sh

@@ -2,4 +2,4 @@
 
 cd ../website
 
-npx @crowdin/cli@latest pull -b master
+npx @crowdin/cli@latest pull -b master --export-only-approved

v2/internal/frontend/desktop/windows/go-webview2/pkg/edge/corewebview2.go

@@ -4,6 +4,7 @@
 package edge
 
 import (
+	"fmt"
 	"log"
 	"runtime"
 	"syscall"
@@ -249,7 +250,7 @@ func (e *ICoreWebView2Environment) CreateWebResourceResponse(content []byte, sta
 		return nil, err
 	}
 	var response *ICoreWebView2WebResourceResponse
-	_, _, err = e.vtbl.CreateWebResourceResponse.Call(
+	hr, _, err := e.vtbl.CreateWebResourceResponse.Call(
 		uintptr(unsafe.Pointer(e)),
 		stream,
 		uintptr(statusCode),
@@ -257,7 +258,14 @@ func (e *ICoreWebView2Environment) CreateWebResourceResponse(content []byte, sta
 		uintptr(unsafe.Pointer(_headers)),
 		uintptr(unsafe.Pointer(&response)),
 	)
-	if err != windows.ERROR_SUCCESS {
+	if windows.Handle(hr) != windows.S_OK {
+		return nil, syscall.Errno(hr)
+	}
+
+	if response == nil {
+		if err == nil {
+			err = fmt.Errorf("unknown error")
+		}
 		return nil, err
 	}
 	return response, nil

v2/internal/frontend/devserver/devserver.go

@@ -62,9 +62,13 @@ func (d *DevWebServer) Run(ctx context.Context) error {
 		return err
 	}
 
+	var myLogger assetserver.Logger
+	if _logger := ctx.Value("logger"); _logger != nil {
+		myLogger = _logger.(*logger.Logger)
+	}
+
 	var assetHandler http.Handler
 	var wsHandler http.Handler
-	var myLogger *logger.Logger
 
 	_fronendDevServerURL, _ := ctx.Value("frontenddevserverurl").(string)
 	if _fronendDevServerURL == "" {
@@ -73,9 +77,6 @@ func (d *DevWebServer) Run(ctx context.Context) error {
 			return c.String(http.StatusOK, assetdir)
 		})
 
-		if _logger := ctx.Value("logger"); _logger != nil {
-			myLogger = _logger.(*logger.Logger)
-		}
 		var err error
 		assetHandler, err = assetserver.NewAssetHandler(assetServerConfig, myLogger)
 		if err != nil {

v2/internal/typescriptify/js-reserved-keywords.go

@@ -61,7 +61,7 @@ var jsReservedKeywords []string = []string{
 	"typeof",
 	"var",
 	"void",
-	"volotile",
+	"volatile",
 	"while",
 	"with",
 	"yield",

v2/pkg/assetserver/assetserver.go

@@ -2,8 +2,11 @@ package assetserver
 
 import (
 	"bytes"
+	"fmt"
+	"math/rand"
 	"net/http"
 	"net/http/httptest"
+	"strings"
 
 	"golang.org/x/net/html"
 
@@ -42,6 +45,9 @@ type AssetServer struct {
 	// Use http based runtime
 	runtimeHandler RuntimeHandler
 
+	// plugin scripts
+	pluginScripts map[string]string
+
 	assetServerWebView
 }
 
@@ -89,6 +95,16 @@ func (d *AssetServer) UseRuntimeHandler(handler RuntimeHandler) {
 	d.runtimeHandler = handler
 }
 
+func (d *AssetServer) AddPluginScript(pluginName string, script string) {
+	if d.pluginScripts == nil {
+		d.pluginScripts = make(map[string]string)
+	}
+	pluginName = strings.ReplaceAll(pluginName, "/", "_")
+	pluginName = html.EscapeString(pluginName)
+	pluginScriptName := fmt.Sprintf("/plugin_%s_%d.js", pluginName, rand.Intn(100000))
+	d.pluginScripts[pluginScriptName] = script
+}
+
 func (d *AssetServer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
 	if isWebSocket(req) {
 		// Forward WebSockets to the distinct websocket handler if it exists
@@ -149,6 +165,11 @@ func (d *AssetServer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
 		d.writeBlob(rw, path, content)
 
 	default:
+		// Check if this is a plugin script
+		if script, ok := d.pluginScripts[path]; ok {
+			d.writeBlob(rw, path, []byte(script))
+			return
+		}
 		d.handler.ServeHTTP(rw, req)
 	}
 }
@@ -174,6 +195,13 @@ func (d *AssetServer) processIndexHTML(indexHTML []byte) ([]byte, error) {
 		return nil, err
 	}
 
+	// Inject plugins
+	for scriptName := range d.pluginScripts {
+		if err := insertScriptInHead(htmlNode, scriptName); err != nil {
+			return nil, err
+		}
+	}
+
 	var buffer bytes.Buffer
 	err = html.Render(&buffer, htmlNode)
 	if err != nil {

v3/TODO.md

@@ -4,8 +4,8 @@ Informal and incomplete list of things needed in v3.
 
 ## General
 
-- [ ] Generate Bindings
-- [ ] Generate TS Models
+- [x] Generate Bindings
+- [x] Generate TS Models
 - [ ] Dev Mode
 - [ ] Generate Info.Plist from `info.json`
 
@@ -41,4 +41,9 @@ Informal and incomplete list of things needed in v3.
 ## Runtime
 
 - [ ] To log or not to log?
-- [ ] Unify cross-platform events, eg. `onClose`
+- [ ] Unify cross-platform events, eg. `onClose`
+
+## Plugins
+
+- [ ] Move logins to `v3/plugins`
+- [ ] Expose application logger to plugins

v3/V3 Changes.md

@@ -108,3 +108,75 @@ This attribute specifies which javascript event should trigger the action. The d
 <button data-wml-event="hover-box" data-wml-trigger="mouseover">Hover over me!</button>
 ```
 
+## Plugins
+
+Plugins are a way to extend the functionality of your Wails application.
+
+### Creating a plugin
+
+Plugins are standard Go structure that adhere to the following interface:
+
+```go
+type Plugin interface {
+    Name() string
+    Init(*application.App) error
+    Shutdown() 
+    CallableByJS() []string
+    InjectJS() string
+}
+```
+
+The `Name()` method returns the name of the plugin. This is used for logging purposes.
+
+The `Init(*application.App) error` method is called when the plugin is loaded. The `*application.App`
+parameter is the application that the plugin is being loaded into. Any errors will prevent
+the application from starting.
+
+The `Shutdown()` method is called when the application is shutting down.
+
+The `CallableByJS()` method returns a list of exported functions that can be called from
+the frontend. These method names must exactly match the names of the methods exported
+by the plugin.
+
+The `InjectJS()` method returns JavaScript that should be injected into all windows as they are created. This is useful for adding custom JavaScript functions that complement the plugin.
+
+### Tips
+
+#### Enums
+
+In Go, enums are often defined as a type and a set of constants. For example:
+
+```go
+type MyEnum int
+
+const (
+    MyEnumOne MyEnum = iota
+    MyEnumTwo
+    MyEnumThree
+)
+```
+
+Due to incompatibility between Go and JavaScript, custom types cannot be used in this way. The best strategy is to use a type alias for float64:
+
+```go
+type MyEnum = float64
+
+const (
+    MyEnumOne MyEnum = iota
+    MyEnumTwo
+    MyEnumThree
+)
+```
+
+In Javascript, you can then use the following:
+
+```js
+const MyEnum = {
+    MyEnumOne: 0,
+    MyEnumTwo: 1,
+    MyEnumThree: 2
+}
+```
+
+- Why use `float64`? Can't we use `int`? 
+  - Because JavaScript doesn't have a concept of `int`. Everything is a `number`, which translates to `float64` in Go. There are also restrictions on casting types in Go's reflection package, which means using `int` doesn't work. 

v3/cmd/wails/main.go

@@ -25,6 +25,11 @@ func main() {
 	generate.NewSubCommandFunction("icons", "Generate icons", commands.GenerateIcons)
 	generate.NewSubCommandFunction("syso", "Generate Windows .syso file", commands.GenerateSyso)
 	generate.NewSubCommandFunction("bindings", "Generate bindings + models", commands.GenerateBindings)
+	plugin := app.NewSubCommand("plugin", "Plugin tools")
+	//plugin.NewSubCommandFunction("list", "List plugins", commands.PluginList)
+	plugin.NewSubCommandFunction("init", "Initialise a new plugin", commands.PluginInit)
+	//plugin.NewSubCommandFunction("add", "Add a plugin", commands.PluginAdd)
+
 	err := app.Run()
 	if err != nil {
 		pterm.Error.Println(err)

v3/examples/binding/GreetService.go

@@ -0,0 +1,16 @@
+package main
+
+type Person struct {
+	name string
+}
+
+type GreetService struct {
+}
+
+func (*GreetService) Greet(name string) string {
+	return "Hello " + name
+}
+
+func (*GreetService) GreetPerson(person Person) string {
+	return "Hello " + person.name
+}

v3/examples/binding/assets/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+HELLO!
+</body>
+</html>

v3/examples/binding/bindings_main.js

@@ -0,0 +1,43 @@
+// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import {main} from './models';
+
+function GreetService(method) {
+    return {
+        packageName: "main",
+        serviceName: "GreetService",
+        methodName: method,
+        args: Array.prototype.slice.call(arguments, 1),
+    };
+}
+
+/**
+ * GreetService.Greet
+ * 
+ * @param name {string}
+ * @returns {Promise<string>}
+ **/
+function Greet(name) {
+    return wails.Call(GreetService("Greet", name));
+}
+
+/**
+ * GreetService.GreetPerson
+ * 
+ * @param person {main.Person}
+ * @returns {Promise<string>}
+ **/
+function GreetPerson(person) {
+    return wails.Call(GreetService("GreetPerson", person));
+}
+
+window.go = window.go || {};
+window.go.main = {
+    GreetService: {
+        Greet,
+        GreetPerson,
+    },
+};
+

v3/examples/binding/go.mod

@@ -0,0 +1,21 @@
+module binding
+
+go 1.20
+
+require github.com/wailsapp/wails/v3 v3.0.0-alpha.0
+
+require (
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/leaanthony/slicer v1.5.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/samber/lo v1.37.0 // indirect
+	github.com/wailsapp/mimetype v1.4.1 // indirect
+	github.com/wailsapp/wails/v2 v2.3.2-0.20230117193915-45c3a501d9e6 // indirect
+	golang.org/x/exp v0.0.0-20220930202632-ec3f01382ef9 // indirect
+	golang.org/x/net v0.7.0 // indirect
+)
+
+replace github.com/wailsapp/wails/v3 => ../..
+
+replace github.com/wailsapp/wails/v2 => ../../../v2

v3/examples/binding/go.sum

@@ -1,22 +1,33 @@
-github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=
-github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
+github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
 github.com/leaanthony/slicer v1.5.0 h1:aHYTN8xbCCLxJmkNKiLB6tgcMARl4eWmH9/F+S/0HtY=
 github.com/leaanthony/slicer v1.5.0/go.mod h1:FwrApmf8gOrpzEWM2J/9Lh79tyq8KTX5AzRtwV7m4AY=
 github.com/matryer/is v1.4.0 h1:sosSmIWwkYITGrxZ25ULNDeKiMNzFSr4V/eqBQP0PeE=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
+github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M=
+github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/samber/lo v1.37.0 h1:XjVcB8g6tgUp8rsPsJ2CvhClfImrpL04YpQHXeHPhRw=
+github.com/samber/lo v1.37.0/go.mod h1:9vaz2O4o8oOnK23pd2TrXufcbdbJIa3b6cstBWKpopA=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
 github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhwHs=
 github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o=
-github.com/wailsapp/wails/v2 v2.3.2-0.20230117193915-45c3a501d9e6 h1:Wn+nhnS+VytzE0PegUzSh4T3hXJCtggKGD/4U5H9+wQ=
-github.com/wailsapp/wails/v2 v2.3.2-0.20230117193915-45c3a501d9e6/go.mod h1:zlNLI0E2c2qA6miiuAHtp0Bac8FaGH0tlhA19OssR/8=
-github.com/wailsapp/wails/v3 v3.0.0-alpha.0 h1:T5gqG98Xr8LBf69oxlPkhpsFD59w2SnqUZk6XHj8Zoc=
-github.com/wailsapp/wails/v3 v3.0.0-alpha.0/go.mod h1:OAfO5bP0TSUvCIHZYc6Dqfow/9RqxzHvYtmhWPpo1c0=
+golang.org/x/exp v0.0.0-20220930202632-ec3f01382ef9 h1:RjggHMcaTVp0LOVZcW0bo8alwHrOaCrGUDgfWUHhnN4=
+golang.org/x/exp v0.0.0-20220930202632-ec3f01382ef9/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
 golang.org/x/net v0.0.0-20210505024714-0287a6fb4125/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20220722155237-a158d28d115b h1:PxfKdU9lEEDYjdIzOtC4qFWgkU2rGHdKlKowJSMN9h0=
-golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g=
+golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
-gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

v3/examples/binding/main.go

@@ -1,25 +1,31 @@
 package main
 
 import (
+	"embed"
 	_ "embed"
 	"log"
 
-	"github.com/wailsapp/wails/v3/examples/binding/services"
-
 	"github.com/wailsapp/wails/v3/pkg/application"
 )
 
-type localStruct struct{}
+//go:embed assets
+var assets embed.FS
 
 func main() {
 	app := application.New(application.Options{
 		Bind: []interface{}{
-			&localStruct{},
-			&services.GreetService{},
+			&GreetService{},
+		},
+		Mac: application.MacOptions{
+			ApplicationShouldTerminateAfterLastWindowClosed: true,
 		},
 	})
 
-	app.NewWebviewWindow()
+	app.NewWebviewWindowWithOptions(&application.WebviewWindowOptions{
+		Assets: application.AssetOptions{
+			FS: assets,
+		},
+	})
 
 	err := app.Run()
 

v3/examples/binding/models.ts

@@ -0,0 +1,24 @@
+// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+export namespace main {
+  
+  export class Person {
+    name: string; // Warning: this is unexported in the Go struct.
+    
+    static createFrom(source: any = {}) {
+      return new Person(source);
+    }
+
+    constructor(source: any = {}) {
+      if ('string' === typeof source) {
+        source = JSON.parse(source);
+      }
+
+      this.name = source["name"]
+      
+    }
+  }
+  
+}

v3/examples/binding/models/index.ts

@@ -1,8 +0,0 @@
-// Code generated by tygo. DO NOT EDIT.
-
-//////////
-// source: person.go
-
-export interface Person {
-  Name: string;
-}

v3/examples/binding/models/person.go

@@ -1,5 +0,0 @@
-package models
-
-type Person struct {
-	Name string
-}

v3/examples/binding/services/GreetService.go

@@ -1,23 +0,0 @@
-package services
-
-import (
-	"github.com/wailsapp/wails/v3/examples/binding/models"
-)
-
-type GreetService struct {
-	SomeVariable int
-	lowercase    string
-	Parent       *models.Person
-}
-
-func (*GreetService) Greet(name string) string {
-	return "Hello " + name
-}
-
-func (g *GreetService) GetPerson() *models.Person {
-	return g.Parent
-}
-
-func (g *GreetService) SetPerson(person *models.Person) {
-	g.Parent = person
-}

v3/examples/binding/services/index.ts

@@ -1,9 +0,0 @@
-// Code generated by tygo. DO NOT EDIT.
-
-//////////
-// source: GreetService.go
-
-export interface GreetService {
-  SomeVariable: number /* int */;
-  Parent?: any /* models.Person */;
-}