erlc-api 3.1.0 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "erlc-api",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "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,24 +13,27 @@ 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 };
+    this.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
-    }
+  /**
+   * 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/erlc.js

@@ -11,5 +11,6 @@ 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.resetGlobalKey = require("./functions/global/resetGlobalKey.js");
 
 exports.Client = require("./classes/client.js");

package/src/functions/global/resetGlobalKey.js

@@ -0,0 +1,60 @@
+const { BASEURL } = require("../../constants.js");
+const { processError } = require("../../utils/errorHandler.js");
+
+/**
+ * Resets the global API key
+ * @returns {Promise<string>} Promise that resolves to the new global API key
+ */
+module.exports = () => {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const fetch = await import("node-fetch");
+      const { config } = await import("../../erlc.js");
+
+      // Check if global token is configured
+      if (!config?.globalToken) {
+        const error = await processError(
+          new Error(
+            "Global token not configured. Please initialize the client first.",
+          ),
+        );
+        return reject(error);
+      }
+
+      const res = await fetch.default(`${BASEURL}/api-key/reset`, {
+        method: "POST",
+        headers: {
+          Authorization: config.globalToken,
+        },
+        timeout: 10000, // 10 second timeout
+      });
+
+      if (!res.ok) {
+        const errorData = await res
+          .json()
+          .catch(() => ({ error: "Unknown API error" }));
+        const error = await processError(res, errorData);
+        return reject(error);
+      }
+
+      // The response is likely a JSON with the new key, or just the key string?
+      // Docs say: "This will send a new key which can only be viewed once."
+      // Let's assume it returns a JSON object or just the string.
+      // Usually these APIs return a JSON object like { "key": "..." } or similar.
+      // However, looking at other endpoints, they return data directly.
+      // Let's assume it returns a JSON with the key, or we can inspect the response content type.
+      // But for now, let's try to parse as JSON.
+
+      const data = await res.json();
+      // If data has a specific field for the key, we should return that.
+      // If the documentation doesn't specify, I'll return the whole data object or try to find the key.
+      // Based on "This will send a new key", it might be { "apiKey": "..." } or just the string if it's text/plain.
+      // Given other endpoints return JSON, this likely returns JSON.
+
+      resolve(data);
+    } catch (error) {
+      const processedError = await processError(error);
+      reject(processedError);
+    }
+  });
+};

package/src/types/index.d.ts

@@ -1,127 +1,127 @@
-declare module "erlc-api" {
-  // Error handling types
-  export class ErlcError extends Error {
-    code: string | number;
-    status?: number;
-    category?: string;
-    severity?: string;
-    suggestions?: string[];
-    retryable?: boolean;
-    timestamp: string;
-    originalError?: Error;
-
-    constructor(
-      message: string,
-      code: string | number,
-      status?: number,
-      originalError?: Error
-    );
-    toJSON(): object;
-    toString(): string;
-  }
-
-  export interface ErrorInfo {
-    message: string;
-    description: string;
-    category: string;
-    severity: string;
-    code?: number;
-  }
-
-  export interface ClientConfig {
-    globalToken: string; // The ER:LC global API token
-  }
-
-  export const BASEURL = "https://api.policeroleplay.community/v1";
-
-  type PlayerId = string;
-  type PlayerName = string;
-  type TextureName = string;
-  type CarName = string;
-
-  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
-    OwnerUsername: string; // The username of the server owner
-    CoOwnerUsernames: string[]; // The usernames 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
-    VanityURL: string; // The vanity URL to join the server
-  }
-
-  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 KillLog {
-    Killed: ErlcPlayer;
-    Timestamp: number; // Timestamp in seconds
-    Killer: ErlcPlayer;
-  }
-
-  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 type ServerBan = Record<PlayerId, PlayerName>;
-
-  export interface VehiclesLog {
-    Texture: string | null;
-    Name: string;
-    Owner: ErlcPlayer;
-  }
-
-  export interface ServerStaff {
-    CoOwners: number[];
-    Admins: Record<string, string>;
-    Mods: Record<string, string>;
-  }
-
-  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 getStaff(serverToken: string): Promise<ServerStaff>;
-  export function getVehicles(serverToken: string): Promise<VehiclesLog[]>;
-  export function runCommand(
-    serverToken: string,
-    command: string
-  ): Promise<boolean>;
-
-  export class Client {
-    constructor(options: ClientConfig);
-    config(): ClientConfig;
-  }
+// Error handling types
+export class ErlcError extends Error {
+  code: string | number;
+  status?: number;
+  category?: string;
+  severity?: string;
+  suggestions?: string[];
+  retryable?: boolean;
+  timestamp: string;
+  originalError?: Error;
+
+  constructor(
+    message: string,
+    code: string | number,
+    status?: number,
+    originalError?: Error,
+  );
+  toJSON(): object;
+  toString(): string;
+}
+
+export interface ErrorInfo {
+  message: string;
+  description: string;
+  category: string;
+  severity: string;
+  code?: number;
+}
+
+export interface ClientConfig {
+  globalToken: string; // The ER:LC global API token
+}
+
+export const BASEURL = "https://api.policeroleplay.community/v1";
+
+type PlayerId = string;
+type PlayerName = string;
+type TextureName = string;
+type CarName = string;
+
+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
+  OwnerUsername: string; // The username of the server owner
+  CoOwnerUsernames: string[]; // The usernames 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
+  VanityURL: string; // The vanity URL to join the server
+}
+
+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 KillLog {
+  Killed: ErlcPlayer;
+  Timestamp: number; // Timestamp in seconds
+  Killer: ErlcPlayer;
+}
+
+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 type ServerBan = Record<PlayerId, PlayerName>;
+
+export interface VehiclesLog {
+  Texture: string | null;
+  Name: string;
+  Owner: ErlcPlayer;
+}
+
+export interface ServerStaff {
+  CoOwners: number[];
+  Admins: Record<string, string>;
+  Mods: Record<string, string>;
+}
+
+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 getStaff(serverToken: string): Promise<ServerStaff>;
+export function getVehicles(serverToken: string): Promise<VehiclesLog[]>;
+export function runCommand(
+  serverToken: string,
+  command: string,
+): Promise<boolean>;
+
+export function resetGlobalKey(): Promise<any>;
+
+export class Client {
+  constructor(options: ClientConfig);
+  config(): ClientConfig;
 }