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

package/dist/types/decorators/command.decorator.d.ts

@@ -0,0 +1,5 @@
+export declare function Command(data?: {
+    adminLevelRequired?: number;
+    suffix?: string;
+}): (target: any, propertyKey: string) => void;
+export declare function Commands(target: any, _prototype: any, providers?: Object[]): void;

package/dist/types/decorators/controller.decorator.d.ts

@@ -0,0 +1 @@
+export declare function Controller(data?: any): (target: any) => void;

package/dist/types/decorators/decorator.utils.d.ts

@@ -0,0 +1,15 @@
+import { Provider } from "injection-js";
+export declare class DecoratorUtils {
+    static map(target: any, _prototype: any, providers: Object[]): {
+        key: any;
+        target: any;
+        value: any;
+    }[];
+}
+export declare function Decorate<T extends {
+    new (...args: any[]): any;
+} & Provider>(instance: T, _prototype: any, providers: Provider[], decorationType?: DecorationType): void;
+export declare enum DecorationType {
+    SERVER = 0,
+    CLIENT = 1
+}

package/dist/types/decorators/event-listener.decorator.d.ts

@@ -0,0 +1,15 @@
+export declare function EventListener(data?: {
+    eventName?: string;
+    direction?: EVENT_DIRECTIONS;
+    type?: 'ui' | 'default';
+}): (target: any, propertyKey: string) => void;
+export declare function EventListeners(target: any, _prototype: any, providers?: Object[]): void;
+export declare enum EVENT_DIRECTIONS {
+    SERVER_TO_SERVER = 0,
+    SERVER_TO_CLIENT = 1,
+    CLIENT_TO_SERVER = 2,
+    CLIENT_TO_CLIENT = 3
+}
+export declare const DEFAULT_EVENTS: {
+    [key: string]: string;
+};

package/dist/types/decorators/export.decorator.d.ts

@@ -0,0 +1,2 @@
+export declare function Export(): (target: any, propertyKey: string) => void;
+export declare function Exports(target: any, _prototype: any, providers?: Object[]): void;

package/dist/types/decorators/index.d.ts

@@ -0,0 +1,6 @@
+export { Command } from './command.decorator';
+export { Controller } from './controller.decorator';
+export { EventListener, EVENT_DIRECTIONS } from './event-listener.decorator';
+export { Export } from './export.decorator';
+export { KeyBinding } from './key-binding.decorator';
+export { UIListener } from './ui-listener.decorator';

package/dist/types/decorators/key-binding.decorator.d.ts

@@ -0,0 +1,8 @@
+export declare function KeyBinding(data: {
+    command?: string;
+    description: string;
+    defaultMapper: KeyBindingType;
+    key: string;
+}): (target: any, propertyKey: string) => void;
+export declare function KeyBindings(target: any, _prototype: any, providers?: Object[]): void;
+export type KeyBindingType = 'digitalbutton_axis' | 'game_controlled' | 'joystick_axis' | 'joystick_axis_negative' | 'joystick_axis_positive' | 'joystick_button' | 'joystick_iaxis' | 'joystick_pov' | 'joystick_pov_axis' | 'keyboard' | 'mkb_axis' | 'mouse_absoluteaxis' | 'mouse_button' | 'mouse_buttonany' | 'mouse_centeredaxis' | 'mouse_relativeaxis' | 'mouse_scaledaxis' | 'mouse_normalized' | 'mouse_wheel' | 'pad_analogbutton' | 'pad_axis' | 'pad_debugbutton' | 'pad_digitalbutton' | 'pad_digitalbuttonany' | 'touchpad_absolute_axis' | 'touchpad_centered_axis';

package/dist/types/decorators/ui-listener.decorator.d.ts

@@ -0,0 +1,4 @@
+export declare function UIListener(data?: {
+    eventName?: string;
+}): (target: any, propertyKey: string) => void;
+export declare function UIListeners(target: any, _prototype: any, providers?: Object[]): void;

package/dist/types/server/entity-controllers/server-entity-entrance.controller.d.ts

@@ -0,0 +1,14 @@
+import { ServerDBDependentController } from '../server-db-dependent.controller';
+export declare class ServerEntityWithEntranceController<T extends {
+    id: number;
+    entranceX: number;
+    entranceY: number;
+    entranceZ: number;
+    exitX: number;
+    exitY: number;
+    exitZ: number;
+}> extends ServerDBDependentController<T> {
+    protected getClosestEntityOfSameTypeToPlayer(player: number): T | null;
+    protected getClosestEntityOfSameTypeEntranceToPlayer(source: number): T | null;
+    protected getClosestEntityOfSameTypeExitToPlayer(source: number): T | null;
+}

package/dist/types/server/index.d.ts

@@ -0,0 +1,23 @@
+/// <reference path="../ambient.declarations.d.ts" />
+import 'reflect-metadata';
+import { Provider } from 'injection-js';
+import { SessionId, SessionLastLocation, SessionName } from './services/session/default-entities';
+export declare const SERVER_PROVIDERS: ({
+    provide: string;
+    useValue: SessionId;
+    multi: boolean;
+} | {
+    provide: string;
+    useValue: SessionName;
+    multi: boolean;
+} | {
+    provide: string;
+    useValue: SessionLastLocation;
+    multi: boolean;
+})[];
+export declare function Server_Init<T extends {
+    new (...args: any[]): any;
+} & Provider>(_class: T, ...providers: Provider[]): Promise<T>;
+export * from './services';
+export * from './models';
+export * from '@armoury/fivem-framework-common';

package/dist/types/server/models/create-vehicle.enums.d.ts

@@ -0,0 +1,3 @@
+export declare enum CREATE_VEHICLE_EVENT_TYPE {
+    ATTACH_TRAILER = 0
+}

package/dist/types/server/models/index.d.ts

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

package/dist/types/server/models/session/base-items/array.session-item.d.ts

@@ -0,0 +1,13 @@
+import { ISessionItem, SessionItem } from "../session-item.model";
+export declare abstract class ArraySessionItem<T> extends SessionItem<Array<T>> implements ISessionItem<Array<T>> {
+    readonly tableName: string;
+    readonly syncedProperties: ISqlProperty[];
+    constructor(name: string, value: Array<T>, critical: boolean | undefined, tableName: string, syncedProperties: ISqlProperty[]);
+    load(accountId: number, characterId: number): Promise<Array<T>>;
+    save(accountId: number, characterId: number, value: Array<T>): Promise<void>;
+    private setup;
+}
+export interface ISqlProperty {
+    name: string;
+    type: string;
+}

package/dist/types/server/models/session/base-items/index.d.ts

@@ -0,0 +1 @@
+export * from './array.session-item';

package/dist/types/server/models/session/index.d.ts

@@ -0,0 +1,3 @@
+export * from './base-items';
+export * from './session-item.model';
+export * from './session.model';

package/dist/types/server/models/session/session-item.model.d.ts

@@ -0,0 +1,22 @@
+export declare abstract class SessionItem<T> implements ISessionItem<T> {
+    readonly name: string;
+    readonly defaultValue: T;
+    readonly critical: boolean;
+    constructor(name: string, defaultValue: T, critical?: boolean);
+    load(_accountId: number, _characterId: number, bruteValue: any): Promise<T>;
+    compute(_playerId: number, originalValue: T): T;
+}
+export interface ISessionItem<T> extends ISessionItemBase {
+    defaultValue: T;
+    compute(playerId: number, originalValue: T): T;
+    load(accountId: number, characterId: number, bruteValue: any): Promise<T>;
+    save?(accountId: number, characterId: number, value: T): Promise<void>;
+}
+export interface ISessionItemBase {
+    name: string;
+    defaultValue: any;
+    critical?: boolean;
+    compute(playerId: number, originalValue: any): any;
+    load(accountId: number, characterId: number, bruteValue: any): any;
+    save?(accountId: number, characterId: number, value: any): Promise<void>;
+}

package/dist/types/server/models/session/session.model.d.ts

@@ -0,0 +1,4 @@
+import { ICharacter } from "../../../shared";
+export interface ISession extends Partial<ICharacter> {
+    [key: string]: any;
+}

package/dist/types/server/server-db-dependent.controller.d.ts

@@ -0,0 +1,29 @@
+import { ServerController } from "./server.controller";
+export declare class ServerDBDependentController<T extends {
+    id: number;
+}> extends ServerController {
+    protected dbTableName: string;
+    private _entities;
+    protected get entities(): T[];
+    private _cachedProperties;
+    protected get cachedProperties(): string[];
+    private _playerToEntityBindings;
+    protected get playerToEntityBindings(): Map<number, (number | string)[]>;
+    constructor(dbTableName: string, loadAllAtStart?: boolean);
+    protected getEntities(): T[];
+    protected createEntity(entity: T, forceId?: number): Promise<T | null>;
+    protected removeEntity(entity: T): Promise<boolean>;
+    protected saveDBEntityAsync(id: number): Promise<boolean>;
+    protected getEntityByDBId(id: number): T | undefined;
+    protected loadDBEntityFor(value: number | string, key?: string, bindTo?: number): Promise<T | T[] | null>;
+    protected loadDBEntities(): Promise<T[]>;
+    private getEntityProperties;
+    private getEntityPropertiesValues;
+    protected syncWithClients(client?: number): void;
+    protected bindEntityToPlayer(entity: T, playerId: number): void;
+    protected bindEntityToPlayerByEntityId(id: number | string, playerId: number): void;
+    protected onBoundEntityDestroyed(_entity: T, _boundPlayer: number): void;
+    onPlayerAuthenticate(playerId: number, _player: any): void;
+    onPlayerDisconnect(): void;
+    private computeTableProperties;
+}

package/dist/types/server/server.base.d.ts

@@ -0,0 +1,7 @@
+export declare class ServerBase {
+    constructor();
+    protected RegisterAdminCommand(commandName: string, adminLevelRequired: number, handlerFunction: Function, restricted: boolean): void;
+    private assignServerBaseListeners;
+    protected setRoutingBucket(playerId: number, routingBucket: number): void;
+    protected routingBucketCondition: (source: number, routingBucket: number) => boolean;
+}

package/dist/types/server/server.controller.d.ts

@@ -0,0 +1,20 @@
+import { ServerEntities } from "./server.entities";
+export declare class ServerController extends ServerEntities {
+    protected translationFile?: {
+        [key: string]: string;
+    };
+    private _translationLanguage;
+    protected get translationLanguage(): string;
+    private _clientsidedResourceMap;
+    protected get clientsidedResourceMap(): Map<number, {
+        [metadataKey: string]: any;
+    }>;
+    protected getPlayerClientsidedCacheKey(playerId: number, key: string): any;
+    protected updatePlayerClientsidedCacheKey(playerId: number, key: string, value: any): void;
+    onPlayerClientsidedCacheLoaded(metadataObject: any): void;
+    onPlayerDisconnect(): void;
+    protected translate(key: string, params?: {
+        [key: string]: string;
+    }): string;
+    protected setTranslationLanguage(language: string): void;
+}

package/dist/types/server/server.entities.d.ts

@@ -0,0 +1,13 @@
+import { ServerBase } from './server.base';
+export declare class ServerEntities extends ServerBase {
+    private _virtualWorldsWithPlayers;
+    /** 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! */
+    protected get virtualWorldsWithPlayers(): Map<number, number[]>;
+    onPlayerEnteredScope(data: {
+        for: number;
+        player: number;
+    }): void;
+    protected setPlayerVirtualWorld(playerId: number, virtualWorld: number): void;
+    protected getPlayerVirtualWorld(playerId: number): number;
+    removeClientsideVehicles(): void;
+}

package/dist/types/server/services/index.d.ts

@@ -0,0 +1,5 @@
+export * from './server-resource-database.service';
+export * from './server-enterable-database.service';
+export * from './server-virtual-worlds.service';
+export * from './server-translate.service';
+export * from './session';

package/dist/types/server/services/server-enterable-database.service.d.ts

@@ -0,0 +1,14 @@
+import { ServerResourceDatabase } from "./server-resource-database.service";
+export declare class ServerEnterableDatabase<T extends {
+    id: number;
+    entranceX: number;
+    entranceY: number;
+    entranceZ: number;
+    exitX: number;
+    exitY: number;
+    exitZ: number;
+}> extends ServerResourceDatabase<T> {
+    getClosestToPlayer(player: number): T | null;
+    getClosestEntranceToPlayer(source: number): T | null;
+    getClosestExitToPlayer(source: number): T | null;
+}

package/dist/types/server/services/server-resource-database.service.d.ts

@@ -0,0 +1,37 @@
+import { Observable } from "rxjs";
+export declare class ServerResourceDatabase<T extends {
+    id: number;
+}> {
+    readonly _tableName: string;
+    readonly _loadAllAtStart?: boolean | undefined;
+    private _onBoundEntityDestroyed$;
+    get onBoundEntityDestroyed$(): Observable<{
+        entity: T;
+        boundPlayer: number;
+    }>;
+    private _onSync$;
+    get onSync$(): Observable<{
+        player: number;
+    } | void>;
+    private _entities;
+    get entities(): T[];
+    private _cachedProperties;
+    get cachedProperties(): string[];
+    private _playerToEntityBindings;
+    get playerToEntityBindings(): Map<number, (number | string)[]>;
+    constructor(_tableName: string, _loadAllAtStart?: boolean | undefined);
+    create(entity: T, forceId?: number): Promise<T | null>;
+    remove(entity: T): Promise<boolean>;
+    saveAsync(id: number): Promise<boolean>;
+    protected loadDBEntityFor(value: number | string, key?: string, bindTo?: number): Promise<T | T[] | null>;
+    protected loadDBEntities(): Promise<T[]>;
+    private getEntityProperties;
+    private getEntityPropertiesValues;
+    bindEntityToPlayer(entity: T, playerId: number): void;
+    bindEntityToPlayerByEntityId(id: number | string, playerId: number): void;
+    onPlayerAuthenticate(playerId: number, _player: any): void;
+    onPlayerDisconnect(): void;
+    private computeTableProperties;
+    getEntityByDBId(id: number): T | undefined;
+    getEntities(): T[];
+}

package/dist/types/server/services/server-translate.service.d.ts

@@ -0,0 +1,12 @@
+export declare class ServerTranslateService {
+    private readonly _translations;
+    private playersMappedToLanguages;
+    constructor(_translations: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    });
+    instant(forPlayer: number, key: string): string;
+    onPlayerDisconnect(): void;
+    getLanguage(forPlayer: number): string;
+}

package/dist/types/server/services/server-virtual-worlds.service.d.ts

@@ -0,0 +1,15 @@
+import { ServerSessionService } from "./session";
+export declare class ServerVirtualWorldsService {
+    private readonly _session;
+    constructor(_session: ServerSessionService);
+    private _virtualWorldsWithPlayers;
+    /** 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(): Map<number, number[]>;
+    onPlayerEnteredScope(data: {
+        for: number;
+        player: number;
+    }): void;
+    setPlayerVirtualWorld(playerId: number, virtualWorld: number): void;
+    getPlayerVirtualWorld(playerId: number): number;
+    removeClientsideVehicles(): void;
+}

package/dist/types/server/services/session/default-entities/character.entity.d.ts

@@ -0,0 +1,5 @@
+export declare class Character {
+    id: bigint;
+    accountId: bigint;
+    name: string;
+}

package/dist/types/server/services/session/default-entities/index.d.ts

@@ -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/types/server/services/session/default-entities/session-account-id.d.ts

@@ -0,0 +1,4 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionAccountId extends SessionItem<number> implements ISessionItem<number> {
+    constructor();
+}

package/dist/types/server/services/session/default-entities/session-cash.d.ts

@@ -0,0 +1,4 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionCash extends SessionItem<number> implements ISessionItem<number> {
+    constructor();
+}

package/dist/types/server/services/session/default-entities/session-hours-played.d.ts

@@ -0,0 +1,5 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionHoursPlayed extends SessionItem<number> implements ISessionItem<number> {
+    constructor();
+    compute(playerId: number, originalValue: number): number;
+}

package/dist/types/server/services/session/default-entities/session-id.d.ts

@@ -0,0 +1,4 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionId extends SessionItem<number> implements ISessionItem<number> {
+    constructor();
+}

package/dist/types/server/services/session/default-entities/session-language.d.ts

@@ -0,0 +1,4 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionLanguage extends SessionItem<string> implements ISessionItem<string> {
+    constructor();
+}

package/dist/types/server/services/session/default-entities/session-last-location.d.ts

@@ -0,0 +1,6 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionLastLocation extends SessionItem<Array<number>> implements ISessionItem<Array<number>> {
+    constructor();
+    compute(playerId: number, originalValue: Array<number>): Array<number>;
+    load(_accountId: number, _characterId: number, bruteValue: any): Promise<Array<number>>;
+}

package/dist/types/server/services/session/default-entities/session-name.d.ts

@@ -0,0 +1,4 @@
+import { SessionItem, ISessionItem } from "../../../models";
+export declare class SessionName extends SessionItem<string> implements ISessionItem<string> {
+    constructor();
+}

package/dist/types/server/services/session/index.d.ts

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

package/dist/types/server/services/session/server-session.service.d.ts

@@ -0,0 +1,70 @@
+import { Provider } from "injection-js";
+import { IAccount } from "../../../shared";
+import { ISessionItemBase } from "../../models";
+import { ISession } from "../../models/session/session.model";
+export declare class ServerSessionService {
+    private readonly _sessionItems?;
+    private _sessions;
+    private _untrackedSessionItems;
+    get players(): number[];
+    get authenticatedPlayers(): number[];
+    constructor(_sessionItems?: ISessionItemBase[] | undefined);
+    /**
+     * Registers an account.
+     * @param playerId The playerId (NOT from the database) of this player
+     * @param accountName The account name of this player
+     * @param hashedPassword The hashed password of this account
+     * @param email The email of this account
+     * @returns The SQL ID of the newly-created account
+     */
+    register(playerId: number, accountName: string, hashedPassword: string, email: string): Promise<number>;
+    /**
+     * Logs into an account
+     * @param playerId The playerId (NOT from the database) of this player
+     * @param email The email of the account
+     * @param hashedPassword The hashed password fo this account
+     * @returns Account data for this account
+     */
+    login(playerId: number, email: string, hashedPassword: string): Promise<IAccount>;
+    /**
+     * Fetches all the characters related to the provided account
+     * @param playerId The playerId (NOT from the database) of this player
+     * @param accountId The accountId of the
+     * @returns Data for all characters on the given account
+     */
+    fetch(playerId: number, accountId?: number): Promise<ISession[]>;
+    /**
+     * Loads the entire character given a character ID
+     * @param playerId The playerId (NOT from the database) of this player
+     * @param characterId The character's SQL ID
+     * @returns Data for the given characterId
+     */
+    load(playerId: number, characterId: number): Promise<ISession>;
+    /**
+     * Creates a character
+     * @param playerId
+     * @param accountName
+     * @param hashedPassword
+     * @param email
+     * @returns
+     */
+    create(playerId: number, accountId?: number): Promise<number>;
+    setPlayerInfo<T>(playerId: number, stat: string, value: T, ...args: any[]): void;
+    setPlayerCash(playerId: number, value: number, options?: SessionUpdaterOptions): void;
+    givePlayerCash(playerId: number, value: number, options?: SessionUpdaterOptions): void;
+    getPlayerCash(playerId: number): number;
+    saveCritical(playerId: number): void;
+    getPlayerInfo<T>(playerId: number, stat: string): T;
+    clearPlayerInfo(playerId: number): void;
+    onResourceStart(resource: string): void;
+    exchangeSessionItems(items: ISessionItemBase[]): ISessionItemBase[];
+    static withDefaults(): Provider;
+    static withItems<T extends {
+        new (...args: any[]): any;
+    }>(...items: T[]): Provider[];
+}
+interface SessionUpdaterOptions {
+    executeSqlCommand?: boolean;
+    ignoreSqlCommandFor?: string[];
+}
+export {};

package/dist/types/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './models';

package/dist/types/shared/models/account.d.ts

@@ -0,0 +1,5 @@
+export interface IAccount {
+    id: number;
+    name: string;
+    email: string;
+}

package/dist/types/shared/models/character.d.ts

@@ -0,0 +1,4 @@
+export interface ICharacter {
+    id: number;
+    accountId: number;
+}

package/dist/types/shared/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './account';
+export * from './character';

package/dist/types/utils/utils.d.ts

@@ -0,0 +1,15 @@
+declare const Delay: (ms: number) => Promise<unknown>;
+declare const isPlayerInArea: (playerPosX: number, playerPosY: number, playerPosZ: number, areaMinX: number, areaMinY: number, areaMinZ: number, areaMaxX: number, areaMaxY: number, areaMaxZ: number) => boolean;
+declare const isPlayerInRangeOfPoint: (playerPosX: number, playerPosY: number, playerPosZ: number, pointX: number, pointY: number, pointZ: number, range: number) => boolean;
+declare const waitUntilThenDo: (condition: Function, func: Function) => Promise<void>;
+export declare const calculateDistance: (pos: number[]) => number;
+export declare const calculateDistanceInKm: (pos: number[]) => number;
+export declare const getRandomPositionInsideArea: (x1: number, x2: number, y1: number, y2: number) => [number, number];
+export declare const isPositionIn2DArea: (x: number, y: number, x1: number, x2: number, y1: number, y2: number) => boolean;
+declare const numberWithCommas: (x: number) => string;
+declare const isJSON: (str: string) => boolean;
+export declare const phoneFormatted: (phone: number) => string;
+export declare const toThousandsString: (input: number, args?: number) => string | number | null;
+export declare const fromThousandsString: (input: string) => number;
+export declare const toTitleCase: (str: string) => string;
+export { Delay, isPlayerInArea, isPlayerInRangeOfPoint, waitUntilThenDo, numberWithCommas, isJSON };

package/package.json

@@ -1,6 +1,36 @@
-{
-  "name": "@armoury/fivem-framework-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+{
+  "name": "@armoury/fivem-framework-server",
+  "version": "1.0.8",
+  "description": "Server APIs for the Armoury FiveM framework",
+  "main": "dist/cjs/server/index.js",
+  "module": "dist/esm/server/index.js",
+  "types": "dist/types/server/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/server/index.d.ts",
+      "import": "./dist/esm/server/index.js",
+      "require": "./dist/cjs/server/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json && node ../../tools/move_ambientdeclaration.js server"
+  },
+  "dependencies": {
+    "@armoury/fivem-framework-common": "1.0.7",
+    "injection-js": "^2.4.0",
+    "reflect-metadata": "^0.2.1",
+    "rxjs": "^7.8.1"
+  },
+  "peerDependencies": {
+    "@armoury/fivem-framework-common": "1.0.7",
+    "@mikro-orm/core": "^6.2.9",
+    "@mikro-orm/mysql": "^6.2.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.