@open-core/framework 0.2.8 → 0.3.0

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

@@ -72,7 +72,7 @@ export interface CommandRegistrationDto {
  * core.registerCommand({ ... })
  * ```
  */
-export interface CorePrincipalExports {
+export interface InternalPrincipalExports {
     /**
      * Gets the full Principal object for a player.
      *
@@ -83,7 +83,7 @@ export interface CorePrincipalExports {
     /**
      * Gets Principal by account ID (works for offline players too).
      *
-     * @param accountId - Database account identifier
+     * @param accountId - Account identifier
      * @returns Principal data or null
      */
     getPrincipalByAccountId(accountId: string): Promise<Principal | null>;
@@ -169,7 +169,7 @@ export interface CorePrincipalExports {
      */
     enforce(source: number, requirements: GuardOptions): Promise<void>;
 }
-export interface CoreCommandsExports {
+export interface InternalCommandsExports {
     /**
      * Registers a command from a RESOURCE with CORE.
      *
@@ -195,7 +195,7 @@ export interface CoreCommandsExports {
      */
     getAllCommands(): CommandInfo[];
 }
-export interface CorePlayerExports {
+export interface InternalPlayerExports {
     /**
      * Gets persistent account ID for a client.
      *
@@ -236,7 +236,7 @@ export interface CorePlayerExports {
     /**
      * Finds a player by their persistent account ID.
      *
-     * @param accountId - Database account identifier
+     * @param accountId - Account identifier
      * @returns Serialized player data or null if not online
      */
     getPlayerByAccountId(accountId: string): SerializedPlayerData | null;
@@ -249,7 +249,7 @@ export interface CorePlayerExports {
     /**
      * Checks if a player with given account ID is online.
      *
-     * @param accountId - Database account identifier
+     * @param accountId - Account identifier
      * @returns True if player is connected
      */
     isPlayerOnline(accountId: string): boolean;

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

@@ -1,4 +1,4 @@
+export * from '../../../kernel/error/security.types';
 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("../../../kernel/error/security.types"), 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

@@ -1,7 +1,7 @@
 import { Player } from '../entities';
 export interface PlayerSessionCreatedPayload {
     clientId: number;
-    license: string;
+    license: string | undefined;
 }
 export interface PlayerSessionDestroyedPayload {
     clientId: number;

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

@@ -1,4 +1,4 @@
-import { Vector3 } from '../../../kernel/utils';
+import { Vector3 } from '../../../';
 /**
  * Vehicle ownership information
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-core/framework",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "description": "Secure, Event-Driven, OOP Engine for FiveM. Stop scripting, start engineering.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
     "type": "git",
     "url": "git+https://github.com/newcore-network/opencore.git"
   },
-  "homepage": "https://github.com/newcore-network/opencore",
+  "homepage": "https://opencorejs.dev",
   "bugs": {
     "url": "https://github.com/newcore-network/opencore/issues"
   },
@@ -20,9 +20,9 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "types": "./dist/kernel/index.d.ts",
+      "import": "./dist/kernel/index.js",
+      "require": "./dist/kernel/index.js"
     },
     "./server": {
       "types": "./dist/runtime/server/index.d.ts",
@@ -34,16 +34,6 @@
       "import": "./dist/runtime/client/index.js",
       "require": "./dist/runtime/client/index.js"
     },
-    "./shared": {
-      "types": "./dist/kernel/shared/index.d.ts",
-      "import": "./dist/kernel/shared/index.js",
-      "require": "./dist/kernel/shared/index.js"
-    },
-    "./utils": {
-      "types": "./dist/kernel/utils/index.d.ts",
-      "import": "./dist/kernel/utils/index.js",
-      "require": "./dist/kernel/utils/index.js"
-    },
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -55,7 +45,7 @@
     "format": "biome format --write .",
     "lint": "biome lint .",
     "lint:fix": "biome lint --write .",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit && tsc -p tsconfig.test.json --noEmit",
     "test": "npx vitest run --project unit --project integration --project e2e",
     "test:ci": "npx vitest run --project unit --project integration",
     "test:watch": "npx vitest --project unit --project integration --project e2e",
@@ -90,8 +80,10 @@
     "@citizenfx/server": "2.0.22443-1",
     "@types/node": "^25.0.3",
     "@vitest/coverage-v8": "^4.0.16",
+    "dependency-cruiser": "^17.3.6",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
+    "graphviz": "^0.0.9",
     "tinybench": "^2.9.0",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",

package/dist/adapters/contracts/IEntityServer.d.ts

@@ -1,88 +0,0 @@
-import { Vector3 } from '../../kernel/utils';
-/**
- * Server-side entity operations adapter.
- *
- * @remarks
- * Abstracts FiveM entity natives for server-side operations.
- * Allows the runtime to work without direct FiveM dependencies.
- */
-export declare abstract class IEntityServer {
-    /**
-     * Checks if an entity exists.
-     */
-    abstract doesExist(handle: number): boolean;
-    /**
-     * Gets entity coordinates.
-     */
-    abstract getCoords(handle: number): Vector3;
-    /**
-     * Sets entity coordinates.
-     */
-    abstract setCoords(handle: number, x: number, y: number, z: number, alive?: boolean, deadFlag?: boolean, ragdollFlag?: boolean, clearArea?: boolean): void;
-    /**
-     * Gets entity heading.
-     */
-    abstract getHeading(handle: number): number;
-    /**
-     * Sets entity heading.
-     */
-    abstract setHeading(handle: number, heading: number): void;
-    /**
-     * Gets entity model hash.
-     */
-    abstract getModel(handle: number): number;
-    /**
-     * Deletes an entity.
-     */
-    abstract delete(handle: number): void;
-    /**
-     * Sets entity orphan mode.
-     * @param mode - 0 = delete when orphaned, 1 = keep, 2 = keep until script restart
-     */
-    abstract setOrphanMode(handle: number, mode: number): void;
-    /**
-     * Sets entity routing bucket.
-     */
-    abstract setRoutingBucket(handle: number, bucket: number): void;
-    /**
-     * Gets entity routing bucket.
-     */
-    abstract getRoutingBucket(handle: number): number;
-    /**
-     * Gets the state bag interface for an entity.
-     */
-    abstract getStateBag(handle: number): EntityStateBag;
-    /**
-     * Gets entity health from state bag.
-     */
-    abstract getHealth(handle: number): number;
-    /**
-     * Sets entity health via state bag (synced to client).
-     */
-    abstract setHealth(handle: number, health: number): void;
-    /**
-     * Gets entity armor from state bag.
-     */
-    abstract getArmor(handle: number): number;
-    /**
-     * Sets entity armor via state bag (synced to client).
-     */
-    abstract setArmor(handle: number, armor: number): void;
-}
-/**
- * State bag interface for entity state synchronization.
- */
-export interface EntityStateBag {
-    /**
-     * Sets a value in the state bag.
-     * @param key - State key
-     * @param value - Value to set
-     * @param replicated - Whether to replicate to clients
-     */
-    set(key: string, value: unknown, replicated?: boolean): void;
-    /**
-     * Gets a value from the state bag.
-     * @param key - State key
-     */
-    get(key: string): unknown;
-}

package/dist/adapters/contracts/IEntityServer.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IEntityServer = void 0;
-/**
- * Server-side entity operations adapter.
- *
- * @remarks
- * Abstracts FiveM entity natives for server-side operations.
- * Allows the runtime to work without direct FiveM dependencies.
- */
-class IEntityServer {
-}
-exports.IEntityServer = IEntityServer;

package/dist/adapters/contracts/IPlayerServer.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IPlayerServer = void 0;
-/**
- * Server-side player operations adapter.
- *
- * @remarks
- * Abstracts FiveM player natives for server-side operations.
- * Allows the runtime to work without direct FiveM dependencies.
- */
-class IPlayerServer {
-}
-exports.IPlayerServer = IPlayerServer;

package/dist/adapters/database/oxmysql.adapter.d.ts

@@ -1,89 +0,0 @@
-/**
- * OxMySQL Adapter
- *
- * Default database adapter using oxmysql resource for FiveM.
- * Requires oxmysql to be installed and running on the server.
- *
- * @see https://github.com/overextended/oxmysql
- * @see https://coxdocs.dev/oxmysql/Functions/transaction
- */
-import { DatabaseContract } from '../../runtime/server/database/database.contract';
-import { ExecuteResult, InsertResult, TransactionInput, TransactionSharedParams } from '../../runtime/server/database/types';
-/**
- * OxMySQL Database Adapter
- *
- * Implements DatabaseContract using oxmysql exports.
- *
- * @example
- * ```typescript
- * import { OxMySQLAdapter } from '@open-core/framework/server'
- *
- * // Usually you don't need to instantiate directly,
- * // use DatabaseService instead
- * const adapter = new OxMySQLAdapter()
- * const users = await adapter.query('SELECT * FROM users')
- * ```
- */
-export declare class OxMySQLAdapter extends DatabaseContract {
-    private ox;
-    constructor();
-    /**
-     * Execute a query and return all matching rows
-     */
-    query<T = any>(sql: string, params?: any[]): Promise<T[]>;
-    /**
-     * Execute a query and return a single row
-     */
-    single<T = any>(sql: string, params?: any[]): Promise<T | null>;
-    /**
-     * Execute a query and return a single scalar value
-     */
-    scalar<T = any>(sql: string, params?: any[]): Promise<T | null>;
-    /**
-     * Execute an UPDATE or DELETE statement
-     */
-    execute(sql: string, params?: any[]): Promise<ExecuteResult>;
-    /**
-     * Execute an INSERT statement
-     */
-    insert(sql: string, params?: any[]): Promise<InsertResult>;
-    /**
-     * Execute multiple queries within a transaction.
-     *
-     * Supports three formats:
-     *
-     * **1. Specific format (object)**
-     * ```typescript
-     * await db.transaction([
-     *   { query: 'INSERT INTO test (id) VALUES (?)', values: [1] },
-     *   { query: 'INSERT INTO test (id, name) VALUES (?, ?)', values: [2, 'bob'] },
-     * ])
-     * ```
-     *
-     * **2. Specific format (tuple)**
-     * ```typescript
-     * await db.transaction([
-     *   ['INSERT INTO test (id) VALUES (?)', [1]],
-     *   ['INSERT INTO test (id, name) VALUES (?, ?)', [2, 'bob']],
-     * ])
-     * ```
-     *
-     * **3. Shared format (named parameters)**
-     * ```typescript
-     * await db.transaction(
-     *   [
-     *     'INSERT INTO test (id, name) VALUES (@someid, @somename)',
-     *     'UPDATE test SET name = @newname WHERE id = @someid',
-     *   ],
-     *   {
-     *     someid: 2,
-     *     somename: 'John Doe',
-     *     newname: 'John Notdoe',
-     *   }
-     * )
-     * ```
-     *
-     * @see https://coxdocs.dev/oxmysql/Functions/transaction
-     */
-    transaction(queries: TransactionInput, sharedParams?: TransactionSharedParams): Promise<boolean>;
-}

package/dist/adapters/database/oxmysql.adapter.js

@@ -1,149 +0,0 @@
-"use strict";
-/**
- * OxMySQL Adapter
- *
- * Default database adapter using oxmysql resource for FiveM.
- * Requires oxmysql to be installed and running on the server.
- *
- * @see https://github.com/overextended/oxmysql
- * @see https://coxdocs.dev/oxmysql/Functions/transaction
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OxMySQLAdapter = void 0;
-const database_contract_1 = require("../../runtime/server/database/database.contract");
-/**
- * Get the oxmysql export from FiveM
- */
-function getOxMySQL() {
-    const ox = exports.oxmysql;
-    if (!ox) {
-        throw new Error('[OpenCore] oxmysql is not available. Make sure oxmysql resource is started before your resource.');
-    }
-    return ox;
-}
-/**
- * Normalize transaction input to oxmysql format
- */
-function normalizeQueries(queries) {
-    if (queries.length === 0)
-        return [];
-    const first = queries[0];
-    // String array - used with shared params
-    if (typeof first === 'string') {
-        return queries;
-    }
-    // Tuple format: [query, values]
-    if (Array.isArray(first)) {
-        return queries.map(([query, values]) => ({
-            query,
-            values,
-        }));
-    }
-    // Already in TransactionQuery format
-    return queries;
-}
-/**
- * OxMySQL Database Adapter
- *
- * Implements DatabaseContract using oxmysql exports.
- *
- * @example
- * ```typescript
- * import { OxMySQLAdapter } from '@open-core/framework/server'
- *
- * // Usually you don't need to instantiate directly,
- * // use DatabaseService instead
- * const adapter = new OxMySQLAdapter()
- * const users = await adapter.query('SELECT * FROM users')
- * ```
- */
-class OxMySQLAdapter extends database_contract_1.DatabaseContract {
-    constructor() {
-        super();
-        this.ox = getOxMySQL();
-    }
-    /**
-     * Execute a query and return all matching rows
-     */
-    async query(sql, params) {
-        const result = await this.ox.query_async(sql, params);
-        return result !== null && result !== void 0 ? result : [];
-    }
-    /**
-     * Execute a query and return a single row
-     */
-    async single(sql, params) {
-        const result = await this.ox.single_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    /**
-     * Execute a query and return a single scalar value
-     */
-    async scalar(sql, params) {
-        const result = await this.ox.scalar_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    /**
-     * Execute an UPDATE or DELETE statement
-     */
-    async execute(sql, params) {
-        const affectedRows = await this.ox.update_async(sql, params);
-        return { affectedRows: affectedRows !== null && affectedRows !== void 0 ? affectedRows : 0 };
-    }
-    /**
-     * Execute an INSERT statement
-     */
-    async insert(sql, params) {
-        const insertId = await this.ox.insert_async(sql, params);
-        return { insertId: insertId !== null && insertId !== void 0 ? insertId : 0 };
-    }
-    /**
-     * Execute multiple queries within a transaction.
-     *
-     * Supports three formats:
-     *
-     * **1. Specific format (object)**
-     * ```typescript
-     * await db.transaction([
-     *   { query: 'INSERT INTO test (id) VALUES (?)', values: [1] },
-     *   { query: 'INSERT INTO test (id, name) VALUES (?, ?)', values: [2, 'bob'] },
-     * ])
-     * ```
-     *
-     * **2. Specific format (tuple)**
-     * ```typescript
-     * await db.transaction([
-     *   ['INSERT INTO test (id) VALUES (?)', [1]],
-     *   ['INSERT INTO test (id, name) VALUES (?, ?)', [2, 'bob']],
-     * ])
-     * ```
-     *
-     * **3. Shared format (named parameters)**
-     * ```typescript
-     * await db.transaction(
-     *   [
-     *     'INSERT INTO test (id, name) VALUES (@someid, @somename)',
-     *     'UPDATE test SET name = @newname WHERE id = @someid',
-     *   ],
-     *   {
-     *     someid: 2,
-     *     somename: 'John Doe',
-     *     newname: 'John Notdoe',
-     *   }
-     * )
-     * ```
-     *
-     * @see https://coxdocs.dev/oxmysql/Functions/transaction
-     */
-    async transaction(queries, sharedParams) {
-        if (queries.length === 0)
-            return true;
-        const normalizedQueries = normalizeQueries(queries);
-        // Use shared params format if provided
-        if (sharedParams) {
-            return await this.ox.transaction_async(normalizedQueries, sharedParams);
-        }
-        return await this.ox.transaction_async(normalizedQueries);
-    }
-}
-exports.OxMySQLAdapter = OxMySQLAdapter;

package/dist/adapters/database/resource.adapter.d.ts

@@ -1,12 +0,0 @@
-import { DatabaseContract } from '../../runtime/server/database/database.contract';
-import { ExecuteResult, InsertResult, TransactionInput, TransactionSharedParams } from '../../runtime/server/database/types';
-export declare class ResourceDatabaseAdapter extends DatabaseContract {
-    private db;
-    constructor();
-    query<T = any>(sql: string, params?: any[]): Promise<T[]>;
-    single<T = any>(sql: string, params?: any[]): Promise<T | null>;
-    scalar<T = any>(sql: string, params?: any[]): Promise<T | null>;
-    execute(sql: string, params?: any[]): Promise<ExecuteResult>;
-    insert(sql: string, params?: any[]): Promise<InsertResult>;
-    transaction(queries: TransactionInput, sharedParams?: TransactionSharedParams): Promise<boolean>;
-}

package/dist/adapters/database/resource.adapter.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceDatabaseAdapter = void 0;
-const database_contract_1 = require("../../runtime/server/database/database.contract");
-function getDbResourceName() {
-    const name = GetConvar('opencore_db_resource', '').trim();
-    if (!name) {
-        throw new Error('[OpenCore] opencore_db_resource is required when opencore_db_adapter=resource');
-    }
-    return name;
-}
-function getDbExports() {
-    const resourceName = getDbResourceName();
-    const db = exports[resourceName];
-    if (!db) {
-        throw new Error(`[OpenCore] Database resource '${resourceName}' is not available. Start it before this resource.`);
-    }
-    return db;
-}
-function normalizeQueries(queries) {
-    if (queries.length === 0)
-        return [];
-    const first = queries[0];
-    if (typeof first === 'string') {
-        return queries;
-    }
-    if (Array.isArray(first)) {
-        return queries.map(([query, values]) => ({
-            query,
-            values,
-        }));
-    }
-    return queries;
-}
-class ResourceDatabaseAdapter extends database_contract_1.DatabaseContract {
-    constructor() {
-        super();
-        this.db = getDbExports();
-    }
-    async query(sql, params) {
-        const result = await this.db.query_async(sql, params);
-        return result !== null && result !== void 0 ? result : [];
-    }
-    async single(sql, params) {
-        const result = await this.db.single_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    async scalar(sql, params) {
-        const result = await this.db.scalar_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    async execute(sql, params) {
-        return await this.db.execute_async(sql, params);
-    }
-    async insert(sql, params) {
-        return await this.db.insert_async(sql, params);
-    }
-    async transaction(queries, sharedParams) {
-        if (queries.length === 0)
-            return true;
-        const normalizedQueries = normalizeQueries(queries);
-        if (sharedParams) {
-            return await this.db.transaction_async(normalizedQueries, sharedParams);
-        }
-        return await this.db.transaction_async(normalizedQueries);
-    }
-}
-exports.ResourceDatabaseAdapter = ResourceDatabaseAdapter;

package/dist/kernel/shared/appearance/index.d.ts

@@ -1 +0,0 @@
-export * from './appearance.interface';

package/dist/runtime/index.d.ts

@@ -1,2 +0,0 @@
-export * as Client from './client';
-export * as Server from './server';

package/dist/runtime/index.js

@@ -1,39 +0,0 @@
-"use strict";
-// Runtime - System execution
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Server = exports.Client = void 0;
-exports.Client = __importStar(require("./client"));
-exports.Server = __importStar(require("./server"));

package/dist/runtime/server/bootstrap.validation.d.ts

@@ -1,12 +0,0 @@
-export type BootstrapValidator = () => string[] | Promise<string[]>;
-/**
- * Register a bootstrap validator.
- *  This is only used for cases of custom validators or resources that require validation,
- *  like Driver resources.
- *
- * @param name - The name of the validator.
- * @param validator - The validator function.
- */
-export declare function registerBootstrapValidator(name: string, validator: BootstrapValidator): void;
-export declare function runBootstrapValidatorsOrThrow(): Promise<void>;
-export declare function registerDefaultBootstrapValidators(): void;