@rbxts/planck 0.2.5 → 0.3.0-alpha.2

package/package.json

@@ -1,51 +1,40 @@
-{
-  "name": "@rbxts/planck",
-  "version": "0.2.5",
-  "description": "An agnostic scheduler for ECS",
-  "main": "out/init.lua",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yetanotherclown/planck"
-  },
-  "homepage": "https://yetanotherclown.github.io/planck",
-  "keywords": [
-    "ECS",
-    "Entity Component System",
-    "Scheduler",
-    "@rbxts",
-    "Roblox",
-    "Roblox-TS",
-    "roblox ts",
-    "roblox-ts"
-  ],
-  "author": "YetAnotherClown",
-  "license": "MIT",
-  "types": "out/index.d.ts",
-  "files": [
-    "out",
-    "!**/*.tsbuildinfo",
-    "!out/__tests__",
-    "!out/__tests__/**/*",
-    "!out/jest.config.luau"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@rbxts/compiler-types": "3.0.0-types.0",
-    "@rbxts/types": "^1.0.813",
-    "@typescript-eslint/eslint-plugin": "^8.19.0",
-    "@typescript-eslint/parser": "^8.19.0",
-    "eslint": "^9.17.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-roblox-ts": "^0.0.36",
-    "prettier": "^3.4.2",
-    "roblox-ts": "^3.0.0",
-    "typescript": "^5.7.2"
-  },
-  "scripts": {
-    "build": "rbxtsc",
-    "watch": "rbxtsc -w"
-  }
-}
+{
+	"name": "@rbxts/planck",
+	"version": "0.3.0-alpha.2",
+	"description": "An Agnostic Scheduler for ECS",
+	"main": "src",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/YetAnotherClown/planck.git"
+	},
+	"keywords": [],
+	"author": "YetAnotherClown",
+	"contributors": [
+		"YetAnotherClown",
+		"MajestikButter"
+	],
+	"homepage": "https://github.com/YetAnotherClown/planck",
+	"license": "MIT",
+	"types": "src/index.d.ts",
+	"files": [
+		"src",
+		"LICENSE.md",
+		"README.md"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"devDependencies": {
+		"@rbxts/compiler-types": "^2.3.0-types.1",
+		"@rbxts/types": "^1.0.781",
+		"@typescript-eslint/eslint-plugin": "^5.8.0",
+		"@typescript-eslint/parser": "^5.8.0",
+		"eslint": "^8.5.0",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-prettier": "^4.0.0",
+		"eslint-plugin-roblox-ts": "^0.0.32",
+		"prettier": "^2.5.1",
+		"roblox-ts": "^3.0.0",
+		"typescript": "^5.4.2"
+	}
+}

package/{out → src}/DependencyGraph.luau

@@ -1,180 +1,220 @@
-local AdjacencyMatrix = {}
-AdjacencyMatrix.__index = AdjacencyMatrix
-
-function AdjacencyMatrix:__tostring()
-	local s = "\n"
-
-	for i = 1, self.length do
-		if i == 1 then
-			s ..= "\n"
-		end
-
-		local sub = ""
-		for j = 1, self.width do
-			if j == self.width then
-				sub ..= `{self.matrix[i][j]}`
-				continue
-			end
-
-			sub ..= `{self.matrix[i][j]}, `
-		end
-
-		sub ..= "\n"
-		s ..= sub
-	end
-
-	return s
-end
-
-function AdjacencyMatrix:extend()
-	self.length = (self.length :: number) + 1
-	self.width = (self.length :: number) + 1
-
-	self.matrix[self.length] = {}
-	for j = 1, self.width do
-		self.matrix[self.length][j] = 0
-	end
-
-	for i = 1, self.length do
-		self.matrix[i][self.width] = 0
-	end
-end
-
-function AdjacencyMatrix:setEdge(i, j, val)
-	self.matrix[i][j] = val
-end
-
-function AdjacencyMatrix:toAdjacencyList()
-	local list = {}
-
-	for i = 1, self.length do
-		list[i] = {}
-		for j = 1, self.width do
-			if self.matrix[i][j] ~= 0 then
-				table.insert(list[i], j)
-			end
-		end
-	end
-
-	return list
-end
-
-function AdjacencyMatrix:topologicalSort(): { number }?
-	local adjacencyList = self:toAdjacencyList()
-
-	local result = {}
-	local inDegrees = table.create(self.length, 0)
-
-	for i = 1, self.length do
-		for _, j in adjacencyList[i] do
-			inDegrees[j] += 1
-		end
-	end
-
-	local queue = {}
-	for i = 1, self.length do
-		if inDegrees[i] == 0 then
-			table.insert(queue, i)
-		end
-	end
-
-	while #queue ~= 0 do
-		local i = table.remove(queue, 1) :: number
-		table.insert(result, i)
-
-		for _, j in adjacencyList[i] do
-			inDegrees[j] -= 1
-			if inDegrees[j] == 0 then
-				table.insert(queue, j)
-			end
-		end
-	end
-
-	if #result ~= self.length then
-		return nil
-	end
-
-	return result
-end
-
-function AdjacencyMatrix.new()
-	return setmetatable({
-		matrix = {},
-		length = 0,
-		width = 0,
-	}, AdjacencyMatrix)
-end
-
-local DependencyGraph = {}
-DependencyGraph.__index = DependencyGraph
-
-function DependencyGraph:getOrderedList(): { any }?
-	local orderedList = {}
-
-	local topologicalSort = self.matrix:topologicalSort()
-	if not topologicalSort then
-		return nil
-	end
-
-	for _, i in topologicalSort do
-		table.insert(orderedList, self.nodes[i])
-	end
-
-	return orderedList
-end
-
-function DependencyGraph:insertBefore(node, beforeNode)
-	if not table.find(self.nodes, beforeNode) then
-		error("Node not found in DependencyGraph:insertBefore(_, unknown)")
-	end
-
-	table.insert(self.nodes, node)
-	local j = #self.nodes
-	local i = table.find(self.nodes, beforeNode)
-
-	self.matrix:extend()
-	self.matrix:setEdge(j, i, 1)
-
-	return self
-end
-
-function DependencyGraph:insertAfter(node, afterNode)
-	if not table.find(self.nodes, afterNode) then
-		error("Node not found in DependencyGraph:insertAfter(_, unknown)")
-	end
-
-	table.insert(self.nodes, node)
-
-	local j = #self.nodes
-	local i = table.find(self.nodes, afterNode)
-
-	self.matrix:extend()
-	self.matrix:setEdge(i, j, 1)
-
-	return self
-end
-
-function DependencyGraph:insert(node)
-	local i = #self.nodes
-	table.insert(self.nodes, node)
-	local j = #self.nodes
-
-	self.matrix:extend()
-
-	if i ~= 0 then
-		self.matrix:setEdge(i, j, 1)
-	end
-
-	return self
-end
-
-function DependencyGraph.new()
-	return setmetatable({
-		nodes = {},
-		matrix = AdjacencyMatrix.new(),
-		length = 0,
-		width = 0,
-	}, DependencyGraph)
-end
-
-return DependencyGraph
+local AdjacencyMatrix = {}
+AdjacencyMatrix.__index = AdjacencyMatrix
+
+export type AdjacencyMatrix = {
+	matrix: { { number } },
+	length: number,
+	width: number,
+
+	extend: (self: AdjacencyMatrix) -> (),
+	setEdge: (self: AdjacencyMatrix, i: number, j: number, v: number) -> (),
+	toAdjacencyList: (self: AdjacencyMatrix) -> { { number } },
+	topologicalSort: (self: AdjacencyMatrix) -> { number }?,
+	new: () -> AdjacencyMatrix,
+}
+
+function AdjacencyMatrix:__tostring()
+	local s = "\n"
+
+	for i = 1, self.length do
+		if i == 1 then
+			s ..= "\n"
+		end
+
+		local sub = ""
+		for j = 1, self.width do
+			if j == self.width then
+				sub ..= `{self.matrix[i][j]}`
+				continue
+			end
+
+			sub ..= `{self.matrix[i][j]}, `
+		end
+
+		sub ..= "\n"
+		s ..= sub
+	end
+
+	return s
+end
+
+function AdjacencyMatrix:extend()
+	self.length = (self.length :: number) + 1
+	self.width = (self.length :: number) + 1
+
+	self.matrix[self.length] = {}
+	for j = 1, self.width do
+		self.matrix[self.length][j] = 0
+	end
+
+	for i = 1, self.length do
+		self.matrix[i][self.width] = 0
+	end
+end
+
+function AdjacencyMatrix:setEdge(i, j, val)
+	self.matrix[i][j] = val
+end
+
+function AdjacencyMatrix:toAdjacencyList()
+	local list = {}
+
+	for i = 1, self.length do
+		list[i] = {}
+		for j = 1, self.width do
+			if self.matrix[i][j] ~= 0 then
+				table.insert(list[i], j)
+			end
+		end
+	end
+
+	return list
+end
+
+function AdjacencyMatrix:topologicalSort(): { number }?
+	local adjacencyList = self:toAdjacencyList()
+
+	local result = {}
+	local inDegrees = table.create(self.length, 0)
+
+	for i = 1, self.length do
+		for _, j in adjacencyList[i] do
+			inDegrees[j] += 1
+		end
+	end
+
+	local queue = {}
+	for i = 1, self.length do
+		if inDegrees[i] == 0 then
+			table.insert(queue, i)
+		end
+	end
+
+	while #queue ~= 0 do
+		local i = table.remove(queue, 1) :: number
+		table.insert(result, i)
+
+		for _, j in adjacencyList[i] do
+			inDegrees[j] -= 1
+			if inDegrees[j] == 0 then
+				table.insert(queue, j)
+			end
+		end
+	end
+
+	if #result ~= self.length then
+		return nil
+	end
+
+	return result
+end
+
+function AdjacencyMatrix.new(): AdjacencyMatrix
+	return setmetatable({
+		matrix = {},
+		length = 0,
+		width = 0,
+	}, AdjacencyMatrix) :: any
+end
+
+export type DependencyGraph<T> = {
+	nodes: { T },
+	matrix: AdjacencyMatrix,
+	length: number,
+	width: number,
+
+	getOrderedList: (self: DependencyGraph<T>) -> { T }?,
+	insert: (self: DependencyGraph<T>, node: T) -> DependencyGraph<T>,
+	insertAfter: (
+		self: DependencyGraph<T>,
+		node: T,
+		afterNode: T
+	) -> DependencyGraph<T>,
+	insertBefore: (
+		self: DependencyGraph<T>,
+		node: T,
+		beforeNode: T
+	) -> DependencyGraph<T>,
+	new: () -> DependencyGraph<T>,
+}
+
+local DependencyGraph = {}
+DependencyGraph.__index = DependencyGraph
+
+function DependencyGraph:getOrderedList(): { any }?
+	local orderedList = {}
+
+	local topologicalSort = self.matrix:topologicalSort()
+	if not topologicalSort then
+		return nil
+	end
+
+	for _, i in topologicalSort do
+		table.insert(orderedList, self.nodes[i])
+	end
+
+	return orderedList
+end
+
+function DependencyGraph:insertBefore(node, beforeNode)
+	if not table.find(self.nodes, beforeNode) then
+		error("Node not found in DependencyGraph:insertBefore(_, unknown)")
+	end
+
+	local j = table.find(self.nodes, node)
+	if not j then
+		table.insert(self.nodes, node)
+		j = #self.nodes
+	end
+
+	local i = table.find(self.nodes, beforeNode)
+
+	self.matrix:extend()
+	self.matrix:setEdge(j, i, 1)
+
+	return self
+end
+
+function DependencyGraph:insertAfter(node, afterNode)
+	if not table.find(self.nodes, afterNode) then
+		error("Node not found in DependencyGraph:insertAfter(_, unknown)")
+	end
+
+	local j = table.find(self.nodes, node)
+	if not j then
+		table.insert(self.nodes, node)
+		j = #self.nodes
+	end
+
+	local i = table.find(self.nodes, afterNode)
+
+	self.matrix:extend()
+	self.matrix:setEdge(i, j, 1)
+
+	return self
+end
+
+function DependencyGraph:insert(node)
+	local i = #self.nodes
+	table.insert(self.nodes, node)
+	local j = #self.nodes
+
+	self.matrix:extend()
+
+	if i ~= 0 then
+		self.matrix:setEdge(i, j, 1)
+	end
+
+	return self
+end
+
+function DependencyGraph.new<T>(): DependencyGraph<T>
+	return setmetatable({
+		nodes = {},
+		matrix = AdjacencyMatrix.new(),
+		length = 0,
+		width = 0,
+	}, DependencyGraph) :: any
+end
+
+return DependencyGraph

package/src/Phase.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Phases represent tags that tell the scheduler when to
+ * schedule a set of systems.
+ */
+export class Phase {
+  /** Runs before the `Startup` Phase. */
+  static PreStartup: Phase;
+  /**
+   * This Phase will run once, the first time the Scheduler is ran,
+   * before any other Phases are ran.
+   */
+  static Startup: Phase;
+  /** Runs after the `Startup` phase. */
+  static PostStartup: Phase;
+
+  private _type: "phase";
+
+  /**
+   * Creates a new Phase, with an optional name to use for debugging.
+   * When no name is provided, the script and line number will be used.
+   */
+  constructor(name?: string);
+}

package/{out → src}/Phase.luau

@@ -1,41 +1,41 @@
---- @class Phase
----
---- Phases represent tags that tell the scheduler when to
---- schedule a set of systems.
-local Phase = {}
-Phase.__index = Phase
-
-function Phase:__tostring()
-	return self._name
-end
-
---- @within Phase
----
---- Creates a new Phase, with an optional name to use for debugging.
---- When no name is provided, the script and line number will be used.
-function Phase.new(name: string?)
-	name = name or debug.info(2, "sl")
-	return setmetatable({
-		_name = name,
-		_type = "phase",
-	}, Phase)
-end
-
---- @prop PreStartup Phase
---- @within Phase
---- Runs before the `Startup` Phase.
-
---- @prop Startup Phase
---- @within Phase
---- This Phase will run once, the first time the Scheduler is ran,
---- before any other Phases are ran.
-
---- @prop PostStartup Phase
---- @within Phase
---- Runs after the `Startup` phase.
-
-Phase.PreStartup = Phase.new("PreStartup")
-Phase.Startup = Phase.new("Startup")
-Phase.PostStartup = Phase.new("PostStartup")
-
-return Phase
+--- @class Phase
+---
+--- Phases represent tags that tell the scheduler when to
+--- schedule a set of systems.
+local Phase = {}
+Phase.__index = Phase
+
+function Phase:__tostring()
+	return self._name
+end
+
+--- @within Phase
+---
+--- Creates a new Phase, with an optional name to use for debugging.
+--- When no name is provided, the script and line number will be used.
+function Phase.new(name: string?)
+	name = name or debug.info(2, "sl")
+	return setmetatable({
+		_name = name,
+		_type = "phase",
+	}, Phase)
+end
+
+--- @prop PreStartup Phase
+--- @within Phase
+--- Runs before the `Startup` Phase.
+
+--- @prop Startup Phase
+--- @within Phase
+--- This Phase will run once, the first time the Scheduler is ran,
+--- before any other Phases are ran.
+
+--- @prop PostStartup Phase
+--- @within Phase
+--- Runs after the `Startup` phase.
+
+Phase.PreStartup = Phase.new("PreStartup")
+Phase.Startup = Phase.new("Startup")
+Phase.PostStartup = Phase.new("PostStartup")
+
+return Phase

package/src/Pipeline.d.ts

@@ -0,0 +1,26 @@
+import { Phase } from "./Phase";
+
+/**
+ * Pipelines represent a set of ordered Phases. Systems cannot be
+ * assigned to Pipelines themselves, but rather to Phases within
+ * those Pipelines.
+ */
+export class Pipeline {
+  /** A Pipeline containing the `PreStartup`, `Startup`, and `PostStartup` phases. */
+  static Startup: Pipeline;
+
+  private _type: "pipeline";
+
+  /**
+   * Creates a new Pipeline, with an optional name to use for debugging.
+   * When no name is provided, the script and line number will be used.
+   */
+  constructor(name?: string);
+
+  /** Adds a Phase to the Pipeline, ordering it implicitly. */
+  insert(phase: Phase): this;
+  /** Adds a Phase to the Pipeline after another Phase, ordering it explicitly. */
+  insertAfter(phase: Phase, after: Phase): this;
+  /** Adds a Phase to the Pipeline before another Phase, ordering it explicitly. */
+  insertBefore(phase: Phase, before: Phase): this;
+}