erlc-api 2.3.2 → 2.3.4

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/README.md

@@ -1,134 +1,110 @@
-# ERLC API
-
-A modern TypeScript/JavaScript API wrapper for ER:LC (Emergency Response: Liberty County) with full browser support.
-
-## Features
-
-- 🚀 Full TypeScript support
-- 🌐 Browser compatible
-- ⚡ Promise-based API
-- 🛡️ Comprehensive error handling
-- 📘 Type definitions included
-- 🔄 CommonJS and ES Module support
-
-## Installation
-
-```bash
-npm install erlc-api
-```
-
-## Usage
-
-### TypeScript/ES Modules
-
-```typescript
-import { Client } from 'erlc-api';
-
-const client = new Client({
-  globalToken: 'your-global-token',
-});
-
-// Get server information
-const serverInfo = await client.getServer('server-token');
-console.log(serverInfo);
-
-// Get players
-const players = await client.getPlayers('server-token');
-console.log(players);
-
-//Run Command
-const Command = await client.runCommand('server-token', ':h Hello');
-console.log(Command);
-```
-
-### CommonJS
-
-```javascript
-const { Client } = require('erlc-api');
-
-const client = new Client({
-  globalToken: 'your-global-token',
-});
-
-// Using async/await
-async function getServerInfo() {
-  try {
-    const server = await client.getServer('server-token');
-    console.log(server);
-  } catch (error) {
-    console.error('Error:', error.message);
-  }
-}
-```
-
-### Browser
-
-```html
-<script src="node_modules/erlc-api/dist/browser/erlc.min.js"></script>
-<script>
-  const client = new ERLC.Client({
-    globalToken: 'your-global-token',
-  });
-
-  client
-    .getServer('server-token')
-    .then((server) => console.log(server))
-    .catch((error) => console.error(error));
-</script>
-```
-
-## API Methods
-
-- `getServer(serverToken)` - Get server information
-- `getPlayers(serverToken)` - Get list of players
-- `getJoinLogs(serverToken)` - Get join/leave logs
-- `getKillLogs(serverToken)` - Get kill logs
-- `getCommandLogs(serverToken)` - Get command logs
-- `getModcallLogs(serverToken)` - Get modcall logs
-- `getBans(serverToken)` - Get server bans
-- `getVehicles(serverToken)` - Get vehicle information
-- `getQueue(serverToken)` - Get queue information
-- `runCommand(serverToken, command)` - Run a server command
-
-## Error Handling
-
-The library includes custom error classes for better error handling:
-
-```typescript
-import { AuthenticationError, ValidationError, NetworkError } from 'erlc-api';
-
-try {
-  await client.getServer('server-token');
-} catch (error) {
-  if (error instanceof AuthenticationError) {
-    console.error('Authentication failed');
-  } else if (error instanceof ValidationError) {
-    console.error('Invalid input');
-  } else if (error instanceof NetworkError) {
-    console.error('Network error occurred');
-  }
-}
-```
-
-## Development
-
-```bash
-# Install dependencies
-npm install
-
-# Run tests
-npm test
-
-# Build
-npm run build
-
-# Lint
-npm run lint
-
-# Format code
-npm run format
-```
-
-## License
-
-MIT License - see LICENSE file for details.
+# ER:LC API Wrapper
+
+A lightweight API Wrapper with 100% coverage of the ER:LC API. Fixed Error and Improvements
+7
+
+## Getting Started
+
+First you need to install the package.
+
+`npm i erlc-api`
+
+### Setting Up
+
+Setting up is super simple:
+
+```js
+// index.js
+const erlc = require("erlc");
+const client = new erlc.Client({
+  globalToken: "", // You get the global key directly from the ERLC developers. To increase your API request limits
+});
+client.config(); // Registers your client
+```
+
+Now you can start using API Methods - here are a few examples:
+
+```js
+// GetServerInfo.js
+const erlc = require("erlc-api"); //JS
+import erlc from "erlc-api"; //  Module or typeScript
+
+const getServerFunc = async () => {
+  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
+
+  //  Expected Response:
+  // {
+  //   Name: "Your Sever Name",
+  //   CurrentPlayers: 0,
+  //   MaxPlayers: 40,
+  //   JoinKey: "Your Code Join",
+  //   AccVerifiedReq: "Disabled" | "Email" | "Phone/ID",
+  //   TeamBalance: true or false ,
+  //   OwnerUsername: "Your Name",
+  //   CoOwnerUsernames: [],
+  //   VanityURL: "https://policeroleplay.community/join?code=YourCode",
+  // },
+};
+
+getServerFunc();
+```
+
+```js
+// GetPlayers.js
+const erlc = require("erlc-api"); //JS
+import erlc from "erlc-api"; //  Module or typeScript
+
+const getPlayersFunc = async () => {
+  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
+  const server = await erlc.getPlayers(serverId).catch(console.log); // Gets the server, logs any errors
+  console.log(server); // Logs the server object
+  //  Expected Response:
+  // [
+  // 	{
+  // 		"Permission": "Server Owner" Or Member, Moderator,
+  // 		"Player": "Player-Username and ID" ,
+  // 		"Team": "Civilian" Or Fire, Police, Sherift
+  // 	}
+  // ]
+};
+getPlayersFunc();
+```
+
+```js
+//getmodCalls.js
+const erlc = require("erlc-api"); //JS
+import erlc from "erlc-api"; //  Module or typeScript
+
+const getModCallsFunc = async () => {
+  const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
+  const server = await erlc.getModcallLogs(serverId).catch(console.log); // Gets the server, logs any errors
+  console.log(server); // Logs the server object
+  //  Expected Response:
+  // {
+  //  Caller: ErlcPlayer;
+  //   Moderator?: ErlcPlayer; // If call is unanswered property is undefined
+  //   Timestamp: number;
+  //  }
+};
+getModCallsFunc()
+```
+
+### [Discord Bot](https://discord.com/oauth2/authorize?client_id=1014990793280323624)
+
+The Discord Bot Back Online 29/05/2024
+
+## [Module Examples](https://scarlet-2.gitbook.io/erlc-api/)
+
+### [PRC API Docs](https://apidocs.policeroleplay.community/reference/api-reference)
+
+## [Liveries]("https://github.com/Exodo0/ERLC-API/tree/main/Custom%20Liveries")
+
+### Credits
+
+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

@@ -0,0 +1 @@
+module.exports = require('./src/erlc')

package/package.json

@@ -1,64 +1,34 @@
-{
-  "name": "erlc-api",
-  "version": "2.3.2",
-  "description": "A modern API wrapper for ER:LC with TypeScript and browser support",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "browser": "dist/browser/erlc.min.js",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "npm run clean && npm run build:all",
-    "build:all": "npm run build:esm && npm run build:cjs && npm run build:browser && npm run build:types",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:browser": "webpack --config webpack.config.js",
-    "build:types": "tsc -p tsconfig.types.json",
-    "clean": "rimraf dist",
-    "test": "jest",
-    "lint": "eslint src --ext .ts",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "docs": "typedoc"
-  },
-  "keywords": [
-    "erlc",
-    "roblox",
-    "prc",
-    "erlc-api",
-    "liberty-county",
-    "typescript",
-    "browser"
-  ],
-  "author": "egologics",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Exodo0/ERLC-API.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Exodo0/ERLC-API/issues"
-  },
-  "homepage": "https://github.com/Exodo0/ERLC-API#readme",
-  "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.1",
-    "@typescript-eslint/eslint-plugin": "^8.23.0",
-    "@typescript-eslint/parser": "^8.23.0",
-    "eslint": "^9.19.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.4.2",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.5",
-    "ts-loader": "^9.5.2",
-    "typedoc": "^0.27.6",
-    "typescript": "^5.7.3",
-    "webpack": "^5.97.1",
-    "webpack-cli": "^6.0.1"
-  },
-  "dependencies": {
-    "axios": "^1.7.9",
-    "erlc-api": "file:"
-  }
-}
+{
+  "name": "erlc-api",
+  "version": "2.3.4",
+  "description": "An ER:LC API wrapper for JS/TS",
+  "main": "index.js",
+  "types": "src/types/index.d.ts",
+  "keywords": [
+    "erlc",
+    "roblox",
+    "prc",
+    "erlc-api",
+    "liberty-county"
+  ],
+  "author": "egologics",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {
+    "erlc-api": "file:",
+    "node-fetch": "^3.3.2"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Exodo0/ERLC-API.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Exodo0/ERLC-API/issues"
+  },
+  "homepage": "https://github.com/Exodo0/ERLC-API#readme"
+}

package/src/classes/client.js

@@ -0,0 +1,36 @@
+const erlc = require('../erlc.js')
+const assert = require('../functions/assert.js')
+
+/**
+ * @typedef {Object} ClientConfig
+ * @property {string} globalToken - Your ER:LC global API token
+ */
+
+/**
+ * Creates an authorised ER:LC client for requests
+ * @class
+ * @param {ClientConfig} options - Client Options
+ */
+
+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
+    }
+}
+
+module.exports = Client

package/src/constants.js

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

package/src/erlc.js

@@ -0,0 +1,14 @@
+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");

package/src/functions/assert.js

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

package/src/functions/server/getBans.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getCommandLogs.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getJoinLogs.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getKillLogs.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getModcallLogs.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getPlayers.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };

package/src/functions/server/getQueue.js

@@ -0,0 +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);
+        }
+  
+        resolve(data);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };