@quenty/selectionutils 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 SelectionUtils ([bb2b8ea](https://github.com/Quenty/NevermoreEngine/commit/bb2b8eab89c1c9d68ca0c5f8efc728c27ff1130f))

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,21 @@
+## SelectionUtils
+<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>
+
+Utility methods around Selection service. Useful for plugins and stories.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/SelectionUtils">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/selectionutils --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@quenty/selectionutils",
+  "version": "1.0.1-canary.38bdfe3.0",
+  "description": "Utility methods around Selection service. Useful for plugins and stories.",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Selection"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/selectionutils/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "5.1.1",
+    "@quenty/brio": "7.1.1-canary.38bdfe3.0",
+    "@quenty/loader": "5.0.1",
+    "@quenty/maid": "2.4.0",
+    "@quenty/rx": "6.1.1-canary.38bdfe3.0",
+    "@quenty/signal": "2.3.0",
+    "@quenty/table": "3.1.0",
+    "@quenty/valueobject": "6.1.1-canary.38bdfe3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "38bdfe3721bddf1d272628b1104b1d8e0abaf24f"
+}

package/src/Shared/RxSelectionUtils.lua

@@ -0,0 +1,189 @@
+--[=[
+	@class RxSelectionUtils
+]=]
+
+local Selection = game:GetService("Selection")
+
+local require = require(script.Parent.loader).load(script)
+
+local Observable = require("Observable")
+local Maid = require("Maid")
+local Brio = require("Brio")
+local ValueObject = require("ValueObject")
+local RxBrioUtils = require("RxBrioUtils")
+local Set = require("Set")
+
+local RxSelectionUtils = {}
+
+--[=[
+	Observes first selection in the selection list which is of a class
+
+	```lua
+	RxSelectionUtils.observeFirstSelectionWhichIsA("BasePart"):Subscribe(function(part)
+		print("part", part)
+	end)
+	```
+
+	@param className string
+	@return Observable<Instance?>
+]=]
+function RxSelectionUtils.observeFirstSelectionWhichIsA(className)
+	assert(type(className) == "string", "Bad className")
+
+	return RxSelectionUtils.observeFirstSelection(function(inst)
+		return inst:IsA(className)
+	end)
+end
+
+--[=[
+	Observes first selection in the selection list which is an "Adornee"
+
+	@return Observable<Instance?>
+]=]
+function RxSelectionUtils.observeFirstAdornee()
+	return RxSelectionUtils.observeFirstSelection(function(inst)
+		return inst:IsA("BasePart") or inst:IsA("Model")
+	end)
+end
+
+--[=[
+	Observes selection in which are an "Adornee"
+
+	@return Observable<Brio<Instance>>
+]=]
+function RxSelectionUtils.observeAdorneesBrio()
+	return RxSelectionUtils.observeSelectionItemsBrio():Pipe({
+		RxBrioUtils.where(function(inst)
+			return inst:IsA("BasePart") or inst:IsA("Model")
+		end)
+	})
+end
+
+
+--[=[
+	Observes first selection which meets condition
+
+	```lua
+	RxSelectionUtils.observeFirstSelection(function(instance)
+		return instance:IsA("BasePart")
+	end):Subscribe(function(part)
+		print("part", part)
+	end)
+	```
+
+	@param where callback
+	@return Observable<Instance?>
+]=]
+function RxSelectionUtils.observeFirstSelection(where)
+	assert(type(where) == "function", "Bad where")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local current = ValueObject.new(nil)
+		maid:GiveTask(current)
+
+		local function handleSelectionChanged()
+			for _, item in pairs(Selection:Get()) do
+				if where(item) then
+					current.Value = item
+					return
+				end
+			end
+
+			current.Value = nil
+		end
+
+		maid:GiveTask(Selection.SelectionChanged:Connect(handleSelectionChanged))
+		handleSelectionChanged()
+
+		maid:GiveTask(current:Observe():Subscribe(function(value)
+			task.spawn(function()
+				sub:Fire(value)
+			end)
+		end))
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes first selection which meets condition
+
+	@param where callback
+	@return Observable<Brio<Instance>>
+]=]
+function RxSelectionUtils.observeFirstSelectionBrio(where)
+	assert(type(where) == "function", "Bad where")
+
+	return RxSelectionUtils.observeFirstSelection(where):Pipe({
+		RxBrioUtils.toBrio();
+		RxBrioUtils.onlyLastBrioSurvives();
+		RxBrioUtils.where(function(value)
+			return value ~= nil
+		end)
+	})
+end
+
+
+--[=[
+	Observes the current selection table.
+
+	@return Observable<{ Instance }>
+]=]
+function RxSelectionUtils.observeSelectionList()
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local current = Selection:Get()
+
+		maid:GiveTask(Selection.SelectionChanged:Connect(function()
+			sub:Fire(Selection:Get())
+		end))
+		sub:Fire(current)
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes selection items by brio. De-duplicates changed events.
+
+	@return Observable<Brio<Instance>>
+]=]
+function RxSelectionUtils.observeSelectionItemsBrio()
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local lastSet = {}
+
+		local function handleSelectionChanged()
+			local currentSet = Set.fromList(Selection:Get())
+			local toRemoveSet = Set.difference(lastSet, currentSet)
+			local toAddSet = Set.difference(currentSet, lastSet)
+			lastSet = currentSet
+
+			-- Remove first
+			for toRemove, _ in pairs(toRemoveSet) do
+				maid[toRemove] = nil
+			end
+
+			-- Then add
+			for toAdd, _ in pairs(toAddSet) do
+				local brio = Brio.new(toAdd)
+				maid[toAdd] = brio
+
+				task.spawn(function()
+					sub:Fire(brio)
+				end)
+			end
+		end
+
+		maid:GiveTask(Selection.SelectionChanged:Connect(handleSelectionChanged))
+		handleSelectionChanged()
+
+		return maid
+	end)
+end
+
+return RxSelectionUtils

package/src/node_modules.project.json

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