Merge pull request #2 from Con-JS-Development/development

Development

Author: conmaster2112

.gitignore

@@ -0,0 +1,5 @@
+/build
+/.regolith
+/node_modules
+/package-lock.json
+/packs

README.md

@@ -1,127 +1,61 @@
-This documentation describes the `ScoreboardDB`, `AsyncDatabase`, and `ScoreboardDatabase` classes. It also using these classes from [Con-Module](https://github.com/Con-JS-Development/Con-Module):
-- The `AsyncSemaphore` from ["Con-Module/Utils/AsyncSemaphore"](https://github.com/Con-JS-Development/Con-Module/blob/main/Docs/con-utils/AsyncSemaphore.md) ([source](https://github.com/Con-JS-Development/Con-Module/blob/main/con-lib/con-utils/Semaphore.js)).
-
-## Internal ScoreboardDB
-
-`ScoreboardDB` is a class that extends [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) and provides an interface to interact with a scoreboard objective in Minecraft. It allows you to store key-value pairs in a scoreboard objective and retrieve them later.
-
-### Create
-
-```js
-ScoreboardDB.create(objective: string | ScoreboardObjective, createNew?: boolean);
-```
-
-Creates a new `ScoreboardDB` instance.
-
-- `objective`: The scoreboard objective to open. Can be a string or a `ScoreboardObjective` instance.
-- `createNew`: Optional. Whether to create a new scoreboard objective if it doesn't exist. Defaults to `true`.
-
-### Properties
-
-#### participants
-
-```js
-scoreboardDB.participants: Map<string, ScoreboardIdentity>;
-```
-
-A read-only property that returns the participants of the scoreboard objective.
-
-#### id
-
-```js
-scoreboardDB.id: string;
-```
-
-A read-only property that returns the id of the scoreboard objective.
-
-#### scoreboardObjective
-
-```js
-scoreboardDB.scoreboardObjective: ScoreboardObjective;
-```
-
-A read-only property that returns the scoreboard objective.
-
-### Methods
-
-#### open
-
-```js
-ScoreboardDB.open(objective: string | ScoreboardObjective): ScoreboardDB;
-```
-
-Opens a scoreboard objective and returns a `ScoreboardDB` instance.
-
-- `objective`: The scoreboard objective to open. Can be a string or a `ScoreboardObjective` instance.
-- Returns: The `ScoreboardDB` instance.
-
-#### delete
-
-```js
-scoreboardDB.delete(key: string): boolean;
-```
-
-Deletes a key from the database.
-
-- `key`: The key to delete from the database.
-- Returns: Whether the key was deleted.
-
-#### clear
-
-```js
-scoreboardDB.clear(): void;
-```
-
-Clears the database.
-
-## Public AsyncDatabase
-
-`AsyncDatabase` is a class that extends `ScoreboardDB` and provides an asynchronous interface to interact with a scoreboard objective in Minecraft. It allows you to store key-value pairs in a scoreboard objective and retrieve them later asynchronously. It is more performant than the synchronous version (`ScoreboardDatabase`) but can be slower when setting values for the same key in one tick.
-
-### Methods
-
-#### set
-
-```js
-async asyncDatabase.set(key: string, value: any): Promise<void>;
-```
-
-Sets a value for a key in the database asynchronously.
-
-- `key`: The key to set.
-- `value`: The value to set.
-
-### Properties
-
-#### semaphores
-
-```js
-asyncDatabase.semaphores: Map<string, AsyncSemaphore>;
-```
-
-A read-only property that returns the semaphores of the database.
-
-## Public ScoreboardDatabase
-
-`ScoreboardDatabase` is a class that extends `ScoreboardDB` and provides an interface to interact with a scoreboard objective in Minecraft. It allows you to store key-value pairs in a scoreboard objective and retrieve them later synchronously.
-
-### Methods
-
-#### set
-
-```js
-scoreboardDatabase.set(key: string, value: any): this;
-```
-
-Sets a value for a key in the database synchronously.
-
-- `key`: The key to set.
-- `value`: The value to set.
-- Returns: The `ScoreboardDatabase` instance.
-
-## Requirements
- - Server Module:
-    - `1.2.0-beta`
-    - `1.3.0-beta`
-
-### [MIT License](./LICENSE)
+# Con-Databases
+This package contains three types of databases, JsonDatabase, NBTDatabase, CustomDatabase. 
+Each of these database types supports all possible Map class operations from ECMAScript, which means.
+### Inherited from Map
+ - size: number of properties
+ - [Symbol.iterator]: is iterable [key, value]
+ - clear(): clear all values
+ - delete(key: string): delete specific value
+ - entries(): generator of all values [key, value]
+ - forEach(callBack: (value, key, this)=>void): for each all elements and call provided function for that
+ - get(key: string): returns value for specific key
+ - set(key: string, value: any): sets new value for provided key
+ - keys(): returns iterbale of keys
+ - values(): returns iterable of values
+### Additional Methods
+ - load(): will load database from provided scoreboard
+ - loadAsync(): will load database asynchonously from profived scoreboard
+ - rebuild(): when database is deleted by user in the world you can call rebuild to save loaded data without lost
+ - rebuildAsync(): same as rebuild() but asyncronouse
+### Additional Properties
+ - objective: returns scoreboard objective what is database binded to
+ - id: returns id of the objective
+ - loaded: returns boolean, true when database is loaded
+ - maxLength: max size of key and value after parsed via parse
+ - savingMode: mode when your database is saving your data after change
+   - OneTimeSave: Saving after value was changed
+   - EndTickSave: Saving at the end of the tick, ater any changes occurs
+   - IntervalTick: Saving Every interval if changes occurs
+
+### Database Types
+ - JsonDatabase, is saving data in JSON form. (SuperFast/EasyToRead)
+ - NBTDatabase, is saving data in NBT form. (Fast/HardToRead)
+ - Custom, is saving data in format of provided parser (undefined/undefined)
+
+### Example
+```js
+// INITIALIZATION OF DATABASE
+const myDB = new JsonDatabase("MyIdentifier").load();
+const myDB = new NBTDatabase("MyIdentifier").load();
+const myDB = new CustomDatabase(JSON /* JSON is parser */,"MyIdentifier").load();
+
+//using (get/set) to (read/write) data (from/to) database
+const worldOpenedCount = myDB.get("openCount")??0;
+myDB.set("openCount", ++worldOpenedCount);
+
+//getting all data saved in database
+for(const [key, value] of myDB.entries()){
+    console.warn(key, value);
+}
+
+//clearing database
+myDB.clear();
+
+//removing specific value
+myDB.delete("Josh");
+
+//forEaching every element in scoreboard
+myDB.forEach((value,key)=>{
+    console.warn(key, value);
+});
+```

config.json

@@ -0,0 +1,21 @@
+{
+	"$schema": "https://raw.githubusercontent.com/Bedrock-OSS/regolith-schemas/main/config/v1.1.json",
+	"author": "conaster",
+	"name": "Database-Event",
+	"packs": {
+		"behaviorPack": "./packs/BP"
+	},
+	"regolith": {
+		"dataPath": "./packs/data",
+		"filterDefinitions": {},
+		"profiles": {
+			"default": {
+				"export": {
+					"readOnly": false,
+					"target": "preview"
+				},
+				"filters": []
+			}
+		}
+	}
+}