@open-core/framework 1.0.1-beta.1 → 1.0.4-beta.1

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

@@ -10,8 +10,13 @@ export interface TransferCompletedPayload {
     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;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-core/framework",
-  "version": "1.0.1-beta.1",
+  "version": "1.0.4-beta.1",
   "description": "Secure, Event-Driven, OOP Engine for FiveM. Stop scripting, start engineering.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,6 +18,34 @@
     "README.md",
     "LICENSE"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js",
+      "require": "./dist/server/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.js"
+    },
+    "./shared": {
+      "types": "./dist/shared/index.d.ts",
+      "import": "./dist/shared/index.js",
+      "require": "./dist/shared/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "watch": "tsc -p tsconfig.build.json --watch",

package/dist/client/loaders/exports.loader.d.ts

@@ -1 +0,0 @@
-export declare const loadClientExports: () => void;

package/dist/client/loaders/exports.loader.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadClientExports = void 0;
-const logger_1 = require("../../shared/logger");
-const clientExports = logger_1.coreLogger.child('Exports', logger_1.LogDomain.CLIENT);
-const loadClientExports = () => {
-    exports('core:sendcommand', (commandName, args = []) => {
-        const rawCommand = `/${commandName} ${args.join(' ')}`;
-        emitNet('core:internal:executeCommand', commandName, args, rawCommand);
-    });
-    clientExports.debug('Client exports loaded: SendCommand');
-};
-exports.loadClientExports = loadClientExports;

package/dist/client/services/core/index.d.ts

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

package/dist/client/services/core/index.js

@@ -1,17 +0,0 @@
-"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("./spawn.service"), exports);

package/dist/client/services/core/spawn.service.d.ts

@@ -1,20 +0,0 @@
-import { Vector3 } from '../../../utils';
-export declare class Spawner {
-    private spawned;
-    init(): Promise<void>;
-    handleSpawn(data: {
-        position: Vector3;
-        model: string;
-    }): Promise<void>;
-    handleRespawn(position: Vector3, heading?: number): Promise<void>;
-    handleTeleport(position: Vector3, heading?: number): Promise<void>;
-    spawn(position: Vector3, model: string, heading?: number): Promise<void>;
-    teleportTo(position: Vector3, heading?: number): Promise<void>;
-    respawn(position: Vector3, heading?: number): Promise<void>;
-    isSpawned(): boolean;
-    private ensureNetworkReady;
-    private closeLoadingScreens;
-    private setPlayerModel;
-    private ensurePed;
-    private placePed;
-}

package/dist/client/services/core/spawn.service.js

@@ -1,143 +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) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Spawner = void 0;
-const tsyringe_1 = require("tsyringe");
-const onNet_1 = require("../../decorators/onNet");
-const logger_1 = require("../../../shared/logger");
-const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-let Spawner = class Spawner {
-    constructor() {
-        this.spawned = false;
-    }
-    async init() {
-        logger_1.loggers.spawn.debug('SpawnService initialized');
-    }
-    async handleSpawn(data) {
-        await this.spawn(data.position, data.model);
-    }
-    async handleRespawn(position, heading = 0.0) {
-        await this.respawn(position, heading);
-    }
-    async handleTeleport(position, heading) {
-        await this.teleportTo(position, heading);
-    }
-    async spawn(position, model, heading = 0.0) {
-        logger_1.loggers.spawn.info('First spawn requested', {
-            position: { x: position.x, y: position.y, z: position.z },
-            model,
-        });
-        await this.ensureNetworkReady();
-        this.closeLoadingScreens();
-        await this.setPlayerModel(model);
-        const ped = await this.ensurePed();
-        await this.placePed(ped, position, heading);
-        this.spawned = true;
-        logger_1.loggers.spawn.info('Player spawned successfully (first spawn)');
-    }
-    async teleportTo(position, heading) {
-        const ped = await this.ensurePed();
-        FreezeEntityPosition(ped, true);
-        SetEntityCoordsNoOffset(ped, position.x, position.y, position.z, false, false, false);
-        if (heading !== undefined) {
-            SetEntityHeading(ped, heading);
-        }
-        FreezeEntityPosition(ped, false);
-        logger_1.loggers.spawn.debug('Teleported', {
-            position: { x: position.x, y: position.y, z: position.z },
-        });
-    }
-    async respawn(position, heading = 0.0) {
-        const ped = await this.ensurePed();
-        ClearPedTasksImmediately(ped);
-        SetEntityHealth(ped, GetEntityMaxHealth(ped));
-        await this.teleportTo(position, heading);
-        logger_1.loggers.spawn.info('Player respawned', {
-            position: { x: position.x, y: position.y, z: position.z },
-        });
-    }
-    isSpawned() {
-        return this.spawned;
-    }
-    async ensureNetworkReady() {
-        while (!NetworkIsSessionStarted()) {
-            await delay(0);
-        }
-    }
-    closeLoadingScreens() {
-        try {
-            ShutdownLoadingScreen();
-        }
-        catch (_a) { }
-        try {
-            ShutdownLoadingScreenNui();
-        }
-        catch (_b) { }
-    }
-    async setPlayerModel(model) {
-        const modelHash = GetHashKey(model);
-        if (!IsModelInCdimage(modelHash) || !IsModelValid(modelHash)) {
-            logger_1.loggers.spawn.error(`Invalid model requested`, { model });
-            throw new Error('MODEL_INVALID');
-        }
-        RequestModel(modelHash);
-        while (!HasModelLoaded(modelHash)) {
-            await delay(0);
-        }
-        SetPlayerModel(PlayerId(), modelHash);
-        SetModelAsNoLongerNeeded(modelHash);
-    }
-    async ensurePed() {
-        let ped = PlayerPedId();
-        while (ped === 0) {
-            await delay(0);
-            ped = PlayerPedId();
-        }
-        return ped;
-    }
-    async placePed(ped, position, heading) {
-        FreezeEntityPosition(ped, true);
-        SetEntityCoordsNoOffset(ped, position.x, position.y, position.z, false, false, false);
-        SetEntityHeading(ped, heading);
-        ResetEntityAlpha(ped);
-        SetEntityVisible(ped, true, false);
-        SetEntityCollision(ped, true, true);
-        SetEntityInvincible(ped, false);
-        ClearPedTasksImmediately(ped);
-        RemoveAllPedWeapons(ped, true);
-        FreezeEntityPosition(ped, false);
-        if (!IsScreenFadedIn() && !IsScreenFadingIn()) {
-            DoScreenFadeIn(500);
-        }
-    }
-};
-exports.Spawner = Spawner;
-__decorate([
-    (0, onNet_1.OnNet)('core:spawner:spawn'),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", Promise)
-], Spawner.prototype, "handleSpawn", null);
-__decorate([
-    (0, onNet_1.OnNet)('core:spawner:respawn'),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object, Object]),
-    __metadata("design:returntype", Promise)
-], Spawner.prototype, "handleRespawn", null);
-__decorate([
-    (0, onNet_1.OnNet)('core:spawner:teleport'),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object, Number]),
-    __metadata("design:returntype", Promise)
-], Spawner.prototype, "handleTeleport", null);
-exports.Spawner = Spawner = __decorate([
-    (0, tsyringe_1.injectable)()
-], Spawner);

package/dist/client/services/streaming/index.d.ts

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

package/dist/client/services/streaming/index.js

@@ -1,17 +0,0 @@
-"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("./streaming.service"), exports);

package/dist/client/services/ui/index.d.ts

@@ -1,3 +0,0 @@
-export * from './notification.service';
-export * from './textui.service';
-export * from './progress.service';

package/dist/client/services/ui/index.js

@@ -1,19 +0,0 @@
-"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("./notification.service"), exports);
-__exportStar(require("./textui.service"), exports);
-__exportStar(require("./progress.service"), exports);

package/dist/client/services/world/index.d.ts

@@ -1,4 +0,0 @@
-export * from './marker.service';
-export * from './blip.service';
-export * from './vehicle.service';
-export * from './ped.service';

package/dist/client/services/world/index.js

@@ -1,20 +0,0 @@
-"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("./marker.service"), exports);
-__exportStar(require("./blip.service"), exports);
-__exportStar(require("./vehicle.service"), exports);
-__exportStar(require("./ped.service"), exports);

package/dist/server/decorators/coreEvent.d.ts

@@ -1,2 +0,0 @@
-import type { CoreEventMap } from '../types/core-events';
-export declare function OnCoreEvent<K extends keyof CoreEventMap>(event: K): (target: any, propertyKey: string) => void;

package/dist/server/decorators/netEvent.d.ts

@@ -1,36 +0,0 @@
-import type { z } from 'zod';
-export interface NetEventOptions {
-    eventName: string;
-    schema?: z.ZodType;
-}
-/**
- * Decorator used to register a server-side NetEvent handler.
- *
- * ## Player Injection
- * The handler method will **always receive a `ServerPlayer` instance as its
- * first argument**, automatically resolved by the Core based on the client
- * that triggered the event.
- *
- * This means you do NOT need to read `source`, `global.source` or call
- * `GetPlayerIdentifier()`: the Core resolves the player for you.
- *
- * ## Example
- * ```ts
- * export class AuthServerController {
- *   @OnNet('auth:loginAttempt')
- *   handleLogin(player: ServerPlayer, username: string, password: string) {
- *     console.log(player.name, 'is trying to log in');
- *   }
- * }
- * ```
- *
- * ## Event Arguments
- * Any arguments sent from the client will be passed **after** the `ServerPlayer`
- * instance:
- *
- * client → emitNet("auth:loginAttempt", username, password)
- * server → handler(player, username, password)
- *
- * @param eventName - The name of the network event to listen for.
- */
-export declare function OnNet(eventName: string, schema?: z.ZodType): (target: any, propertyKey: string) => void;

package/dist/server/decorators/netEvent.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnNet = OnNet;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * Decorator used to register a server-side NetEvent handler.
- *
- * ## Player Injection
- * The handler method will **always receive a `ServerPlayer` instance as its
- * first argument**, automatically resolved by the Core based on the client
- * that triggered the event.
- *
- * This means you do NOT need to read `source`, `global.source` or call
- * `GetPlayerIdentifier()`: the Core resolves the player for you.
- *
- * ## Example
- * ```ts
- * export class AuthServerController {
- *   @OnNet('auth:loginAttempt')
- *   handleLogin(player: ServerPlayer, username: string, password: string) {
- *     console.log(player.name, 'is trying to log in');
- *   }
- * }
- * ```
- *
- * ## Event Arguments
- * Any arguments sent from the client will be passed **after** the `ServerPlayer`
- * instance:
- *
- * client → emitNet("auth:loginAttempt", username, password)
- * server → handler(player, username, password)
- *
- * @param eventName - The name of the network event to listen for.
- */
-function OnNet(eventName, schema) {
-    return (target, propertyKey) => {
-        const metadata = { eventName, schema };
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.NET_EVENT, metadata, target, propertyKey);
-    };
-}