erlc-api 2.3.3 → 3.0.0

package/src/functions/server/getBans.js

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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);
+      }
+    }
+  });
+};

package/src/functions/server/getServer.js

@@ -0,0 +1,78 @@
+const { BASEURL, Vanity } = 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`, {
+        headers: {
+          "Authorization": config?.globalToken,
+          "Server-Key": serverToken,
+        },
+      });
+
+      const data = await res.json().catch((err) => {
+        return reject(err);
+      });
+
+      if (!res.ok) {
+        return reject(data);
+      }
+
+      const getUsername = async (userId) => {
+        try {
+          const response = await fetch.default(`https://users.roblox.com/v1/users/${userId}`);
+          const userData = await response.json();
+          if (!response.ok) {
+            console.warn(`Warning: Could not fetch username for ID: ${userId}`);
+            return `User:${userId}`; // Fallback format
+          }
+          return userData.name;
+        } catch (error) {
+          console.warn(`Warning: Error fetching username for ID: ${userId}`, error);
+          return `User:${userId}`; // Fallback format
+        }
+      };
+
+      try {
+        // Get owner username
+        const ownerUsername = await getUsername(data.OwnerId);
+        
+        // Get co-owner usernames (handle empty array case)
+        const coOwnerUsernames = data.CoOwnerIds && data.CoOwnerIds.length > 0 
+          ? await Promise.all(data.CoOwnerIds.map(getUsername))
+          : [];
+        
+        // Create vanity URL
+        const vanityURL = `${Vanity}${data.JoinKey}`;
+
+        // Add the new properties to the response
+        const enhancedData = {
+          ...data,
+          OwnerUsername: ownerUsername,
+          CoOwnerUsernames: coOwnerUsernames,
+          VanityURL: vanityURL
+        };
+
+        // Remove the original ID properties as they're now converted to usernames
+        delete enhancedData.OwnerId;
+        delete enhancedData.CoOwnerIds;
+
+        resolve(enhancedData);
+      } catch (error) {
+        // If username fetching fails, still return the original data with IDs
+        console.warn('Warning: Could not fetch usernames, returning data with IDs:', error);
+        const fallbackData = {
+          ...data,
+          VanityURL: `${Vanity}${data.JoinKey}`
+        };
+        resolve(fallbackData);
+      }
+
+    } catch (error) {
+      reject(error);
+    }
+  });
+};

package/src/functions/server/getStaff.js

@@ -0,0 +1,54 @@
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves server staff information
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Object>} Promise that resolves to server staff 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/staff`, {
+        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 || { CoOwners: [], Admins: {}, Mods: {} });
+
+    } 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/getVehicles.js

@@ -0,0 +1,54 @@
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Retrieves server vehicles information
+ * @param {string} serverToken - The server API key
+ * @returns {Promise<Array>} Promise that resolves to array of vehicles
+ */
+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/vehicles`, {
+        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/runCommand.js

@@ -0,0 +1,70 @@
+const { BASEURL } = require("../../constants.js");
+
+/**
+ * Executes a command on the server
+ * @param {string} serverToken - The server API key
+ * @param {string} command - The command to execute
+ * @returns {Promise<boolean>} Promise that resolves to true if command was executed successfully
+ */
+module.exports = (serverToken, command) => {
+  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'));
+    }
+
+    if (!command || typeof command !== 'string') {
+      return reject(new Error('Command is required and must be a string'));
+    }
+
+    if (command.trim().length === 0) {
+      return reject(new Error('Command cannot be empty'));
+    }
+
+    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 requestBody = JSON.stringify({ command: command.trim() });
+
+      const res = await fetch.default(`${BASEURL}/server/command`, {
+        method: "POST",
+        headers: {
+          "Authorization": config.globalToken,
+          "Server-Key": serverToken,
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+        timeout: 15000, // 15 second timeout for commands
+      });
+
+      if (!res.ok) {
+        const errorData = await res.json().catch(() => ({ error: 'Unknown API error' }));
+        const error = new Error(`Command execution failed: ${res.status} - ${errorData.error || res.statusText}`);
+        error.status = res.status;
+        error.data = errorData;
+        return reject(error);
+      }
+
+      // Command executed successfully
+      resolve(true);
+
+    } 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: Command took too long to execute'));
+      } else if (error.message.includes('JSON')) {
+        reject(new Error('Invalid command format'));
+      } else {
+        reject(error);
+      }
+    }
+  });
+};

package/src/types/custom.d.ts

@@ -0,0 +1,5 @@
+declare module 'NodeModule' {
+    interface NodeModule {
+      type?: string;
+    }
+  }