Change module.json to work with old location of socketlib

This reverts commit 1b657b463d.

.github/workflows/main.yml

@@ -0,0 +1,121 @@
+# GitHub Actions workflow for creating a new FoundryVTT module release.
+#
+# Useful References:
+#   - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+#   - https://docs.github.com/en/actions/learn-github-actions/contexts
+#   - https://docs.github.com/en/actions/learn-github-actions/environment-variables
+#
+# Troubleshooting Checklist:
+#   - Is the module's manifest file valid JSON?
+#     You can test your manifest file using https://jsonlint.com/.
+#
+#   - Does the module's manifest have all the required keys?
+#     See https://foundryvtt.com/article/module-development/#manifest for more
+#     information.
+#
+#   - Are all the proper files and directories being included in the release's
+#     module archive ("module.zip")?
+#     Check that the correct files are being passed to the `zip` command run
+#     in the "Create Module Archive" step below.
+#
+#   - Is the release tag the proper format?
+#     See the comments for the "Extract Version From Tag" step below.
+#
+#   - Is a GitHub release being published?
+#     This workflow will only run when a release is published, not when a
+#     release is updated. Furthermore, note that while a GitHub release will
+#     (by default) create a repository tag, a repository tag will not create
+#     or publish a GitHub release.
+#
+#   - Has the module's entry on FoundryVTT's module administration site
+#     (https://foundryvtt.com/admin) been updated?
+#
+name: Create Module Files For GitHub Release
+
+
+env:
+  # The URL used for the module's "Project URL" link on FoundryVTT's website.
+  project_url: "https://github.com/${{github.repository}}"
+
+  # A URL that will always point to the latest manifest.
+  # FoundryVTT uses this URL to check whether the current module version that
+  # is installed is the latest version. This URL should NOT change,
+  # otherwise FoundryVTT won't be able to perform this check.
+  latest_manifest_url: "https://github.com/${{github.repository}}/releases/latest/download/module.json"
+
+  # The URL to the module archive associated with the module release being
+  # processed by this workflow.
+  release_module_url: "https://github.com/${{github.repository}}/releases/download/${{github.event.release.tag_name}}/module.zip"
+
+
+on:
+  # Only run this workflow when a release is published.
+  # To modify this workflow when other events occur, see:
+  #   - https://docs.github.com/en/actions/using-workflows/triggering-a-workflow
+  #   - https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
+  #   - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+  #
+  # Note that some steps may depend on context variables that are only
+  # available for release events, so if you add other events, you may need to
+  # alter other parts of this workflow.
+  release:
+    types: [published]
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # Substitute the Manifest and Download URLs in the module.json
+      - name: Substitute Manifest and Download Links For Versioned Ones
+        id: sub_manifest_link_version
+        uses: microsoft/variable-substitution@v1
+        with:
+          files: 'module.json'
+        env:
+          version: ${{github.event.release.tag_name}}
+          url: https://github.com/${{github.repository}}
+          manifest: https://github.com/${{github.repository}}/releases/latest/download/module.json
+          download: https://github.com/${{github.repository}}/releases/download/${{github.event.release.tag_name}}/module.zip
+
+      # Create a "module.zip" archive containing all the module's required files.
+      # If you have other directories or files that will need to be added to
+      # your packaged module, add them here.
+      - name: Create Module Archive
+        run: |
+          # Note that `zip` will only emit warnings when a file or directory
+          # doesn't exist, it will not fail.
+          zip                                    \
+            `# Options`                          \
+            --recurse-paths                      \
+            `# The name of the output file`      \
+             ./module.zip                        \
+            `# The files that will be included.` \
+            module.json                          \
+            LICENSE                              \
+            CHANGELOG.md                         \
+            README.md                            \
+            src/
+          # Don't forget to add a backslash at the end of the line for any
+          # additional files or directories!
+
+
+      # Update the GitHub release with the manifest and module archive files.
+      - name: Update Release With Files
+        id: create_version_release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true
+          name: ${{ github.event.release.name }}
+          draft: ${{ github.event.release.unpublished }}
+          prerelease: ${{ github.event.release.prerelease }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          artifacts: './module.json, ./module.zip'
+          tag: ${{ github.event.release.tag_name }}
+          body: ${{ github.event.release.body }}

.gitignore

@@ -0,0 +1 @@
+socketlib.lock

CHANGELOG.md

@@ -1,3 +1,53 @@
+## 1.1.2
+### Compatibility
+- Updated for compatibility with Foundry 13 (338).
+
+## 1.1.1
+- Update module.json for new location and maintainer.
+
+## 1.1.0
+### Compatibility
+- Updated for compatibilty with Foundry 12 (thanks Clemente!)
+
+## 1.0.13
+### Compatibility
+- Verified compatibility with Foundry 11
+
+
+## 1.0.12
+### Compatibility
+- Foundry 10 will no longer show a deprecation warning when modules or systems register in socketlib
+
+## 1.0.11
+### Compatibility
+- Updated for compatibility with Foundry 10
+
+
+## 1.0.10
+### Compatibility
+- Verified compatibility with Foundry 9
+
+
+## 1.0.9
+### Compatibility
+- Verified compatibility with Foundry 0.8.9
+
+
+## 1.0.8
+### Compatibility
+- Verified compatibility with Foundry 0.8.8
+
+
+## 1.0.7
+### Compatibility
+- Verified compatibility with Foundry 0.8.7
+
+
+## 1.0.6
+### Compatibility
+- Verified compatibility with Foundry 0.8.5
+
+
 ## 1.0.5
 ### Compatibility
 - Add support for Foundry 0.8.2

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Manuel Vögele
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,8 @@
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/staebchenfisch)
+[![ko-fi](https://img.shields.io/badge/Ko--Fi-farling-success)](https://ko-fi.com/farling)
+[![patreon](https://img.shields.io/badge/Patreon-amusingtime-success)](https://patreon.com/amusingtime)
+![GitHub License](https://img.shields.io/github/license/farling42/foundryvtt-socketlib)
+![Latest Release Download Count](https://img.shields.io/github/downloads/farling42/foundryvtt-socketlib/latest/module.zip)
+![Forge installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2Ffoundryvtt-socketlib)
 
 # socketlib
 A library for simplifying working with foundries sockets. This module does not have any user facing features. You only need to install it if one of the modules you use lists it as a dependency.

module.json

@@ -1,27 +1,36 @@
 {
-	"name": "socketlib",
+	"id": "socketlib",
 	"title": "socketlib",
 	"description": "A library for easier handling of foundry sockets",
-	"version": "1.0.5",
-	"minimumCoreVersion" : "0.7.9",
-	"compatibleCoreVersion" : "0.8.2",
+	"version": "1.1.1",
+	"compatibility": {
+		"minimum": "11",
+		"verified": "13.338"
+	},
 	"library": true,
 	"authors": [
-		{
+        {
+            "name": "Farling",
+            "url": "https://github.com/farling42",
+            "email": "foundryvtt@amusingtime.uk",
+            "discord": "farling",
+            "ko-fi": "farling",
+            "patreon": "amusingtime"
+        },
+        {
 			"name": "Manuel Vögele",
 			"email": "develop@manuel-voegele.de",
-			"discord": "Stäbchenfisch#5107"
+			"discord": "Stäbchenfisch#5107",
+			"flags": {}
 		}
 	],
 	"esmodules": [
-		"src/libwrapper_shim.js",
 		"src/socketlib.js"
 	],
-	"url": "https://github.com/manuelVo/foundryvtt-socketlib",
-	"download": "https://github.com/manuelVo/foundryvtt-socketlib/archive/v1.0.5.zip",
-	"manifest": "https://raw.githubusercontent.com/manuelVo/foundryvtt-socketlib/master/module.json",
-	"readme": "https://github.com/manuelVo/foundryvtt-socketlib/blob/master/README.md",
-	"changelog": "https://github.com/manuelVo/foundryvtt-socketlib/blob/master/CHANGELOG.md",
-	"bugs": "https://github.com/manuelVo/foundryvtt-socketlib/issues",
-	"allowBugReporter": false
+	"url": "https://github.com/farling42/foundryvtt-socketlib",
+	"download": "https://github.com/farling42/foundryvtt-socketlib/releases/download/v1.1.1/module.zip",
+	"manifest": "https://github.com/farling42/foundryvtt-socketlib/releases/latest/download/module.json",
+	"readme": "https://github.com/farling42/foundryvtt-socketlib/blob/master/README.md",
+	"changelog": "https://github.com/farling42/foundryvtt-socketlib/blob/master/CHANGELOG.md",
+	"bugs": "https://github.com/farling42/foundryvtt-socketlib/issues"
 }

src/libwrapper_shim.js

@@ -1,61 +0,0 @@
-// SPDX-License-Identifier: MIT
-// Copyright © 2021 fvtt-lib-wrapper Rui Pinheiro
-
-'use strict';
-
-// A shim for the libWrapper library
-export let libWrapper = undefined;
-
-Hooks.once('init', () => {
-	// Check if the real module is already loaded - if so, use it
-	if(globalThis.libWrapper && !(globalThis.libWrapper.is_fallback ?? true)) {
-		libWrapper = globalThis.libWrapper;
-		return;
-	}
-
-	// Fallback implementation
-	libWrapper = class {
-		static get is_fallback() { return true };
-
-		static register(module, target, fn, type="MIXED", {chain=undefined}={}) {
-			const is_setter = target.endsWith('#set');
-			target = !is_setter ? target : target.slice(0, -4);
-			const split = target.split('.');
-			const fn_name = split.pop();
-			const root_nm = split.splice(0,1)[0];
-			const _eval = eval; // The browser doesn't expose all global variables (e.g. 'Game') inside globalThis, but it does to an eval. We copy it to a variable to have it run in global scope.
-			const obj = split.reduce((x,y)=>x[y], globalThis[root_nm] ?? _eval(root_nm));
-
-			let iObj = obj;
-			let descriptor = null;
-			while(iObj) {
-				descriptor = Object.getOwnPropertyDescriptor(iObj, fn_name);
-				if(descriptor) break;
-				iObj = Object.getPrototypeOf(iObj);
-			}
-			if(!descriptor || descriptor?.configurable === false) throw `libWrapper Shim: '${target}' does not exist, could not be found, or has a non-configurable descriptor.`;
-
-			let original = null;
-			const wrapper = (chain ?? type != 'OVERRIDE') ? function() { return fn.call(this, original.bind(this), ...arguments); } : function() { return fn.apply(this, arguments); };
-
-			if(!is_setter) {
-				if(descriptor.value) {
-					original = descriptor.value;
-					descriptor.value = wrapper;
-				}
-				else {
-					original = descriptor.get;
-					descriptor.get = wrapper;
-				}
-			}
-			else {
-				if(!descriptor.set) throw `libWrapper Shim: '${target}' does not have a setter`;
-				original = descriptor.set;
-				descriptor.set = wrapper;
-			}
-
-			descriptor.configurable = true;
-			Object.defineProperty(obj, fn_name, descriptor);
-		}
-	}
-});

src/socketlib.js

@@ -1,4 +1,3 @@
-import {libWrapper} from "./libwrapper_shim.js";
 import * as errors from "./errors.js";
 
 const RECIPIENT_TYPES = {
@@ -18,9 +17,10 @@ const MESSAGE_TYPES = {
 
 Hooks.once("init", () => {
 	window.socketlib = new Socketlib();
-	libWrapper.register("socketlib", "Users.prototype.constructor._handleUserActivity", handleUserActivity);
 	Hooks.callAll("socketlib.ready");
-}, "WRAPPER");
+});
+
+Hooks.on("userConnected", handleUserActivity);
 
 class Socketlib {
 	constructor() {
@@ -38,7 +38,7 @@ class Socketlib {
 			console.error(`socketlib | Someone tried to register module '${moduleName}', but no module with that name is active. As a result the registration request has been ignored.`);
 			return undefined;
 		}
-		if (!module.data.socket) {
+		if (!module.socket) {
 			console.error(`socketlib | Failed to register socket for module '${moduleName}'. Please set '"socket":true' in your manifset and restart foundry (you need to reload your world - simply reloading your browser won't do).`);
 			return undefined;
 		}
@@ -55,7 +55,7 @@ class Socketlib {
 		const existingSocket = this.system;
 		if (existingSocket)
 			return existingSocket;
-		if (!game.system.data.socket) {
+		if (!game.system.socket) {
 			console.error(`socketlib | Failed to register socket for system '${systemId}'. Please set '"socket":true' in your manifest and restart foundry (you need to reload your world - simply reloading your browser won't do).`);
 		}
 		const newSocket = new SocketlibSocket(systemId, "system");
@@ -90,7 +90,7 @@ class SocketlibSocket {
 			return this._executeLocal(func, ...args);
 		}
 		else {
-			if (!game.users.find(isActiveGM)) {
+			if (!game.users.activeGM) {
 				throw new errors.SocketlibNoGMConnectedError(`Could not execute handler '${name}' (${func.name}) as GM, because no GM is connected.`);
 			}
 			return this._sendRequest(name, args, RECIPIENT_TYPES.ONE_GM);
@@ -162,7 +162,7 @@ class SocketlibSocket {
 
 	_sendRequest(handlerName, args, recipient) {
 		const message = {handlerName, args, recipient};
-		message.id = randomID();
+		message.id = foundry.utils.randomID();
 		message.type = MESSAGE_TYPES.REQUEST;
 		const promise = new Promise((resolve, reject) => this.pendingRequests.set(message.id, {handlerName, resolve, reject, recipient}));
 		game.socket.emit(this.socketName, message);
@@ -224,7 +224,7 @@ class SocketlibSocket {
 		else {
 			switch (recipient) {
 				case RECIPIENT_TYPES.ONE_GM:
-					if (!isResponsibleGM())
+					if (!game.users.activeGM?.isSelf)
 						return;
 					break;
 				case RECIPIENT_TYPES.ALL_GMS:
@@ -303,42 +303,25 @@ class SocketlibSocket {
 	}
 }
 
-function isResponsibleGM() {
-	if (!game.user.isGM)
-		return false;
-	const connectedGMs = game.users.filter(isActiveGM);
-	return !connectedGMs.some(other => other.data._id < game.user.data._id);
-}
-
-function isActiveGM(user) {
-	return user.active && user.isGM;
-}
-
-function handleUserActivity(wrapper, userId, activityData={}) {
-	const user = game.users.get(userId);
-	const wasActive = user.active;
-	const result = wrapper(userId, activityData);
-
-	// If user disconnected
-	if (!user.active && wasActive) {
+function handleUserActivity(user, active) {
+	if (!active) {
 		const modules = Array.from(socketlib.modules.values());
 		if (socketlib.system)
 			modules.concat(socketlib.system);
-		const GMConnected = Boolean(game.users.find(isActiveGM));
 		// Reject all promises that are still waiting for a response from this player
 		for (const socket of modules) {
 			const failedRequests = Array.from(socket.pendingRequests.entries()).filter(([id, request]) => {
 				const recipient = request.recipient;
 				const handlerName = request.handlerName;
 				if (recipient === RECIPIENT_TYPES.ONE_GM) {
-					if (!GMConnected) {
+					if (!game.users.activeGM) {
 						request.reject(new errors.SocketlibNoGMConnectedError(`Could not execute handler '${handlerName}' as GM, because all GMs disconnected while the execution was being dispatched.`));
 						return true;
 					}
 				}
 				else if (recipient instanceof Array) {
-					if (recipient.includes(userId)) {
-						request.reject(new errors.SocketlibInvalidUserError(`User '${game.users.get(userId).name}' (${userId}) disconnected while handler '${handlerName}' was being dispatched.`));
+					if (recipient.includes(user.id)) {
+						request.reject(new errors.SocketlibInvalidUserError(`User '${user.name}' (${user.id}) disconnected while handler '${handlerName}' was being dispatched.`));
 						return true;
 					}
 				}
@@ -349,5 +332,4 @@ function handleUserActivity(wrapper, userId, activityData={}) {
 			}
 		}
 	}
-	return result;
 }