erlc-api 2.3.4 → 3.0.0

package/src/constants.js

@@ -1,2 +1,2 @@
-exports.Vanity = "https://policeroleplay.community/join?code="
+exports.Vanity = "https://policeroleplay.community/join?code="
 exports.BASEURL = "https://api.policeroleplay.community/v1"

package/src/erlc.js

@@ -1,14 +1,15 @@
-exports.config = {};
-
-exports.getBans = require("./functions/server/getBans.js");
-exports.getCommandLogs = require("./functions/server/getCommandLogs.js");
-exports.getJoinLogs = require("./functions/server/getJoinLogs.js");
-exports.getKillLogs = require("./functions/server/getKillLogs.js");
-exports.getModcallLogs = require("./functions/server/getModcallLogs.js");
-exports.getPlayers = require("./functions/server/getPlayers.js");
-exports.getServer = require("./functions/server/getServer.js");
-exports.getQueue = require("./functions/server/getQueue.js");
-exports.runCommand = require("./functions/server/runCommand.js");
-exports.getVehicles = require("./functions/server/getVehicles.js");
-
-exports.Client = require("./classes/client.js");
+exports.config = {};
+
+exports.getBans = require("./functions/server/getBans.js");
+exports.getCommandLogs = require("./functions/server/getCommandLogs.js");
+exports.getJoinLogs = require("./functions/server/getJoinLogs.js");
+exports.getKillLogs = require("./functions/server/getKillLogs.js");
+exports.getModcallLogs = require("./functions/server/getModcallLogs.js");
+exports.getPlayers = require("./functions/server/getPlayers.js");
+exports.getServer = require("./functions/server/getServer.js");
+exports.getQueue = require("./functions/server/getQueue.js");
+exports.runCommand = require("./functions/server/runCommand.js");
+exports.getVehicles = require("./functions/server/getVehicles.js");
+exports.getStaff = require("./functions/server/getStaff.js");
+
+exports.Client = require("./classes/client.js");

package/src/functions/assert.js

@@ -1,5 +1,5 @@
-module.exports = function(condition, message) {
-    if (!condition) {
-        throw new Error(message);
-    }
+module.exports = function(condition, message) {
+    if (!condition) {
+        throw new Error(message);
+    }
 }

package/src/functions/server/getBans.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves the list of banned players from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Object>} Promise that resolves to banned players object
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/bans`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(data || {});
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getCommandLogs.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves command logs from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of command logs
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/commandlogs`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getJoinLogs.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves join/leave logs from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of join logs
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/joinlogs`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getKillLogs.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves kill logs from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of kill logs
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/killlogs`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getModcallLogs.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves moderator call logs from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of modcall logs
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/modcalls`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getPlayers.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves current players from a server
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of current players
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/players`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/functions/server/getQueue.js

@@ -1,28 +1,54 @@
-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);
-        }
-  
-        resolve(data);
-      } catch (error) {
-        reject(error);
-      }
-    });
-  };
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves server queue information
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of queued player IDs
+ */
+module.exports = (serverToken) => {
+  return new Promise(async (resolve, reject) => {
+    // Input validation
+    if (!serverToken || typeof serverToken !== 'string') {
+      return reject(new Error('Server token is required and must be a string'));
+    }
+
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        return reject(new Error('Global token not configured. Please initialize the client first.'));
+      }
+
+      const res = await fetch.default(`${BASEURL}/server/queue`, {
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`API Error: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      const data = await res.json();
+      resolve(Array.isArray(data) ? data : []);
+
+    } catch (error) {
+      // Handle different types of errors
+      if (error.code === 'ENOTFOUND') {
+        reject(new Error('Network error: Unable to connect to ER:LC API'));
+      } else if (error.name === 'AbortError') {
+        reject(new Error('Request timeout: API took too long to respond'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};