@open-core/framework 0.2.4 → 0.2.5

package/dist/runtime/server/bus/internal-event.bus.d.ts

@@ -0,0 +1,6 @@
+import { InternalEventMap } from '../types/internal-events';
+type InternalEventName = keyof InternalEventMap;
+type InternalEventHandler<E extends InternalEventName> = (payload: InternalEventMap[E]) => void;
+export declare function onFrameworkEvent<E extends InternalEventName>(event: E, handler: InternalEventHandler<E>): () => void;
+export declare function emitFrameworkEvent<E extends InternalEventName>(event: E, payload: InternalEventMap[E]): void;
+export {};

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

@@ -11,7 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionController = void 0;
 const shared_1 = require("../../../kernel/shared");
-const core_event_bus_1 = require("../bus/core-event-bus");
+const internal_event_bus_1 = require("../bus/internal-event.bus");
 const decorators_1 = require("../decorators");
 const onFiveMEvent_1 = require("../decorators/onFiveMEvent");
 const services_1 = require("../services");
@@ -33,12 +33,12 @@ let SessionController = class SessionController {
             license: license !== null && license !== void 0 ? license : 'none',
         });
         await this.persistance.handleSessionLoad(player);
-        (0, core_event_bus_1.emitFrameworkEvent)('core:playerSessionCreated', { clientId, license });
+        (0, internal_event_bus_1.emitFrameworkEvent)('internal:playerSessionCreated', { clientId, license });
         setImmediate(() => {
             const currentPlayer = this.playerDirectory.getByClient(clientId);
             if (!currentPlayer)
                 return;
-            (0, core_event_bus_1.emitFrameworkEvent)('core:playerFullyConnected', { clientId, license });
+            (0, internal_event_bus_1.emitFrameworkEvent)('internal:playerFullyConnected', currentPlayer);
         });
     }
     async onPlayerDropped() {
@@ -48,7 +48,7 @@ let SessionController = class SessionController {
             await this.persistance.handleSessionSave(player);
         }
         this.playerSessionLifecycle.unbind(clientId);
-        (0, core_event_bus_1.emitFrameworkEvent)('core:playerSessionDestroyed', { clientId });
+        (0, internal_event_bus_1.emitFrameworkEvent)('internal:playerSessionDestroyed', { clientId });
         shared_1.loggers.session.info(`Player session destroyed`, { clientId });
     }
 };

package/dist/runtime/server/decorators/onFrameworkEvent.d.ts

@@ -1,4 +1,9 @@
-import { CoreEventMap } from '../types/core-events';
+import { InternalEventMap } from '../types/internal-events';
+/**
+ * Handler function type for framework events.
+ * Accepts the event payload and returns void or Promise<void>.
+ */
+type FrameworkEventHandler<K extends keyof InternalEventMap> = (payload: InternalEventMap[K]) => void | Promise<void>;
 /**
  * Registers a method as a listener for an internal OpenCore framework event.
  *
@@ -6,17 +11,21 @@ import { CoreEventMap } from '../types/core-events';
  * This decorator only stores metadata. The framework binds listeners during bootstrap by scanning
  * controller methods.
  *
- * @param event - Core event name, strongly typed to {@link CoreEventMap}.
+ * The method signature is type-checked against the event payload. TypeScript will error if
+ * the handler parameter type doesn't match the expected payload for the specified event.
+ *
+ * @param event - Core event name, strongly typed to {@link InternalEventMap}.
  *
  * @example
  * ```ts
  * @Server.Controller()
  * export class SystemController {
- *   @Server.OnFrameworkEvent('server:ready')
- *   onServerReady() {
- *     console.log('OpenCore framework is ready')
+ *   @Server.OnFrameworkEvent('core:playerSessionCreated')
+ *   onPlayerSession(payload: PlayerSessionCreatedPayload) {
+ *     console.log(`Player ${payload.clientId} connected`)
  *   }
  * }
  * ```
  */
-export declare function OnFrameworkEvent<K extends keyof CoreEventMap>(event: K): (target: any, propertyKey: string) => void;
+export declare function OnFrameworkEvent<K extends keyof InternalEventMap>(event: K): (target: object, propertyKey: string | symbol, _descriptor: TypedPropertyDescriptor<FrameworkEventHandler<K>>) => void;
+export {};

package/dist/runtime/server/decorators/onFrameworkEvent.js

@@ -9,21 +9,24 @@ const metadata_server_keys_1 = require("../system/metadata-server.keys");
  * This decorator only stores metadata. The framework binds listeners during bootstrap by scanning
  * controller methods.
  *
- * @param event - Core event name, strongly typed to {@link CoreEventMap}.
+ * The method signature is type-checked against the event payload. TypeScript will error if
+ * the handler parameter type doesn't match the expected payload for the specified event.
+ *
+ * @param event - Core event name, strongly typed to {@link InternalEventMap}.
  *
  * @example
  * ```ts
  * @Server.Controller()
  * export class SystemController {
- *   @Server.OnFrameworkEvent('server:ready')
- *   onServerReady() {
- *     console.log('OpenCore framework is ready')
+ *   @Server.OnFrameworkEvent('core:playerSessionCreated')
+ *   onPlayerSession(payload: PlayerSessionCreatedPayload) {
+ *     console.log(`Player ${payload.clientId} connected`)
  *   }
  * }
  * ```
  */
 function OnFrameworkEvent(event) {
-    return (target, propertyKey) => {
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.CORE_EVENT, { event }, target, propertyKey);
+    return (target, propertyKey, _descriptor) => {
+        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.INTERNAL_EVENT, { event }, target, propertyKey);
     };
 }

package/dist/runtime/server/entities/player.d.ts

@@ -65,6 +65,11 @@ export declare class Player {
      * @returns An array of identifier strings (e.g., `['steam:11000...', 'license:2332...']`).
      */
     getIdentifiers(): string[];
+    /**
+     * FiveM license
+     */
+    getLicense(): string | undefined;
+    getIdentifier(identifier: string): string | undefined;
     /**
      * Sends a network event exclusively to this specific player (Client-side).
      * Wrapper for `emitNet` ensuring the correct target Source ID is used.
@@ -130,6 +135,7 @@ export declare class Player {
      * @param accountID - The unique ID from the database.
      */
     linkAccount(accountID: LinkedID): void;
+    unlinkAccount(): void;
     /**
      * Checks if the player currently possesses a specific state flag.
      *

package/dist/runtime/server/entities/player.js

@@ -67,6 +67,15 @@ class Player {
     getIdentifiers() {
         return this.adapters.playerServer.getIdentifiers(this.clientIDStr);
     }
+    /**
+     * FiveM license
+     */
+    getLicense() {
+        return this.adapters.playerServer.getIdentifier(this.clientIDStr, 'license');
+    }
+    getIdentifier(identifier) {
+        return this.adapters.playerServer.getIdentifier(this.clientIDStr, identifier);
+    }
     /**
      * Sends a network event exclusively to this specific player (Client-side).
      * Wrapper for `emitNet` ensuring the correct target Source ID is used.
@@ -153,6 +162,9 @@ class Player {
     linkAccount(accountID) {
         this.session.accountID = accountID;
     }
+    unlinkAccount() {
+        this.session.accountID = undefined;
+    }
     /**
      * Checks if the player currently possesses a specific state flag.
      *

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

@@ -1,4 +1,5 @@
 export * from './bootstrap.validation';
+export { onFrameworkEvent } from './bus/internal-event.bus';
 export * from './configs';
 export * from './contracts/index';
 export { init } from './core';
@@ -9,4 +10,4 @@ export * from './runtime';
 export * from './services';
 export * from './setup';
 export * from './templates';
-export type * from './types/core-events';
+export type * from './types/internal-events';

package/dist/runtime/server/index.js

@@ -15,8 +15,10 @@ 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.init = void 0;
+exports.init = exports.onFrameworkEvent = void 0;
 __exportStar(require("./bootstrap.validation"), exports);
+var internal_event_bus_1 = require("./bus/internal-event.bus");
+Object.defineProperty(exports, "onFrameworkEvent", { enumerable: true, get: function () { return internal_event_bus_1.onFrameworkEvent; } });
 // Configs
 __exportStar(require("./configs"), exports);
 __exportStar(require("./contracts/index"), exports);

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

@@ -5,7 +5,6 @@ import { IPlayerServer } from '../../../../adapters/contracts/IPlayerServer';
 import { Player } from '../../entities';
 import { PlayerDirectoryPort } from '../ports/player-directory.port';
 import { PlayerSessionLifecyclePort } from '../ports/player-session-lifecycle.port';
-import { LinkedID } from '../types/linked-id';
 import { PlayerSession } from '../types/player-session.object';
 /**
  * Service responsible for managing the lifecycle of player sessions.
@@ -41,16 +40,6 @@ export declare class PlayerService implements PlayerDirectoryPort, PlayerSession
      * @returns The newly created `Player` instance.
      */
     bind(clientID: number, identifiers?: PlayerSession['identifiers']): Player;
-    /**
-     * Associates an authenticated Account ID (database ID) with an active player session.
-     *
-     * Call this method once the player has successfully authenticated (e.g., after character selection
-     * or login) to link their session to their persistent data.
-     *
-     * @param clientID - The FiveM server ID of the player.
-     * @param accountID - The unique identifier from your database/persistence layer.
-     */
-    linkAccount(clientID: number, accountID: LinkedID): void;
     /**
      * Terminates a player session and removes them from the registry.
      *

package/dist/runtime/server/services/core/player.service.js

@@ -70,21 +70,6 @@ let PlayerService = class PlayerService {
         });
         return player;
     }
-    /**
-     * Associates an authenticated Account ID (database ID) with an active player session.
-     *
-     * Call this method once the player has successfully authenticated (e.g., after character selection
-     * or login) to link their session to their persistent data.
-     *
-     * @param clientID - The FiveM server ID of the player.
-     * @param accountID - The unique identifier from your database/persistence layer.
-     */
-    linkAccount(clientID, accountID) {
-        const player = this.playersByClient.get(clientID);
-        if (!player)
-            return;
-        player.linkAccount(accountID);
-    }
     /**
      * Terminates a player session and removes them from the registry.
      *

package/dist/runtime/server/services/ports/player-session-lifecycle.port.d.ts

@@ -1,5 +1,4 @@
 import { Player } from '../../entities';
-import { LinkedID } from '../types/linked-id';
 import { PlayerSession } from '../types/player-session.object';
 /**
  * Core port responsible for managing the lifecycle of player sessions.
@@ -35,15 +34,4 @@ export declare abstract class PlayerSessionLifecyclePort {
      * @param clientID - The FiveM server client ID (`source`).
      */
     abstract unbind(clientID: number): void;
-    /**
-     * Links an authenticated account to an existing player session.
-     *
-     * @remarks
-     * This method is typically invoked after successful authentication or
-     * character selection to associate persistent data with the active session.
-     *
-     * @param clientID - The FiveM server client ID (`source`).
-     * @param accountID - The persistent account identifier.
-     */
-    abstract linkAccount(clientID: number, accountID: LinkedID): void;
 }

package/dist/runtime/server/system/metadata-server.keys.d.ts

@@ -3,7 +3,7 @@ export declare const METADATA_KEYS: {
     COMMAND: string;
     NET_EVENT: string;
     TICK: string;
-    CORE_EVENT: string;
+    INTERNAL_EVENT: string;
     FIVEM_EVENT: string;
     EXPORT: string;
     PUBLIC: string;

package/dist/runtime/server/system/metadata-server.keys.js

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.METADATA_KEYS = void 0;
 exports.METADATA_KEYS = {
-    CONTROLLER: 'core:meta:controller',
-    COMMAND: 'core:meta:command',
-    NET_EVENT: 'core:meta:net_event',
-    TICK: 'core:meta:tick',
-    CORE_EVENT: 'core:meta:core_event',
-    FIVEM_EVENT: 'core:meta:fivem_event',
-    EXPORT: 'core:meta:export',
-    PUBLIC: 'core:meta:public',
-    THROTTLE: 'core:throttle',
-    REQUIRES_STATE: 'core:requires_state',
+    CONTROLLER: 'decorator:meta:controller',
+    COMMAND: 'decorator:meta:command',
+    NET_EVENT: 'decorator:meta:net_event',
+    TICK: 'decorator:meta:tick',
+    INTERNAL_EVENT: 'decorator:meta:internal_event',
+    FIVEM_EVENT: 'decorator:meta:fivem_event',
+    EXPORT: 'decorator:meta:export',
+    PUBLIC: 'decorator:meta:public',
+    THROTTLE: 'decorator:throttle',
+    REQUIRES_STATE: 'decorator:requires_state',
 };

package/dist/runtime/server/system/processors/{coreEvent.processor.d.ts → internalEvent.processor.d.ts}

@@ -1,5 +1,5 @@
 import { DecoratorProcessor } from '../../../../kernel/di/decorator-processor';
-export declare class CoreEventProcessor implements DecoratorProcessor {
+export declare class InternalEventProcessor implements DecoratorProcessor {
     readonly metadataKey: string;
     process(instance: any, methodName: string, metadata: {
         event: string;

package/dist/runtime/server/system/processors/{coreEvent.processor.js → internalEvent.processor.js}

@@ -6,27 +6,27 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoreEventProcessor = void 0;
+exports.InternalEventProcessor = void 0;
 const tsyringe_1 = require("tsyringe");
 const logger_1 = require("../../../../kernel/shared/logger");
-const core_event_bus_1 = require("../../bus/core-event-bus");
+const internal_event_bus_1 = require("../../bus/internal-event.bus");
 const resolve_method_1 = require("../../helpers/resolve-method");
 const metadata_server_keys_1 = require("../metadata-server.keys");
-let CoreEventProcessor = class CoreEventProcessor {
+let InternalEventProcessor = class InternalEventProcessor {
     constructor() {
-        this.metadataKey = metadata_server_keys_1.METADATA_KEYS.CORE_EVENT;
+        this.metadataKey = metadata_server_keys_1.METADATA_KEYS.INTERNAL_EVENT;
     }
     process(instance, methodName, metadata) {
-        const result = (0, resolve_method_1.resolveMethod)(instance, methodName, `[CoreEventProcessor] Method "${methodName}" not found`);
+        const result = (0, resolve_method_1.resolveMethod)(instance, methodName, `[InternalEventProcessor] Method "${methodName}" not found`);
         if (!result)
             return;
         const { handler, handlerName } = result;
-        (0, core_event_bus_1.onFrameworkEvent)(metadata.event, (payload) => {
+        (0, internal_event_bus_1.onFrameworkEvent)(metadata.event, (payload) => {
             try {
                 handler(payload);
             }
             catch (error) {
-                logger_1.loggers.eventBus.error(`Handler error in CoreEvent`, {
+                logger_1.loggers.eventBus.error(`Handler error in InternalEvent`, {
                     event: metadata.event,
                     handler: handlerName,
                 }, error);
@@ -35,7 +35,7 @@ let CoreEventProcessor = class CoreEventProcessor {
         logger_1.loggers.eventBus.debug(`Registered: ${metadata.event} -> ${handlerName}`);
     }
 };
-exports.CoreEventProcessor = CoreEventProcessor;
-exports.CoreEventProcessor = CoreEventProcessor = __decorate([
+exports.InternalEventProcessor = InternalEventProcessor;
+exports.InternalEventProcessor = InternalEventProcessor = __decorate([
     (0, tsyringe_1.injectable)()
-], CoreEventProcessor);
+], InternalEventProcessor);

package/dist/runtime/server/system/processors.register.js

@@ -7,9 +7,9 @@ const security_handler_contract_1 = require("../contracts/security/security-hand
 const default_net_event_security_observer_1 = require("../services/default/default-net-event-security-observer");
 const default_security_handler_1 = require("../services/default/default-security.handler");
 const command_processor_1 = require("./processors/command.processor");
-const coreEvent_processor_1 = require("./processors/coreEvent.processor");
 const export_processor_1 = require("./processors/export.processor");
 const fivemEvent_processor_1 = require("./processors/fivemEvent.processor");
+const internalEvent_processor_1 = require("./processors/internalEvent.processor");
 const netEvent_processor_1 = require("./processors/netEvent.processor");
 const tick_processor_1 = require("./processors/tick.processor");
 function registerSystemServer(ctx) {
@@ -27,7 +27,7 @@ function registerSystemServer(ctx) {
     if (features.exports.enabled) {
         index_1.di.register('DecoratorProcessor', { useClass: export_processor_1.ExportProcessor });
     }
-    index_1.di.register('DecoratorProcessor', { useClass: coreEvent_processor_1.CoreEventProcessor });
+    index_1.di.register('DecoratorProcessor', { useClass: internalEvent_processor_1.InternalEventProcessor });
     if (features.commands.enabled) {
         index_1.di.register('DecoratorProcessor', { useClass: command_processor_1.CommandProcessor });
     }

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

@@ -1,4 +1,4 @@
-export * from './core-events';
 export * from './core-exports';
+export * from './internal-events';
 export * from './security.types';
 export * from './vehicle.types';

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

@@ -14,7 +14,7 @@ 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("./core-events"), exports);
 __exportStar(require("./core-exports"), exports);
+__exportStar(require("./internal-events"), exports);
 __exportStar(require("./security.types"), exports);
 __exportStar(require("./vehicle.types"), exports);

package/dist/runtime/server/types/internal-events.d.ts

@@ -0,0 +1,19 @@
+import { Player } from '../entities';
+export interface PlayerSessionCreatedPayload {
+    clientId: number;
+    license: string;
+}
+export interface PlayerSessionDestroyedPayload {
+    clientId: number;
+}
+export interface TransferCompletedPayload {
+    playerId: number;
+    amount: number;
+    targetId: number;
+}
+export type InternalEventMap = {
+    'internal:playerSessionCreated': PlayerSessionCreatedPayload;
+    'internal:playerSessionDestroyed': PlayerSessionDestroyedPayload;
+    'internal:transfer:completed': TransferCompletedPayload;
+    'internal:playerFullyConnected': Player;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-core/framework",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Secure, Event-Driven, OOP Engine for FiveM. Stop scripting, start engineering.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/runtime/server/bus/core-event-bus.d.ts

@@ -1,6 +0,0 @@
-import { CoreEventMap } from '../types/core-events';
-type CoreEventName = keyof CoreEventMap;
-type CoreEventHandler<E extends CoreEventName> = (payload: CoreEventMap[E]) => void;
-export declare function onFrameworkEvent<E extends CoreEventName>(event: E, handler: CoreEventHandler<E>): () => void;
-export declare function emitFrameworkEvent<E extends CoreEventName>(event: E, payload: CoreEventMap[E]): void;
-export {};

package/dist/runtime/server/types/core-events.d.ts

@@ -1,22 +0,0 @@
-export interface PlayerSessionCreatedPayload {
-    clientId: number;
-    license: string;
-}
-export interface PlayerSessionDestroyedPayload {
-    clientId: number;
-}
-export interface TransferCompletedPayload {
-    playerId: number;
-    amount: number;
-    targetId: number;
-}
-export interface PlayerFullyConnectedPayload {
-    clientId: number;
-    license: string;
-}
-export type CoreEventMap = {
-    'core:playerSessionCreated': PlayerSessionCreatedPayload;
-    'core:playerSessionDestroyed': PlayerSessionDestroyedPayload;
-    'core:transfer:completed': TransferCompletedPayload;
-    'core:playerFullyConnected': PlayerFullyConnectedPayload;
-};