@open-core/framework 1.0.4-beta.1 → 1.0.5-beta.2

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

@@ -1,53 +0,0 @@
-/**
- * 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
- */
-export type { DatabaseConfig, ExecuteResult, InsertResult, TransactionQuery, TransactionQueryTuple, TransactionSharedParams, TransactionInput, DatabaseAdapterFactory, } from './types';
-export { DatabaseContract } from './database.contract';
-export { DatabaseService } from './database.service';
-export { getDatabaseService, initDatabase, query, single, scalar, execute, insert, transaction, } from './database.service';
-export { OxMySQLAdapter } from './adapters/oxmysql.adapter';

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/database/types.d.ts

@@ -1,67 +0,0 @@
-/**
- * Database Module Types
- *
- * Core types for the database abstraction layer.
- */
-/**
- * Result of an execute/update operation
- */
-export interface ExecuteResult {
-    /** Number of rows affected by the operation */
-    affectedRows: number;
-}
-/**
- * Result of an insert operation
- */
-export interface InsertResult {
-    /** The auto-generated ID of the inserted row */
-    insertId: number;
-}
-/**
- * Configuration for database adapters
- */
-export interface DatabaseConfig {
-    /** Adapter identifier (e.g., 'oxmysql', 'mysql-async') */
-    adapter?: string;
-    /** Enable debug logging */
-    debug?: boolean;
-    /** Connection timeout in milliseconds */
-    timeout?: number;
-}
-/**
- * Transaction query definition for oxmysql (specific format)
- *
- * @see https://coxdocs.dev/oxmysql/Functions/transaction
- */
-export interface TransactionQuery {
-    query: string;
-    /** Parameter values for the query (oxmysql uses 'values') */
-    values?: any[];
-}
-/**
- * Transaction query as tuple format [query, values]
- */
-export type TransactionQueryTuple = [string, any[]?];
-/**
- * Shared parameters for transaction queries (named parameters format)
- *
- * @example
- * ```typescript
- * const params: TransactionSharedParams = {
- *   someid: 2,
- *   somename: 'John Doe',
- *   newname: 'John Notdoe'
- * }
- * ```
- */
-export interface TransactionSharedParams {
-    [key: string]: any;
-}
-/**
- * Transaction input - can be specific format, tuple format, or just strings
- */
-export type TransactionInput = TransactionQuery[] | TransactionQueryTuple[] | string[];
-/**
- * Database adapter factory function type
- */
-export type DatabaseAdapterFactory = () => import('./database.contract').DatabaseContract;

package/dist/server/database/types.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * Database Module Types
- *
- * Core types for the database abstraction layer.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/server/database.d.ts

@@ -1,7 +0,0 @@
-/**
- * Database Module Re-export
- *
- * This file re-exports the database module for backwards compatibility.
- * Prefer importing directly from '@open-core/framework/server' or './database/index'
- */
-export * from './database/index';

package/dist/server/database.js

@@ -1,23 +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 });
-/**
- * Database Module Re-export
- *
- * This file re-exports the database module for backwards compatibility.
- * Prefer importing directly from '@open-core/framework/server' or './database/index'
- */
-__exportStar(require("./database/index"), exports);

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.d.ts

@@ -1,25 +0,0 @@
-import type { ClassConstructor } from '../../system/class-constructor';
-export declare const serverControllerRegistry: ClassConstructor[];
-/**
- * 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
- *   }
- * }
- * ```
- */
-export declare function Controller(): (target: ClassConstructor) => void;

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/guard.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Guard = Guard;
-const container_1 = require("../container");
-const services_1 = require("../services");
-const logger_1 = require("../../shared/logger");
-/**
- * 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)
- *   }
- * }
- * ```
- */
-function Guard(options) {
-    return function (target, propertyKey, descriptor) {
-        var _a;
-        if (!descriptor) {
-            // In benchmarks or edge cases, only register metadata without method wrapping
-            // This should NOT happen in production code with proper TypeScript compilation
-            logger_1.loggers.security.warn(`@Guard decorator: PropertyDescriptor not available. Only metadata will be registered. This should not happen in production code. Target: ${(_a = target.constructor) === null || _a === void 0 ? void 0 : _a.name}, Method: ${propertyKey}`);
-            Reflect.defineMetadata('core:guard', options, target, propertyKey);
-            return;
-        }
-        const originalMethod = descriptor.value;
-        descriptor.value = async function (...args) {
-            var _a;
-            const player = args[0];
-            if (!player || !player.clientID) {
-                logger_1.loggers.security.warn(`@Guard misuse: First argument is not a Player`, {
-                    method: propertyKey,
-                    targetClass: (_a = target.constructor) === null || _a === void 0 ? void 0 : _a.name,
-                });
-                throw new Error('Guard Security Error: Context is not a player');
-            }
-            const accessControl = container_1.di.resolve(services_1.AccessControlService);
-            await accessControl.enforce(player, {
-                minRank: options.rank,
-                permission: options.permission,
-            });
-            return originalMethod.apply(this, args);
-        };
-        // no need a defined metadata key, as we won't read it later
-        Reflect.defineMetadata('core:guard', options, target, propertyKey);
-        return descriptor;
-    };
-}

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

@@ -1,10 +0,0 @@
-export * from './bind';
-export * from './utils';
-export { Command, CommandConfig } from './command';
-export * from './onFrameworkEvent';
-export * from './onNet';
-export * from './onTick';
-export { Controller } from './controller';
-export * from './throttle';
-export * from './guard';
-export * from './requiresState';

package/dist/server/decorators/index.js

@@ -1,29 +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 });
-exports.Controller = exports.Command = void 0;
-__exportStar(require("./bind"), exports);
-__exportStar(require("./utils"), exports);
-var command_1 = require("./command");
-Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
-__exportStar(require("./onFrameworkEvent"), exports);
-__exportStar(require("./onNet"), exports);
-__exportStar(require("./onTick"), exports);
-var controller_1 = require("./controller");
-Object.defineProperty(exports, "Controller", { enumerable: true, get: function () { return controller_1.Controller; } });
-__exportStar(require("./throttle"), exports);
-__exportStar(require("./guard"), exports);
-__exportStar(require("./requiresState"), exports);

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;