roport 1.3.2 → 2.0.0

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/README.md

@@ -1,33 +0,0 @@
-## ValueBaseUtils
-<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>
-
-Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.
-
-<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ValueBaseUtils">View docs →</a></div>
-
-## Installation
-```
-npm install @quenty/valuebaseutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValue)`
-
-### `ValueBaseUtils.setValue(parent, instanceType, name, value)`
-
-### `ValueBaseUtils.getValue(parent, instanceType, name, default)`
-
-### `ValueBaseUtils.createGetSet(instanceType, name)`
-

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/default.project.json

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

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/package.json

@@ -1,38 +0,0 @@
-{
-  "name": "@quenty/valuebaseutils",
-  "version": "13.20.2",
-  "description": "Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.",
-  "keywords": [
-    "Roblox",
-    "Nevermore",
-    "Lua",
-    "ValueBase"
-  ],
-  "bugs": {
-    "url": "https://github.com/Quenty/NevermoreEngine/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Quenty/NevermoreEngine.git",
-    "directory": "src/valuebaseutils/"
-  },
-  "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/quenty"
-  },
-  "license": "MIT",
-  "contributors": [
-    "Quenty"
-  ],
-  "dependencies": {
-    "@quenty/brio": "file:../brio",
-    "@quenty/instanceutils": "file:../instanceutils",
-    "@quenty/loader": "file:../loader",
-    "@quenty/promise": "file:../promise",
-    "@quenty/rx": "file:../rx",
-    "@quenty/rxsignal": "file:../rxsignal"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/src/Shared/RxValueBaseUtils.lua

@@ -1,77 +0,0 @@
---!strict
---[=[
-	@class RxValueBaseUtils
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Brio = require("Brio")
-local Observable = require("Observable")
-local Rx = require("Rx")
-local RxBrioUtils = require("RxBrioUtils")
-local RxInstanceUtils = require("RxInstanceUtils")
-
-local RxValueBaseUtils = {}
-
---[=[
-	Observes a value base underneath a parent (last named child).
-
-	@param parent Instance
-	@param className string
-	@param name string
-	@param predicate callback -- Optional callback
-	@return Observable<Brio<any>>
-]=]
-function RxValueBaseUtils.observeBrio(
-	parent: Instance,
-	className: string,
-	name: string,
-	predicate: Rx.Predicate<any>?
-): Observable.Observable<Brio.Brio<any>>
-	assert(typeof(parent) == "Instance", "Bad parent")
-	assert(type(className) == "string", "Bad className")
-	assert(type(name) == "string", "Bad naem")
-
-	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name):Pipe({
-		RxBrioUtils.switchMapBrio(RxValueBaseUtils.observeValue) :: any,
-		RxBrioUtils.onlyLastBrioSurvives() :: any,
-		if predicate then RxBrioUtils.where(predicate) :: any else nil :: never,
-	}) :: any
-end
-
---[=[
-	Observes a value base underneath a parent
-
-	@param parent Instance
-	@param className string
-	@param name string
-	@param defaultValue any
-	@return Observable<any>
-]=]
-function RxValueBaseUtils.observe(
-	parent: Instance,
-	className: string,
-	name: string,
-	defaultValue: any?
-): Observable.Observable<any>
-	assert(typeof(parent) == "Instance", "Bad parent")
-	assert(type(className) == "string", "Bad className")
-	assert(type(name) == "string", "Bad name")
-
-	return RxValueBaseUtils.observeBrio(parent, className, name):Pipe({
-		RxBrioUtils.emitOnDeath(defaultValue) :: any,
-	}) :: any
-end
-
---[=[
-	Observables a given value object's value
-	@param valueObject Instance
-	@return Observable<T>
-]=]
-function RxValueBaseUtils.observeValue(valueObject: ValueBase): Observable.Observable<any>
-	assert(typeof(valueObject) == "Instance", "Bad valueObject")
-
-	return RxInstanceUtils.observeProperty(valueObject, "Value")
-end
-
-return RxValueBaseUtils

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/src/Shared/ValueBaseUtils.lua

@@ -1,221 +0,0 @@
---!strict
---[=[
-	Provides utilities for working with ValueBase objects, like [IntValue] or [ObjectValue] in Roblox.
-
-	@class ValueBaseUtils
-]=]
-
-local ValueBaseUtils = {}
-
-local TYPE_TO_CLASSNAME_LOOKUP = {
-	["nil"] = "ObjectValue",
-	boolean = "BoolValue",
-	number = "NumberValue",
-	string = "StringValue",
-
-	BrickColor = "BrickColorValue",
-	CFrame = "CFrameValue",
-	Color3 = "Color3Value",
-	Instance = "ObjectValue",
-	Ray = "RayValue",
-	Vector3 = "Vector3Value",
-}
-
-local VALUE_BASE_TYPE_LOOKUP = {
-	BoolValue = "boolean",
-	NumberValue = "number",
-	IntValue = "number",
-	StringValue = "string",
-	BrickColorValue = "BrickColor",
-	CFrameValue = "CFrame",
-	Color3Value = "Color3",
-	ObjectValue = "Instance",
-	RayValue = "Ray",
-	Vector3Value = "Vector3",
-}
-
-export type ValueBaseType =
-	"BoolValue"
-	| "NumberValue"
-	| "IntValue"
-	| "StringValue"
-	| "BrickColorValue"
-	| "CFrameValue"
-	| "Color3Value"
-	| "ObjectValue"
-	| "RayValue"
-	| "Vector3Value"
-
---[=[
-	Returns true if the value is a ValueBase instance
-
-	@param instance Instance
-	@return boolean
-]=]
-function ValueBaseUtils.isValueBase(instance: Instance): boolean
-	return typeof(instance) == "Instance" and instance:IsA("ValueBase")
-end
-
---[=[
-	Gets the lua type for the given class name
-
-	@param valueBaseClassName string
-	@return string?
-]=]
-function ValueBaseUtils.getValueBaseType(valueBaseClassName: ValueBaseType): string?
-	return VALUE_BASE_TYPE_LOOKUP[valueBaseClassName]
-end
-
---[=[
-	Gets class type for the given lua type
-
-	@param luaType string
-	@return string?
-]=]
-function ValueBaseUtils.getClassNameFromType(luaType: string): string?
-	return TYPE_TO_CLASSNAME_LOOKUP[luaType]
-end
-
---[=[
-	Initializes the value as needed
-
-	@param parent Instance
-	@param instanceType string
-	@param name string
-	@param defaultValue any?
-	@return Instance
-]=]
-function ValueBaseUtils.getOrCreateValue(
-	parent: Instance,
-	instanceType: ValueBaseType,
-	name: string,
-	defaultValue
-): Instance
-	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
-	assert(type(name) == "string", "Bad argument 'name'")
-
-	local foundChild = parent:FindFirstChild(name)
-	if foundChild then
-		if not foundChild:IsA(instanceType) then
-			warn(
-				string.format(
-					"[ValueBaseUtils.getOrCreateValue] - Value of type %q of name %q is of type %q in %s instead",
-					instanceType,
-					name,
-					foundChild.ClassName,
-					foundChild:GetFullName()
-				)
-			)
-		end
-
-		return foundChild
-	else
-		local newChild: any = Instance.new(instanceType)
-		newChild.Name = name
-		newChild.Value = defaultValue
-		newChild.Parent = parent
-
-		return newChild
-	end
-end
-
---[=[
-	Sets the value for the parent
-
-	@param parent Instance
-	@param instanceType string
-	@param name string
-	@param value any
-	@return any
-]=]
-function ValueBaseUtils.setValue(parent: Instance, instanceType: ValueBaseType, name: string, value: any)
-	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
-	assert(type(name) == "string", "Bad argument 'name'")
-
-	local foundChild = parent:FindFirstChild(name)
-	if foundChild then
-		if not foundChild:IsA(instanceType) then
-			warn(
-				string.format(
-					"[ValueBaseUtils.setValue] - Value of type %q of name %q is of type %q in %s instead",
-					instanceType,
-					name,
-					foundChild.ClassName,
-					foundChild:GetFullName()
-				)
-			)
-		end
-
-		(foundChild :: any).Value = value
-	else
-		local newChild: any = Instance.new(instanceType)
-		newChild.Name = name
-		newChild.Value = value
-		newChild.Parent = parent
-	end
-end
-
---[=[
-	Gets the value in the children
-
-	@param parent Instance
-	@param instanceType string
-	@param name string
-	@param default any?
-	@return any
-]=]
-function ValueBaseUtils.getValue(parent: Instance, instanceType: ValueBaseType, name: string, default: any?)
-	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
-	assert(type(name) == "string", "Bad argument 'name'")
-
-	local foundChild = parent:FindFirstChild(name)
-	if foundChild then
-		if foundChild:IsA(instanceType) then
-			return (foundChild :: any).Value
-		else
-			warn(
-				string.format(
-					"[ValueBaseUtils.getValue] - Value of type %q of name %q is of type %q in %s instead",
-					instanceType,
-					name,
-					foundChild.ClassName,
-					foundChild:GetFullName()
-				)
-			)
-			return nil
-		end
-	else
-		return default
-	end
-end
-
---[=[
-	Gets a getter, setter, and initializer for the instance type and name.
-
-	@param instanceType string
-	@param name string
-	@return function
-	@return function
-	@return function
-]=]
-function ValueBaseUtils.createGetSet(instanceType: ValueBaseType, name: string)
-	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
-	assert(type(name) == "string", "Bad argument 'name'")
-
-	return function(parent, defaultValue)
-		assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-
-		return ValueBaseUtils.getValue(parent, instanceType, name, defaultValue)
-	end, function(parent, value)
-		assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-
-		return ValueBaseUtils.setValue(parent, instanceType, name, value)
-	end, function(parent, defaultValue)
-		return ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValue)
-	end
-end
-
-return ValueBaseUtils

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/src/Shared/ValueBaseValue.lua

@@ -1,114 +0,0 @@
---[=[
-	For when attributes don't work
-
-	@class ValueBaseValue
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local RunService = game:GetService("RunService")
-
-local Brio = require("Brio")
-local Observable = require("Observable")
-local Rx = require("Rx")
-local RxSignal = require("RxSignal")
-local RxValueBaseUtils = require("RxValueBaseUtils")
-local ValueBaseUtils = require("ValueBaseUtils")
-
-local ValueBaseValue = {}
-ValueBaseValue.ClassName = "ValueBaseValue"
-ValueBaseValue.__index = ValueBaseValue
-
-export type ValueBaseValue = typeof(setmetatable(
-	{} :: {
-		_parent: Instance,
-		_className: ValueBaseUtils.ValueBaseType,
-		_name: string,
-		_defaultValue: any?,
-		Value: any?,
-		Changed: RxSignal.RxSignal<any>,
-	},
-	{} :: typeof({ __index = ValueBaseValue })
-))
-
---[=[
-	Constructs a ValueBaseValue object. This is a wrapper around the value base
-	underneath the parent. It will create the value base if it does not exist.
-
-	@param parent Instance
-	@param className string
-	@param name string
-	@param defaultValue any?
-	@return ValueBaseValue
-]=]
-function ValueBaseValue.new(
-	parent: Instance,
-	className: ValueBaseUtils.ValueBaseType,
-	name: string,
-	defaultValue: any?
-): ValueBaseValue
-	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
-	assert(type(className) == "string", "Bad argument 'className'")
-	assert(type(name) == "string", "Bad argument 'name'")
-
-	local self = {}
-
-	self._parent = parent
-	self._name = name
-	self._className = className
-	self._defaultValue = defaultValue
-
-	-- Initialize on the server
-	if RunService:IsServer() then
-		ValueBaseUtils.getOrCreateValue(parent, self._className, self._name, self._defaultValue)
-	end
-
-	return setmetatable(self, ValueBaseValue) :: any
-end
-
---[=[
-	Observes the value base value. This will return a brio of the value base
-	underneath the parent.
-
-	@param predicate ((any) -> boolean)? -- Optional callback
-	@return Observable<Brio<any>>
-]=]
-function ValueBaseValue.ObserveBrio(
-	self: ValueBaseValue,
-	predicate: Rx.Predicate<any>?
-): Observable.Observable<Brio.Brio<any>>
-	return RxValueBaseUtils.observeBrio(self._parent, self._className, self._name, predicate)
-end
-
---[=[
-	Observes the value base value's
-
-	@return Observable<any>
-]=]
-function ValueBaseValue.Observe(self: ValueBaseValue): Observable.Observable<any>
-	return RxValueBaseUtils.observe(self._parent, self._className, self._name, self._defaultValue)
-end
-
-(ValueBaseValue :: any).__index = function(self: any, index)
-	if index == "Value" then
-		return ValueBaseUtils.getValue(self._parent, self._className, self._name, self._defaultValue)
-	elseif index == "Changed" then
-		return RxSignal.new(self:Observe():Pipe({
-			Rx.skip(1),
-		}))
-	elseif ValueBaseValue[index] or index == "_defaultValue" then
-		return ValueBaseValue[index]
-	else
-		error(string.format("%q is not a member of ValueBaseValue", tostring(index)))
-	end
-end
-
-function ValueBaseValue.__newindex(self: ValueBaseValue, index, value)
-	if index == "Value" then
-		ValueBaseUtils.setValue(self._parent, self._className, self._name, value)
-	else
-		error(string.format("%q is not a member of ValueBaseValue", tostring(index)))
-	end
-end
-
-return ValueBaseValue

package/templates/default/src/shared/modules/Nevermore/valuebaseutils/src/node_modules.project.json

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