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

package/dist/cjs/server/server-db-dependent.controller.js

@@ -0,0 +1,227 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerDBDependentController = void 0;
+// TODO: Remove
+const server_controller_1 = require("./server.controller");
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+let ServerDBDependentController = class ServerDBDependentController extends server_controller_1.ServerController {
+    get entities() {
+        return this._entities;
+    }
+    get cachedProperties() {
+        return this._cachedProperties;
+    }
+    get playerToEntityBindings() {
+        return this._playerToEntityBindings;
+    }
+    constructor(dbTableName, loadAllAtStart = false) {
+        super();
+        this.dbTableName = dbTableName;
+        this._entities = [];
+        this._cachedProperties = [];
+        this._playerToEntityBindings = new Map();
+        this.computeTableProperties();
+        if (loadAllAtStart) {
+            this.loadDBEntities();
+        }
+    }
+    getEntities() {
+        return this._entities;
+    }
+    createEntity(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.dbTableName}\` (${entityProperties.join(', ')}) VALUES (${Array(entityProperties.length).fill('?').join(', ')})`, entityValues);
+                const createdEntity = Object.assign(Object.assign({}, entity), { id: forceId || id });
+                this._entities.push(createdEntity);
+                this.syncWithClients();
+                return createdEntity;
+            }
+            catch (error) {
+                console.log(error);
+                return null;
+            }
+        })();
+    }
+    removeEntity(entity) {
+        return (async () => {
+            try {
+                const result = await Cfx.exports['oxmysql'].query_async(`DELETE FROM \`${this.dbTableName}\` WHERE id = ?`, [entity.id]);
+                this._entities = this._entities.filter((_entity) => _entity.id !== entity.id);
+                this.syncWithClients();
+                return !!result;
+            }
+            catch (error) {
+                console.log(error);
+                return false;
+            }
+        })();
+    }
+    saveDBEntityAsync(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.dbTableName}\` SET ${updateKeys.join(concatString).concat(concatString).slice(0, -2)} WHERE id = ?`, [...updateValues, entity.id]);
+                if (result) {
+                    this.syncWithClients();
+                }
+                return result > 0;
+            }
+            catch (error) {
+                console.log(error);
+                return false;
+            }
+        })();
+    }
+    getEntityByDBId(id) {
+        return this._entities.find((_entity) => _entity.id === id);
+    }
+    async loadDBEntityFor(value, key = 'id', bindTo) {
+        const result = (await Cfx.exports['oxmysql'].query_async(`SELECT * FROM \`${this.dbTableName}\` WHERE ${key} = ?`, [value])).map((resultItem) => {
+            Object.keys(resultItem).forEach((property) => {
+                resultItem[property] = JSON.parse((0, fivem_framework_common_1.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.syncWithClients(); }, 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.dbTableName}\``, [])).map((resultItem) => {
+            Object.keys(resultItem).forEach((property) => {
+                resultItem[property] = JSON.parse((0, fivem_framework_common_1.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.syncWithClients(); }, 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();
+        });
+    }
+    syncWithClients(client) {
+        // 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`, client || -1, this.entities);
+    }
+    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]);
+            }
+        }
+    }
+    onBoundEntityDestroyed(_entity, _boundPlayer) { }
+    onPlayerAuthenticate(playerId, _player) {
+        if (this._entities.length) {
+            this.syncWithClients(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(entityBoundToPlayer, 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.dbTableName}`, []);
+        if (result) {
+            result.forEach((sqlStructureObject) => {
+                this._cachedProperties.push(sqlStructureObject.Field);
+            });
+        }
+        else {
+            console.error(`[SQL ERROR:] computeTableProperties for ${Cfx.Server.GetCurrentResourceName()} did not work.`);
+        }
+    }
+};
+exports.ServerDBDependentController = ServerDBDependentController;
+__decorate([
+    (0, fivem_framework_common_1.Export)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], ServerDBDependentController.prototype, "getEntities", null);
+__decorate([
+    (0, fivem_framework_common_1.EventListener)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", void 0)
+], ServerDBDependentController.prototype, "onPlayerAuthenticate", null);
+__decorate([
+    (0, fivem_framework_common_1.EventListener)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ServerDBDependentController.prototype, "onPlayerDisconnect", null);
+exports.ServerDBDependentController = ServerDBDependentController = __decorate([
+    (0, fivem_framework_common_1.Controller)(),
+    __metadata("design:paramtypes", [String, Boolean])
+], ServerDBDependentController);

package/dist/cjs/server/server.base.js

@@ -0,0 +1,32 @@
+"use strict";
+// TODO: Remove
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerBase = void 0;
+class ServerBase {
+    constructor() {
+        this.routingBucketCondition = (source, routingBucket) => true;
+        this.assignServerBaseListeners();
+    }
+    // TODO: Remove this. We have created a brand new cool decorator for this
+    RegisterAdminCommand(commandName, adminLevelRequired, handlerFunction, restricted) {
+        Cfx.Server.RegisterCommand(commandName, (source, args, _raw) => {
+            if (Number(Cfx.exports['authentication'].getPlayerInfo(source, 'adminLevel')) < adminLevelRequired) {
+                // TODO: Add error chat message OR some kind of visual notice here
+                return;
+            }
+            handlerFunction(source, args, _raw);
+        }, restricted);
+    }
+    assignServerBaseListeners() {
+        Cfx.Server.onNet(`${Cfx.Server.GetCurrentResourceName()}:set-client-routing-bucket`, (source, routingBucket) => {
+            if (this.routingBucketCondition(source, routingBucket)) {
+                Cfx.Server.SetEntityRoutingBucket(source, routingBucket);
+            }
+        });
+    }
+    setRoutingBucket(playerId, routingBucket) {
+        Cfx.Server.SetEntityRoutingBucket(Cfx.Server.GetPlayerPed(playerId.toString()), routingBucket);
+        Cfx.Server.TriggerClientEvent(`${Cfx.Server.GetCurrentResourceName()}:set-routing-bucket`, playerId, routingBucket);
+    }
+}
+exports.ServerBase = ServerBase;

package/dist/cjs/server/server.controller.js

@@ -0,0 +1,83 @@
+"use strict";
+// TODO: Remove
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerController = void 0;
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+const server_entities_1 = require("./server.entities");
+let ServerController = class ServerController extends server_entities_1.ServerEntities {
+    constructor() {
+        super(...arguments);
+        this._translationLanguage = 'en';
+        this._clientsidedResourceMap = new Map();
+    }
+    get translationLanguage() {
+        return this._translationLanguage;
+    }
+    get clientsidedResourceMap() {
+        return this._clientsidedResourceMap;
+    }
+    getPlayerClientsidedCacheKey(playerId, key) {
+        if (this._clientsidedResourceMap.has(playerId)) {
+            const metadataObject = this._clientsidedResourceMap.get(playerId);
+            if (metadataObject[key]) {
+                return metadataObject[key];
+            }
+        }
+        return null;
+    }
+    updatePlayerClientsidedCacheKey(playerId, key, value) {
+        const currentPlayerClientsidedResourceMapValue = this._clientsidedResourceMap.has(playerId)
+            ? this._clientsidedResourceMap.get(playerId) || {}
+            : {};
+        currentPlayerClientsidedResourceMapValue[key] = value;
+        this._clientsidedResourceMap.set(playerId, currentPlayerClientsidedResourceMapValue);
+        Cfx.Server.TriggerClientEvent('armoury-overlay:update-resource-metadata', playerId, Cfx.Server.GetCurrentResourceName(), key, value);
+    }
+    onPlayerClientsidedCacheLoaded(metadataObject) {
+        if (metadataObject[Cfx.Server.GetCurrentResourceName()]) {
+            this._clientsidedResourceMap.set(Cfx.source, metadataObject[Cfx.Server.GetCurrentResourceName()]);
+        }
+    }
+    onPlayerDisconnect() {
+        if (this._clientsidedResourceMap.has(Cfx.source)) {
+            this._clientsidedResourceMap.delete(Cfx.source);
+        }
+    }
+    translate(key, params) {
+        let content = this.translationFile[this._translationLanguage][key];
+        if (params) {
+            Object.keys(params).forEach((param) => {
+                content = content.replace(`{${param}}`, params[param]);
+            });
+        }
+        return content;
+    }
+    setTranslationLanguage(language) {
+        this._translationLanguage = language;
+    }
+};
+exports.ServerController = ServerController;
+__decorate([
+    (0, fivem_framework_common_1.EventListener)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ServerController.prototype, "onPlayerClientsidedCacheLoaded", null);
+__decorate([
+    (0, fivem_framework_common_1.EventListener)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ServerController.prototype, "onPlayerDisconnect", null);
+exports.ServerController = ServerController = __decorate([
+    (0, fivem_framework_common_1.Controller)()
+], ServerController);

package/dist/cjs/server/server.entities.js

@@ -0,0 +1,57 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerEntities = void 0;
+// TODO: Remove
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+const server_base_1 = require("./server.base");
+let ServerEntities = class ServerEntities extends server_base_1.ServerBase {
+    constructor() {
+        super(...arguments);
+        // 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);
+        Cfx.exports['authentication'].setPlayerInfo(playerId, 'virtualWorld', virtualWorld);
+    }
+    getPlayerVirtualWorld(playerId) {
+        return Math.max(0, Number(Cfx.exports['authentication'].getPlayerInfo(playerId, 'virtualWorld')));
+    }
+    removeClientsideVehicles() {
+        Cfx.Server.TriggerClientEvent(`${Cfx.Server.GetCurrentResourceName()}:ARM_remove-vehicles`, -1);
+    }
+};
+exports.ServerEntities = ServerEntities;
+__decorate([
+    (0, fivem_framework_common_1.EventListener)({ eventName: 'playerEnteredScope' }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], ServerEntities.prototype, "onPlayerEnteredScope", null);
+exports.ServerEntities = ServerEntities = __decorate([
+    (0, fivem_framework_common_1.Controller)()
+], ServerEntities);

package/dist/cjs/server/services/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./server-resource-database.service"), exports);
+__exportStar(require("./server-enterable-database.service"), exports);
+__exportStar(require("./server-virtual-worlds.service"), exports);
+__exportStar(require("./server-translate.service"), exports);
+__exportStar(require("./session"), exports);

package/dist/cjs/server/services/server-enterable-database.service.js

@@ -0,0 +1,37 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerEnterableDatabase = void 0;
+const injection_js_1 = require("injection-js");
+const server_resource_database_service_1 = require("./server-resource-database.service");
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+let ServerEnterableDatabase = class ServerEnterableDatabase extends server_resource_database_service_1.ServerResourceDatabase {
+    getClosestToPlayer(player) {
+        return this.getClosestExitToPlayer(player) || this.getClosestEntranceToPlayer(player);
+    }
+    getClosestEntranceToPlayer(source) {
+        // TODO: Replace here to actually get the closest, not the first one in the range
+        const playerPosition = Cfx.Server.GetEntityCoords(Cfx.Server.GetPlayerPed(source.toString()));
+        const entity = this.entities.find((_entity) => (0, fivem_framework_common_1.isPlayerInRangeOfPoint)(playerPosition[0], playerPosition[1], playerPosition[2], _entity.entranceX, _entity.entranceY, _entity.entranceZ, 3.0));
+        return entity || null;
+    }
+    getClosestExitToPlayer(source) {
+        const virtualWorld = Math.max(0, Number(Cfx.exports['authentication'].getPlayerInfo(source, 'virtualWorld')));
+        const entity = this.getEntityByDBId(virtualWorld);
+        const playerPosition = Cfx.Server.GetEntityCoords(Cfx.Server.GetPlayerPed(source.toString()));
+        // TODO: Replace here to actually get the closest, not the first one in the range
+        if (entity && (0, fivem_framework_common_1.isPlayerInRangeOfPoint)(playerPosition[0], playerPosition[1], playerPosition[2], entity.exitX, entity.exitY, entity.exitZ, 3.0)) {
+            return entity;
+        }
+        return null;
+    }
+};
+exports.ServerEnterableDatabase = ServerEnterableDatabase;
+exports.ServerEnterableDatabase = ServerEnterableDatabase = __decorate([
+    (0, injection_js_1.Injectable)()
+], ServerEnterableDatabase);