Skip to content

Commit a108faf

Browse files
pablo-1610pablo-1610
committed
Merge branch 'master' of https://github.com/PabloCodingg/cfx-api 
2 parents 971e544 + bd88633 commit a108faf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+4923
-2377
lines changed

‎.eslintignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
2-
dist
2+
dist
3+
tests

‎.eslintrc

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"plugin:@typescript-eslint/recommended"
1111
],
1212
"rules": {
13-
"no-console": 2
13+
"no-console": 2,
14+
"@typescript-eslint/no-explicit-any": ["off"]
1415
}
1516
}

‎.github/FUNDING.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: PABLO-1610

‎.github/dependabot.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "npm"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/eslint.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: ESLint
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
lint:
7+
name: ESLint
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout repository
11+
uses: actions/checkout@v2
12+
13+
- name: Install Node
14+
uses: actions/setup-node@v2
15+
with:
16+
node-version: 16
17+
cache: npm
18+
19+
- name: Install ESLint
20+
run: npm install
21+
22+
- name: Run ESLint
23+
run: npm run lint

‎.github/workflows/npm-publish.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Node.js Package
2+
3+
on:
4+
release:
5+
types: [ created ]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-node@v1
13+
with:
14+
node-version: 12
15+
- run: npm ci
16+
- run: npm test
17+
18+
publish-npm:
19+
needs: build
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v2
23+
- uses: actions/setup-node@v1
24+
with:
25+
node-version: 12
26+
registry-url: https://registry.npmjs.org/
27+
- run: npm ci
28+
- run: npm publish
29+
env:
30+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
31+
32+
publish-gpr:
33+
needs: build
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions/checkout@v2
37+
- uses: actions/setup-node@v1
38+
with:
39+
node-version: 12
40+
registry-url: https://npm.pkg.github.com/
41+
- run: npm ci
42+
- run: npm publish
43+
env:
44+
NODE_AUTH_TOKEN: ${{secrets.GIT_TOKEN}}

‎.github/workflows/unit_tests.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: unit-tests
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
pull_request:
7+
8+
jobs:
9+
check_lib_compilation:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/[email protected]
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Install Dependencies
18+
run: npm i --save
19+
20+
- name: Compile Library
21+
run: npm run compile
22+
23+
run_tests:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/[email protected]
28+
with:
29+
fetch-depth: 0
30+
31+
- name: Install Dependencies
32+
run: npm i -D
33+
34+
- name: Execute Unit Tests
35+
run: npm run test

‎dist/index.d.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
export * from "./types";
2-
export declare function fetchServer(id: string): Promise<import("./models/CfxCitizenServer").default | undefined>;
3-
export declare function fetchStatus(): Promise<import("./models/CfxStatus").default | undefined>;
4-
export declare function fetchUnresolvedIncidents(): Promise<import("./types").CfxUnresolvedIncidents | undefined>;
1+
export * from "./types";
2+
export declare function fetchServer(id: string): Promise<import("./models/CfxCitizenServer").default | undefined>;
3+
export declare function fetchStatus(): Promise<import("./models/CfxStatus").default | undefined>;
4+
export declare function fetchUnresolvedIncidents(): Promise<import("./models/CfxUnresolvedIncidents").default | undefined>;
5+
export declare function fetchPinnedServers(): Promise<import("./models/CfxPinnedServers").default | undefined>;

‎dist/index.js

+41-36
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
1-
"use strict";
2-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3-
if (k2 === undefined) k2 = k;
4-
var desc = Object.getOwnPropertyDescriptor(m, k);
5-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6-
desc = { enumerable: true, get: function() { return m[k]; } };
7-
}
8-
Object.defineProperty(o, k2, desc);
9-
}) : (function(o, m, k, k2) {
10-
if (k2 === undefined) k2 = k;
11-
o[k2] = m[k];
12-
}));
13-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
14-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15-
};
16-
var __importDefault = (this && this.__importDefault) || function (mod) {
17-
return (mod && mod.__esModule) ? mod : { "default": mod };
18-
};
19-
Object.defineProperty(exports, "__esModule", { value: true });
20-
exports.fetchUnresolvedIncidents = exports.fetchStatus = exports.fetchServer = void 0;
21-
const CfxStatus_module_1 = __importDefault(require("./modules/CfxStatus.module"));
22-
const CfxCitizenServer_module_1 = __importDefault(require("./modules/CfxCitizenServer.module"));
23-
const CfxUnresolvedIncidents_module_1 = __importDefault(require("./modules/CfxUnresolvedIncidents.module"));
24-
__exportStar(require("./types"), exports);
25-
async function fetchServer(id) {
26-
return await CfxCitizenServer_module_1.default.get().retrieve(id);
27-
}
28-
exports.fetchServer = fetchServer;
29-
async function fetchStatus() {
30-
return await CfxStatus_module_1.default.get().retrieve();
31-
}
32-
exports.fetchStatus = fetchStatus;
33-
async function fetchUnresolvedIncidents() {
34-
return await CfxUnresolvedIncidents_module_1.default.get().retrieve();
35-
}
36-
exports.fetchUnresolvedIncidents = fetchUnresolvedIncidents;
1+
"use strict";
2+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3+
if (k2 === undefined) k2 = k;
4+
var desc = Object.getOwnPropertyDescriptor(m, k);
5+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6+
desc = { enumerable: true, get: function() { return m[k]; } };
7+
}
8+
Object.defineProperty(o, k2, desc);
9+
}) : (function(o, m, k, k2) {
10+
if (k2 === undefined) k2 = k;
11+
o[k2] = m[k];
12+
}));
13+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
14+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15+
};
16+
var __importDefault = (this && this.__importDefault) || function (mod) {
17+
return (mod && mod.__esModule) ? mod : { "default": mod };
18+
};
19+
Object.defineProperty(exports, "__esModule", { value: true });
20+
exports.fetchPinnedServers = exports.fetchUnresolvedIncidents = exports.fetchStatus = exports.fetchServer = void 0;
21+
const CfxStatus_module_1 = __importDefault(require("./modules/CfxStatus.module"));
22+
const CfxCitizenServer_module_1 = __importDefault(require("./modules/CfxCitizenServer.module"));
23+
const CfxUnresolvedIncidents_module_1 = __importDefault(require("./modules/CfxUnresolvedIncidents.module"));
24+
const CfxPinnedServers_module_1 = __importDefault(require("./modules/CfxPinnedServers.module"));
25+
__exportStar(require("./types"), exports);
26+
async function fetchServer(id) {
27+
return await CfxCitizenServer_module_1.default.get().retrieve(id);
28+
}
29+
exports.fetchServer = fetchServer;
30+
async function fetchStatus() {
31+
return await CfxStatus_module_1.default.get().retrieve();
32+
}
33+
exports.fetchStatus = fetchStatus;
34+
async function fetchUnresolvedIncidents() {
35+
return await CfxUnresolvedIncidents_module_1.default.get().retrieve();
36+
}
37+
exports.fetchUnresolvedIncidents = fetchUnresolvedIncidents;
38+
async function fetchPinnedServers() {
39+
return await CfxPinnedServers_module_1.default.get().retrieve();
40+
}
41+
exports.fetchPinnedServers = fetchPinnedServers;

‎dist/models/CfxCitizenPlayer.d.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { CfxCitizenPlayerPayload } from "../types";
2-
export default class CfxCitizenPlayer {
3-
endpoint: string;
4-
id: number;
5-
identifiers: string[];
6-
name: string;
7-
ping: number;
8-
constructor(payload: CfxCitizenPlayerPayload);
9-
}
1+
import { CfxCitizenPlayerPayload } from "../types";
2+
export default class CfxCitizenPlayer {
3+
endpoint: string;
4+
id: number;
5+
identifiers: string[];
6+
name: string;
7+
ping: number;
8+
constructor(payload: CfxCitizenPlayerPayload);
9+
}

‎dist/models/CfxCitizenPlayer.js

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
"use strict";
2-
Object.defineProperty(exports, "__esModule", { value: true });
3-
class CfxCitizenPlayer {
4-
endpoint;
5-
id;
6-
identifiers;
7-
name;
8-
ping;
9-
constructor(payload) {
10-
this.endpoint = payload.endpoint;
11-
this.id = payload.id;
12-
this.identifiers = payload.identifiers;
13-
this.name = payload.name;
14-
this.ping = payload.ping;
15-
}
16-
}
17-
exports.default = CfxCitizenPlayer;
1+
"use strict";
2+
Object.defineProperty(exports, "__esModule", { value: true });
3+
class CfxCitizenPlayer {
4+
endpoint;
5+
id;
6+
identifiers;
7+
name;
8+
ping;
9+
constructor(payload) {
10+
this.endpoint = payload.endpoint;
11+
this.id = payload.id;
12+
this.identifiers = payload.identifiers;
13+
this.name = payload.name;
14+
this.ping = payload.ping;
15+
}
16+
}
17+
exports.default = CfxCitizenPlayer;

‎dist/models/CfxCitizenServer.d.ts

+39-39
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
import { CfxCitizenServerData, CfxCitizenServerDataData } from "../types";
2-
export default class CitizenServer {
3-
id: string;
4-
data: CfxCitizenServerDataData;
5-
constructor(data: CfxCitizenServerData);
6-
get playersCount(): number;
7-
get players(): import("../types").CfxCitizenPlayerPayload[];
8-
get gameType(): string;
9-
get hostname(): string;
10-
get mapName(): string;
11-
get maxPlayers(): number;
12-
get enhancedHostSupport(): boolean;
13-
get resources(): string[];
14-
get serverVersion(): string;
15-
get publicVariables(): import("../types").CfxCitizenServerDataPublicVariables;
16-
get playersCountFromServerReport(): number;
17-
get ownerId(): number;
18-
get private(): boolean;
19-
get fallback(): boolean;
20-
get connectedEndpoints(): string[];
21-
get upvotePower(): number;
22-
get burstPower(): number;
23-
get supported(): string;
24-
get ownerName(): string;
25-
get ownerProfileUrl(): string;
26-
get ownerAvatarUrl(): string;
27-
get lastSeenDate(): string;
28-
get iconVersion(): number;
29-
get isOneSyncEnabled(): boolean;
30-
get elementClub(): string;
31-
get tags(): string[];
32-
get projectName(): string;
33-
get projectDesc(): string;
34-
get isFull(): boolean;
35-
hasResource(resource: string): boolean;
36-
hasAnyResourceStartingWith(resource: string): boolean;
37-
hasTag(tag: string): boolean;
38-
isPlayerOnline(name: string): boolean;
39-
}
1+
import { CfxCitizenServerData, CfxCitizenServerDataData } from "../types";
2+
export default class CitizenServer {
3+
id: string;
4+
data: CfxCitizenServerDataData;
5+
constructor(data: CfxCitizenServerData);
6+
get playersCount(): number;
7+
get players(): import("../types").CfxCitizenPlayerPayload[];
8+
get gameType(): string;
9+
get hostname(): string;
10+
get mapName(): string;
11+
get maxPlayers(): number;
12+
get enhancedHostSupport(): boolean;
13+
get resources(): string[];
14+
get serverVersion(): string;
15+
get publicVariables(): import("../types").CfxCitizenServerDataPublicVariables;
16+
get playersCountFromServerReport(): number;
17+
get ownerId(): number;
18+
get private(): boolean;
19+
get fallback(): boolean;
20+
get connectedEndpoints(): string[];
21+
get upvotePower(): number;
22+
get burstPower(): number;
23+
get supported(): string;
24+
get ownerName(): string;
25+
get ownerProfileUrl(): string;
26+
get ownerAvatarUrl(): string;
27+
get lastSeenDate(): string;
28+
get iconVersion(): number;
29+
get isOneSyncEnabled(): boolean;
30+
get elementClub(): string;
31+
get tags(): string[];
32+
get projectName(): string;
33+
get projectDesc(): string;
34+
get isFull(): boolean;
35+
hasResource(resource: string): boolean;
36+
hasAnyResourceStartingWith(resource: string): boolean;
37+
hasTag(tag: string): boolean;
38+
isPlayerOnline(name: string): boolean;
39+
}

0 commit comments

Comments
 (0)