@open-core/framework 0.1.0-alpha.1 → 0.2.1-beta.1

package/dist/server/database/index.js

@@ -1,70 +0,0 @@
-"use strict";
-/**
- * Database Module
- *
- * Provides a flexible database abstraction layer with pluggable adapters.
- * Uses oxmysql by default for FiveM environments.
- *
- * @example
- * ```typescript
- * import {
- *   DatabaseService,
- *   initDatabase,
- *   query,
- *   single,
- *   transaction,
- * } from '@open-core/framework/server'
- *
- * // Option 1: Use standalone functions
- * initDatabase()
- * const users = await query<User>('SELECT * FROM users')
- *
- * // Option 2: Use DI
- * @injectable()
- * class UserService {
- *   constructor(@inject(DatabaseService) private db: DatabaseService) {}
- *
- *   async findUser(id: number) {
- *     return this.db.single<User>('SELECT * FROM users WHERE id = ?', [id])
- *   }
- * }
- *
- * // Option 3: Use transactions (specific format)
- * const success = await transaction([
- *   { query: 'INSERT INTO orders (user_id) VALUES (?)', values: [userId] },
- *   { query: 'INSERT INTO order_items (order_id, product_id) VALUES (?, ?)', values: [orderId, productId] },
- * ])
- *
- * // Option 4: Use transactions (shared params format)
- * const success = await transaction(
- *   [
- *     'INSERT INTO orders (user_id) VALUES (@userid)',
- *     'UPDATE users SET order_count = order_count + 1 WHERE id = @userid',
- *   ],
- *   { userid: userId }
- * )
- * ```
- *
- * @see https://coxdocs.dev/oxmysql/Functions/transaction
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OxMySQLAdapter = exports.transaction = exports.insert = exports.execute = exports.scalar = exports.single = exports.query = exports.initDatabase = exports.getDatabaseService = exports.DatabaseService = exports.DatabaseContract = void 0;
-// Contract
-var database_contract_1 = require("./database.contract");
-Object.defineProperty(exports, "DatabaseContract", { enumerable: true, get: function () { return database_contract_1.DatabaseContract; } });
-// Service
-var database_service_1 = require("./database.service");
-Object.defineProperty(exports, "DatabaseService", { enumerable: true, get: function () { return database_service_1.DatabaseService; } });
-// Standalone functions
-var database_service_2 = require("./database.service");
-Object.defineProperty(exports, "getDatabaseService", { enumerable: true, get: function () { return database_service_2.getDatabaseService; } });
-Object.defineProperty(exports, "initDatabase", { enumerable: true, get: function () { return database_service_2.initDatabase; } });
-Object.defineProperty(exports, "query", { enumerable: true, get: function () { return database_service_2.query; } });
-Object.defineProperty(exports, "single", { enumerable: true, get: function () { return database_service_2.single; } });
-Object.defineProperty(exports, "scalar", { enumerable: true, get: function () { return database_service_2.scalar; } });
-Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return database_service_2.execute; } });
-Object.defineProperty(exports, "insert", { enumerable: true, get: function () { return database_service_2.insert; } });
-Object.defineProperty(exports, "transaction", { enumerable: true, get: function () { return database_service_2.transaction; } });
-// Adapters
-var oxmysql_adapter_1 = require("./adapters/oxmysql.adapter");
-Object.defineProperty(exports, "OxMySQLAdapter", { enumerable: true, get: function () { return oxmysql_adapter_1.OxMySQLAdapter; } });

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

@@ -1,2 +0,0 @@
-export type BindingScope = 'singleton' | 'transient';
-export declare function Bind(scope?: BindingScope): (target: any) => void;

package/dist/server/decorators/bind.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Bind = Bind;
-const tsyringe_1 = require("tsyringe");
-function Bind(scope = 'singleton') {
-    return function (target) {
-        (0, tsyringe_1.injectable)()(target);
-        if (scope === 'singleton') {
-            (0, tsyringe_1.singleton)()(target);
-        }
-        else {
-            (0, tsyringe_1.scoped)(tsyringe_1.Lifecycle.ResolutionScoped)(target);
-        }
-    };
-}

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

@@ -1,49 +0,0 @@
-import type { ClassConstructor } from '../../system/class-constructor';
-import type z from 'zod';
-import type { Player } from '../entities/player';
-export interface CommandConfig {
-    /**
-     * The command name (e.g. "revive", "deposit"), used in chat "/revive"
-     */
-    command: string;
-    /**
-     * The command description, maybe "/help revive"
-     */
-    description?: string;
-    /**
-     * The command usage, maybe "/revive <player>"
-     */
-    usage?: string;
-    /**
-     * The command schema, used to validate the arguments, validated with zod
-     * @example
-     * ```ts
-     * Server.Command({
-     *   command: 'revive',
-     *   schema: z.object({
-     *     player: z.string(),
-     *   }),
-     * })
-     * ```
-     */
-    schema?: z.ZodType;
-}
-export interface CommandMetadata extends CommandConfig {
-    methodName: string;
-    target: ClassConstructor;
-    paramTypes?: any;
-}
-type ServerCommandHandler = (player: Player, ...args: any[]) => any;
-/**
- * Decorator used to mark a controller method as a command.
- * This method will be registered and then executed by the command service.
- * It will depend on the chat you have implemented following the dependency conventions.
- *
- * @param configOrName - The command name (e.g. "revive", "deposit")
- * @validation zod schema
- * @handlerSignature ```ts
- *  (player: Server.Player, args: any[]) => any
- * ```
- */
-export declare function Command(configOrName: string | CommandConfig): <T extends ServerCommandHandler>(target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<T>) => void;
-export {};

package/dist/server/decorators/command.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = Command;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * Decorator used to mark a controller method as a command.
- * This method will be registered and then executed by the command service.
- * It will depend on the chat you have implemented following the dependency conventions.
- *
- * @param configOrName - The command name (e.g. "revive", "deposit")
- * @validation zod schema
- * @handlerSignature ```ts
- *  (player: Server.Player, args: any[]) => any
- * ```
- */
-function Command(configOrName) {
-    return (target, propertyKey, descriptor) => {
-        const config = typeof configOrName === 'string' ? { command: configOrName } : configOrName;
-        const paramTypes = Reflect.getMetadata('design:paramtypes', target, propertyKey);
-        const metadata = Object.assign(Object.assign({}, config), { methodName: propertyKey, target: target.constructor, paramTypes });
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.COMMAND, metadata, target, propertyKey);
-    };
-}

package/dist/server/decorators/controller.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serverControllerRegistry = void 0;
-exports.Controller = Controller;
-const tsyringe_1 = require("tsyringe");
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-exports.serverControllerRegistry = [];
-/**
- * Class decorator used to mark a class as a Server Controller.
- *
- * This decorator performs the following actions:
- * 1. Marks the class as `@injectable` (via tsyringe) for dependency injection.
- * 2. Defines metadata identifying the class as a 'server' type controller.
- * 3. Automatically adds the class constructor to the `serverControllerRegistry`.
- *
- * @returns The decorator function to apply to the class.
- *
- * @example
- * ```ts
- * import { Controller } from '@core/server/decorators'
- *
- * @Server.Controller()
- * export class PlayerController {
- *   constructor(private playerService: PlayerService) {
- *     // Dependency injection works automatically here
- *   }
- * }
- * ```
- */
-function Controller() {
-    return function (target) {
-        (0, tsyringe_1.injectable)()(target);
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.CONTROLLER, { type: 'server' }, target);
-        exports.serverControllerRegistry.push(target);
-    };
-}

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

@@ -1,39 +0,0 @@
-/**
- * Export
- * -----------------------------------------
- * Declares a method as an externally accessible export
- * within the FiveM environment.
- *
- * Methods decorated with `@Export()` are automatically
- * registered by the framework and exposed as native
- * FXServer exports, allowing other resources to call them
- * using:
- *
- *   exports.resourceName.exportName(...)
- *
- * This decorator is typically used inside controller
- * classes, where the framework’s module loader inspects
- * metadata to register commands, events and exports
- * consistently.
- *
- * @param name Optional name to expose. If omitted,
- *             the method name is used.
- *
- * ```ts
- * @Server.Controller()
- * export class AccountController {
- *   @Server.Export('getAccountById')
- *   getAccount(id: string) {
- *     return this.accountService.find(id)
- *   }
- * }
- *
- * // From another resource:
- * // const result = exports['core-resource'].getAccountById('1234')
- *```
- * Internally, this decorator stores metadata used by
- * the server bootstrap to automatically register the
- * export through FXServer's `global.exports` API.
- *
- */
-export declare function Export(name?: string): (target: any, propertyKey: string) => void;

package/dist/server/decorators/export.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Export = Export;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * Export
- * -----------------------------------------
- * Declares a method as an externally accessible export
- * within the FiveM environment.
- *
- * Methods decorated with `@Export()` are automatically
- * registered by the framework and exposed as native
- * FXServer exports, allowing other resources to call them
- * using:
- *
- *   exports.resourceName.exportName(...)
- *
- * This decorator is typically used inside controller
- * classes, where the framework’s module loader inspects
- * metadata to register commands, events and exports
- * consistently.
- *
- * @param name Optional name to expose. If omitted,
- *             the method name is used.
- *
- * ```ts
- * @Server.Controller()
- * export class AccountController {
- *   @Server.Export('getAccountById')
- *   getAccount(id: string) {
- *     return this.accountService.find(id)
- *   }
- * }
- *
- * // From another resource:
- * // const result = exports['core-resource'].getAccountById('1234')
- *```
- * Internally, this decorator stores metadata used by
- * the server bootstrap to automatically register the
- * export through FXServer's `global.exports` API.
- *
- */
-function Export(name) {
-    return (target, propertyKey) => {
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.EXPORT, { exportName: name || propertyKey }, target, propertyKey);
-    };
-}

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

@@ -1,56 +0,0 @@
-export interface GuardOptions {
-    /**
-     * Minimum rank required to execute the method.
-     * Permissions and Role/Ranks are defined by your Principal Controller
-     */
-    rank?: number;
-    /**
-     * Permission required to execute the method.
-     * Permissions and Role/Ranks are defined by your Principal Controller
-     */
-    permission?: string;
-}
-/**
- * Guard
- * ------------------------------------------------------------
- * Declarative access-control decorator for controller methods.
- *
- * `@Guard()` protects a method by enforcing rank and/or
- * permission requirements before executing it.
- *
- * Requirements are evaluated through the AccessControlService,
- * which determines whether the player (first argument of the
- * method) is authorized to perform the action.
- *
- * Usage of this decorator allows you to express authorization
- * rules directly at the controller level, promoting a clean
- * and explicit security model.
- *
- * @param options GuardOptions
- *   - rank: minimum rank required to execute the method.
- *   - permission: specific permission required.
- *
- * Notes:
- * - The decorated method must receive a `Server.Player`
- *   instance as its first argument.
- * - When compiling improperly (e.g., benchmarks, stripped
- *   decorators), the PropertyDescriptor may be missing.
- *   In that case, only metadata is recorded and execution
- *   fallback is disabled. This should *never* occur in a
- *   production environment.
- *
- * ```ts
- * export class FactionController {
- *   @Server.Guard({ permission: 'factions.manage' })
- *   async createFaction(player: Player, dto: CreateFactionDTO) {
- *     return this.service.create(dto)
- *   }
- *
- *   @Server.Guard({ rank: 3 })
- *   async promoteMember(player: Player, memberID: string) {
- *     return this.service.promote(player, memberID)
- *   }
- * }
- * ```
- */
-export declare function Guard(options: GuardOptions): (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => PropertyDescriptor | undefined;

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

@@ -1,6 +0,0 @@
-/**
- * Listen to FiveM events server-side, check the list below
- *
- * https://docs.fivem.net/docs/scripting-reference/events/server-events/
- */
-export declare function OnFiveMEvent(event: string): (target: any, propertyKey: string) => void;

package/dist/server/decorators/onFiveMEvent.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnFiveMEvent = OnFiveMEvent;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * Listen to FiveM events server-side, check the list below
- *
- * https://docs.fivem.net/docs/scripting-reference/events/server-events/
- */
-function OnFiveMEvent(event) {
-    return (target, propertyKey) => {
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.FIVEM_EVENT, { event }, target, propertyKey);
-    };
-}

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

@@ -1,22 +0,0 @@
-import type { CoreEventMap } from '../types/core-events';
-/**
- * Method decorator used to register a method as a listener for an internal OpenCore framework event.
- *
- * When the specified framework event is emitted, this method will be automatically triggered
- * with the arguments provided by the event payload.
- *
- * @param event - The name of the core event to listen for (typed strictly to `CoreEventMap`).
- *
- *
- * ```ts
- * @Server.Controller()
- * export class SystemController {
- *
- *   @OnFrameworkEvent('server:ready')
- *   public onServerStart() {
- *     console.log('OpenCore Framework is ready!')
- *   }
- * }
- * ```
- */
-export declare function OnFrameworkEvent<K extends keyof CoreEventMap>(event: K): (target: any, propertyKey: string) => void;

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

@@ -1,58 +0,0 @@
-import type { z } from 'zod';
-import type { Player } from '../entities/player';
-export interface NetEventOptions {
-    eventName: string;
-    schema?: z.ZodType;
-    paramTypes?: any;
-}
-type ServerNetHandler<TArgs extends any[] = any[]> = (player: Player, ...args: TArgs) => any;
-/**
- * Registers a server-side network event handler.
- *
- * The decorated method is invoked when the client triggers
- * `emitNet(eventName, ...)`.
- *
- * ## Player Injection
- * The first argument of the handler **must be `Player`** and is automatically
- * replaced with a `Server.Player` instance representing the client that
- * fired the event. You do NOT need to read `source` manually.
- *
- * ## Auto-Validation
- * Arguments after `Player` are automatically validated based on their TypeScript types:
- * - `string` → `z.string()`
- * - `number` → `z.number()`
- * - `boolean` → `z.boolean()`
- * - `any[]` → `z.array(z.any())` (array content not validated)
- *
- * ## Explicit Schema (Advanced)
- * For stricter validation (ranges, formats, nested objects), provide a Zod schema:
- *
- * @example Auto-validation (simple)
- * ```ts
- * @OnNet("auth:login")
- * handleLogin(player: Player, username: string, password: string) {
- *   // username and password are validated as strings automatically
- * }
- * ```
- *
- * @example Explicit schema (strict validation)
- * ```ts
- * const transferSchema = z.object({
- *   targetId: z.number().positive(),
- *   amount: z.number().min(1).max(1000000),
- * })
- *
- * @OnNet("bank:transfer", { schema: transferSchema })
- * handleTransfer(player: Player, data: z.infer<typeof transferSchema>) {
- *   // data.amount is guaranteed to be between 1 and 1,000,000
- * }
- * ```
- *
- * @param eventName - The network event name to listen for.
- * @param options - Optional configuration object.
- * @param options.schema - Zod schema for strict payload validation.
- */
-export declare function OnNet<TArgs extends any[]>(eventName: string, options?: {
-    schema?: z.ZodType;
-}): <H extends ServerNetHandler<TArgs>>(target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<H>) => void;
-export {};

package/dist/server/decorators/onNet.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnNet = OnNet;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * Registers a server-side network event handler.
- *
- * The decorated method is invoked when the client triggers
- * `emitNet(eventName, ...)`.
- *
- * ## Player Injection
- * The first argument of the handler **must be `Player`** and is automatically
- * replaced with a `Server.Player` instance representing the client that
- * fired the event. You do NOT need to read `source` manually.
- *
- * ## Auto-Validation
- * Arguments after `Player` are automatically validated based on their TypeScript types:
- * - `string` → `z.string()`
- * - `number` → `z.number()`
- * - `boolean` → `z.boolean()`
- * - `any[]` → `z.array(z.any())` (array content not validated)
- *
- * ## Explicit Schema (Advanced)
- * For stricter validation (ranges, formats, nested objects), provide a Zod schema:
- *
- * @example Auto-validation (simple)
- * ```ts
- * @OnNet("auth:login")
- * handleLogin(player: Player, username: string, password: string) {
- *   // username and password are validated as strings automatically
- * }
- * ```
- *
- * @example Explicit schema (strict validation)
- * ```ts
- * const transferSchema = z.object({
- *   targetId: z.number().positive(),
- *   amount: z.number().min(1).max(1000000),
- * })
- *
- * @OnNet("bank:transfer", { schema: transferSchema })
- * handleTransfer(player: Player, data: z.infer<typeof transferSchema>) {
- *   // data.amount is guaranteed to be between 1 and 1,000,000
- * }
- * ```
- *
- * @param eventName - The network event name to listen for.
- * @param options - Optional configuration object.
- * @param options.schema - Zod schema for strict payload validation.
- */
-function OnNet(eventName, options) {
-    return (target, propertyKey, descriptor) => {
-        const paramTypes = Reflect.getMetadata('design:paramtypes', target, propertyKey);
-        const metadata = { eventName, schema: options === null || options === void 0 ? void 0 : options.schema, paramTypes };
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.NET_EVENT, metadata, target, propertyKey);
-    };
-}

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

@@ -1,32 +0,0 @@
-/**
- * OnTick
- * ------------------------------------------------------------
- * Marks a method to be executed on every server tick.
- *
- * Methods decorated with `@OnTick()` are automatically
- * registered by the framework's scheduler and invoked on each
- * FXServer tick (~ every 0–10 ms depending on workload).
- *
- * This decorator should be used for lightweight recurring
- * logic: status updates, background checks, cleanup tasks,
- * or time-based processes relevant to gameplay.
- *
- * Heavy or blocking operations should be avoided inside tick
- * handlers, as they directly impact global server performance.
- *
- * ```ts
- * export class SyncController {
- *   @OnTick()
- *   updatePlayers() {
- *     // Runs every tick
- *     this.service.syncPositions()
- *   }
- * }
- *
- * ```
- *
- * Internally, the decorator only stores metadata. The
- * server bootstrap scans for this metadata and binds the
- * method to FiveM's tick cycle.
- */
-export declare function OnTick(): (target: any, propertyKey: string) => void;

package/dist/server/decorators/onTick.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnTick = OnTick;
-const metadata_server_keys_1 = require("../system/metadata-server.keys");
-/**
- * OnTick
- * ------------------------------------------------------------
- * Marks a method to be executed on every server tick.
- *
- * Methods decorated with `@OnTick()` are automatically
- * registered by the framework's scheduler and invoked on each
- * FXServer tick (~ every 0–10 ms depending on workload).
- *
- * This decorator should be used for lightweight recurring
- * logic: status updates, background checks, cleanup tasks,
- * or time-based processes relevant to gameplay.
- *
- * Heavy or blocking operations should be avoided inside tick
- * handlers, as they directly impact global server performance.
- *
- * ```ts
- * export class SyncController {
- *   @OnTick()
- *   updatePlayers() {
- *     // Runs every tick
- *     this.service.syncPositions()
- *   }
- * }
- *
- * ```
- *
- * Internally, the decorator only stores metadata. The
- * server bootstrap scans for this metadata and binds the
- * method to FiveM's tick cycle.
- */
-function OnTick() {
-    return (target, propertyKey) => {
-        Reflect.defineMetadata(metadata_server_keys_1.METADATA_KEYS.TICK, {}, target, propertyKey);
-    };
-}

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

@@ -1,27 +0,0 @@
-/**
- * Marks a server-side NetEvent handler as publicly accessible.
- *
- * This decorator disables authentication requirements for the
- * decorated method. It should only be applied to endpoints used for:
- * - Login
- * - Registration
- * - Public information retrieval
- *
- * ## Security Warning
- * This decorator must be used with caution. Public endpoints must NOT
- * modify sensitive game state unless necessary.
- *
- * ## Example
- * ```ts
- * class AuthServerController {
- *   @Public()
- *   @OnNet("auth:login")
- *   async login(player: Server.Player, credentials: AuthCredentials) {
- *     // no authentication required for this event
- *   }
- * }
- * ```
- *
- * @returns Method decorator that marks a handler as unauthenticated.
- */
-export declare function Public(): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/server/decorators/requiresState.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiresState = RequiresState;
-const utils_1 = require("../../utils");
-/**
- * Enforces gameplay state requirements before executing a method.
- *
- * The decorator intercepts the method call and verifies whether
- * the player satisfies required state flags (e.g. "dead", "cuffed",
- * "on_duty_police").
- *
- * ## Whitelist (`has`)
- * The player MUST have *all* required states. Missing any state blocks execution.
- *
- * ## Blacklist (`missing`)
- * The player MUST NOT have any of the forbidden states.
- *
- * ## Error Handling
- * - Throws a normal Error if the method is called without a valid Player.
- * - Throws an `AppError(GAME_STATE_ERROR)` if validation fails.
- *
- * ## Example
- * ```ts
- * @RequiresState({ missing: ["dead", "cuffed"] })
- * openInventory(player: Server.Player) { ... }
- *
- * @RequiresState({
- *   has: ["police_duty"],
- *   missing: ["dead"],
- *   errorMessage: "You must be on duty to access the armory."
- * })
- * openArmory(player: Server.Player) { ... }
- * ```
- *
- * @param req - State validation configuration.
- */
-function RequiresState(req) {
-    return function (target, propertyKey, descriptor) {
-        const originalMethod = descriptor.value;
-        descriptor.value = async function (...args) {
-            const player = args[0];
-            if (!player) {
-                throw new Error(`@RequiresState used on ${propertyKey} without Player context`);
-            }
-            if (req.has) {
-                for (const state of req.has) {
-                    if (!player.hasState(state)) {
-                        throw new utils_1.AppError('GAME_STATE_ERROR', req.errorMessage || `You must be [${state}] to do this.`, 'client');
-                    }
-                }
-            }
-            if (req.missing) {
-                for (const state of req.missing) {
-                    if (player.hasState(state)) {
-                        throw new utils_1.AppError('GAME_STATE_ERROR', req.errorMessage || `You can't do this while you're [${state}].`, 'client');
-                    }
-                }
-            }
-            return originalMethod.apply(this, args);
-        };
-        return descriptor;
-    };
-}