Initial support for Typescript decl file

* feat: new distros: manjaroARM & Deepin

cmd/fs.go

@@ -132,6 +132,16 @@ func (fs *FSHelper) LocalDir(dir string) (*Dir, error) {
 	}, err
 }
 
+// LoadRelativeFile loads the given file relative to the caller's directory
+func (fs *FSHelper) LoadRelativeFile(relativePath string) ([]byte, error) {
+	_, filename, _, _ := runtime.Caller(0)
+	fullPath, err := filepath.Abs(filepath.Join(path.Dir(filename), relativePath))
+	if err != nil {
+		return nil, err
+	}
+	return ioutil.ReadFile(fullPath)
+}
+
 // GetSubdirs will return a list of FQPs to subdirectories in the given directory
 func (d *Dir) GetSubdirs() (map[string]string, error) {
 

cmd/helpers.go

@@ -99,8 +99,7 @@ func BuildApplication(binaryName string, forceRebuild bool, buildMode string, pa
 				binaryName = strings.TrimSuffix(binaryName, ".exe")
 			}
 		}
-		buildCommand.Add("-o")
-		buildCommand.Add(binaryName)
+		buildCommand.Add("-o", binaryName)
 	}
 
 	// If we are forcing a rebuild
@@ -121,6 +120,16 @@ func BuildApplication(binaryName string, forceRebuild bool, buildMode string, pa
 
 	ldflags += "-X github.com/wailsapp/wails.BuildMode=" + buildMode
 
+	// If we wish to generate typescript
+	if projectOptions.typescriptDefsFilename != "" {
+		cwd, err := os.Getwd()
+		if err != nil {
+			return err
+		}
+		filename := filepath.Join(cwd, projectOptions.FrontEnd.Dir, projectOptions.typescriptDefsFilename)
+		ldflags += " -X github.com/wailsapp/wails/lib/binding.typescriptDefinitionFilename=" + filename
+	}
+
 	buildCommand.AddSlice([]string{"-ldflags", ldflags})
 	err = NewProgramHelper().RunCommandArray(buildCommand.AsSlice())
 	if err != nil {

cmd/linux.go

@@ -47,6 +47,12 @@ const (
 	ArcoLinux
 	// Manjaro distribution
 	Manjaro
+	// ManjaroARM distribution
+	ManjaroARM
+	// Deepin distribution
+	Deepin
+	// Raspbian distribution
+	Raspbian
 )
 
 // DistroInfo contains all the information relating to a linux distribution
@@ -102,6 +108,7 @@ func parseOsRelease(osRelease string) *DistroInfo {
 			version = strings.Trim(splitLine[1], "\"")
 		}
 	}
+
 	// Check distro name against list of distros
 	switch osID {
 	case "fedora":
@@ -134,6 +141,12 @@ func parseOsRelease(osRelease string) *DistroInfo {
 		result.Distribution = ArcoLinux
 	case "manjaro":
 		result.Distribution = Manjaro
+	case "manjaro-arm":
+		result.Distribution = ManjaroARM
+	case "deepin":
+		result.Distribution = Deepin
+	case "raspbian":
+		result.Distribution = Raspbian
 	default:
 		result.Distribution = Unknown
 	}

cmd/linuxdb.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"log"
 
-	"github.com/leaanthony/mewn"
 	"gopkg.in/yaml.v3"
 )
 
@@ -79,11 +78,14 @@ func (l *LinuxDB) GetDistro(distro string) *Distribution {
 // NewLinuxDB creates a new LinuxDB instance from the bundled
 // linuxdb.yaml file.
 func NewLinuxDB() *LinuxDB {
-	data := mewn.Bytes("./linuxdb.yaml")
+	data, err := fs.LoadRelativeFile("./linuxdb.yaml")
+	if err != nil {
+		log.Fatal("Could not load linuxdb.yaml")
+	}
 	result := LinuxDB{
 		Distributions: make(map[string]*Distribution),
 	}
-	err := result.ImportData(data)
+	err = result.ImportData(data)
 	if err != nil {
 		log.Fatal(err)
 	}

cmd/linuxdb.yaml

@@ -82,6 +82,15 @@ distributions:
         gccversioncommand: *gccdumpfullversion
         programs: *debiandefaultprograms
         libraries: *debiandefaultlibraries
+  deepin:
+    id: deepin
+    releases:
+      default:
+        version: default
+        name: Deepin
+        gccversioncommand: *gccdumpfullversion
+        programs: *debiandefaultprograms
+        libraries: *debiandefaultlibraries
   void:
     id: void
     releases:
@@ -158,6 +167,15 @@ distributions:
             help: Please install with `sudo pacman -S gtk3` and try again
           - name: webkit2gtk
             help: Please install with `sudo pacman -S webkit2gtk` and try again
+  arcolinux:
+    id: arcolinux
+    releases:
+      default:
+        version: default
+        name: ArcoLinux
+        gccversioncommand: *gccdumpversion
+        programs: *archdefaultprograms
+        libraries: *archdefaultlibraries
   manjaro:
     id: manjaro
     releases:
@@ -167,12 +185,12 @@ distributions:
         gccversioncommand: *gccdumpversion
         programs: *archdefaultprograms
         libraries: *archdefaultlibraries
-  arcolinux:
-    id: arcolinux
+  manjaro-arm:
+    id: manjaro-arm
     releases:
       default:
         version: default
-        name: ArcoLinux
+        name: Manjaro-ARM
         gccversioncommand: *gccdumpversion
         programs: *archdefaultprograms
         libraries: *archdefaultlibraries
@@ -194,4 +212,14 @@ distributions:
           - name: gtk+:3
             help: Please install with `sudo emerge gtk+:3` and try again
           - name: webkit-gtk
-            help: Please install with `sudo emerge webkit-gtk` and try again
+            help: Please install with `sudo emerge webkit-gtk` and try again
+
+  raspbian:
+    id: raspbian
+    releases:
+      default:
+        version: default
+        name: Raspbian
+        gccversioncommand: *gccdumpfullversion
+        programs: *debiandefaultprograms
+        libraries: *debiandefaultlibraries

cmd/project.go

@@ -142,21 +142,22 @@ func (ph *ProjectHelper) NewProjectOptions() *ProjectOptions {
 
 // ProjectOptions holds all the options available for a project
 type ProjectOptions struct {
-	Name             string    `json:"name"`
-	Description      string    `json:"description"`
-	Author           *author   `json:"author,omitempty"`
-	Version          string    `json:"version"`
-	OutputDirectory  string    `json:"-"`
-	UseDefaults      bool      `json:"-"`
-	Template         string    `json:"-"`
-	BinaryName       string    `json:"binaryname"`
-	FrontEnd         *frontend `json:"frontend,omitempty"`
-	NPMProjectName   string    `json:"-"`
-	system           *SystemHelper
-	log              *Logger
-	templates        *TemplateHelper
-	selectedTemplate *TemplateDetails
-	WailsVersion     string
+	Name                   string    `json:"name"`
+	Description            string    `json:"description"`
+	Author                 *author   `json:"author,omitempty"`
+	Version                string    `json:"version"`
+	OutputDirectory        string    `json:"-"`
+	UseDefaults            bool      `json:"-"`
+	Template               string    `json:"-"`
+	BinaryName             string    `json:"binaryname"`
+	FrontEnd               *frontend `json:"frontend,omitempty"`
+	NPMProjectName         string    `json:"-"`
+	system                 *SystemHelper
+	log                    *Logger
+	templates              *TemplateHelper
+	selectedTemplate       *TemplateDetails
+	WailsVersion           string
+	typescriptDefsFilename string
 }
 
 // Defaults sets the default project template
@@ -165,6 +166,11 @@ func (po *ProjectOptions) Defaults() {
 	po.WailsVersion = Version
 }
 
+// SetTypescriptDefsFilename indicates that we want to generate typescript bindings to the given file
+func (po *ProjectOptions) SetTypescriptDefsFilename(filename string) {
+	po.typescriptDefsFilename = filename
+}
+
 // GetNPMBinaryName returns the type of package manager used by the project
 func (po *ProjectOptions) GetNPMBinaryName() (PackageManager, error) {
 	if po.FrontEnd == nil {

cmd/system.go

@@ -274,9 +274,9 @@ func CheckDependencies(logger *Logger) (bool, error) {
 		distroInfo := GetLinuxDistroInfo()
 
 		switch distroInfo.Distribution {
-		case Ubuntu, Debian, Zorin, Parrot, Linuxmint, Elementary, Kali, Neon:
+		case Ubuntu, Debian, Zorin, Parrot, Linuxmint, Elementary, Kali, Neon, Deepin, Raspbian:
 			libraryChecker = DpkgInstalled
-		case Arch, Manjaro, ArcoLinux:
+		case Arch, ArcoLinux, Manjaro, ManjaroARM:
 			libraryChecker = PacmanInstalled
 		case CentOS, Fedora:
 			libraryChecker = RpmInstalled

cmd/version.go

@@ -1,4 +1,4 @@
 package cmd
 
 // Version - Wails version
-const Version = "v1.0.2-pre2"
+const Version = "v1.0.2-pre4"

cmd/wails/4_build.go

@@ -13,6 +13,8 @@ func init() {
 	var packageApp = false
 	var forceRebuild = false
 	var debugMode = false
+	var typescriptFilename = ""
+
 	buildSpinner := spinner.NewSpinner()
 	buildSpinner.SetSpinSpeed(50)
 
@@ -21,7 +23,8 @@ func init() {
 		LongDescription(commandDescription).
 		BoolFlag("p", "Package application on successful build", &packageApp).
 		BoolFlag("f", "Force rebuild of application components", &forceRebuild).
-		BoolFlag("d", "Build in Debug mode", &debugMode)
+		BoolFlag("d", "Build in Debug mode", &debugMode).
+		StringFlag("t", "Generate Typescript definitions to given file (at runtime)", &typescriptFilename)
 
 	initCmd.Action(func() error {
 
@@ -73,16 +76,13 @@ func init() {
 				return err
 			}
 
-				// Ensure that runtime init.js is the production version
-				err = cmd.InstallProdRuntime(projectDir, projectOptions)
-				if err != nil {
-					return err
-				}
+			// Ensure that runtime init.js is the production version
+			err = cmd.InstallProdRuntime(projectDir, projectOptions)
+			if err != nil {
+				return err
+			}
 		}
 
-	
-
-
 		// Move to project directory
 		err = os.Chdir(projectDir)
 		if err != nil {
@@ -101,6 +101,11 @@ func init() {
 			buildMode = cmd.BuildModeDebug
 		}
 
+		// Save if we wish to dump typescript or not
+		if typescriptFilename != "" {
+			projectOptions.SetTypescriptDefsFilename(typescriptFilename)
+		}
+
 		err = cmd.BuildApplication(projectOptions.BinaryName, forceRebuild, buildMode, packageApp, projectOptions)
 		if err != nil {
 			return err

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/kennygrant/sanitize v1.2.4
 	github.com/konsorten/go-windows-terminal-sequences v1.0.2 // indirect
 	github.com/leaanthony/mewn v0.10.7
-	github.com/leaanthony/slicer v1.3.2
+	github.com/leaanthony/slicer v1.4.0
 	github.com/leaanthony/spinner v0.5.3
 	github.com/mattn/go-colorable v0.1.1 // indirect
 	github.com/mattn/go-isatty v0.0.7 // indirect
@@ -31,3 +31,5 @@ require (
 	gopkg.in/AlecAivazis/survey.v1 v1.8.4
 	gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22
 )
+
+go 1.13

go.sum

@@ -36,6 +36,8 @@ github.com/leaanthony/mewn v0.10.7 h1:jCcNJyIUOpwj+I5SuATvCugDjHkoo+j6ubEOxxrxmP
 github.com/leaanthony/mewn v0.10.7/go.mod h1:CRkTx8unLiSSilu/Sd7i1LwrdaAL+3eQ3ses99qGMEQ=
 github.com/leaanthony/slicer v1.3.2 h1:kGWWFoyaY5WzwGrUsHXMmGbssuYthP4qYBNlkNpNAB8=
 github.com/leaanthony/slicer v1.3.2/go.mod h1:VMB/HGvr3uR3MRpFWHWAm0w+DHQLzPHYe2pKfpFlQIQ=
+github.com/leaanthony/slicer v1.4.0 h1:Q9u4w+UBU4WHjXnEDdz+eRLMKF/rnyosRBiqULnc1J8=
+github.com/leaanthony/slicer v1.4.0/go.mod h1:FwrApmf8gOrpzEWM2J/9Lh79tyq8KTX5AzRtwV7m4AY=
 github.com/leaanthony/spinner v0.5.3 h1:IMTvgdQCec5QA4qRy0wil4XsRP+QcG1OwLWVK/LPZ5Y=
 github.com/leaanthony/spinner v0.5.3/go.mod h1:oHlrvWicr++CVV7ALWYi+qHk/XNA91D9IJ48IqmpVUo=
 github.com/leaanthony/synx v0.1.0 h1:R0lmg2w6VMb8XcotOwAe5DLyzwjLrskNkwU7LLWsyL8=

lib/binding/manager.go

@@ -2,7 +2,11 @@ package binding
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
 	"reflect"
+	"strings"
 	"unicode"
 
 	"github.com/wailsapp/wails/lib/interfaces"
@@ -10,6 +14,8 @@ import (
 	"github.com/wailsapp/wails/lib/messages"
 )
 
+var typescriptDefinitionFilename = ""
+
 // Manager handles method binding
 type Manager struct {
 	methods          map[string]*boundMethod
@@ -21,16 +27,19 @@ type Manager struct {
 	renderer         interfaces.Renderer
 	runtime          interfaces.Runtime // The runtime object to pass to bound structs
 	objectsToBind    []interface{}
-	bindPackageNames bool // Package name should be considered when binding
+	bindPackageNames bool                // Package name should be considered when binding
+	structList       map[string][]string // structList["mystruct"] = []string{"Method1", "Method2"}
 }
 
 // NewManager creates a new Manager struct
 func NewManager() interfaces.BindingManager {
+
 	result := &Manager{
 		methods:         make(map[string]*boundMethod),
 		functions:       make(map[string]*boundFunction),
 		log:             logger.NewCustomLogger("Bind"),
 		internalMethods: newInternalMethods(),
+		structList:      make(map[string][]string),
 	}
 	return result
 }
@@ -88,9 +97,53 @@ func (b *Manager) initialise() error {
 			return err
 		}
 	}
+
+	// If we wish to generate a typescript definition file...
+	if typescriptDefinitionFilename != "" {
+		err := b.generateTypescriptDefinitions()
+		if err != nil {
+			return err
+		}
+	}
 	return nil
 }
 
+// Generate typescript
+func (b *Manager) generateTypescriptDefinitions() error {
+
+	var output strings.Builder
+
+	for structname, methodList := range b.structList {
+		output.WriteString(fmt.Sprintf("Interface %s {\n", structname))
+		for _, method := range methodList {
+			output.WriteString(fmt.Sprintf("\t%s: (...args : any[]) => Promise\n", method))
+		}
+		output.WriteString("}\n")
+	}
+
+	output.WriteString("\n")
+	output.WriteString("Interface Backend {\n")
+
+	for structname := range b.structList {
+		output.WriteString(fmt.Sprintf("\t%[1]s: %[1]s\n", structname))
+	}
+	output.WriteString("}\n")
+
+	globals := `
+declare global {
+	interface Window {
+		backend: Backend;
+	}
+}`
+	output.WriteString(globals)
+
+	b.log.Info("Written Typescript file: " + typescriptDefinitionFilename)
+
+	dir := filepath.Dir(typescriptDefinitionFilename)
+	os.MkdirAll(dir, 0755)
+	return ioutil.WriteFile(typescriptDefinitionFilename, []byte(output.String()), 0755)
+}
+
 // bind the given struct method
 func (b *Manager) bindMethod(object interface{}) error {
 
@@ -104,6 +157,12 @@ func (b *Manager) bindMethod(object interface{}) error {
 
 	b.log.Debugf("Processing struct: %s", baseName)
 
+	// Calc actual name
+	actualName := strings.TrimPrefix(baseName, "main.")
+	if b.structList[actualName] == nil {
+		b.structList[actualName] = []string{}
+	}
+
 	// Iterate over method definitions
 	for i := 0; i < objectType.NumMethod(); i++ {
 
@@ -113,6 +172,8 @@ func (b *Manager) bindMethod(object interface{}) error {
 		fullMethodName := baseName + "." + methodName
 		method := reflect.ValueOf(object).MethodByName(methodName)
 
+		b.structList[actualName] = append(b.structList[actualName], methodName)
+
 		// Skip unexported methods
 		if !unicode.IsUpper([]rune(methodName)[0]) {
 			continue

lib/event/manager.go

@@ -3,7 +3,6 @@ package event
 import (
 	"fmt"
 	"sync"
-	"time"
 
 	"github.com/wailsapp/wails/lib/interfaces"
 	"github.com/wailsapp/wails/lib/logger"
@@ -13,6 +12,7 @@ import (
 // Manager handles and processes events
 type Manager struct {
 	incomingEvents chan *messages.EventData
+	quitChannel    chan struct{}
 	listeners      map[string][]*eventListener
 	running        bool
 	log            *logger.CustomLogger
@@ -24,6 +24,7 @@ type Manager struct {
 func NewManager() interfaces.EventManager {
 	return &Manager{
 		incomingEvents: make(chan *messages.EventData, 100),
+		quitChannel:    make(chan struct{}, 1),
 		listeners:      make(map[string][]*eventListener),
 		running:        false,
 		log:            logger.NewCustomLogger("Events"),
@@ -141,8 +142,8 @@ func (e *Manager) Start(renderer interfaces.Renderer) {
 						}
 					}
 				}
-			default:
-				time.Sleep(1 * time.Millisecond)
+			case <-e.quitChannel:
+				e.running = false
 			}
 		}
 		e.wg.Done()
@@ -152,7 +153,7 @@ func (e *Manager) Start(renderer interfaces.Renderer) {
 // Shutdown is called when exiting the Application
 func (e *Manager) Shutdown() {
 	e.log.Debug("Shutting Down")
-	e.running = false
+	e.quitChannel <- struct{}{}
 	e.log.Debug("Waiting for main loop to exit")
 	e.wg.Wait()
 }

lib/ipc/manager.go

@@ -3,7 +3,6 @@ package ipc
 import (
 	"fmt"
 	"sync"
-	"time"
 
 	"github.com/wailsapp/wails/lib/interfaces"
 	"github.com/wailsapp/wails/lib/logger"
@@ -124,8 +123,8 @@ func (i *Manager) Start(eventManager interfaces.EventManager, bindingManager int
 				i.log.DebugFields("Finished processing message", logger.Fields{
 					"1D": &incomingMessage,
 				})
-			default:
-				time.Sleep(1 * time.Millisecond)
+			case <-i.quitChannel:
+				i.running = false
 			}
 		}
 		i.log.Debug("Stopping")
@@ -175,7 +174,7 @@ func (i *Manager) SendResponse(response *ipcResponse) error {
 // Shutdown is called when exiting the Application
 func (i *Manager) Shutdown() {
 	i.log.Debug("Shutdown called")
-	i.running = false
+	i.quitChannel <- struct{}{}
 	i.log.Debug("Waiting of main loop shutdown")
 	i.wg.Wait()
 }

runtime/js/runtime/events.js

@@ -52,7 +52,8 @@ function Once(eventName, callback) {
  * @param {string} eventName
  */
 function Emit(eventName) {
-	return window.wails.Events.Emit(eventName);
+	var args = [eventName].slice.call(arguments);
+	return window.wails.Events.Emit.apply(null, args);
 }
 
 

runtime/js/runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wailsapp/runtime",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Wails Javascript runtime library",
   "main": "main.js",
   "types": "runtime.d.ts",