@quenty/enums 1.1.0-canary.644.d3040d7.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.1.0-canary.644.d3040d7.0 (2026-01-16)
+
+
+### Features
+
+* Add SimpleEnum package and interface, to simplify enum usage across Nevermore ([d3040d7](https://github.com/Quenty/NevermoreEngine/commit/d3040d7a07ae7b2586bb982399b401fe19f1eb3f))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2026 James Onnen (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,23 @@
+## Enums
+
+<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>
+
+A very simple enum implementation that makes typechecking boilerplate simpler.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/SimpleEnum">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/enums --save
+```

package/default.project.json

@@ -0,0 +1,14 @@
+{
+  "name": "enums",
+  "globIgnorePaths": [
+    "**/.package-lock.json",
+    "**/.pnpm",
+    "**/.pnpm-workspace-state-v1.json",
+    "**/.modules.yaml",
+    "**/.ignored",
+    "**/.ignored_*"
+  ],
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@quenty/enums",
+  "version": "1.1.0-canary.644.d3040d7.0",
+  "description": "Custom Luau enum implementation",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "enums"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/enums/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "scripts": {
+    "preinstall": "npx only-allow pnpm"
+  },
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/loader": "10.9.3",
+    "@quentystudios/t": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "d3040d7a07ae7b2586bb982399b401fe19f1eb3f"
+}

package/src/Shared/SimpleEnum.lua

@@ -0,0 +1,157 @@
+--!strict
+--[=[
+	A very simple enum implementation that makes typechecking boilerplate simpler.
+
+	```lua
+	local require = require(script.Parent.loader).load(script)
+
+	local SimpleEnum = require("SimpleEnum")
+
+	export type MyEnumType = "none" | "always"
+
+	return SimpleEnum.new({
+		NONE = "none" :: "none",
+		ALWAYS = "always" :: "always",
+	})
+	```
+
+	@class SimpleEnum
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local t = require("t")
+
+local SimpleEnum = {}
+SimpleEnum.ClassName = "SimpleEnum"
+
+export type EnumValue = any
+
+export type SimpleEnum<EnumMembers> = EnumMembers & {
+	GetKeys: (self: SimpleEnum<EnumMembers>) -> { string },
+	GetValues: (self: SimpleEnum<EnumMembers>) -> { EnumValue },
+	GetMap: (self: SimpleEnum<EnumMembers>) -> EnumMembers,
+	IsValue: (self: SimpleEnum<EnumMembers>, value: any) -> (boolean, string?),
+	GetInterface: (self: SimpleEnum<EnumMembers>) -> (value: any) -> (boolean, string?),
+}
+
+export type PrivateSimpleEnum<EnumMembers> =
+	typeof(setmetatable(
+		{} :: {
+			_members: { [string]: EnumValue },
+		},
+		{} :: typeof({ __index = SimpleEnum })
+	))
+	& SimpleEnum<EnumMembers>
+
+--[=[
+	Creates a new SimpleEnum. This is indexable like a normal table, BUT it is also
+	type-checkable via `IsValue` and `GetInterface` and more.
+]=]
+function SimpleEnum.new<EnumMembers>(members: EnumMembers): SimpleEnum<EnumMembers>
+	assert(type(members) == "table", "Members must be a table")
+
+	local self: SimpleEnum<EnumMembers> = setmetatable({
+		_members = table.freeze(members),
+	}, SimpleEnum) :: any
+
+	for key, value in pairs(members :: any) do
+		rawset(self, key, value)
+	end
+
+	return self
+end
+
+--[=[
+	Returns the list of enum keys.
+]=]
+function SimpleEnum.GetKeys<EnumMembers>(self: SimpleEnum<EnumMembers>): { string }
+	local members: any = rawget(self, "_members")
+	local keys = {}
+	for key, _ in pairs(members) do
+		table.insert(keys, key)
+	end
+	return keys
+end
+
+--[=[
+	Returns the list of enum values.
+]=]
+function SimpleEnum.GetValues<EnumMembers>(self: SimpleEnum<EnumMembers>): { EnumValue }
+	local members: any = rawget(self, "_members")
+	local values = {}
+	for _, value in pairs(members) do
+		table.insert(values, value)
+	end
+	return values
+end
+
+--[=[
+	Returns the map of enum members.
+]=]
+function SimpleEnum.GetMap<EnumMembers>(self: SimpleEnum<EnumMembers>): EnumMembers
+	return rawget(self, "_members") :: EnumMembers
+end
+
+--[=[
+	Returns whether the value is a valid enum value.
+
+	```lua
+	local MyEnum = SimpleEnum.new({
+		FOO = "foo",
+		BAR = "bar",
+	})
+
+	print(MyEnum:IsValue("foo")) --> true
+	print(MyEnum:IsValue("baz")) --> false, "Expected one of: foo, bar; got baz"
+	```
+]=]
+function SimpleEnum.IsValue<EnumMembers>(self: PrivateSimpleEnum<EnumMembers>, value: any): (boolean, string?)
+	return self:GetInterface()(value)
+end
+
+--[=[
+	Returns a type-checking function for the enum.
+
+	```lua
+	local MyEnum = SimpleEnum.new({
+		FOO = "foo",
+		BAR = "bar",
+	})
+
+	local typeChecker = MyEnum:GetInterface()
+
+	print(typeChecker("foo")) --> true
+	print(typeChecker("baz")) --> false, "Expected one of: foo, bar; got baz"
+	```
+]=]
+function SimpleEnum.GetInterface<EnumMembers>(self: PrivateSimpleEnum<EnumMembers>): (value: any) -> (boolean, string?)
+	local found = rawget(self :: any, "_typeChecker")
+	if found then
+		return found
+	end
+
+	local typeChecker: any = t.valueOf(self:GetValues())
+	rawset(self :: any, "_typeChecker", typeChecker)
+	return typeChecker
+end
+
+SimpleEnum.__index = function<EnumMembers>(self: PrivateSimpleEnum<EnumMembers>, index: string)
+	if SimpleEnum[index] then
+		return SimpleEnum[index]
+	elseif self._members[index] then
+		return self._members[index]
+	else
+		error(`'{tostring(self)}' has no member '{index}'`)
+	end
+end
+
+SimpleEnum.__iter = function<EnumMembers>(self: PrivateSimpleEnum<EnumMembers>)
+	return pairs(self._members)
+end
+
+SimpleEnum.__newindex = function<EnumMembers>(self: PrivateSimpleEnum<EnumMembers>, index: string)
+	error(`Cannot assign to member '{index}' of enum '{tostring(self)}'`)
+end
+
+return SimpleEnum

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,19 @@
+{
+  "name": "EnumsTest",
+  "globIgnorePaths": [
+    "**/.package-lock.json",
+    "**/.pnpm",
+    "**/.pnpm-workspace-state-v1.json",
+    "**/.modules.yaml",
+    "**/.ignored",
+    "**/.ignored_*"
+  ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "enums": {
+        "$path": ".."
+      }
+    }
+  }
+}