Update plugins and docs

.github/workflows/pr.yml

@@ -6,15 +6,6 @@ on:
     types: [submitted]
 
 jobs:
-  debug_context:
-    name: Debug Context
-    runs-on: ubuntu-latest
-    steps:
-      - name: Print GitHub Context
-        run: echo "$GITHUB_CONTEXT"
-        env:
-          GITHUB_CONTEXT: ${{ toJson(github) }}
-
   check_docs:
     name: Check Docs
     if: ${{github.repository == 'wailsapp/wails' && contains(github.head_ref,'feature/')}}
@@ -80,26 +71,14 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Run tests (mac) | v2
-        if: ${{ matrix.os == 'macos-latest' && github.base_ref == 'master' }}
+      - name: Run tests (mac)
+        if: matrix.os == 'macos-latest'
         env:
           CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
         working-directory: ./v2
         run: go test -v ./...
 
-      - name: Run tests (!mac) | v2
-        if: ${{ matrix.os != 'macos-latest' && github.base_ref == 'master' }}
-        working-directory:  ./v2
-        run: go test -v ./...
-
-      - name: Run tests (mac) | v3
-        if: ${{ matrix.os == 'macos-latest' && github.base_ref == 'v3-alpha' }}
-        env:
-          CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
-        working-directory: ./v3
-        run: go test -v ./...
-
-      - name: Run tests (!mac) | v3
-        if: ${{ matrix.os != 'macos-latest' && github.base_ref == 'v3-alpha' }}
-        working-directory:  ./v3
+      - name: Run tests (!mac)
+        if: matrix.os != 'macos-latest'
+        working-directory: ./v2
         run: go test -v ./...

mkdocs-website/docs/en/changelog.md

@@ -31,7 +31,6 @@ 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)
 
 ### Fixed
 
@@ -57,8 +56,6 @@ 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)
 
 ### Changed
 

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

@@ -158,6 +158,7 @@ tasks:
         oauth
         plain
         screen
+        server
         show-macos-toolbar
         systray
         video

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>

v3/examples/server/build/info.json

@@ -0,0 +1,15 @@
+{
+	"fixed": {
+		"file_version": "v1.0.0"
+	},
+	"info": {
+		"0000": {
+			"ProductVersion": "v1.0.0",
+			"CompanyName": "My Company Name",
+			"FileDescription": "A thing that does a thing",
+			"LegalCopyright": "(c) 2023 My Company Name",
+			"ProductName": "My Product Name",
+			"Comments": "This is a comment"
+		}
+	}
+}

v3/examples/server/build/wails.exe.manifest

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1" xmlns:asmv3="urn:schemas-microsoft-com:asm.v3">
+    <assemblyIdentity type="win32" name="com.wails.myproductname" version="v1.0.0.0" processorArchitecture="*"/>
+    <dependency>
+        <dependentAssembly>
+            <assemblyIdentity type="win32" name="Microsoft.Windows.Common-Controls" version="6.0.0.0" processorArchitecture="*" publicKeyToken="6595b64144ccf1df" language="*"/>
+        </dependentAssembly>
+    </dependency>
+    <asmv3:application>
+        <asmv3:windowsSettings>
+            <dpiAware xmlns="http://schemas.microsoft.com/SMI/2005/WindowsSettings">true/pm</dpiAware> <!-- fallback for Windows 7 and 8 -->
+            <dpiAwareness xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">permonitorv2,permonitor</dpiAwareness> <!-- falls back to per-monitor if per-monitor v2 is not supported -->
+        </asmv3:windowsSettings>
+    </asmv3:application>
+</assembly>

v3/examples/server/go.mod

@@ -1,21 +1,14 @@
-module oauth
+module server_demo
 
 go 1.22
 
-require (
-	github.com/gorilla/pat v1.0.2
-	github.com/gorilla/sessions v1.2.2
-	github.com/markbates/goth v1.79.0
-	github.com/wailsapp/wails/v3 v3.0.0-alpha.4
-)
+toolchain go1.22.0
+
+require github.com/wailsapp/wails/v3 v3.0.0-alpha.0
 
 require (
-	dario.cat/mergo v1.0.0 // indirect
 	github.com/Microsoft/go-winio v0.6.1 // indirect
-	github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect
 	github.com/bep/debounce v1.2.1 // indirect
-	github.com/cloudflare/circl v1.3.7 // indirect
-	github.com/cyphar/filepath-securejoin v0.2.4 // indirect
 	github.com/ebitengine/purego v0.4.0-alpha.4 // indirect
 	github.com/emirpasic/gods v1.18.1 // indirect
 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
@@ -23,39 +16,37 @@ require (
 	github.com/go-git/go-git/v5 v5.11.0 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/godbus/dbus/v5 v5.1.0 // indirect
-	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/uuid v1.3.0 // indirect
-	github.com/gorilla/context v1.1.2 // indirect
-	github.com/gorilla/mux v1.8.1 // indirect
-	github.com/gorilla/securecookie v1.1.2 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/kevinburke/ssh_config v1.2.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
 	github.com/leaanthony/go-ansi-parser v1.6.1 // indirect
 	github.com/leaanthony/u v1.1.0 // indirect
 	github.com/lmittmann/tint v1.0.3 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.19 // indirect
-	github.com/pjbgf/sha1cd v0.3.0 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/rogpeppe/go-internal v1.11.0 // indirect
 	github.com/samber/lo v1.38.1 // indirect
 	github.com/sergi/go-diff v1.2.0 // indirect
-	github.com/skeema/knownhosts v1.2.1 // indirect
+	github.com/stretchr/testify v1.8.4 // indirect
 	github.com/wailsapp/go-webview2 v1.0.9 // indirect
 	github.com/wailsapp/mimetype v1.4.1 // indirect
 	github.com/xanzy/ssh-agent v0.3.3 // indirect
-	golang.org/x/crypto v0.22.0 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
 	golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect
-	golang.org/x/mod v0.12.0 // indirect
 	golang.org/x/net v0.21.0 // indirect
-	golang.org/x/oauth2 v0.17.0 // indirect
-	golang.org/x/sys v0.19.0 // indirect
-	golang.org/x/tools v0.13.0 // indirect
-	google.golang.org/appengine v1.6.8 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
+	golang.org/x/sys v0.18.0 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
 )
 
 replace github.com/wailsapp/wails/v3 => ../..
+
+replace github.com/wailsapp/wails/v2 => ../../../v2