erlc-api 1.3.4 → 1.3.6

package/README.md

@@ -25,20 +25,38 @@ client.config(); // Registers your client
 Now you can start using API Methods - here are a few examples:
 
 ```js
-// api.js
-
-const erlc = require("erlc");
+// GetServerInfo.js
+const erlc = require("erlc-api");
 
 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();
 ```
 
+### [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)
 
 ### Credits

package/package.json

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

package/src/types/index.d.ts

@@ -1,74 +1,81 @@
-declare module 'erlc' {
-    export interface ClientConfig {
-        globalToken: string // The ER:LC global API token
-    }
+declare module "erlc-api" {
+  export interface ClientConfig {
+    globalToken: string; // The ER:LC global API token
+  }
 
-    export const BASEURL = "https://api.policeroleplay.community/v1"
+  export const BASEURL = "https://api.policeroleplay.community/v1";
 
-    type PlayerId = string
-    type PlayerName = string
+  type PlayerId = string;
+  type PlayerName = string;
 
-    export type ErlcPlayer = `${PlayerName}:${PlayerId}` // Playername:UserID
-    export type ErlcPlayerPermission = "Normal" | "Server Administrator" | "Server Owner" | "Server Moderator"
+  export type ErlcPlayer = `${PlayerName}:${PlayerId}`; // Playername:UserID
+  export type ErlcPlayerPermission =
+    | "Normal"
+    | "Server Administrator"
+    | "Server Owner"
+    | "Server Moderator";
 
-    export interface ServerStatus {
-        Name: string; // The server name
-        OwnerId: number; // The roblox id of the server owner
-        CoOwnerIds: number[]; // The roblox ids of the server co owners
-        CurrentPlayers: number; // The amount of people currently in-game
-        MaxPlayers: number; // The amount of people who can join the server including server owner
-        JoinKey: string; // The code used to join the private server
-        AccVerifiedReq: "Disabled" | "Email" | "Phone/ID"; // The level of verification roblox accounts need to join the private server
-        TeamBalance: boolean; // If team balance is enabled or not
-    }
+  export interface ServerStatus {
+    Name: string; // The server name
+    OwnerId: number; // The roblox id of the server owner
+    CoOwnerIds: number[]; // The roblox ids of the server co owners
+    CurrentPlayers: number; // The amount of people currently in-game
+    MaxPlayers: number; // The amount of people who can join the server including server owner
+    JoinKey: string; // The code used to join the private server
+    AccVerifiedReq: "Disabled" | "Email" | "Phone/ID"; // The level of verification roblox accounts need to join the private server
+    TeamBalance: boolean; // If team balance is enabled or not
+  }
 
-    export interface ServerPlayer {
-        Player: ErlcPlayer;
-        Permission: ErlcPlayerPermission;
-    }
+  export interface ServerPlayer {
+    Player: ErlcPlayer;
+    Permission: ErlcPlayerPermission;
+  }
 
-    export interface JoinLog {
-        Join: boolean; // True is join and False is leave
-        Timestamp: number; // Timestamp in seconds
-        Player: ErlcPlayer;
-    }
+  export interface JoinLog {
+    Join: boolean; // True is join and False is leave
+    Timestamp: number; // Timestamp in seconds
+    Player: ErlcPlayer;
+  }
 
-    export interface KillLog {
-        Killed: ErlcPlayer;
-        Timestamp: number; // Timestamp in seconds
-        Killer: ErlcPlayer;
-    }
+  export interface KillLog {
+    Killed: ErlcPlayer;
+    Timestamp: number; // Timestamp in seconds
+    Killer: ErlcPlayer;
+  }
 
-    export interface CommandLog {
-        Player: ErlcPlayer;
-        Timestamp: number; // Timestamp in seconds
-        Command: string;
-    }
+  export interface CommandLog {
+    Player: ErlcPlayer;
+    Timestamp: number; // Timestamp in seconds
+    Command: string;
+  }
 
-    export interface ModcallLog {
-        Caller: ErlcPlayer;
-        Moderator?: ErlcPlayer; // If call is unanswered property is undefined
-        Timestamp: number; // Timestamp in seconds
-    }
+  export interface ModcallLog {
+    Caller: ErlcPlayer;
+    Moderator?: ErlcPlayer; // If call is unanswered property is undefined
+    Timestamp: number; // Timestamp in seconds
+  }
 
-    export type ServerBan = Record<PlayerId, PlayerName>; 
+  export type ServerBan = Record<PlayerId, PlayerName>;
 
-    export interface VSMCommandBody {
-        command : string; // ":h Hey everyone!"
-    }
+  export interface VSMCommandBody {
+    command: string; // ":h Hey everyone!"
+  }
 
-    export function getBans(serverToken: string): Promise<ServerBan>;
-    export function getCommandLogs(serverToken: string): Promise<CommandLog[]>;
-    export function getJoinLogs(serverToken: string): Promise<JoinLog[]>;
-    export function getKillLogs(serverToken: string): Promise<KillLog[]>;
-    export function getModcallLogs(serverToken: string): Promise<ModcallLog[]>;
-    export function getPlayers(serverToken: string): Promise<ServerPlayer[]>;
-    export function getQueue(serverToken: string): Promise<number[]>;
-    export function getServer(serverToken: string): Promise<ServerStatus>;
-    export function runCommand(serverToken: string, command: string): Promise<boolean>;
+  export function getBans(serverToken: string): Promise<ServerBan>;
+  export function getCommandLogs(serverToken: string): Promise<CommandLog[]>;
+  export function getJoinLogs(serverToken: string): Promise<JoinLog[]>;
+  export function getKillLogs(serverToken: string): Promise<KillLog[]>;
+  export function getModcallLogs(serverToken: string): Promise<ModcallLog[]>;
+  export function getPlayers(serverToken: string): Promise<ServerPlayer[]>;
+  export function getQueue(serverToken: string): Promise<number[]>;
+  export function getServer(serverToken: string): Promise<ServerStatus>;
+  export function runCommand(
+    serverToken: string,
+    command: string
+  ): Promise<boolean>;
 
-    export class Client {
-        constructor(options: ClientConfig)
-        config(): ClientConfig;
-    }
-}
+  export class Client {
+    constructor(options: ClientConfig);
+    config(): ClientConfig;
+  }
+}