@open-core/framework 0.2.1-beta.1 → 0.2.4

package/dist/runtime/server/services/chat.service.d.ts

@@ -1,5 +1,6 @@
 import { Server } from '../../..';
 import { RGB } from '../../../kernel/utils';
+import { PlayerDirectoryPort } from './ports/player-directory.port';
 /**
  * Service for sending chat messages to players.
  *
@@ -7,6 +8,8 @@ import { RGB } from '../../../kernel/utils';
  * This service emits framework chat events over the network.
  */
 export declare class ChatService {
+    private readonly playerDirectory;
+    constructor(playerDirectory: PlayerDirectoryPort);
     /**
      * Broadcast a chat message to all connected players.
      *
@@ -30,4 +33,34 @@ export declare class ChatService {
      * @param player - Target player.
      */
     clearChat(player: Server.Player): void;
+    /**
+     * Send a chat message to multiple players.
+     *
+     * @param players - Array of target players or their client IDs.
+     * @param message - Message body.
+     * @param author - Author label.
+     * @param color - Message color (RGB).
+     */
+    sendMany(players: (Server.Player | number)[], message: string, author?: string, color?: RGB): void;
+    /**
+     * Send a chat message to players within a certain radius of a specific player.
+     *
+     * @param playerFrom - Origin player.
+     * @param message - Message body.
+     * @param radius - Distance radius in game units.
+     * @param author - Author label.
+     * @param color - Message color (RGB).
+     */
+    sendNearby(playerFrom: Server.Player, message: string, radius: number, author?: string, color?: RGB): void;
+    /**
+     * Broadcast a system message to all players.
+     *
+     * @param message - Message body.
+     * @param color - Message color (RGB). Defaults to a light blue/cyan.
+     */
+    broadcastSystem(message: string, color?: RGB): void;
+    /**
+     * Clear chat for all connected players.
+     */
+    clearChatAll(): void;
 }

package/dist/runtime/server/services/chat.service.js

@@ -5,9 +5,13 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     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.ChatService = void 0;
 const tsyringe_1 = require("tsyringe");
+const player_directory_port_1 = require("./ports/player-directory.port");
 /**
  * Service for sending chat messages to players.
  *
@@ -15,6 +19,9 @@ const tsyringe_1 = require("tsyringe");
  * This service emits framework chat events over the network.
  */
 let ChatService = class ChatService {
+    constructor(playerDirectory) {
+        this.playerDirectory = playerDirectory;
+    }
     /**
      * Broadcast a chat message to all connected players.
      *
@@ -50,8 +57,67 @@ let ChatService = class ChatService {
     clearChat(player) {
         emitNet('core:chat:clear', player.clientID);
     }
+    /**
+     * Send a chat message to multiple players.
+     *
+     * @param players - Array of target players or their client IDs.
+     * @param message - Message body.
+     * @param author - Author label.
+     * @param color - Message color (RGB).
+     */
+    sendMany(players, message, author = 'SYSTEM', color = { r: 255, g: 255, b: 255 }) {
+        players.forEach((p) => {
+            const targetId = typeof p === 'number' ? p : p.clientID;
+            emitNet('core:chat:addMessage', targetId, {
+                args: [author, message],
+                color: color,
+            });
+        });
+    }
+    /**
+     * Send a chat message to players within a certain radius of a specific player.
+     *
+     * @param playerFrom - Origin player.
+     * @param message - Message body.
+     * @param radius - Distance radius in game units.
+     * @param author - Author label.
+     * @param color - Message color (RGB).
+     */
+    sendNearby(playerFrom, message, radius, author = playerFrom.name, color = { r: 255, g: 255, b: 255 }) {
+        const originPos = playerFrom.getPosition();
+        if (!originPos)
+            return;
+        const allPlayers = this.playerDirectory.getAll();
+        const nearbyPlayers = allPlayers.filter((p) => {
+            const pos = p.getPosition();
+            if (!pos)
+                return false;
+            const dx = originPos.x - pos.x;
+            const dy = originPos.y - pos.y;
+            const dz = originPos.z - pos.z;
+            const distance = Math.sqrt(dx * dx + dy * dy + dz * dz);
+            return distance <= radius;
+        });
+        this.sendMany(nearbyPlayers, message, author, color);
+    }
+    /**
+     * Broadcast a system message to all players.
+     *
+     * @param message - Message body.
+     * @param color - Message color (RGB). Defaults to a light blue/cyan.
+     */
+    broadcastSystem(message, color = { r: 0, g: 191, b: 255 }) {
+        this.broadcast(message, 'SYSTEM', color);
+    }
+    /**
+     * Clear chat for all connected players.
+     */
+    clearChatAll() {
+        emitNet('core:chat:clear', -1);
+    }
 };
 exports.ChatService = ChatService;
 exports.ChatService = ChatService = __decorate([
-    (0, tsyringe_1.injectable)()
+    (0, tsyringe_1.injectable)(),
+    __metadata("design:paramtypes", [player_directory_port_1.PlayerDirectoryPort])
 ], ChatService);

package/dist/runtime/server/services/core/command.service.d.ts

@@ -22,7 +22,7 @@ export declare class CommandService extends CommandExecutionPort {
      * @param meta - Command metadata collected from the {@link Command} decorator.
      * @param handler - The bound method to invoke.
      */
-    register(meta: CommandMetadata, handler: Function): void;
+    register(meta: CommandMetadata, handler: (...args: any[]) => any): void;
     /**
      * Executes a registered command.
      *

package/dist/runtime/server/services/parallel/worker-pool.js

@@ -305,12 +305,16 @@ class WorkerPool extends SimpleEventEmitter {
             const idleWorker = this.findIdleWorker();
             if (idleWorker) {
                 const task = this.taskQueue.shift();
+                if (!task)
+                    break;
                 this.assignTask(idleWorker, task);
             }
             else if (this.workers.size < this.config.maxWorkers) {
                 const newWorker = this.spawnWorker();
                 if (newWorker) {
                     const task = this.taskQueue.shift();
+                    if (!task)
+                        break;
                     this.assignTask(newWorker, task);
                 }
                 else {

package/dist/runtime/server/services/ports/command-execution.port.d.ts

@@ -25,7 +25,7 @@ export declare abstract class CommandExecutionPort {
      * @param metadata - Command metadata from decorator
      * @param handler - Bound method to invoke when command is executed
      */
-    abstract register(metadata: CommandMetadata, handler: Function): void;
+    abstract register(metadata: CommandMetadata, handler: (...args: any[]) => any): void;
     /**
      * Executes a registered command.
      *

package/dist/runtime/server/services/remote/remote-command.service.d.ts

@@ -36,7 +36,7 @@ export declare class RemoteCommandService extends CommandExecutionPort {
      * The handler and full metadata are stored locally for schema validation.
      * Only serializable metadata is sent to CORE for security validation.
      */
-    register(metadata: CommandMetadata, handler: Function): void;
+    register(metadata: CommandMetadata, handler: (...args: any[]) => any): void;
     /**
      * Executes a command handler stored in this resource.
      *

package/dist/runtime/server/services/services.register.js

@@ -9,13 +9,13 @@ const player_service_1 = require("./core/player.service");
 const principal_service_1 = require("./core/principal.service");
 const http_service_1 = require("./http/http.service");
 const persistence_service_1 = require("./persistence.service");
-const player_session_lifecycle_port_1 = require("./ports/player-session-lifecycle.port");
+const command_execution_port_1 = require("./ports/command-execution.port");
 const player_directory_port_1 = require("./ports/player-directory.port");
+const player_session_lifecycle_port_1 = require("./ports/player-session-lifecycle.port");
 const principal_port_1 = require("./ports/principal.port");
 const remote_command_service_1 = require("./remote/remote-command.service");
 const remote_player_service_1 = require("./remote/remote-player.service");
 const remote_principal_service_1 = require("./remote/remote-principal.service");
-const command_execution_port_1 = require("./ports/command-execution.port");
 /**
  * Registers server runtime services in the dependency injection container.
  *

package/package.json

@@ -1,98 +1,100 @@
-{
-  "name": "@open-core/framework",
-  "version": "0.2.1-beta.1",
-  "description": "Secure, Event-Driven, OOP Engine for FiveM. Stop scripting, start engineering.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "type": "commonjs",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/newcore-network/opencore.git"
-  },
-  "homepage": "https://github.com/newcore-network/opencore",
-  "bugs": {
-    "url": "https://github.com/newcore-network/opencore/issues"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    },
-    "./server": {
-      "types": "./dist/runtime/server/index.d.ts",
-      "import": "./dist/runtime/server/index.js",
-      "require": "./dist/runtime/server/index.js"
-    },
-    "./client": {
-      "types": "./dist/runtime/client/index.d.ts",
-      "import": "./dist/runtime/client/index.js",
-      "require": "./dist/runtime/client/index.js"
-    },
-    "./shared": {
-      "types": "./dist/kernel/shared/index.d.ts",
-      "import": "./dist/kernel/shared/index.js",
-      "require": "./dist/kernel/shared/index.js"
-    },
-    "./utils": {
-      "types": "./dist/kernel/utils/index.d.ts",
-      "import": "./dist/kernel/utils/index.js",
-      "require": "./dist/kernel/utils/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "watch": "tsc -p tsconfig.build.json --watch",
-    "check": "biome check .",
-    "check:fix": "biome check --write .",
-    "check:fix:unsafe": "biome check --write --unsafe",
-    "format": "biome format --write .",
-    "lint": "biome lint .",
-    "lint:fix": "biome lint --write .",
-    "typecheck": "tsc --noEmit",
-    "test": "npx vitest run --project unit --project integration --project e2e",
-    "test:watch": "npx vitest --project unit --project integration --project e2e",
-    "test:unit": "npx vitest run --project unit",
-    "test:integration": "npx vitest run --project integration",
-    "test:coverage": "npx vitest run --coverage",
-    "bench": "npx tsx benchmark/index.ts",
-    "bench:core": "npx tsx benchmark/index.ts --core",
-    "bench:load": "npx vitest run --project benchmark",
-    "bench:all": "npx tsx benchmark/index.ts --all"
-  },
-  "keywords": [
-    "framework",
-    "opencore",
-    "fivem",
-    "typescript",
-    "roleplay"
-  ],
-  "author": "OpenCore Team",
-  "license": "MPL-2.0",
-  "packageManager": "pnpm@10.13.1",
-  "dependencies": {
-    "reflect-metadata": "^0.2.2",
-    "tsyringe": "^4.10.0",
-    "uuid": "^13.0.0",
-    "zod": "^4.1.13"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.3.10",
-    "@citizenfx/client": "2.0.22443-1",
-    "@citizenfx/server": "2.0.22443-1",
-    "@types/node": "^24.10.1",
-    "@vitest/coverage-v8": "^4.0.15",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-import": "^2.32.0",
-    "tinybench": "^2.7.0",
-    "tsx": "^4.19.2",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
-  }
-}
+{
+  "name": "@open-core/framework",
+  "version": "0.2.4",
+  "description": "Secure, Event-Driven, OOP Engine for FiveM. Stop scripting, start engineering.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/newcore-network/opencore.git"
+  },
+  "homepage": "https://github.com/newcore-network/opencore",
+  "bugs": {
+    "url": "https://github.com/newcore-network/opencore/issues"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/runtime/server/index.d.ts",
+      "import": "./dist/runtime/server/index.js",
+      "require": "./dist/runtime/server/index.js"
+    },
+    "./client": {
+      "types": "./dist/runtime/client/index.d.ts",
+      "import": "./dist/runtime/client/index.js",
+      "require": "./dist/runtime/client/index.js"
+    },
+    "./shared": {
+      "types": "./dist/kernel/shared/index.d.ts",
+      "import": "./dist/kernel/shared/index.js",
+      "require": "./dist/kernel/shared/index.js"
+    },
+    "./utils": {
+      "types": "./dist/kernel/utils/index.d.ts",
+      "import": "./dist/kernel/utils/index.js",
+      "require": "./dist/kernel/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "watch": "tsc -p tsconfig.build.json --watch",
+    "check": "biome check .",
+    "check:fix": "biome check --write .",
+    "check:fix:unsafe": "biome check --write --unsafe",
+    "format": "biome format --write .",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "typecheck": "tsc --noEmit",
+    "test": "npx vitest run --project unit --project integration --project e2e",
+    "test:ci": "npx vitest run --project unit --project integration",
+    "test:watch": "npx vitest --project unit --project integration --project e2e",
+    "test:unit": "npx vitest run --project unit",
+    "test:integration": "npx vitest run --project integration",
+    "test:e2e": "npx vitest run --project e2e",
+    "test:coverage": "npx vitest run --coverage",
+    "bench": "npx tsx benchmark/index.ts",
+    "bench:core": "npx tsx benchmark/index.ts --core",
+    "bench:load": "npx vitest run --project benchmark",
+    "bench:all": "npx tsx benchmark/index.ts --all"
+  },
+  "keywords": [
+    "framework",
+    "opencore",
+    "fivem",
+    "typescript",
+    "roleplay"
+  ],
+  "author": "OpenCore Team",
+  "license": "MPL-2.0",
+  "packageManager": "pnpm@10.13.1",
+  "dependencies": {
+    "reflect-metadata": "^0.2.2",
+    "tsyringe": "^4.10.0",
+    "uuid": "^13.0.0",
+    "zod": "^4.1.13"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.10",
+    "@citizenfx/client": "2.0.22443-1",
+    "@citizenfx/server": "2.0.22443-1",
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "^4.0.15",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "tinybench": "^2.7.0",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15"
+  }
+}

package/dist/kernel/di/tokens.d.ts

@@ -1,30 +0,0 @@
-/**
- * Dependency Injection Tokens for OpenCore.
- *
- * Using string tokens instead of class references for injection
- * avoids issues with circular dependencies and "TypeInfo not known"
- * errors in certain build environments.
- */
-export declare const DI_TOKENS: {
-    readonly CommandExecutionPort: symbol;
-    readonly PlayerDirectoryPort: symbol;
-    readonly PrincipalPort: symbol;
-    readonly DecoratorProcessor: "DecoratorProcessor";
-    readonly DatabaseService: symbol;
-    readonly HttpService: symbol;
-    readonly ChatService: symbol;
-    readonly RateLimiterService: symbol;
-    readonly PrincipalProvider: symbol;
-    readonly AuthProvider: symbol;
-    readonly Exports: symbol;
-    readonly EngineEvents: symbol;
-    readonly NetTransport: symbol;
-    readonly Tick: symbol;
-    readonly PlayerInfo: symbol;
-    readonly ResourceInfo: symbol;
-    readonly EntityServer: symbol;
-    readonly VehicleServer: symbol;
-    readonly PlayerServer: symbol;
-    readonly Hasher: symbol;
-    readonly PedAppearanceServer: symbol;
-};

package/dist/kernel/di/tokens.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DI_TOKENS = void 0;
-/**
- * Dependency Injection Tokens for OpenCore.
- *
- * Using string tokens instead of class references for injection
- * avoids issues with circular dependencies and "TypeInfo not known"
- * errors in certain build environments.
- */
-exports.DI_TOKENS = {
-    // Ports
-    CommandExecutionPort: Symbol.for('CommandExecutionPort'),
-    PlayerDirectoryPort: Symbol.for('PlayerDirectoryPort'),
-    PrincipalPort: Symbol.for('PrincipalPort'),
-    // Decorator Processors
-    DecoratorProcessor: 'DecoratorProcessor',
-    // Services
-    DatabaseService: Symbol.for('DatabaseService'),
-    HttpService: Symbol.for('HttpService'),
-    ChatService: Symbol.for('ChatService'),
-    RateLimiterService: Symbol.for('RateLimiterService'),
-    // Providers
-    PrincipalProvider: Symbol.for('PrincipalProvider'),
-    AuthProvider: Symbol.for('AuthProvider'),
-    // Adapters
-    Exports: Symbol.for('IExports'),
-    EngineEvents: Symbol.for('IEngineEvents'),
-    NetTransport: Symbol.for('INetTransport'),
-    Tick: Symbol.for('ITick'),
-    PlayerInfo: Symbol.for('IPlayerInfo'),
-    ResourceInfo: Symbol.for('IResourceInfo'),
-    EntityServer: Symbol.for('IEntityServer'),
-    VehicleServer: Symbol.for('IVehicleServer'),
-    PlayerServer: Symbol.for('IPlayerServer'),
-    Hasher: Symbol.for('IHasher'),
-    PedAppearanceServer: Symbol.for('IPedAppearanceServer'),
-};

package/dist/runtime/client/interfaces/appearance.interface.d.ts

@@ -1,25 +0,0 @@
-export interface PlayerAppearance {
-  components?: Record<
-    number,
-    {
-      drawable: number
-      texture: number
-    }
-  >
-  props?: Record<
-    number,
-    {
-      drawable: number
-      texture: number
-    }
-  >
-  faceFeatures?: Record<number, number>
-  headBlend?: {
-    shapeFirst: number
-    shapeSecond: number
-    shapeMix: number
-    skinFirst: number
-    skinSecond: number
-    skinMix: number
-  }
-}

package/dist/runtime/client/interfaces/appearance.interface.js

@@ -1,2 +0,0 @@
-'use strict'
-Object.defineProperty(exports, '__esModule', { value: true })

package/dist/runtime/server/controllers/command.controller.d.ts

@@ -1,15 +0,0 @@
-import { CommandExecutionPort } from '../services/ports/command-execution.port'
-import { Player } from '../entities'
-/**
- * Network controller for command execution.
- *
- * @remarks
- * Receives command execution requests from clients and delegates to CommandExecutionPort.
- * In CORE mode, executes commands directly or delegates to owning resource.
- * In RESOURCE mode, delegates to CORE via exports.
- */
-export declare class CommandNetworkController {
-  private readonly commandService
-  constructor(commandService: CommandExecutionPort)
-  onCommandReceived(player: Player, command: string, args: string[]): Promise<void>
-}

package/dist/runtime/server/controllers/command.controller.js

@@ -1,100 +0,0 @@
-'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) ||
-  ((k, v) => {
-    if (typeof Reflect === 'object' && typeof Reflect.metadata === 'function')
-      return Reflect.metadata(k, v)
-  })
-Object.defineProperty(exports, '__esModule', { value: true })
-exports.CommandNetworkController = void 0
-const onNet_1 = require('../decorators/onNet')
-const command_execution_port_1 = require('../services/ports/command-execution.port')
-const entities_1 = require('../entities')
-const decorators_1 = require('../decorators')
-const logger_1 = require('../../../kernel/shared/logger')
-const utils_1 = require('../../../kernel/utils')
-/**
- * Network controller for command execution.
- *
- * @remarks
- * Receives command execution requests from clients and delegates to CommandExecutionPort.
- * In CORE mode, executes commands directly or delegates to owning resource.
- * In RESOURCE mode, delegates to CORE via exports.
- */
-let CommandNetworkController = class CommandNetworkController {
-  constructor(commandService) {
-    this.commandService = commandService
-  }
-  async onCommandReceived(player, command, args) {
-    try {
-      if (command.startsWith('/')) command = command.slice(1)
-      if (!player.clientID || player.clientID === null || player.clientID === undefined) {
-        console.log('DEBUG; Player entity not received in core:execute-command')
-      }
-      if (args.length > 10 || !/^[a-zA-Z0-9:_-]+$/.test(command)) {
-        logger_1.loggers.command.warn(`Rejected suspicious command: ${command}`, {
-          playerId: player.clientID,
-          playerName: player.name,
-        })
-        return
-      }
-      logger_1.loggers.command.trace(`Received: /${command}`, {
-        playerId: player.clientID,
-        playerName: player.name,
-      })
-      await this.commandService.execute(player, command, args)
-    } catch (error) {
-      if (error instanceof utils_1.AppError) {
-        if (error.code === 'GAME:BAD_REQUEST' || error.code === 'COMMAND:NOT_FOUND')
-          player.send(error.message, 'error')
-        else player.send('An error occurred while executing the command', 'error')
-        logger_1.loggers.command.error(
-          `Execution failed: /${command}`,
-          {
-            playerId: player.clientID,
-          },
-          error,
-        )
-      }
-    }
-  }
-}
-exports.CommandNetworkController = CommandNetworkController
-__decorate(
-  [
-    (0, decorators_1.Public)(),
-    (0, onNet_1.OnNet)('core:execute-command'),
-    __metadata('design:type', Function),
-    __metadata('design:paramtypes', [entities_1.Player, String, Array]),
-    __metadata('design:returntype', Promise),
-  ],
-  CommandNetworkController.prototype,
-  'onCommandReceived',
-  null,
-)
-exports.CommandNetworkController = CommandNetworkController = __decorate(
-  [
-    (0, decorators_1.Controller)(),
-    __metadata('design:paramtypes', [command_execution_port_1.CommandExecutionPort]),
-  ],
-  CommandNetworkController,
-)