erlc-api 1.3.12 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +126 -110
  3. package/dist/browser/erlc.min.js +1 -0
  4. package/dist/cjs/client.d.ts +25 -0
  5. package/dist/cjs/client.d.ts.map +1 -0
  6. package/dist/cjs/client.js +152 -0
  7. package/dist/cjs/client.js.map +1 -0
  8. package/dist/cjs/errors/index.d.ts +13 -0
  9. package/dist/cjs/errors/index.d.ts.map +1 -0
  10. package/dist/cjs/errors/index.js +32 -0
  11. package/dist/cjs/errors/index.js.map +1 -0
  12. package/dist/cjs/index.d.ts +4 -0
  13. package/dist/cjs/index.d.ts.map +1 -0
  14. package/dist/cjs/index.js +20 -0
  15. package/dist/cjs/index.js.map +1 -0
  16. package/dist/cjs/types/index.d.ts +46 -0
  17. package/dist/cjs/types/index.d.ts.map +1 -0
  18. package/dist/cjs/types/index.js +3 -0
  19. package/dist/cjs/types/index.js.map +1 -0
  20. package/dist/esm/client.d.ts +25 -0
  21. package/dist/esm/client.d.ts.map +1 -0
  22. package/dist/esm/client.js +145 -0
  23. package/dist/esm/client.js.map +1 -0
  24. package/dist/esm/errors/index.d.ts +13 -0
  25. package/dist/esm/errors/index.d.ts.map +1 -0
  26. package/dist/esm/errors/index.js +25 -0
  27. package/dist/esm/errors/index.js.map +1 -0
  28. package/dist/esm/index.d.ts +4 -0
  29. package/dist/esm/index.d.ts.map +1 -0
  30. package/dist/esm/index.js +4 -0
  31. package/dist/esm/index.js.map +1 -0
  32. package/dist/esm/types/index.d.ts +46 -0
  33. package/dist/esm/types/index.d.ts.map +1 -0
  34. package/dist/esm/types/index.js +2 -0
  35. package/dist/esm/types/index.js.map +1 -0
  36. package/dist/types/client.d.ts +25 -0
  37. package/dist/types/client.d.ts.map +1 -0
  38. package/dist/types/errors/index.d.ts +13 -0
  39. package/dist/types/errors/index.d.ts.map +1 -0
  40. package/dist/types/index.d.ts +4 -0
  41. package/dist/types/index.d.ts.map +1 -0
  42. package/dist/types/types/index.d.ts +46 -0
  43. package/dist/types/types/index.d.ts.map +1 -0
  44. package/package.json +65 -33
  45. package/.gitattributes +0 -2
  46. package/index.js +0 -1
  47. package/src/classes/client.js +0 -36
  48. package/src/constants.js +0 -2
  49. package/src/erlc.js +0 -14
  50. package/src/functions/assert.js +0 -5
  51. package/src/functions/server/getBans.js +0 -28
  52. package/src/functions/server/getCommandLogs.js +0 -28
  53. package/src/functions/server/getJoinLogs.js +0 -28
  54. package/src/functions/server/getKillLogs.js +0 -28
  55. package/src/functions/server/getModcallLogs.js +0 -28
  56. package/src/functions/server/getPlayers.js +0 -28
  57. package/src/functions/server/getQueue.js +0 -28
  58. package/src/functions/server/getServer.js +0 -52
  59. package/src/functions/server/getVehicles.js +0 -28
  60. package/src/functions/server/runCommand.js +0 -29
  61. package/src/types/custom.d.ts +0 -5
  62. package/src/types/index.d.ts +0 -91
@@ -1,36 +0,0 @@
1
- const erlc = require('../erlc.js')
2
- const assert = require('../functions/assert.js')
3
-
4
- /**
5
- * @typedef {Object} ClientConfig
6
- * @property {string} globalToken - Your ER:LC global API token
7
- */
8
-
9
- /**
10
- * Creates an authorised ER:LC client for requests
11
- * @class
12
- * @param {ClientConfig} options - Client Options
13
- */
14
-
15
- class Client {
16
-
17
- /**
18
- * @constructor
19
- * @param {ClientConfig} options - Client Options
20
- */
21
- constructor(options) {
22
- assert(typeof options === 'object', `Syntax error: object expected for "options", received ${typeof options}`);
23
- this.options = { ...options };
24
- }
25
-
26
- /**
27
- * Updates and returns the client configurationg
28
- * @returns {ClientConfig} The client configuration.
29
- */
30
- config() {
31
- erlc.config = this.options
32
- return erlc.config
33
- }
34
- }
35
-
36
- module.exports = Client
package/src/constants.js DELETED
@@ -1,2 +0,0 @@
1
- exports.Vanity = "https://policeroleplay.community/join?code="
2
- exports.BASEURL = "https://api.policeroleplay.community/v1"
package/src/erlc.js DELETED
@@ -1,14 +0,0 @@
1
- exports.config = {};
2
-
3
- exports.getBans = require("./functions/server/getBans.js");
4
- exports.getCommandLogs = require("./functions/server/getCommandLogs.js");
5
- exports.getJoinLogs = require("./functions/server/getJoinLogs.js");
6
- exports.getKillLogs = require("./functions/server/getKillLogs.js");
7
- exports.getModcallLogs = require("./functions/server/getModcallLogs.js");
8
- exports.getPlayers = require("./functions/server/getPlayers.js");
9
- exports.getServer = require("./functions/server/getServer.js");
10
- exports.getQueue = require("./functions/server/getQueue.js");
11
- exports.runCommand = require("./functions/server/runCommand.js");
12
- exports.getVehicles = require("./functions/server/getVehicles.js");
13
-
14
- exports.Client = require("./classes/client.js");
@@ -1,5 +0,0 @@
1
- module.exports = function(condition, message) {
2
- if (!condition) {
3
- throw new Error(message);
4
- }
5
- }
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/bans`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/commandlogs`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/joinlogs`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/killlogs`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/modcalls`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/players`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/queue`, {
10
- headers: {
11
- "Authorization": config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,52 +0,0 @@
1
- const { BASEURL , Vanity} = require("../../constants.js");
2
- module.exports = (serverToken) => {
3
- return new Promise(async (resolve, reject) => {
4
- try {
5
- const fetch = await import("node-fetch");
6
- const { config } = await import("../../erlc.js");
7
-
8
- const res = await fetch.default(`${BASEURL}/server`, {
9
- headers: {
10
- "Authorization": config?.globalToken,
11
- "Server-Key": serverToken,
12
- },
13
- });
14
-
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
- const getUsername = async (userId) => {
23
- const response = await fetch.default(`https://users.roblox.com/v1/users/${userId}`);
24
- const userData = await response.json();
25
- if (!response.ok) {
26
- throw new Error(`Error fetching username for ID: ${userId}`);
27
- }
28
- return userData.name;
29
- };
30
- try {
31
- const ownerUsername = await getUsername(data.OwnerId);
32
- const coOwnerUsernames = await Promise.all(data.CoOwnerIds.map(getUsername));
33
- const VanityURL = `${Vanity}${data.JoinKey}`
34
-
35
-
36
- data.OwnerUsername = ownerUsername;
37
- data.CoOwnerUsernames = coOwnerUsernames;
38
- data.VanityURL = VanityURL
39
-
40
- delete data.OwnerId;
41
- delete data.CoOwnerIds;
42
-
43
- resolve(data);
44
- } catch (error) {
45
- reject(error);
46
- }
47
-
48
- } catch (error) {
49
- reject(error);
50
- }
51
- });
52
- };
@@ -1,28 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
-
9
- const res = await fetch.default(`${BASEURL}/server/vehicles`, {
10
- headers: {
11
- Authorization: config?.globalToken,
12
- "Server-Key": serverToken,
13
- },
14
- });
15
- const data = await res.json().catch((err) => {
16
- return reject(err);
17
- });
18
-
19
- if (!res.ok) {
20
- return reject(data);
21
- }
22
-
23
- resolve(data);
24
- } catch (error) {
25
- reject(error);
26
- }
27
- });
28
- };
@@ -1,29 +0,0 @@
1
- const { BASEURL } = require("../../constants.js");
2
-
3
- module.exports = (serverToken, command) => {
4
- return new Promise(async (resolve, reject) => {
5
- try {
6
- const fetch = await import("node-fetch");
7
- const { config } = await import("../../erlc.js");
8
- const params = JSON.stringify({ command: `${command}` });
9
- const res = await fetch.default(`${BASEURL}/server/command`, {
10
- headers: {
11
- Authorization: config?.globalToken,
12
- "Server-Key": serverToken,
13
- "Content-Type": "application/json",
14
- },
15
- method: "POST",
16
- body: params,
17
- });
18
-
19
- if (!res.ok) {
20
- const errorData = await res.json();
21
- return reject(errorData);
22
- }
23
-
24
- resolve(true);
25
- } catch (error) {
26
- reject(error);
27
- }
28
- });
29
- };
@@ -1,5 +0,0 @@
1
- declare module 'NodeModule' {
2
- interface NodeModule {
3
- type?: string;
4
- }
5
- }
@@ -1,91 +0,0 @@
1
- declare module "erlc-api" {
2
- export interface ClientConfig {
3
- globalToken: string; // The ER:LC global API token
4
- }
5
-
6
- export const BASEURL = "https://api.policeroleplay.community/v1";
7
-
8
- type PlayerId = string;
9
- type PlayerName = string;
10
- type TextureName = string;
11
- type CarName = string;
12
-
13
- export type ErlcPlayer = `${PlayerName}:${PlayerId}`; // Playername:UserID
14
- export type ErlcPlayerPermission =
15
- | "Normal"
16
- | "Server Administrator"
17
- | "Server Owner"
18
- | "Server Moderator";
19
-
20
- export interface ServerStatus {
21
- Name: string; // The server name
22
- OwnerId: number; // The roblox id of the server owner
23
- CoOwnerIds: number[]; // The roblox ids of the server co owners
24
- CurrentPlayers: number; // The amount of people currently in-game
25
- MaxPlayers: number; // The amount of people who can join the server including server owner
26
- JoinKey: string; // The code used to join the private server
27
- AccVerifiedReq: "Disabled" | "Email" | "Phone/ID"; // The level of verification roblox accounts need to join the private server
28
- TeamBalance: boolean; // If team balance is enabled or not
29
- }
30
-
31
- export interface ServerPlayer {
32
- Player: ErlcPlayer;
33
- Permission: ErlcPlayerPermission;
34
- }
35
-
36
- export interface JoinLog {
37
- Join: boolean; // True is join and False is leave
38
- Timestamp: number; // Timestamp in seconds
39
- Player: ErlcPlayer;
40
- }
41
-
42
- export interface KillLog {
43
- Killed: ErlcPlayer;
44
- Timestamp: number; // Timestamp in seconds
45
- Killer: ErlcPlayer;
46
- }
47
-
48
- export interface CommandLog {
49
- Player: ErlcPlayer;
50
- Timestamp: number; // Timestamp in seconds
51
- Command: string;
52
- }
53
-
54
- export interface ModcallLog {
55
- Caller: ErlcPlayer;
56
- Moderator?: ErlcPlayer; // If call is unanswered property is undefined
57
- Timestamp: number; // Timestamp in seconds
58
- }
59
-
60
- export type ServerBan = Record<PlayerId, PlayerName>;
61
-
62
- export interface VehiclesLog {
63
- Texture: string | null;
64
- Name: string;
65
- Owner: ErlcPlayer;
66
- }
67
-
68
- export interface VSMCommandBody {
69
- command: string; // ":h Hey everyone!"
70
- }
71
-
72
-
73
- export function getBans(serverToken: string): Promise<ServerBan>;
74
- export function getCommandLogs(serverToken: string): Promise<CommandLog[]>;
75
- export function getJoinLogs(serverToken: string): Promise<JoinLog[]>;
76
- export function getKillLogs(serverToken: string): Promise<KillLog[]>;
77
- export function getModcallLogs(serverToken: string): Promise<ModcallLog[]>;
78
- export function getPlayers(serverToken: string): Promise<ServerPlayer[]>;
79
- export function getQueue(serverToken: string): Promise<number[]>;
80
- export function getServer(serverToken: string): Promise<ServerStatus>;
81
- export function getVehicles(serverToken: string): Promise<VehiclesLog[]>;
82
- export function runCommand(
83
- serverToken: string,
84
- command: string
85
- ): Promise<boolean>;
86
-
87
- export class Client {
88
- constructor(options: ClientConfig);
89
- config(): ClientConfig;
90
- }
91
- }