@quenty/bindtocloseservice 1.0.1-canary.38bdfe3.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.38bdfe3.0 (2022-09-07)
+
+
+### Features
+
+* Add BindToCloseService package and implement across places binding to close ([afdd829](https://github.com/Quenty/NevermoreEngine/commit/afdd829538c9d0ce2d6f51ad9fee9063f0f5bd24))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2022 Quenty
+
+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.

package/README.md

@@ -0,0 +1,22 @@
+## BindToCloseService
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Service which binds to game close and allows unbinding.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BindToCloseService">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/bindtocloseservice --save
+```
+

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "bindtocloseservice",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/bindtocloseservice",
+  "version": "1.0.1-canary.38bdfe3.0",
+  "description": "Bind to game close API in a centralized location.",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/blend/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@quenty/loader": "5.0.1",
+    "@quenty/promise": "5.1.2-canary.38bdfe3.0",
+    "@quenty/symbol": "2.1.0"
+  },
+  "devDependencies": {
+    "@quenty/contentproviderutils": "5.1.2-canary.38bdfe3.0",
+    "@quenty/playerthumbnailutils": "5.2.2-canary.38bdfe3.0"
+  },
+  "gitHead": "38bdfe3721bddf1d272628b1104b1d8e0abaf24f"
+}

package/src/Server/BindToCloseService.lua

@@ -0,0 +1,62 @@
+--[=[
+	Allows unregisterable BindToClose callbacks. This is important because you can't unbind
+	:BindToClose calls normally, so we need to provide another place to guarantee clean shutdowns.
+
+	@class BindToCloseService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local PromiseUtils = require("PromiseUtils")
+local Symbol = require("Symbol")
+local Promise = require("Promise")
+
+local BindToCloseService = {}
+BindToCloseService.ServiceName = "BindToCloseService"
+
+function BindToCloseService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._subscriptions = {}
+end
+
+function BindToCloseService:Start()
+	game:BindToClose(function()
+		local promises = {}
+
+		for _, caller in pairs(self._subscriptions) do
+			local promise = caller()
+			if Promise.isPromise(promise) then
+				table.insert(promises, promise)
+			else
+				warn("[BindToCloseService.BindToClose] - Bad promise returned from close callback.")
+			end
+		end
+
+		local ok, err = PromiseUtils.all(promises):Yield()
+		if not ok then
+			warn(err)
+		end
+	end)
+end
+
+--[=[
+	Binds the promise to call on close. Can be unregistered
+
+	@param saveCallback function
+	@return function -- Call to unregister callback
+]=]
+function BindToCloseService:RegisterPromiseOnCloseCallback(saveCallback)
+	assert(type(saveCallback) == "function", "Bad saveCallback")
+
+	local id = Symbol.named("savingCallbackId")
+
+	self._subscriptions[id] = saveCallback
+
+	return function()
+		self._subscriptions[id] = nil
+	end
+end
+
+return BindToCloseService

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}