new scripts: jaylydb and assert

JaylyDev · JaylyDev · commit 6df68b686ec1 · 2023-05-19T18:47:35.000+01:00
Fix JaylyDev#240
diff --git a/scripts/assert/index.js b/scripts/assert/index.js
@@ -0,0 +1,32 @@
+/**
+ * Indicates the failure of an assertion. All errors thrown by the `assert` function
+ * will be instances of the `AssertionError` class.
+ */
+export class AssertionError extends Error {
+    constructor(options) {
+        if (typeof options.message !== "object" && typeof options.message !== "undefined")
+            throw new Error('The "options" argument must be an object.' + "\n");
+        super();
+        this.code = "ERR_ASSERTION";
+        this.name = AssertionError.name;
+        this.generatedMessage = !options.message;
+        this.actual = this.generatedMessage ? options.actual : false;
+        this.expected = this.generatedMessage ? options.expected : true;
+        this.operator = this.generatedMessage ? options.operator : "==";
+        this.message = this.generatedMessage ? `${JSON.stringify(this.actual)} ${this.operator} ${JSON.stringify(this.expected)}` + "\n" : options.message + "\n";
+    }
+}
+/**
+ * Tests if `value` is equal to true, an `AssertionError` is thrown otherwise.
+ */
+export function assert(value, message) {
+    let error;
+    if (typeof message === "string")
+        error = new AssertionError({ message });
+    else if (message instanceof Error)
+        error = message;
+    else
+        error = new AssertionError({ actual: false, expected: true, operator: "!=" });
+    if (!value)
+        throw error;
+}
diff --git a/scripts/assert/index.ts b/scripts/assert/index.ts
@@ -0,0 +1,41 @@
+
+/**
+ * Indicates the failure of an assertion. All errors thrown by the `assert` function
+ * will be instances of the `AssertionError` class.
+ */
+export class AssertionError extends Error {
+  actual: unknown;
+  expected: unknown;
+  operator: string;
+  generatedMessage: boolean;
+  code = "ERR_ASSERTION";
+  constructor(options?: {
+    /** If provided, the error message is set to this value. */
+    message?: string | undefined;
+    /** The `actual` property on the error instance. */
+    actual?: unknown | undefined;
+    /** The `expected` property on the error instance. */
+    expected?: unknown | undefined;
+    /** The `operator` property on the error instance. */
+    operator?: string | undefined;
+  }) {
+    if (typeof options.message !== "object" && typeof options.message !== "undefined") throw new Error('The "options" argument must be an object.' + "\n");
+    super();
+    this.name = AssertionError.name;
+    this.generatedMessage = !options.message;
+    this.actual = this.generatedMessage ? options.actual : false;
+    this.expected = this.generatedMessage ? options.expected : true;
+    this.operator = this.generatedMessage ? options.operator : "==";
+    this.message = this.generatedMessage ? `${JSON.stringify(this.actual)} ${this.operator} ${JSON.stringify(this.expected)}` + "\n" : options.message + "\n";
+  }
+}
+/**
+ * Tests if `value` is equal to true, an `AssertionError` is thrown otherwise.
+ */
+export function assert(value: unknown, message?: string | Error): asserts value {
+  let error: string | Error;
+  if (typeof message === "string") error = new AssertionError({ message });
+  else if (message instanceof Error) error = message;
+  else error = new AssertionError({ actual: false, expected: true, operator: "!=" });
+  if (!value) throw error;
+}
diff --git a/scripts/jaylydb/index.d.ts b/scripts/jaylydb/index.d.ts
@@ -1,20 +1,48 @@
 /**
- * Database using scoreboard
- * @beta
+ * A simple database for storing data in a Minecraft world, using scoreboard.
  */
 declare class JaylyDB implements Map<string, string | number | boolean> {
-    constructor(id: string);
-    private objective;
-    private getParticipant;
+    /**
+     * @param id An identifier for the database
+     * @param encrypted whether this database is encrypted or not, note that encryption state cannot be changed after creation
+     */
+    constructor(id: string, encrypted?: boolean);
+    /**
+     * @returns the number of elements in the database.
+     */
+    get size(): number;
+    /**
+     * Clears every element in the database.
+     */
     clear(): void;
+    /**
+     * @returns — true if an element in the database exists and has been removed, false otherwise.
+     */
     delete(key: string): boolean;
-    forEach(callbackfn: (value: string | number | boolean, key: string, map: Map<string, string | number | boolean>) => void): void;
-    get(key: string): string | number | boolean;
+    /**
+     * Executes a provided function once per each key/value pair in the database, in insertion order.
+     */
+    forEach(callbackfn: (value: string | number | boolean, key: string, map: this) => void): void;
+    /**
+     * Returns a specified element from the database.
+     * @param key The key of the element to return.
+     * @param reloadCache If set to true, the database object reloads cache before returning the element. This is made for when the database is modified from a external source.
+     * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
+     */
+    get(key: string, reloadCache?: boolean): string | number | boolean | undefined;
     has(key: string): boolean;
+    /**
+     * Adds a new element with a specified key and value to the database. If an element with the same key already exists, the element will be updated.
+     */
     set(key: string, value: string | number | boolean): this;
-    get size(): number;
     entries(): IterableIterator<[string, string | number | boolean]>;
+    /**
+     * Returns an iterable of keys in the database
+     */
     keys(): IterableIterator<string>;
+    /**
+     * Returns an iterable of values in the map
+     */
     values(): IterableIterator<string | number | boolean>;
     [Symbol.iterator](): IterableIterator<[string, string | number | boolean]>;
     [Symbol.toStringTag]: string;
diff --git a/scripts/jaylydb/index.js b/scripts/jaylydb/index.js
@@ -1,12 +1,9 @@
-// Script example for ScriptAPI
-// Author: Jayly <https://github.com/JaylyDev>
-// Project: https://github.com/JaylyDev/ScriptAPI
 var _a;
 // Script example for ScriptAPI
 // Author: Jayly <https://github.com/JaylyDev>
 // Project: https://github.com/JaylyDev/ScriptAPI
 import { ScoreboardIdentityType, world } from "@minecraft/server";
-const version = "1.0.4";
+const version = "1.0.5";
 const str = () => ('00000000000000000' + (Math.random() * 0xffffffffffffffff).toString(16)).slice(-16);
 /**
  * A rough mechanism for create a random uuid. Not as secure as uuid without as much of a guarantee of uniqueness,
@@ -19,22 +16,22 @@ const uuid = () => {
     return `${a.slice(0, 8)}-${a.slice(8, 12)}-4${a.slice(13)}-a${b.slice(1, 4)}-${b.slice(4)}`;
 };
 const allowedTypes = ["string", "number", "boolean"];
-function encrypt(data, salt) {
+const encrypt = (data, salt) => {
     const encryptedChars = [];
     for (let i = 0; i < data.length; i++) {
         const charCode = data.charCodeAt(i) + salt.charCodeAt(i % salt.length);
         encryptedChars.push(charCode);
     }
     return String.fromCharCode(...encryptedChars);
-}
-function decrypt(encrypted, salt) {
+};
+const decrypt = (encrypted, salt) => {
     const decryptedChars = [];
     for (let i = 0; i < encrypted.length; i++) {
         const charCode = encrypted.charCodeAt(i) - salt.charCodeAt(i % salt.length);
         decryptedChars.push(charCode);
     }
     return String.fromCharCode(...decryptedChars);
-}
+};
 const CreateCrashReport = (action, data, error, salt) => {
     console.log("[JaylyDB] Failed to " + action + " JSON data.", "\nVersion: " + version, "\nData: " + data, "\nSalt: " + salt, "\nError: " + error.message, "\n" + error.stack);
     throw new Error(`Failed to ${action} data. Please check content log file for more info.\n`);
@@ -134,14 +131,11 @@ class JaylyDB {
      * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
      */
     get(key, reloadCache = false) {
-        if (!reloadCache && this.displayDataCache.has(key)) {
-            const displayData = this.displayDataCache.get(key);
-            return displayData[key];
-        }
+        if (!reloadCache && this.displayDataCache.has(key))
+            return this.displayDataCache.get(key);
         const participant = this.participants.get(key);
-        if (!participant) {
+        if (!participant)
             return undefined;
-        }
         const displayName = participant.displayName;
         const displayData = DisplayName.parse(displayName, this.salt);
         this.displayDataCache.set(key, displayData[key]);
diff --git a/scripts/jaylydb/index.ts b/scripts/jaylydb/index.ts
@@ -2,7 +2,7 @@
 // Author: Jayly <https://github.com/JaylyDev>
 // Project: https://github.com/JaylyDev/ScriptAPI
 import { ScoreboardIdentity, ScoreboardIdentityType, ScoreboardObjective, world } from "@minecraft/server";
-const version = "1.0.4";
+const version = "1.0.5";
 const str = () => ('00000000000000000' + (Math.random() * 0xffffffffffffffff).toString(16)).slice(-16);
 /**
  * A rough mechanism for create a random uuid. Not as secure as uuid without as much of a guarantee of uniqueness,
@@ -17,23 +17,23 @@ const uuid = () => {
 
 const allowedTypes = ["string", "number", "boolean"];
 
-function encrypt(data: string, salt: string): string {
+const encrypt = (data: string, salt: string): string => {
   const encryptedChars: number[] = [];
   for (let i = 0; i < data.length; i++) {
     const charCode = data.charCodeAt(i) + salt.charCodeAt(i % salt.length);
     encryptedChars.push(charCode);
   }
   return String.fromCharCode(...encryptedChars);
-}
+};
 
-function decrypt(encrypted: string, salt: string): string {
+const decrypt = (encrypted: string, salt: string): string => {
   const decryptedChars: number[] = [];
   for (let i = 0; i < encrypted.length; i++) {
     const charCode = encrypted.charCodeAt(i) - salt.charCodeAt(i % salt.length);
     decryptedChars.push(charCode);
   }
   return String.fromCharCode(...decryptedChars);
-}
+};
 
 const CreateCrashReport = (action: "save" | "load", data: string, error: Error, salt?: string): never => {
   console.log(
@@ -45,6 +45,7 @@ const CreateCrashReport = (action: "save" | "load", data: string, error: Error,
   );
   throw new Error(`Failed to ${action} data. Please check content log file for more info.\n`);
 };
+
 /**
  * Parse and stringify scoreboard display name
  * @beta
@@ -143,15 +144,9 @@ class JaylyDB implements Map<string, string | number | boolean> {
    * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
    */
   get(key: string, reloadCache: boolean = false): string | number | boolean | undefined {
-    if (!reloadCache && this.displayDataCache.has(key)) {
-      const displayData = this.displayDataCache.get(key)!;
-      return displayData[key];
-    }
-
+    if (!reloadCache && this.displayDataCache.has(key)) return this.displayDataCache.get(key)!;
     const participant = this.participants.get(key);
-    if (!participant) {
-      return undefined;
-    }
+    if (!participant) return undefined;
 
     const displayName = participant.displayName;
     const displayData = DisplayName.parse(displayName, this.salt);
diff --git a/scripts/jaylydb/tests.js b/scripts/jaylydb/tests.js
@@ -1,5 +1,6 @@
 import { world } from "@minecraft/server";
 import { JaylyDB } from "./index.js";
+import { AssertionError, assert } from "assert/index";
 /**
  * @param {number} length
  */
@@ -77,3 +78,18 @@ world.afterEvents.worldInitialize.subscribe(() => {
         benchmark(db_encrypted, 100, bytes);
     }
 });
+function generateRandomString(length) {
+const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+let result = '';
+
+for (let i = 0; i < length; i++) {
+    const randomIndex = Math.floor(Math.random() * characters.length);
+    result += characters.charAt(randomIndex);
+}
+
+return result;
+}
+const datab = new JaylyDB(generateRandomString(10));
+const expected = "test41";
+datab.set("test1", expected);
+assert(datab.get("test1") === expected, new AssertionError({ actual: datab.get("test1"), operator: "!=", expected }));
diff --git a/scripts/minecraft-language/index.js b/scripts/minecraft-language/index.js
@@ -1,6 +1,3 @@
-// Script example for ScriptAPI
-// Author: bot174 <https://github.com/bot174>
-// Project: https://github.com/JaylyDev/ScriptAPI
 export const languageKeys = [
     "accessibility.disableTTS",
     "accessibility.enableTTS",
diff --git a/scripts/simulated-player/index.js b/scripts/simulated-player/index.js
@@ -1,6 +1,3 @@
-// Script example for ScriptAPI
-// Author: Jayly <https://github.com/JaylyDev>
-// Project: https://github.com/JaylyDev/ScriptAPI
 import * as Minecraft from "@minecraft/server";
 /**
  * A simulated player can be used to represent
