[v3] New binding generator

mkdocs-website/docs/en/changelog.md

@@ -73,6 +73,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The `@wailsio/runtime` package does not publish its API on the `window.wails` object, and does not start the WML system. This has been done to improve encapsulation. The WML system can be started manually if desired by calling the new `WML.Enable` method. The bundled JS runtime script still performs both operations automatically. By [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - The Window API module `@wailsio/runtime/src/window` now exposes the containing window object as a default export. It is not possible anymore to import individual methods through ESM named or namespace import syntax.
 - The JS window API has been updated to match the current Go `WebviewWindow` API. Some methods have changed name or prototype, specifically: `Screen` becomes `GetScreen`; `GetZoomLevel`/`SetZoomLevel` become `GetZoom`/`SetZoom`; `GetZoom`, `Width` and `Height` now return values directly instead of wrapping them within objects. By [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
+- The binding generator now uses calls by ID by default. The `-id` CLI option has been removed. Use the `-names` CLI option to switch back to calls by name. By [@fbbdev](https://github.com/fbbdev) in [#3468](https://github.com/wailsapp/wails/pull/3468)
+- New binding code layout: output files were previously organised in folders named after their containing package; now full Go import paths are used, including the module path. By [@fbbdev](https://github.com/fbbdev) in [#3468](https://github.com/wailsapp/wails/pull/3468)
+- The struct field `application.Options.Bind` has been renamed to `application.Options.Services`. By [@fbbdev](https://github.com/fbbdev) in [#3468](https://github.com/wailsapp/wails/pull/3468)
+- New syntax for binding services: service instances must now be wrapped in a call to `application.NewService`. By [@fbbdev](https://github.com/fbbdev) in [#3468](https://github.com/wailsapp/wails/pull/3468)
 
 ### Removed
 

v3/Taskfile.yaml

@@ -3,6 +3,10 @@
 version: "3"
 
 includes:
+  generator:
+    taskfile: ./internal/generator
+    dir: ./internal/generator
+
   runtime:
     taskfile: ./internal/runtime
     dir: ./internal/runtime

v3/cmd/wails3/main.go

@@ -1,13 +1,15 @@
 package main
 
 import (
-	"github.com/pterm/pterm"
-	"github.com/samber/lo"
 	"os"
 	"runtime/debug"
 
+	"github.com/pterm/pterm"
+	"github.com/samber/lo"
+
 	"github.com/leaanthony/clir"
 	"github.com/wailsapp/wails/v3/internal/commands"
+	"github.com/wailsapp/wails/v3/internal/flags"
 )
 
 func init() {
@@ -42,7 +44,13 @@ func main() {
 	generate.NewSubCommandFunction("build-assets", "Generate build assets", commands.GenerateBuildAssets)
 	generate.NewSubCommandFunction("icons", "Generate icons", commands.GenerateIcons)
 	generate.NewSubCommandFunction("syso", "Generate Windows .syso file", commands.GenerateSyso)
-	generate.NewSubCommandFunction("bindings", "Generate bindings + models", commands.GenerateBindings)
+	bindgen := generate.NewSubCommand("bindings", "Generate bindings + models")
+	var bindgenFlags flags.GenerateBindingsOptions
+	bindgen.AddFlags(&bindgenFlags)
+	bindgen.Action(func() error {
+		return commands.GenerateBindings(&bindgenFlags, bindgen.OtherArgs())
+	})
+	bindgen.LongDescription("\nUsage: wails3 generate bindings [flags] [patterns...]\n\nPatterns match packages to scan for bound types.\nPattern format is analogous to that of the Go build tool,\ne.g. './...' matches packages in the current directory and all descendants.\nIf no pattern is given, the tool will fall back to the current directory.")
 	generate.NewSubCommandFunction("constants", "Generate JS constants from Go", commands.GenerateConstants)
 	generate.NewSubCommandFunction(".desktop", "Generate .desktop file", commands.GenerateDotDesktop)
 	generate.NewSubCommandFunction("appimage", "Generate Linux AppImage", commands.GenerateAppImage)

v3/examples/binding/GreetService.go

@@ -1,17 +1,39 @@
 package main
 
-import "github.com/wailsapp/wails/v3/examples/binding/data"
+import (
+	"strconv"
+
+	"github.com/wailsapp/wails/v3/examples/binding/data"
+)
 
 // GreetService is a service that greets people
 type GreetService struct {
 }
 
 // Greet greets a person
-func (*GreetService) Greet(name string) string {
-	return "Hello " + name
+func (*GreetService) Greet(name string, counts ...int) string {
+	times := " "
+
+	for index, count := range counts {
+		if index > 0 {
+			times += ", "
+		}
+		times += strconv.Itoa(count)
+	}
+
+	if len(counts) > 0 {
+		times += " times "
+	}
+
+	return "Hello" + times + name
 }
 
 // GreetPerson greets a person
-func (*GreetService) GreetPerson(person data.Person) string {
-	return "Hello " + person.Name
+func (srv *GreetService) GreetPerson(person data.Person) string {
+	return srv.Greet(person.Name, person.Counts...)
+}
+
+// GetPerson returns a person with the given name.
+func (srv *GreetService) GetPerson(name string) data.Person {
+	return data.Person{Name: name}
 }

v3/internal/parser/testdata/variable_single_from_other_function/frontend/bindings/services/models.interfaces.ts → v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/index.js

@@ -2,9 +2,4 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
-
-export interface Address {
-    street: string;
-    state: string;
-    country: string;
-}
+export * from "./models.js";

v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js

@@ -0,0 +1,53 @@
+// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+import {Create as $Create} from "/wails/runtime.js";
+
+/**
+ * Person holds someone's most important attributes
+ */
+export class Person {
+    /**
+     * Creates a new Person instance.
+     * @param {Partial<Person>} [$$source = {}] - The source object to create the Person.
+     */
+    constructor($$source = {}) {
+        if (!("name" in $$source)) {
+            /**
+             * Name is the person's name
+             * @member
+             * @type {string}
+             */
+            this["name"] = "";
+        }
+        if (!("counts" in $$source)) {
+            /**
+             * Counts tracks the number of time the person
+             * has been greeted in various ways
+             * @member
+             * @type {number[]}
+             */
+            this["counts"] = [];
+        }
+
+        Object.assign(this, $$source);
+    }
+
+    /**
+     * Creates a new Person instance from a string or object.
+     * @param {any} [$$source = {}]
+     * @returns {Person}
+     */
+    static createFrom($$source = {}) {
+        const $$createField1_0 = $$createType0;
+        let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source;
+        if ("counts" in $$parsedSource) {
+            $$parsedSource["counts"] = $$createField1_0($$parsedSource["counts"]);
+        }
+        return new Person(/** @type {Partial<Person>} */($$parsedSource));
+    }
+}
+
+// Private type creation functions
+const $$createType0 = $Create.Array($Create.Any);

v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js

@@ -0,0 +1,50 @@
+// @ts-check
+// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
+// This file is automatically generated. DO NOT EDIT
+
+/**
+ * GreetService is a service that greets people
+ * @module
+ */
+
+import {Call as $Call, Create as $Create} from "/wails/runtime.js";
+
+import * as data$0 from "./data/models.js";
+
+/**
+ * GetPerson returns a person with the given name.
+ * @param {string} name
+ * @returns {Promise<data$0.Person> & { cancel(): void }}
+ */
+export function GetPerson(name) {
+    let $resultPromise = /** @type {any} */($Call.ByID(2952413357, name));
+    let $typingPromise = /** @type {any} */($resultPromise.then(($result) => {
+        return $$createType0($result);
+    }));
+    $typingPromise.cancel = $resultPromise.cancel.bind($resultPromise);
+    return $typingPromise;
+}
+
+/**
+ * Greet greets a person
+ * @param {string} name
+ * @param {number[]} counts
+ * @returns {Promise<string> & { cancel(): void }}
+ */
+export function Greet(name, ...counts) {
+    let $resultPromise = /** @type {any} */($Call.ByID(1411160069, name, counts));
+    return $resultPromise;
+}
+
+/**
+ * GreetPerson greets a person
+ * @param {data$0.Person} person
+ * @returns {Promise<string> & { cancel(): void }}
+ */
+export function GreetPerson(person) {
+    let $resultPromise = /** @type {any} */($Call.ByID(4021313248, person));
+    return $resultPromise;
+}
+
+// Private type creation functions
+const $$createType0 = data$0.Person.createFrom;

v3/internal/parser/testdata/function_from_imported_package/frontend/bindings/services/models.interfaces.ts → v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/index.js

@@ -2,9 +2,7 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
-
-export interface Address {
-    street: string;
-    state: string;
-    country: string;
-}
+import * as GreetService from "./greetservice.js";
+export {
+    GreetService
+};

v3/examples/binding/assets/index.html

@@ -79,16 +79,52 @@
 <div class="input-box" id="input">
     <input autofocus autocomplete="off" class="input" id="name" type="text"/>
     <button class="btn" id="greet-btn">Greet</button>
+    <button class="btn" id="greetperson-btn">GreetPerson</button>
 </div>
 <script type="module">
-    import * as GreetService from "./bindings/main/GreetService.js";
+    import {GreetService} from "./bindings/github.com/wailsapp/wails/v3/examples/binding/index.js";
+    import * as data from "./bindings/github.com/wailsapp/wails/v3/examples/binding/data/index.js";
+
+    let greetCount = 0, greetPersonCount = 0;
 
     async function greet() {
-        document.getElementById("result").innerHTML =
-            await GreetService.Greet(document.getElementById("name").value);
+        ++greetCount;
+        if (greetPersonCount < 1) {
+            if (greetCount < 2) {
+                document.getElementById("result").innerHTML =
+                    await GreetService.Greet(document.getElementById("name").value);
+            } else {
+                document.getElementById("result").innerHTML =
+                    await GreetService.Greet(document.getElementById("name").value, greetCount);
+            }
+        } else {
+            document.getElementById("result").innerHTML =
+                    await GreetService.Greet(document.getElementById("name").value, greetCount, greetPersonCount);
+        }
+    }
+
+    async function greetPerson() {
+        ++greetPersonCount;
+
+        const name = document.getElementById("name").value;
+
+        let person;
+        if (name === "Quincy") {
+            person = await GreetService.GetPerson(name);
+        } else {
+            person = new data.Person({ name });
+        }
+
+        if (greetCount > 0)
+            person.counts.push(greetCount);
+        if (greetCount > 0 || greetPersonCount > 1)
+            person.counts.push(greetPersonCount);
+
+        document.getElementById("result").innerHTML = await GreetService.GreetPerson(person);
     }
 
     document.getElementById("greet-btn").onclick = greet;
+    document.getElementById("greetperson-btn").onclick = greetPerson;
 </script>
 </body>
 </html>

v3/examples/binding/data/person.go

@@ -4,4 +4,8 @@ package data
 type Person struct {
 	// Name is the person's name
 	Name string `json:"name"`
+
+	// Counts tracks the number of time the person
+	// has been greeted in various ways
+	Counts []int `json:"counts"`
 }

v3/examples/binding/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"embed"
-	_ "embed"
 	"log"
 
 	"github.com/wailsapp/wails/v3/pkg/application"
@@ -13,8 +12,8 @@ var assets embed.FS
 
 func main() {
 	app := application.New(application.Options{
-		Bind: []any{
-			&GreetService{},
+		Services: []application.Service{
+			application.NewService(&GreetService{}),
 		},
 		Assets: application.AssetOptions{
 			Handler: application.BundledAssetFileServer(assets),