erlc-api 1.3.1 → 1.3.3

package/README.md

@@ -17,7 +17,7 @@ Setting up is super simple:
 
 const erlc = require("erlc");
 const client = new erlc.Client({
-  globalToken: "", // Here you enter your global token provided for the API
+  globalToken: "", // You get the global key directly from the ERLC developers. To increase your API request limits
 });
 client.config(); // Registers your client
 ```
@@ -30,7 +30,7 @@ Now you can start using API Methods - here are a few examples:
 const erlc = require("erlc");
 
 const getServerFunc = async () => {
-  const serverId = ""; // The server ApiKey you wish to target
+  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
   const server = await erlc.getServer(serverId).catch(console.log); // Gets the server, logs any errors
 
   console.log(server); // Logs the server object
@@ -45,3 +45,4 @@ getServerFunc();
 
 Library Re-Development - [Egologics](https://twitter.com/0Adexus0)
 API Development - [Police Roleplay Community](https://twitter.com/PRC_Roblox)
+Apply for more API request limits - [Discord](https://discord.gg/prc)

package/index.js

@@ -1 +1 @@
-module.exports = require("./src/erlc");
+module.exports = require('./src/erlc')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "erlc-api",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "An ER:LC API wrapper for JS/TS",
   "main": "index.js",
   "types": "src/types/index.d.ts",

package/src/classes/client.js

@@ -1,5 +1,5 @@
-const erlc = require("../erlc.js");
-const assert = require("../functions/assert.js");
+const erlc = require('../erlc.js')
+const assert = require('../functions/assert.js')
 
 /**
  * @typedef {Object} ClientConfig
@@ -13,26 +13,24 @@ const assert = require("../functions/assert.js");
  */
 
 class Client {
-  /**
-   * @constructor
-   * @param {ClientConfig} options - Client Options
-   */
-  constructor(options) {
-    assert(
-      typeof options === "object",
-      `Syntax error: object expected for "options", received ${typeof options}`
-    );
-    this.options = { ...options };
-  }
 
-  /**
-   * Updates and returns the client configurationg
-   * @returns {ClientConfig} The client configuration.
-   */
-  config() {
-    erlc.config = this.options;
-    return erlc.config;
-  }
+    /**
+     * @constructor
+     * @param {ClientConfig} options - Client Options
+     */
+    constructor(options) {
+        assert(typeof options === 'object', `Syntax error: object expected for "options", received ${typeof options}`);
+        this.options = { ...options };
+      }
+    
+     /**
+     * Updates and returns the client configurationg
+     * @returns {ClientConfig} The client configuration.
+     */
+    config() {
+        erlc.config = this.options
+        return erlc.config
+    }
 }
 
-module.exports = Client;
+module.exports = Client

package/src/functions/server/getBans.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/bans`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/bans`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getCommandLogs.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/commandlogs`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/commandlogs`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getJoinLogs.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/joinlogs`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/joinlogs`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getKillLogs.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/killlogs`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/killlogs`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getModcallLogs.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/modcalls`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/modcalls`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getPlayers.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/players`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/players`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getQueue.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-
-      const res = await fetch.default(`${BASEURL}/server/queue`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-        },
-      });
-      const data = await res.json().catch((err) => {
-        return reject(err);
-      });
-
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+  
+        const res = await fetch.default(`${BASEURL}/server/queue`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+          },
+        });
+        const data = await res.json().catch((err) => {
+          return reject(err);
+        });
+  
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(data);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };

package/src/functions/server/getServer.js

@@ -1,4 +1,4 @@
-const { BASEURL, Vanity } = require("../../constants.js");
+const { BASEURL , Vanity} = require("../../constants.js");
 module.exports = (serverToken) => {
   return new Promise(async (resolve, reject) => {
     try {
@@ -7,7 +7,7 @@ module.exports = (serverToken) => {
 
       const res = await fetch.default(`${BASEURL}/server`, {
         headers: {
-          Authorization: config?.globalToken,
+          "Authorization": config?.globalToken,
           "Server-Key": serverToken,
         },
       });
@@ -20,9 +20,7 @@ module.exports = (serverToken) => {
         return reject(data);
       }
       const getUsername = async (userId) => {
-        const response = await fetch.default(
-          `https://users.roblox.com/v1/users/${userId}`
-        );
+        const response = await fetch.default(`https://users.roblox.com/v1/users/${userId}`);
         const userData = await response.json();
         if (!response.ok) {
           throw new Error(`Error fetching username for ID: ${userId}`);
@@ -31,14 +29,13 @@ module.exports = (serverToken) => {
       };
       try {
         const ownerUsername = await getUsername(data.OwnerId);
-        const coOwnerUsernames = await Promise.all(
-          data.CoOwnerIds.map(getUsername)
-        );
-        const VanityURL = `${Vanity}${data.JoinKey}`;
+        const coOwnerUsernames = await Promise.all(data.CoOwnerIds.map(getUsername));
+        const VanityURL = `${Vanity}${data.JoinKey}`
+   
 
         data.OwnerUsername = ownerUsername;
         data.CoOwnerUsernames = coOwnerUsernames;
-        data.VanityURL = VanityURL;
+        data.VanityURL = VanityURL
 
         delete data.OwnerId;
         delete data.CoOwnerIds;
@@ -47,8 +44,9 @@ module.exports = (serverToken) => {
       } catch (error) {
         reject(error);
       }
+
     } catch (error) {
       reject(error);
     }
   });
-};
+};

package/src/functions/server/runCommand.js

@@ -1,28 +1,28 @@
 const { BASEURL } = require("../../constants.js");
 
 module.exports = (serverToken, command) => {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const fetch = await import("node-fetch");
-      const { config } = await import("../../erlc.js");
-      const params = JSON.stringify({ command: `${command}` });
-      console.log(params);
-      const res = await fetch.default(`${BASEURL}/server/command`, {
-        headers: {
-          Authorization: config?.globalToken,
-          "Server-Key": serverToken,
-          "Content-Type": "application/json",
-        },
-        method: "POST",
-        body: params,
-      });
-      if (!res.ok) {
-        return reject(data);
+    return new Promise(async (resolve, reject) => {
+      try {
+        const fetch = await import("node-fetch");
+        const { config } = await import("../../erlc.js");
+        const params = JSON.stringify({command: `${command}`})
+        console.log(params)
+        const res = await fetch.default(`${BASEURL}/server/command`, {
+          headers: {
+            "Authorization": config?.globalToken,
+            "Server-Key": serverToken,
+            "Content-Type": "application/json"
+          },
+          method: "POST",
+          body: params
+        });
+        if (!res.ok) {
+          return reject(data);
+        }
+  
+        resolve(true);
+      } catch (error) {
+        reject(error);
       }
-
-      resolve(true);
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
+    });
+  };