@open-core/framework 0.2.8 → 0.3.0

package/dist/runtime/server/devmode/dev-mode.service.js

@@ -9,53 +9,43 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DevModeService = void 0;
 const tsyringe_1 = require("tsyringe");
 const container_1 = require("../../../kernel/di/container");
-const logger_1 = require("../../../kernel/shared/logger");
-const dev_transport_factory_1 = require("../../../kernel/shared/logger/transports/dev-transport.factory");
+const logger_1 = require("../../../kernel/logger");
+const dev_transport_factory_1 = require("../../../kernel/logger/transports/dev-transport.factory");
 const event_interceptor_service_1 = require("./event-interceptor.service");
-const hot_reload_server_1 = require("./hot-reload.server");
 const player_simulator_service_1 = require("./player-simulator.service");
 const state_inspector_service_1 = require("./state-inspector.service");
-// Safe wrapper for FiveM ExecuteCommand (no-op in Node.js)
-function safeExecuteCommand(command) {
-    if (typeof ExecuteCommand === 'function') {
-        ExecuteCommand(command);
-    }
-    else {
-        logger_1.loggers.bootstrap.warn('[DevMode] ExecuteCommand not available (not running in FiveM)');
-    }
-}
 /**
  * Main DevMode service that orchestrates all development tools.
  *
- * Provides a unified interface for:
- * - Hot reload server for automatic resource restarting
- * - Event interception and recording
- * - Runtime state inspection
- * - Player simulation
- * - Log streaming to external tools
+ * @remarks
+ * Provides a unified interface for internal framework debugging and telemetry.
+ * It coordinates:
+ * - Event interception and recording (Net, Commands, etc)
+ * - Runtime state inspection (DI, Players, Services)
+ * - Player simulation for offline logic testing
+ * - Telemetry bridge for external CLI integration
  */
 let DevModeService = class DevModeService {
     constructor() {
         this.enabled = false;
         this.options = null;
-        this.hotReloadServer = null;
         this.logTransport = null;
     }
     get interceptor() {
-        return container_1.di.resolve(event_interceptor_service_1.EventInterceptorService);
+        return container_1.GLOBAL_CONTAINER.resolve(event_interceptor_service_1.EventInterceptorService);
     }
     get inspector() {
-        return container_1.di.resolve(state_inspector_service_1.StateInspectorService);
+        return container_1.GLOBAL_CONTAINER.resolve(state_inspector_service_1.StateInspectorService);
     }
     get simulator() {
-        return container_1.di.resolve(player_simulator_service_1.PlayerSimulatorService);
+        return container_1.GLOBAL_CONTAINER.resolve(player_simulator_service_1.PlayerSimulatorService);
     }
     /**
      * Enables DevMode with the specified options.
      * @param options - DevMode configuration
      */
     async enable(options) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e;
         if (this.enabled) {
             logger_1.loggers.bootstrap.warn('[DevMode] Already enabled, skipping');
             return;
@@ -63,26 +53,20 @@ let DevModeService = class DevModeService {
         this.options = options;
         this.enabled = true;
         logger_1.loggers.bootstrap.info('[DevMode] Enabling development mode...', {
-            hotReload: (_a = options.hotReload) === null || _a === void 0 ? void 0 : _a.enabled,
-            bridge: (_b = options.bridge) === null || _b === void 0 ? void 0 : _b.autoConnect,
-            interceptor: (_c = options.interceptor) === null || _c === void 0 ? void 0 : _c.enabled,
-            simulator: (_d = options.simulator) === null || _d === void 0 ? void 0 : _d.enabled,
+            bridge: (_a = options.bridge) === null || _a === void 0 ? void 0 : _a.autoConnect,
+            interceptor: (_b = options.interceptor) === null || _b === void 0 ? void 0 : _b.enabled,
+            simulator: (_c = options.simulator) === null || _c === void 0 ? void 0 : _c.enabled,
         });
-        // Start hot reload server
-        if ((_e = options.hotReload) === null || _e === void 0 ? void 0 : _e.enabled) {
-            this.hotReloadServer = new hot_reload_server_1.HotReloadServer(options.hotReload);
-            this.hotReloadServer.start();
-        }
         // Configure event interceptor
         if (options.interceptor) {
             this.interceptor.configure(options.interceptor);
         }
         // Connect to CLI bridge
-        if ((_f = options.bridge) === null || _f === void 0 ? void 0 : _f.autoConnect) {
+        if ((_d = options.bridge) === null || _d === void 0 ? void 0 : _d.autoConnect) {
             await this.connectToBridge(options.bridge.url);
         }
         // Auto-connect simulated players
-        if (((_g = options.simulator) === null || _g === void 0 ? void 0 : _g.enabled) && options.simulator.autoConnectPlayers > 0) {
+        if (((_e = options.simulator) === null || _e === void 0 ? void 0 : _e.enabled) && options.simulator.autoConnectPlayers > 0) {
             this.simulator.connectMany(options.simulator.autoConnectPlayers);
         }
         logger_1.loggers.bootstrap.info('[DevMode] Development mode enabled successfully');
@@ -94,11 +78,6 @@ let DevModeService = class DevModeService {
         if (!this.enabled)
             return;
         logger_1.loggers.bootstrap.info('[DevMode] Disabling development mode...');
-        // Stop hot reload server
-        if (this.hotReloadServer) {
-            this.hotReloadServer.stop();
-            this.hotReloadServer = null;
-        }
         // Disconnect log transport
         if (this.logTransport) {
             void (0, dev_transport_factory_1.stopDevTransport)(this.logTransport);
@@ -277,9 +256,6 @@ let DevModeService = class DevModeService {
             case 'command':
                 this.handleRemoteCommand(message.payload);
                 break;
-            case 'reload':
-                this.handleRemoteReload(message.payload);
-                break;
             default:
                 logger_1.loggers.bootstrap.debug('[DevMode] Unknown bridge message type', { type: message.type });
         }
@@ -313,10 +289,6 @@ let DevModeService = class DevModeService {
                 logger_1.loggers.bootstrap.warn('[DevMode] Unknown remote command', { name: command.name });
         }
     }
-    handleRemoteReload(payload) {
-        logger_1.loggers.bootstrap.info(`[DevMode] Remote reload requested for: ${payload.resource}`);
-        safeExecuteCommand(`restart ${payload.resource}`);
-    }
 };
 exports.DevModeService = DevModeService;
 exports.DevModeService = DevModeService = __decorate([

package/dist/runtime/server/devmode/index.d.ts

@@ -1,8 +1,6 @@
-export * from './contracts';
 export { DevModeService } from './dev-mode.service';
 export { EventInterceptorService } from './event-interceptor.service';
-export { HotReloadServer } from './hot-reload.server';
 export { PlayerSimulatorService } from './player-simulator.service';
 export { StateInspectorService } from './state-inspector.service';
-export type { BridgeMessage, BridgeOptions, DevEvent, DevModeOptions, HotReloadOptions, InterceptorOptions, RuntimeSnapshot, SimulatedPlayer, SimulatedPlayerOptions, SimulatorOptions, } from './types';
+export type { BridgeMessage, BridgeOptions, DevEvent, DevModeOptions, InterceptorOptions, RuntimeSnapshot, SimulatedPlayer, SimulatedPlayerOptions, SimulatorOptions, } from './types';
 export { DEFAULT_DEVMODE_OPTIONS } from './types';

package/dist/runtime/server/devmode/index.js

@@ -1,29 +1,12 @@
 "use strict";
 // DevMode - Development tools for OpenCore
-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 });
-exports.DEFAULT_DEVMODE_OPTIONS = exports.StateInspectorService = exports.PlayerSimulatorService = exports.HotReloadServer = exports.EventInterceptorService = exports.DevModeService = void 0;
+exports.DEFAULT_DEVMODE_OPTIONS = exports.StateInspectorService = exports.PlayerSimulatorService = exports.EventInterceptorService = exports.DevModeService = void 0;
 // Contracts
-__exportStar(require("./contracts"), exports);
 var dev_mode_service_1 = require("./dev-mode.service");
 Object.defineProperty(exports, "DevModeService", { enumerable: true, get: function () { return dev_mode_service_1.DevModeService; } });
 var event_interceptor_service_1 = require("./event-interceptor.service");
 Object.defineProperty(exports, "EventInterceptorService", { enumerable: true, get: function () { return event_interceptor_service_1.EventInterceptorService; } });
-var hot_reload_server_1 = require("./hot-reload.server");
-Object.defineProperty(exports, "HotReloadServer", { enumerable: true, get: function () { return hot_reload_server_1.HotReloadServer; } });
 var player_simulator_service_1 = require("./player-simulator.service");
 Object.defineProperty(exports, "PlayerSimulatorService", { enumerable: true, get: function () { return player_simulator_service_1.PlayerSimulatorService; } });
 var state_inspector_service_1 = require("./state-inspector.service");

package/dist/runtime/server/devmode/player-simulator.service.js

@@ -10,7 +10,7 @@ exports.PlayerSimulatorService = void 0;
 const tsyringe_1 = require("tsyringe");
 const INetTransport_1 = require("../../../adapters/contracts/INetTransport");
 const container_1 = require("../../../kernel/di/container");
-const logger_1 = require("../../../kernel/shared/logger");
+const logger_1 = require("../../../kernel/logger");
 const player_session_lifecycle_port_1 = require("../services/ports/player-session-lifecycle.port");
 /**
  * Service for simulating player connections during development.
@@ -24,10 +24,10 @@ let PlayerSimulatorService = class PlayerSimulatorService {
         this.clientIdCounter = 90000; // Start high to avoid conflicts with real players
     }
     get transport() {
-        return container_1.di.resolve(INetTransport_1.INetTransport);
+        return container_1.GLOBAL_CONTAINER.resolve(INetTransport_1.INetTransport);
     }
     get sessionLifecycle() {
-        return container_1.di.resolve(player_session_lifecycle_port_1.PlayerSessionLifecyclePort);
+        return container_1.GLOBAL_CONTAINER.resolve(player_session_lifecycle_port_1.PlayerSessionLifecyclePort);
     }
     /**
      * Connects a simulated player.

package/dist/runtime/server/devmode/state-inspector.service.js

@@ -27,7 +27,7 @@ let StateInspectorService = class StateInspectorService extends IDevModeInspecto
         this.fiveMEventHandlers = new Map();
     }
     get players() {
-        return container_1.di.resolve(player_directory_port_1.PlayerDirectoryPort);
+        return container_1.GLOBAL_CONTAINER.resolve(player_directory_port_1.PlayerDirectoryPort);
     }
     captureSnapshot() {
         const ctx = (0, runtime_1.getRuntimeContext)();
@@ -64,7 +64,7 @@ let StateInspectorService = class StateInspectorService extends IDevModeInspecto
         // Note: This is a simplified implementation
         // The actual implementation depends on tsyringe internals
         try {
-            const container = container_1.di;
+            const container = container_1.GLOBAL_CONTAINER;
             if (container._registry) {
                 for (const [token, registration] of container._registry) {
                     const tokenName = typeof token === 'function' ? token.name : String(token);

package/dist/runtime/server/devmode/types.d.ts

@@ -29,96 +29,131 @@ export interface DevEvent {
 }
 /**
  * Message sent through the DevMode bridge.
+ *
+ * @remarks
+ * The bridge acts as a telemetry and control tunnel between the OpenCore runtime
+ * and the external CLI. It allows for real-time log streaming and state inspection.
  */
 export interface BridgeMessage {
-    type: 'log' | 'event' | 'state' | 'command' | 'reload' | 'ping' | 'pong';
+    /**
+     * Message type:
+     * - 'log': Real-time server log streaming
+     * - 'event': Notification of a captured event (net, command, etc)
+     * - 'state': Runtime state snapshot response
+     * - 'command': Control command from CLI (e.g. trigger simulation)
+     * - 'ping'/'pong': Connection heartbeat
+     */
+    type: 'log' | 'event' | 'state' | 'command' | 'ping' | 'pong';
+    /** Data associated with the message */
     payload: unknown;
 }
 /**
  * Snapshot of the runtime state.
+ *
+ * @remarks
+ * Used by the CLI to visualize the current state of the framework without
+ * requiring game access.
  */
 export interface RuntimeSnapshot {
     /** Capture timestamp */
     timestamp: number;
-    /** Current framework mode */
+    /** Current framework mode (CORE, RESOURCE, STANDALONE) */
     mode: FrameworkMode;
-    /** Enabled features */
+    /** Enabled features and their status */
     features: Record<string, boolean>;
-    /** Player information */
+    /** Player information (simulated and real) */
     players: {
         count: number;
         ids: number[];
     };
-    /** Registered handlers */
+    /** Registered handlers for discovery */
     handlers: {
         commands: string[];
         netEvents: string[];
         exports: string[];
         fiveMEvents: string[];
     };
-    /** DI container info */
+    /** DI container information */
     diContainer: {
         registrations: number;
         singletons: string[];
     };
 }
-/**
- * Hot reload configuration.
- */
-export interface HotReloadOptions {
-    /** Enable hot reload server */
-    enabled: boolean;
-    /** HTTP port for reload endpoint */
-    port: number;
-    /** Resources allowed to trigger reload (empty = all) */
-    allowedResources?: string[];
-}
 /**
  * Bridge configuration for CLI connection.
+ *
+ * @remarks
+ * The bridge enables advanced development features like log streaming to CLI
+ * and state inspection. It does NOT handle resource restarts (txAdmin handles that).
  */
 export interface BridgeOptions {
-    /** WebSocket URL to connect to */
+    /**
+     * WebSocket URL of the OpenCore CLI bridge.
+     * @defaultValue 'ws://localhost:3848'
+     */
     url: string;
-    /** Auto-connect on dev mode start */
+    /**
+     * Whether to connect to the bridge automatically on startup.
+     * @defaultValue false
+     */
     autoConnect: boolean;
-    /** Reconnect on disconnect */
+    /** Whether to attempt reconnection if connection is lost */
     reconnect?: boolean;
-    /** Reconnect interval in milliseconds */
+    /** Delay between reconnection attempts in milliseconds */
     reconnectInterval?: number;
 }
 /**
  * Event interceptor configuration.
+ *
+ * @remarks
+ * The interceptor captures and records all incoming/outgoing events (Net, Commands, etc.)
+ * for debugging purposes.
  */
 export interface InterceptorOptions {
     /** Enable event interception */
     enabled: boolean;
-    /** Record event history */
+    /** Whether to keep a history of events in memory */
     recordHistory: boolean;
-    /** Maximum events to keep in history */
+    /** Maximum number of events to keep in the history buffer */
     maxHistorySize: number;
 }
 /**
  * Player simulator configuration.
+ *
+ * @remarks
+ * The simulator allows for creating "virtual" players that the framework
+ * treats as real, enabling testing of permissions, economy, and logic without game clients.
  */
 export interface SimulatorOptions {
-    /** Enable player simulation */
+    /** Enable player simulation features */
     enabled: boolean;
-    /** Number of players to auto-connect on start */
+    /** Number of virtual players to connect automatically on startup */
     autoConnectPlayers: number;
 }
 /**
  * Main DevMode configuration.
+ *
+ * @remarks
+ * Development mode provides tools for debugging, inspection, and simulation.
+ * It is dynamically loaded and should be disabled in production.
  */
 export interface DevModeOptions {
-    /** Enable dev mode */
+    /**
+     * Master switch for development mode.
+     * If false, no dev tools will be loaded.
+     */
     enabled: boolean;
-    /** Hot reload configuration */
-    hotReload?: HotReloadOptions;
-    /** Bridge configuration */
+    /**
+     * CLI Bridge configuration for telemetry and logs.
+     */
     bridge?: BridgeOptions;
-    /** Interceptor configuration */
+    /**
+     * Event interceptor for debugging network/command flow.
+     */
     interceptor?: InterceptorOptions;
-    /** Simulator configuration */
+    /**
+     * Virtual player simulator for offline testing.
+     */
     simulator?: SimulatorOptions;
 }
 /**
@@ -157,5 +192,6 @@ export interface SimulatedPlayer {
 }
 /**
  * Default DevMode configuration.
+ * Centered on telemetry and simulation, delegating resource management to CLI/txAdmin.
  */
 export declare const DEFAULT_DEVMODE_OPTIONS: DevModeOptions;

package/dist/runtime/server/devmode/types.js

@@ -3,13 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_DEVMODE_OPTIONS = void 0;
 /**
  * Default DevMode configuration.
+ * Centered on telemetry and simulation, delegating resource management to CLI/txAdmin.
  */
 exports.DEFAULT_DEVMODE_OPTIONS = {
     enabled: false,
-    hotReload: {
-        enabled: true,
-        port: 3847,
-    },
     bridge: {
         url: 'ws://localhost:3848',
         autoConnect: false,