Update plugins and docs

.github/workflows/build-and-test-alpha.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Install linux dependencies
         if: matrix.os == 'ubuntu-latest'
-        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev javascriptcoregtk-4.1-dev build-essential pkg-config
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev javascriptcoregtk-4.1-dev build-essential pkg-config
 
       - name: Setup Go
         uses: actions/setup-go@v3
@@ -122,7 +122,7 @@ jobs:
 
       - name: Install linux dependencies
         if: matrix.os == 'ubuntu-latest'
-        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev javascriptcoregtk-4.1-dev build-essential pkg-config
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev javascriptcoregtk-4.1-dev build-essential pkg-config
 
       - name: Build Wails3 CLI
         run: |

.github/workflows/pr.yml

@@ -62,12 +62,8 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Install linux dependencies (v3)
-        if:  ${{ matrix.os == 'ubuntu-latest' && github.event.pull_request.base.ref == 'v3-alpha' }}
-        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config
-
-      - name: Install linux dependencies (v2)
-        if:  ${{ matrix.os == 'ubuntu-latest' && github.event.pull_request.base.ref == 'master' }}
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
 
       - name: Setup Go
@@ -75,28 +71,14 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Run tests (mac) | v2
-        if: ${{ matrix.os == 'macos-latest' && github.event.pull_request.base.ref == 'master' }}
+      - name: Run tests (mac)
+        if: matrix.os == 'macos-latest'
         env:
           CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
-          CGO_CFLAGS: -mmacosx-version-min=10.13
         working-directory: ./v2
         run: go test -v ./...
 
-      - name: Run tests (!mac) | v2
-        if: ${{ matrix.os != 'macos-latest' && github.event.pull_request.base.ref == 'master' }}
-        working-directory:  ./v2
-        run: go test -v ./...
-
-      - name: Run tests (mac) | v3
-        if: ${{ matrix.os == 'macos-latest' && github.event.pull_request.base.ref == 'v3-alpha' }}
-        env:
-          CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
-          CGO_CFLAGS: -mmacosx-version-min=10.13
-        working-directory: ./v3
-        run: go test -v ./...
-
-      - name: Run tests (!mac) | v3
-        if: ${{ matrix.os != 'macos-latest' && github.event.pull_request.base.ref == 'v3-alpha' }}
-        working-directory:  ./v3
+      - name: Run tests (!mac)
+        if: matrix.os != 'macos-latest'
+        working-directory: ./v2
         run: go test -v ./...

.github/workflows/publish-npm.yml

@@ -1,20 +0,0 @@
-on:
-  push:
-    branches: ['v3-alpha']
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-      - run: npm ci
-        working-directory: v3/internal/runtime/desktop/@wailsio/runtime
-
-      - uses: JS-DevTools/npm-publish@v3
-        with:
-          package: v3/internal/runtime/desktop/@wailsio/runtime
-          access: public
-          token: ${{ secrets.NPM_TOKEN }}

mkdocs-website/docs/en/changelog.md

@@ -31,13 +31,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support multiple space-separated trigger events in the WML system by [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - Add ESM exports from the bundled JS runtime script by [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - Add binding generator flag for using the bundled JS runtime script instead of the npm package by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
-- Implement `setIcon` on linux by [@abichinger](https://github.com/abichinger) in [#3354](https://github.com/wailsapp/wails/pull/3354)
-- Add flag `-port` to dev command and support environment variable `WAILS_VITE_PORT` by [@abichinger](https://github.com/abichinger) in [#3429](https://github.com/wailsapp/wails/pull/3429)
-- Add tests for bound method calls by [@abichinger](https://github.com/abichinger) in [#3431](https://github.com/wailsapp/wails/pull/3431)
 
 ### Fixed
 
-- Fixed react template css to show footer by [atterpac](https://github.com/atterpac) in [#3477](https://github.com/wailsapp/wails/pull/3477)
 - Fixed zombie processes when working in devmode by updating to latest refresh by [Atterpac](https://github.com/atterpac) in [#3320](https://github.com/wailsapp/wails/pull/3320).
 - Fixed appimage webkit file sourcing by [Atterpac](https://github.com/atterpac) in [#3306](https://github.com/wailsapp/wails/pull/3306).
 - Fixed Doctor apt package verify by [Atterpac](https://github.com/Atterpac) in [#2972](https://github.com/wailsapp/wails/pull/2972).
@@ -60,16 +56,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix custom context menu closing immediately on linux by [@abichinger](https://github.com/abichinger) in [#3330](https://github.com/wailsapp/wails/pull/3330)
 - Fix the output path and extension of model files produced by the binding generator by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
 - Fix the import paths of model files in JS code produced by the binding generator by [@fbbdev](https://github.com/fbbdev) in [#3334](https://github.com/wailsapp/wails/pull/3334)
-- Fix drag-n-drop on some linux distros by [@abichinger](https://github.com/abichinger) in [#3346](https://github.com/wailsapp/wails/pull/3346)
-- Fix missing task for macOS when using `wails3 task dev` by [@hfoxy](https://github.com/hfoxy) in [#3417](https://github.com/wailsapp/wails/pull/3417)
-- Fix registering events causing a nil map assignment by [@hfoxy](https://github.com/hfoxy) in [#3426](https://github.com/wailsapp/wails/pull/3426)
-- Fix unmarshaling of bound method parameters by [@fbbdev](https://github.com/fbbdev) in [#3431](https://github.com/wailsapp/wails/pull/3431)
-- Fix handling of multiple return values from bound methods by [@fbbdev](https://github.com/fbbdev) in [#3431](https://github.com/wailsapp/wails/pull/3431)
-- Fix doctor detection of npm that is not installed with system package manager by [@pekim](https://github.com/pekim) in [#3458](https://github.com/wailsapp/wails/pull/3458)
 
 ### Changed
 
-- Update linux webkit dependency to webkit2gtk-4.1 over webkitgtk2-4.0 to support Ubuntu 24.04 LTS by [atterpac](https://github.com/atterpac) in [#3461](https://github.com/wailsapp/wails/pull/3461)
 - The bundled JS runtime script is now an ESM module: script tags importing it must have the `type="module"` attribute. By [@fbbdev](https://github.com/fbbdev) in [#3295](https://github.com/wailsapp/wails/pull/3295)
 - 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.

mkdocs-website/docs/en/learn/plugins.md

@@ -44,118 +44,7 @@ The `README.md` file provides documentation for the plugin. This should include
 
 ## Example
 
-Here's the Log plugin implementation:
-
-```go
-package log
-
-import (
-	"embed"
-	_ "embed"
-	"github.com/wailsapp/wails/v3/pkg/application"
-	"io/fs"
-	"log/slog"
-)
-
-//go:embed assets/*
-var assets embed.FS
-
-// ---------------- Plugin Setup ----------------
-// This is the main plugin struct. It can be named anything you like.
-// It must implement the application.Plugin interface.
-// Both the Init() and Shutdown() methods are called synchronously when the app starts and stops.
-
-type Config struct {
-	// Logger is the logger to use. If not set, a default logger will be used.
-	Logger *slog.Logger
-
-	// LogLevel defines the log level of the logger.
-	LogLevel slog.Level
-
-	// Handles errors that occur when writing to the log
-	ErrorHandler func(err error)
-}
-
-type Plugin struct {
-	config *Config
-	app    *application.App
-	level  slog.LevelVar
-}
-
-func NewPluginWithConfig(config *Config) *Plugin {
-	if config.Logger == nil {
-		config.Logger = application.DefaultLogger(config.LogLevel)
-	}
-
-	result := &Plugin{
-		config: config,
-	}
-	result.level.Set(config.LogLevel)
-	return result
-}
-
-func NewPlugin() *Plugin {
-	return NewPluginWithConfig(&Config{})
-}
-
-// Shutdown is called when the app is shutting down
-// You can use this to clean up any resources you have allocated
-func (p *Plugin) Shutdown() error { return nil }
-
-// Name returns the name of the plugin.
-// You should use the go module format e.g. github.com/myuser/myplugin
-func (p *Plugin) Name() string {
-	return "github.com/wailsapp/wails/v3/plugins/log"
-}
-
-func (p *Plugin) Init(api application.PluginAPI) error {
-	return nil
-}
-
-// CallableByJS returns a list of methods that can be called from the frontend
-func (p *Plugin) CallableByJS() []string {
-	return []string{
-		"Debug",
-		"Info",
-		"Warning",
-		"Error",
-		"SetLogLevel",
-	}
-}
-
-func (p *Plugin) Assets() fs.FS {
-	return assets
-}
-
-// ---------------- Plugin Methods ----------------
-// Plugin methods are just normal Go methods. You can add as many as you like.
-// The only requirement is that they are exported (start with a capital letter).
-// You can also return any type that is JSON serializable.
-// See https://golang.org/pkg/encoding/json/#Marshal for more information.
-
-func (p *Plugin) Debug(message string, args ...any) {
-	p.config.Logger.Debug(message, args...)
-}
-
-func (p *Plugin) Info(message string, args ...any) {
-	p.config.Logger.Info(message, args...)
-}
-
-func (p *Plugin) Warning(message string, args ...any) {
-	p.config.Logger.Warn(message, args...)
-}
-
-func (p *Plugin) Error(message string, args ...any) {
-	p.config.Logger.Error(message, args...)
-}
-
-func (p *Plugin) SetLogLevel(level slog.Level) {
-	p.level.Set(level)
-}
-
-```
-
-This plugin can be added to the application like this:
+Here's an example of how to use a plugin in your Wails application:
 
 ```go
     Plugins: map[string]application.Plugin{

v2/internal/staticanalysis/test/standard/go.mod

@@ -1,8 +1,8 @@
 module changeme
 
-go 1.22
+go 1.18
 
-require github.com/wailsapp/wails/v2 v2.8.0
+require github.com/wailsapp/wails/v2 v2.3.1
 
 require (
 	github.com/bep/debounce v1.2.1 // indirect

v3/Taskfile.yaml

@@ -132,28 +132,12 @@ tasks:
       - task: format
 #      - task: docs:update:api
 
-  test:example:darwin:
+  test:example:
     dir: 'examples/{{.DIR}}'
-    platforms:
-      - darwin
     cmds:
       - echo "Building example {{.DIR}}"
       - go mod tidy
       - go build -o "testbuild-{{.DIR}}{{exeExt}}"
-    env:
-      CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
-      CGO_CFLAGS: -mmacosx-version-min=10.13
-
-  test:example:notdarwin:
-    dir: 'examples/{{.DIR}}'
-    platforms:
-      - linux
-      - windows
-    cmds:
-      - echo "Building example {{.DIR}}"
-      - go mod tidy
-      - go build -o "testbuild-{{.DIR}}{{exeExt}}"
-
 
   test:examples:
     summary: Builds the examples
@@ -171,8 +155,10 @@ tasks:
         hide-window
         keybindings
         menu
+        oauth
         plain
         screen
+        server
         show-macos-toolbar
         systray
         video
@@ -181,10 +167,6 @@ tasks:
         wml
     cmds:
       - for: { var: EXAMPLEDIRS }
-        task: test:example:darwin
-        vars:
-          DIR: "{{.ITEM}}"
-      - for: { var: EXAMPLEDIRS }
-        task: test:example:notdarwin
+        task: test:example
         vars:
           DIR: "{{.ITEM}}"

v3/examples/environment/assets/index.html

@@ -7,8 +7,7 @@
         body {
             padding-top: 75px;
             margin: 0 auto;
-            background-color: white;
-            color: black;
+            color: white;
             text-align: -webkit-center;
             font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif
         }
@@ -55,7 +54,9 @@
         html += "<tr><td>Debug</td><td>"+ result.Debug +"</td></tr>";
         if(result.PlatformInfo) {
             for (let key in result.PlatformInfo) {
+                if (obj.hasOwnProperty(key)) {
                     html += "<tr><td>"+key+"</td><td>"+ result.PlatformInfo[key] +"</td></tr>";
+                }
             }
         }
         html += "</table>";

v3/examples/oauth/README.md

@@ -0,0 +1,3 @@
+# OAuth Example
+
+This example is not ready for testing yet.

v3/examples/oauth/assets/index.html

@@ -0,0 +1,41 @@
+<!-- templates/index.html -->
+<!doctype html>
+<html>
+<head>
+    <title>Google SignIn</title>
+    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"> <!-- load bulma css -->
+    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> <!-- load fontawesome -->
+</head>
+<body>
+<div id="main" class="container">
+    <div class="jumbotron text-center text-success" style="padding-top:70px;">
+        <h1><span class="fa fa-lock"></span> Social Authentication</h1>
+        <p>Login or Register with:</p>
+        <a wml-event="github-login" class="btn btn-primary"><span class="fa fa-github" style="color: #FFF"></span> SignIn with Github</a>
+    </div>
+</div>
+<div id="details" class="text-center" style="display: none">
+    <image id="logo" style="width:250px"></image>
+    <h3 id="name" style="padding-top: 10px"></h3>
+    <a wml-event="github-logout" class="btn btn-primary"><span class="fa fa-github" style="color: #FFF"></span> Logout </a>
+</div>
+<script type="module">
+    import * as wails from "/wails/runtime.js";
+
+    wails.Events.On("wails:oauth:success", (event) => {
+        document.getElementById("main").style.display = "none";
+        document.getElementById("details").style.display = "block";
+        document.getElementById("name").innerText = event.data.Name;
+        document.getElementById("logo").src = event.data.AvatarURL;
+        document.body.style.backgroundColor = "#000";
+        document.body.style.color = "#FFF";
+    });
+    wails.Events.On("wails:oauth:loggedout", (event) => {
+        document.getElementById("details").style.display = "none";
+        document.getElementById("main").style.display = "block";
+        document.body.style.backgroundColor = "#FFF";
+        document.body.style.color = "#000";
+    });
+</script>
+</body>
+</html>

v3/examples/oauth/main.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"embed"
+	_ "embed"
+	"log"
+	"os"
+
+	"github.com/markbates/goth"
+	"github.com/markbates/goth/providers/github"
+	"github.com/wailsapp/wails/v3/pkg/application"
+	"github.com/wailsapp/wails/v3/plugins/oauth"
+)
+
+//go:embed assets
+var assets embed.FS
+
+func main() {
+
+	oAuthPlugin := oauth.NewPlugin(oauth.Config{
+		Providers: []goth.Provider{
+			github.New(
+				os.Getenv("clientkey"),
+				os.Getenv("secret"),
+				"http://localhost:9876/auth/github/callback",
+				"email",
+				"profile"),
+		},
+	})
+
+	app := application.New(application.Options{
+		Name:        "OAuth Demo",
+		Description: "A demo of the oauth Plugin",
+		Mac: application.MacOptions{
+			ApplicationShouldTerminateAfterLastWindowClosed: true,
+		},
+		Assets: application.AssetOptions{
+			Handler: application.AssetFileServerFS(assets),
+		},
+		Plugins: map[string]application.Plugin{
+			"github.com/wailsapp/wails/v3/plugins/oauth": oAuthPlugin,
+		},
+	})
+
+	app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{
+		Title:                  "OAuth Demo",
+		DevToolsEnabled:        true,
+		OpenInspectorOnStartup: true,
+		Mac: application.MacWindow{
+			Backdrop:                application.MacBackdropTranslucent,
+			TitleBar:                application.MacTitleBarHiddenInsetUnified,
+			InvisibleTitleBarHeight: 50,
+		},
+	})
+
+	app.Events.On("github-login", func(e *application.WailsEvent) {
+		oAuthPlugin.Github()
+	})
+	app.Events.On("github-logout", func(e *application.WailsEvent) {
+		oAuthPlugin.LogoutGithub()
+	})
+
+	err := app.Run()
+
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+}

v3/examples/server/README.md

@@ -0,0 +1,3 @@
+# Server Example
+
+This example is not ready for testing yet.

v3/examples/server/Taskfile.yml

@@ -0,0 +1,41 @@
+version: '3'
+
+tasks:
+
+  pre-build:
+    summary: Pre-build hooks
+
+  post-build:
+    summary: Post-build hooks
+
+  build:
+    summary: Builds the application
+    cmds:
+      - task: pre-build
+      - go build -gcflags=all="-N -l" -o bin/testapp main.go
+      - task: post-build
+    env:
+      GO_CFLAGS: "-mmacosx-version-min=10.13"
+      GO_LDFLAGS: "-mmacosx-version-min=10.13"
+
+  generate-icons:
+    summary: Generates Windows `.ico` and Mac `.icns` files from an image
+    cmds:
+      # Generates both .ico and .icns files
+      - wails generate icons -input build/appicon.png
+
+  build-prod:
+    summary: Creates a production build of the application
+    cmds:
+      - go build -tags production -ldflags="-w -s" -o bin/testapp
+
+  package-darwin:
+    summary: Packages a production build of the application into a `.app` bundle
+    deps:
+        - build-prod
+        - generate-icons
+    cmds:
+      - mkdir -p buildtest.app/Contents/{MacOS,Resources}
+      - cp build/icons.icns buildtest.app/Contents/Resources
+      - cp bin/testapp buildtest.app/Contents/MacOS
+      - cp build/Info.plist buildtest.app/Contents

v3/examples/server/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/server/build/Info.dev.plist

@@ -0,0 +1,35 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundlePackageType</key>
+        <string>APPL</string>
+        <key>CFBundleName</key>
+        <string>My App</string>
+        <key>CFBundleExecutable</key>
+        <string>app</string>
+        <key>CFBundleIdentifier</key>
+        <string>com.wails.app</string>
+        <key>CFBundleVersion</key>
+        <string>v1.0.0</string>
+        <key>CFBundleGetInfoString</key>
+        <string>The ultimate thing</string>
+        <key>CFBundleShortVersionString</key>
+        <string>v1</string>
+        <key>CFBundleIconFile</key>
+        <string>icons</string>
+        <key>LSMinimumSystemVersion</key>
+        <string>10.13.0</string>
+        <key>NSHighResolutionCapable</key>
+        <string>true</string>
+        <key>NSHumanReadableCopyright</key>
+        <string>(c) Me</string>
+        <key>NSAppTransportSecurity</key>
+        <dict>
+            <key>NSAllowsLocalNetworking</key>
+            <true/>
+        </dict>
+    </dict>
+</plist>
+
+    </dict>
+</plist>

v3/examples/server/build/Info.plist

@@ -0,0 +1,27 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundlePackageType</key>
+        <string>APPL</string>
+        <key>CFBundleName</key>
+        <string>My App</string>
+        <key>CFBundleExecutable</key>
+        <string>testapp</string>
+        <key>CFBundleIdentifier</key>
+        <string>com.wails.app</string>
+        <key>CFBundleVersion</key>
+        <string>v1.0.0</string>
+        <key>CFBundleGetInfoString</key>
+        <string>The ultimate thing</string>
+        <key>CFBundleShortVersionString</key>
+        <string>v1</string>
+        <key>CFBundleIconFile</key>
+        <string>icons</string>
+        <key>LSMinimumSystemVersion</key>
+        <string>10.13.0</string>
+        <key>NSHighResolutionCapable</key>
+        <string>true</string>
+        <key>NSHumanReadableCopyright</key>
+        <string>(c) Me</string>
+    </dict>
+</plist>