@armoury/fivem-framework-server 0.0.0-stage → 1.0.7

package/dist/esm/server/services/server-resource-database.service.js

@@ -0,0 +1,239 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable, Optional } from "injection-js";
+import { Subject } from "rxjs";
+import { EventListener, Export, isJSON } from '@armoury/fivem-framework-common';
+let ServerResourceDatabase = class ServerResourceDatabase {
+    get onBoundEntityDestroyed$() {
+        return this._onBoundEntityDestroyed$.asObservable();
+    }
+    get onSync$() {
+        return this._onSync$.asObservable();
+    }
+    get entities() {
+        return this._entities;
+    }
+    get cachedProperties() {
+        return this._cachedProperties;
+    }
+    get playerToEntityBindings() {
+        return this._playerToEntityBindings;
+    }
+    constructor(_tableName, _loadAllAtStart) {
+        this._tableName = _tableName;
+        this._loadAllAtStart = _loadAllAtStart;
+        this._onBoundEntityDestroyed$ = new Subject();
+        this._onSync$ = new Subject();
+        this._entities = [];
+        this._cachedProperties = [];
+        this._playerToEntityBindings = new Map();
+        this.computeTableProperties();
+        if (this._loadAllAtStart) {
+            this.loadDBEntities();
+        }
+        this.onSync$.subscribe((data) => {
+            var _a;
+            // TODO: Probable performance issue cause. Entity updates should be sent to clients only for a specific property, so they don't need to wipe ALL data and rewrite it back.
+            Cfx.Server.TriggerClientEvent(`${Cfx.Server.GetCurrentResourceName()}:db-send-entities`, (_a = data === null || data === void 0 ? void 0 : data.player) !== null && _a !== void 0 ? _a : -1, this.entities);
+        });
+    }
+    create(entity, forceId) {
+        return (async () => {
+            try {
+                let entityProperties = this.getEntityProperties(entity);
+                let entityValues = this.getEntityPropertiesValues(entity, entityProperties);
+                if (forceId) {
+                    entityProperties = ['id', ...entityProperties];
+                    entityValues = [forceId.toString(), ...entityValues];
+                }
+                const id = await Cfx.exports['oxmysql'].insert_async(`INSERT INTO \`${this._tableName}\` (${entityProperties.join(', ')}) VALUES (${Array(entityProperties.length).fill('?').join(', ')})`, entityValues);
+                const createdEntity = Object.assign(Object.assign({}, entity), { id: forceId || id });
+                this._entities.push(createdEntity);
+                this._onSync$.next();
+                return createdEntity;
+            }
+            catch (error) {
+                console.log(error);
+                return null;
+            }
+        })();
+    }
+    remove(entity) {
+        return (async () => {
+            try {
+                const result = await Cfx.exports['oxmysql'].query_async(`DELETE FROM \`${this._tableName}\` WHERE id = ?`, [entity.id]);
+                this._entities = this._entities.filter((_entity) => _entity.id !== entity.id);
+                this._onSync$.next();
+                return !!result;
+            }
+            catch (error) {
+                console.log(error);
+                return false;
+            }
+        })();
+    }
+    saveAsync(id) {
+        return (async () => {
+            try {
+                const entity = this.getEntityByDBId(id);
+                if (!entity)
+                    return false;
+                const updateKeys = this.getEntityProperties(entity);
+                const updateValues = this.getEntityPropertiesValues(entity, updateKeys);
+                const concatString = ' = ?, ';
+                const result = await Cfx.exports['oxmysql'].update_async(`UPDATE \`${this._tableName}\` SET ${updateKeys.join(concatString).concat(concatString).slice(0, -2)} WHERE id = ?`, [...updateValues, entity.id]);
+                if (result) {
+                    this._onSync$.next();
+                }
+                return result > 0;
+            }
+            catch (error) {
+                console.log(error);
+                return false;
+            }
+        })();
+    }
+    async loadDBEntityFor(value, key = 'id', bindTo) {
+        const result = (await Cfx.exports['oxmysql'].query_async(`SELECT * FROM \`${this._tableName}\` WHERE ${key} = ?`, [value])).map((resultItem) => {
+            Object.keys(resultItem).forEach((property) => {
+                resultItem[property] = JSON.parse(isJSON(resultItem[property].toString()) ? resultItem[property] : `"${resultItem[property]}"`, function (_k, v) {
+                    return (typeof v === "object" || isNaN(v)) ? v : Number(v);
+                });
+            });
+            return resultItem;
+        });
+        if (result === null || result === void 0 ? void 0 : result.length) {
+            result.forEach((entity) => {
+                this._entities.push(entity);
+                if (bindTo) {
+                    this.bindEntityToPlayerByEntityId(entity.id, bindTo);
+                }
+            });
+            setTimeout(() => { this._onSync$.next(); }, 2000);
+            return ((result === null || result === void 0 ? void 0 : result.length) > 1 ? result : result[0]);
+        }
+        return null;
+    }
+    async loadDBEntities() {
+        const result = (await Cfx.exports['oxmysql'].query_async(`SELECT * FROM \`${this._tableName}\``, [])).map((resultItem) => {
+            Object.keys(resultItem).forEach((property) => {
+                resultItem[property] = JSON.parse(isJSON(resultItem[property].toString()) ? resultItem[property] : `"${resultItem[property]}"`, function (_k, v) {
+                    return (typeof v === "object" || isNaN(v)) ? v : Number(v);
+                });
+            });
+            return resultItem;
+        });
+        if (result === null || result === void 0 ? void 0 : result.length) {
+            this._entities = result;
+            setTimeout(() => { this._onSync$.next(); }, 2000);
+        }
+        return this._entities;
+    }
+    getEntityProperties(entity) {
+        const keys = [];
+        for (let key in entity) {
+            if (key !== 'id' && (!this._cachedProperties.length || this._cachedProperties.includes(key))) {
+                keys.push(key);
+            }
+        }
+        return keys;
+    }
+    getEntityPropertiesValues(entity, properties) {
+        return properties.map((key) => {
+            if (Array.isArray(entity[key]) || typeof (entity[key]) === 'object') {
+                return JSON.stringify(entity[key]);
+            }
+            return entity[key].toString();
+        });
+    }
+    bindEntityToPlayer(entity, playerId) {
+        if (this.entities.includes(entity)) {
+            this.bindEntityToPlayerByEntityId(entity.id, playerId);
+        }
+    }
+    bindEntityToPlayerByEntityId(id, playerId) {
+        const entityExists = this._entities.some((entity) => entity.id === id);
+        if (entityExists) {
+            if (this._playerToEntityBindings.has(playerId)) {
+                this._playerToEntityBindings.set(playerId, [...this._playerToEntityBindings.get(playerId), id]);
+            }
+            else {
+                this._playerToEntityBindings.set(playerId, [id]);
+            }
+        }
+    }
+    onPlayerAuthenticate(playerId, _player) {
+        console.log('a player has authenticated!');
+        if (this._entities.length) {
+            this._onSync$.next({ player: playerId });
+        }
+    }
+    onPlayerDisconnect() {
+        if (this._playerToEntityBindings.has(Cfx.source)) {
+            const bindings = (this._playerToEntityBindings.has(Cfx.source)
+                ? this._playerToEntityBindings.get(Cfx.source)
+                : []);
+            bindings.forEach((entityId) => {
+                const entityBoundToPlayer = this._entities.find((entity) => entity.id === entityId);
+                if (entityBoundToPlayer) {
+                    this._onBoundEntityDestroyed$.next({ entity: entityBoundToPlayer, boundPlayer: Cfx.source });
+                    this._entities.splice(this._entities.indexOf(entityBoundToPlayer), 1);
+                }
+            });
+            this._playerToEntityBindings.delete(Cfx.source);
+        }
+    }
+    async computeTableProperties() {
+        const result = await Cfx.exports['oxmysql'].query_async(`DESCRIBE ${this._tableName}`, []);
+        if (result) {
+            result.forEach((sqlStructureObject) => {
+                this._cachedProperties.push(sqlStructureObject.Field);
+            });
+        }
+        else {
+            console.error(`[SQL ERROR:] computeTableProperties for ${Cfx.Server.GetCurrentResourceName()} did not work.`);
+        }
+    }
+    getEntityByDBId(id) {
+        return this._entities.find((_entity) => _entity.id === id);
+    }
+    getEntities() {
+        return this._entities;
+    }
+};
+__decorate([
+    EventListener(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", void 0)
+], ServerResourceDatabase.prototype, "onPlayerAuthenticate", null);
+__decorate([
+    EventListener(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ServerResourceDatabase.prototype, "onPlayerDisconnect", null);
+__decorate([
+    Export(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], ServerResourceDatabase.prototype, "getEntities", null);
+ServerResourceDatabase = __decorate([
+    Injectable(),
+    __param(0, Inject('tableName')),
+    __param(1, Optional()),
+    __param(1, Inject('loadEverythingAtStart')),
+    __metadata("design:paramtypes", [String, Boolean])
+], ServerResourceDatabase);
+export { ServerResourceDatabase };

package/dist/esm/server/services/server-translate.service.js

@@ -0,0 +1,51 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from "injection-js";
+import { EventListener } from '@armoury/fivem-framework-common';
+let ServerTranslateService = class ServerTranslateService {
+    constructor(_translations) {
+        this._translations = _translations;
+        this.playersMappedToLanguages = new Map();
+    }
+    instant(forPlayer, key) {
+        var _a;
+        const language = this.getLanguage(forPlayer);
+        return ((_a = this._translations[language]) === null || _a === void 0 ? void 0 : _a[key]) || key;
+    }
+    onPlayerDisconnect() {
+        const player = Cfx.source;
+        if (this.playersMappedToLanguages.has(player)) {
+            this.playersMappedToLanguages.delete(player);
+        }
+    }
+    getLanguage(forPlayer) {
+        if (this.playersMappedToLanguages.has(forPlayer)) {
+            return this.playersMappedToLanguages.get(forPlayer);
+        }
+        const language = Cfx.exports['authentication'].getPlayerInfo(forPlayer, 'language');
+        this.playersMappedToLanguages.set(forPlayer, language);
+        return language;
+    }
+};
+__decorate([
+    EventListener(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ServerTranslateService.prototype, "onPlayerDisconnect", null);
+ServerTranslateService = __decorate([
+    Injectable(),
+    __param(0, Inject('translations')),
+    __metadata("design:paramtypes", [Object])
+], ServerTranslateService);
+export { ServerTranslateService };

package/dist/esm/server/services/server-virtual-worlds.service.js

@@ -0,0 +1,59 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from "injection-js";
+import { EventListener } from '@armoury/fivem-framework-common';
+import { ServerSessionService } from "./session";
+let ServerVirtualWorldsService = class ServerVirtualWorldsService {
+    constructor(_session) {
+        this._session = _session;
+        // Probable performance issue? Maybe calling the export so many times when changing the virtual world is too costly?
+        this._virtualWorldsWithPlayers = new Map();
+    }
+    /** This only counts virtual worlds related to the resource! If another resource changes the virtual world of the player, this resource won't know it! */
+    get virtualWorldsWithPlayers() {
+        return this._virtualWorldsWithPlayers;
+    }
+    onPlayerEnteredScope(data) {
+        Cfx.Server.TriggerClientEvent(`${Cfx.Server.GetCurrentResourceName()}:refresh-virtual-world`, data.for);
+    }
+    setPlayerVirtualWorld(playerId, virtualWorld) {
+        const currentPlayerVirtualWorld = this.getPlayerVirtualWorld(playerId);
+        if (!isNaN(currentPlayerVirtualWorld)) {
+            this._virtualWorldsWithPlayers.set(currentPlayerVirtualWorld, (this._virtualWorldsWithPlayers.has(currentPlayerVirtualWorld) ? this._virtualWorldsWithPlayers.get(currentPlayerVirtualWorld) : []).filter((_playerId) => _playerId !== playerId));
+        }
+        const newPlayersInVirtualWorld = [
+            ...(this._virtualWorldsWithPlayers.has(virtualWorld) ? this._virtualWorldsWithPlayers.get(virtualWorld) : []),
+            playerId
+        ];
+        this._virtualWorldsWithPlayers.set(virtualWorld, newPlayersInVirtualWorld);
+        this._session.setPlayerInfo(playerId, 'virtualWorld', virtualWorld);
+    }
+    getPlayerVirtualWorld(playerId) {
+        return Math.max(0, this._session.getPlayerInfo(playerId, 'virtualWorld'));
+    }
+    removeClientsideVehicles() {
+        Cfx.Server.TriggerClientEvent(`${Cfx.Server.GetCurrentResourceName()}:ARM_remove-vehicles`, -1);
+    }
+};
+__decorate([
+    EventListener({ eventName: 'playerEnteredScope' }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ServerVirtualWorldsService.prototype, "onPlayerEnteredScope", null);
+ServerVirtualWorldsService = __decorate([
+    Injectable(),
+    __param(0, Inject(ServerSessionService)),
+    __metadata("design:paramtypes", [ServerSessionService])
+], ServerVirtualWorldsService);
+export { ServerVirtualWorldsService };

package/dist/esm/server/services/session/default-entities/character.entity.js

@@ -0,0 +1,28 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Entity, PrimaryKey, Property } from '@mikro-orm/core';
+let Character = class Character {
+};
+__decorate([
+    PrimaryKey(),
+    __metadata("design:type", typeof BigInt === "function" ? BigInt : Object)
+], Character.prototype, "id", void 0);
+__decorate([
+    Property(),
+    __metadata("design:type", typeof BigInt === "function" ? BigInt : Object)
+], Character.prototype, "accountId", void 0);
+__decorate([
+    Property(),
+    __metadata("design:type", String)
+], Character.prototype, "name", void 0);
+Character = __decorate([
+    Entity()
+], Character);
+export { Character };

package/dist/esm/server/services/session/default-entities/index.js

@@ -0,0 +1,8 @@
+export * from './character.entity';
+export * from './session-account-id';
+export * from './session-cash';
+export * from './session-hours-played';
+export * from './session-language';
+export * from './session-last-location';
+export * from './session-name';
+export * from './session-id';

package/dist/esm/server/services/session/default-entities/session-account-id.js

@@ -0,0 +1,6 @@
+import { SessionItem } from "../../../models";
+export class SessionAccountId extends SessionItem {
+    constructor() {
+        super('accountId', 0);
+    }
+}

package/dist/esm/server/services/session/default-entities/session-cash.js

@@ -0,0 +1,6 @@
+import { SessionItem } from "../../../models";
+export class SessionCash extends SessionItem {
+    constructor() {
+        super('cash', 0, true);
+    }
+}

package/dist/esm/server/services/session/default-entities/session-hours-played.js

@@ -0,0 +1,12 @@
+import { SessionItem } from "../../../models";
+export class SessionHoursPlayed extends SessionItem {
+    constructor() {
+        super('hoursPlayed', 0, true);
+    }
+    compute(playerId, originalValue) {
+        const lastUpdate = Cfx.Server.GetConvarInt(`${playerId}_PI_hoursPlayed_lastUpdate`, new Date().getTime());
+        return Number(originalValue) + Math.floor((Math.abs(lastUpdate - new Date().getTime()) /
+            (1000 * 60)) %
+            60) * 0.017;
+    }
+}

package/dist/esm/server/services/session/default-entities/session-id.js

@@ -0,0 +1,6 @@
+import { SessionItem } from "../../../models";
+export class SessionId extends SessionItem {
+    constructor() {
+        super('id', 0);
+    }
+}

package/dist/esm/server/services/session/default-entities/session-language.js

@@ -0,0 +1,6 @@
+import { SessionItem } from "../../../models";
+export class SessionLanguage extends SessionItem {
+    constructor() {
+        super('language', 'en');
+    }
+}

package/dist/esm/server/services/session/default-entities/session-last-location.js

@@ -0,0 +1,15 @@
+import { SessionItem } from "../../../models";
+export class SessionLastLocation extends SessionItem {
+    constructor() {
+        super('lastLocation', [], true);
+    }
+    compute(playerId, originalValue) {
+        return [
+            ...Cfx.Server.GetEntityCoords(Cfx.Server.GetPlayerPed(playerId.toString())).slice(0, 4),
+            originalValue[4] || 0
+        ];
+    }
+    async load(_accountId, _characterId, bruteValue) {
+        return JSON.parse(bruteValue);
+    }
+}

package/dist/esm/server/services/session/default-entities/session-name.js

@@ -0,0 +1,6 @@
+import { SessionItem } from "../../../models";
+export class SessionName extends SessionItem {
+    constructor() {
+        super('name', '');
+    }
+}

package/dist/esm/server/services/session/index.js

@@ -0,0 +1 @@
+export * from './server-session.service';