Update In protoform (#345)

* Create README.md

* Update README.md

* Add files via upload

* Update index.js

* Update index.js

* Update test.js

* Update index.js

* pass format checks

* rename ProtoForm to protoform

* Update README.md

* Update index.js

* Update tests.js

* Update index.d.ts

* Update index.d.ts

* Update index.d.ts

---------

Co-authored-by: Jayly <65847850+JaylyDev@users.noreply.github.com>

Author: GamerFile

scripts/protoform/README.md

@@ -1,6 +1,6 @@
 # ProtoForm
 
-**ProtoForm** is a versatile library for creating and managing various types of forms in your Minecraft server plugins. It simplifies the process of generating modal, message, and action forms, providing a clean and structured way to handle user input.
+**ProtoForm** simplifies the creation and management of Minecraft forms and responses. With a single class, it provides an efficient and easy way to generate various forms. This can save you time compared to the original approach, as minimal code is required. The form type is determined based on the keys/properties provided in the object, resulting in clean and concise code with reduced storage needs.
 
 ## Features
 
@@ -23,14 +23,16 @@ import { ProtoForm } from "./index.js";
 ```
 ### ModalForm
 
+- **fields** key determines that it's a **ModalForm**
+
 ```js
 const modalForm = new ProtoForm({
   title: "Example Modal Form",
   fields: [
-    ["text", ["Label", "Placeholder", "Default"]],
-    ["slider",["Label",2/* Min */,10/* Max */,2/*Step*/,6/*Default*/]],
-    ["dropdown",["Label",["Option 1","Option 2", "Option 3"]/* Options */,1 /*Default*/]],
-    ["toggle",["Label",true /*default*/]]
+    ["text", "Label", "Placeholder", "Default"],
+    ["slider","Label",2/* Min */,10/* Max */,2/*Step*/,6/*Default*/],
+    ["dropdown","Label",["Option 1","Option 2", "Option 3"]/* Options */,1 /*Default*/],
+    ["toggle","Label",true /*default*/]
   ],
   response: (data) => {
     // Handle form submission
@@ -40,6 +42,8 @@ const modalForm = new ProtoForm({
 ```
 ### MessageForm
 
+- **btn1** and **btn2** determines that it's a **MessageForm**
+
 ```js
 const messageForm = new ProtoForm({
   title: "Example Message Form",
@@ -54,12 +58,17 @@ const messageForm = new ProtoForm({
 ```
 ### ActionForm
 
+- **btns** key determine that it's an **ActionForm**
+
 ```js
 const actionForm = new ProtoForm({
   title: "Example Action Form",
+  body: "Example Action Form Body",
   btns: [
     ["Button 1", "path/to/btn1_texture"],
     ["Button 2", "path/to/btn2_texture"],
+    "Button 3",
+    ["Button 4"],
     // Add more buttons as needed
   ],
   response: (data) => {
@@ -68,6 +77,7 @@ const actionForm = new ProtoForm({
   }
 });
 ```
+
 ### Showing Forms To Player
 
 ```js
@@ -76,5 +86,19 @@ modalForm.show(player);
 messageForm.show(player);
 actionForm.show(player);
 ```
+
+### Case Errors
+
+- When **fields** and **btn1** or **btn2** keys are used togethor, it throws error.
+  
+- When **fields** and **btns** keys are used togethor, it throws error.
+  
+- When **btns** and **btn1** or **btn2** keys are used togethor, it throws error.
+
+- When **title** is missing, it throws error.
+
+- When **body** is missing with **btns** or **btn1** and **btn2**, it throws error. =>  When **body** is missing in **MessageForm** or **ActionForm**, it throws error.
+
+
 ## Author
 These Scripts Are Written By **GamerFile**

scripts/protoform/index.d.ts

@@ -11,7 +11,7 @@ declare class ProtoForm {
     body?: string;
     btn1?: string;
     btn2?: string;
-    btns?: [string, string | undefined][];
+    btns?: (string | [string] | [string, string | undefined])[];
     response?: (result: FormResponse) => void;
   });
 

scripts/protoform/index.js

@@ -68,11 +68,8 @@ export class ProtoForm {
         if (!body) throw new Error("Body is essential in ActionFormData.");
         this.form.title(title);
         this.form.body(body);
-        btns.forEach(([text, texture]) => {
-          this.form?.button(
-            text,
-            texture ?? undefined
-          );
+        btns.forEach((btn) => {
+          typeof btn == "string"? this.form?.button(btn): this.form?.button(btn[0],btn[1] ?? undefined)
         });
       }
     } else if (fields) {
@@ -83,7 +80,7 @@ export class ProtoForm {
       if (this.form instanceof ModalFormData) {
         this.form.title(title);
 
-        fields.forEach(([type, details]) => {
+        fields.forEach(([type, ...details]) => {
           switch (type) {
             case "text":
               this.form?.textField(

scripts/protoform/tests.js

@@ -5,7 +5,7 @@ import { ProtoForm } from "index.js";
 const actionform = new ProtoForm({
     title: "Test ActionForm",
     body: "Body...",
-    btns: [["Hey","Texture Path"],["Btn2","Path2"]],
+    btns: [["Hey","Texture Path"],["Btn2","Path2"],"btn3","btn4",["btn5"]],
     response: ({selection:s}) => {
         console.warn("selected no" + s)
     }