Add a UniqueID builtin to allow assigning uuid identifiers more easily

Config/eslint.json

@@ -88,6 +88,8 @@
 		"Table": "writable",
 		"TerrainMap": "writable",
 		"UIParent": "writable",
+		"UUID": "writable",
+		"UniqueID": "writable",
 		"validateString": "writable",
 		"validateNumber": "writable",
 		"Vector3D": "writable",

Core/Aliases.js

@@ -9,6 +9,7 @@ const BABYLON = require("babylonjs/babylon.max"); // C_WebGL & C_Sound
 const BITMAP = require("bmp-js"); // C_Bitmap
 const MESSAGEPACK = require("@msgpack/msgpack"); // C_Message
 const JOI = require("joi"); // C_Validation
+const UUID = require("uuid"); // UniqueID builtin
 
 function dump(...data) {
 	console.log(data);
@@ -18,3 +19,11 @@ function printf(message, ...rest) {
 	// If we don't check the length, it will print an empty array when there are no parameters
 	rest.length > 0 ? console.log(message, ...rest) : console.log(message);
 }
+
+// Explicitly export so that their presence can be tested for more easily
+// BABYLON already exports itself globally by default
+window.BITMAP = BITMAP;
+window.JOI = JOI;
+window.MESSAGEPACK = MESSAGEPACK;
+window.NODE = NODE;
+window.UUID = UUID;

Core/Builtins/UniqueID.js

@@ -0,0 +1,8 @@
+class UniqueID {
+	constructor() {
+		this.identifier = UUID.v4();
+	}
+	toString() {
+		return this.identifier;
+	}
+}

Tests/Builtins/UniqueID.js

@@ -0,0 +1,13 @@
+describe("UniqueID", () => {
+	it("should be exported into the global environment", () => {
+		assertEquals(UniqueID.name, "UniqueID");
+	});
+
+	let exportedApiSurface = ["toString"];
+
+	exportedApiSurface.forEach((namedExport) => {
+		it("should export function " + namedExport, () => {
+			assertEquals(typeof UniqueID[namedExport], "function");
+		});
+	});
+});

Tests/SharedConstants/Aliases.js

@@ -0,0 +1,16 @@
+describe("Aliases", () => {
+	const exportedObjects = ["BABYLON", "BITMAP", "JOI", "MESSAGEPACK", "NODE", "UUID"];
+	const exportedFunctions = ["dump", "printf"];
+
+	exportedObjects.forEach((namedExport) => {
+		it("should export global object " + namedExport, () => {
+			assertEquals(typeof window[namedExport], "object");
+		});
+	});
+
+	exportedFunctions.forEach((namedExport) => {
+		it("should export global function " + namedExport, () => {
+			assertEquals(typeof window[namedExport], "function");
+		});
+	});
+});

Tests/run-renderer-tests.js

@@ -1,6 +1,6 @@
 const testSuites = {
-	SharedConstants: ["SharedConstants/Paths.js"],
-	Builtins: ["Builtins/Assertions.js", "Builtins/LocalCacheTests.js", "Builtins/Validators.js"],
+	SharedConstants: ["SharedConstants/Aliases.js", "SharedConstants/Paths.js"],
+	Builtins: ["Builtins/Assertions.js", "Builtins/LocalCacheTests.js", "Builtins/UniqueID.js", "Builtins/Validators.js"],
 	C_Settings: [
 		"API/C_Settings/validate.js",
 		"API/C_Settings/validateDefaultSettings.js",

index.html

@@ -141,4 +141,5 @@
 		</script>
 	</body>
 	<script src="Core/Builtins/Validation.js"></script>
+	<script src="Core/Builtins/UniqueID.js"></script>
 </html>

package.json

@@ -14,7 +14,8 @@
 		"bmp-js": "^0.1.0",
 		"joi": "17.4.1",
 		"maxrects-packer": "2.7.2",
-		"tippy.js": "6.3.6"
+		"tippy.js": "6.3.6",
+		"uuid": "8.3.2"
 	},
 	"devDependencies": {
 		"electron": "13.3.0",