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

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

@@ -0,0 +1,88 @@
+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

@@ -0,0 +1,13 @@
+"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/IExports.d.ts

@@ -0,0 +1,4 @@
+export declare abstract class IExports {
+    abstract register(exportName: string, handler: (...args: any[]) => any): void;
+    abstract getResource<T = any>(resourceName: string): T | undefined;
+}

package/dist/adapters/contracts/IExports.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IExports = void 0;
+class IExports {
+}
+exports.IExports = IExports;

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

@@ -0,0 +1,15 @@
+/**
+ * Hash utility adapter.
+ *
+ * @remarks
+ * Abstracts hash functions like GetHashKey.
+ */
+export declare abstract class IHasher {
+    /**
+     * Gets the hash key for a string (joaat hash).
+     *
+     * @param str - String to hash
+     * @returns Hash value
+     */
+    abstract getHashKey(str: string): number;
+}

package/dist/adapters/contracts/IHasher.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IHasher = void 0;
+/**
+ * Hash utility adapter.
+ *
+ * @remarks
+ * Abstracts hash functions like GetHashKey.
+ */
+class IHasher {
+}
+exports.IHasher = IHasher;

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

@@ -0,0 +1,8 @@
+export type NetTarget = number | number[] | 'all';
+export type NetEventContext = {
+    clientId: number;
+};
+export declare abstract class INetTransport {
+    abstract onNet(eventName: string, handler: (ctx: NetEventContext, ...args: any[]) => void | Promise<void>): void;
+    abstract emitNet(eventName: string, target: NetTarget, ...args: any[]): void;
+}

package/dist/adapters/contracts/INetTransport.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INetTransport = void 0;
+class INetTransport {
+}
+exports.INetTransport = INetTransport;

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

@@ -0,0 +1,206 @@
+import { HeadBlendData } from '../../kernel/shared';
+/**
+ * Client-side ped appearance operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM ped appearance natives for client-side operations.
+ * Allows the runtime to work without direct FiveM dependencies.
+ *
+ * Most appearance natives are client-only (headBlend, faceFeatures, overlays, tattoos).
+ * This adapter provides a unified interface for all appearance operations.
+ */
+export declare abstract class IPedAppearanceClient {
+    /**
+     * Sets a ped's component variation (clothing, hair, etc.).
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @param drawable - Drawable index
+     * @param texture - Texture index
+     * @param palette - Palette ID (usually 2)
+     */
+    abstract setComponentVariation(ped: number, componentId: number, drawable: number, texture: number, palette: number): void;
+    /**
+     * Sets a ped's prop (hat, glasses, etc.).
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @param drawable - Drawable index
+     * @param texture - Texture index
+     * @param attach - Whether to attach the prop
+     */
+    abstract setPropIndex(ped: number, propId: number, drawable: number, texture: number, attach: boolean): void;
+    /**
+     * Clears a ped's prop.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID to clear (0-7)
+     */
+    abstract clearProp(ped: number, propId: number): void;
+    /**
+     * Sets the ped to default component variation.
+     *
+     * @param ped - Ped entity handle
+     */
+    abstract setDefaultComponentVariation(ped: number): void;
+    /**
+     * Sets the ped's head blend data for facial structure.
+     *
+     * @remarks
+     * This must be called before setting face features, overlays, or overlay colors.
+     *
+     * @param ped - Ped entity handle
+     * @param data - Head blend configuration
+     */
+    abstract setHeadBlendData(ped: number, data: HeadBlendData): void;
+    /**
+     * Sets a face feature morph value.
+     *
+     * @remarks
+     * SetPedHeadBlendData must be called before this.
+     *
+     * @param ped - Ped entity handle
+     * @param index - Feature index (0-19)
+     * @param scale - Scale value (-1.0 to 1.0)
+     */
+    abstract setFaceFeature(ped: number, index: number, scale: number): void;
+    /**
+     * Sets a head overlay (makeup, facial hair, etc.).
+     *
+     * @remarks
+     * SetPedHeadBlendData must be called before this.
+     *
+     * @param ped - Ped entity handle
+     * @param overlayId - Overlay ID (0-12)
+     * @param index - Overlay variation index (255 to disable)
+     * @param opacity - Opacity (0.0-1.0)
+     */
+    abstract setHeadOverlay(ped: number, overlayId: number, index: number, opacity: number): void;
+    /**
+     * Sets the color for a head overlay.
+     *
+     * @remarks
+     * Must be called after SetPedHeadOverlay.
+     *
+     * @param ped - Ped entity handle
+     * @param overlayId - Overlay ID (0-12)
+     * @param colorType - Color type (0: default, 1: hair, 2: makeup)
+     * @param colorId - Primary color ID
+     * @param secondColorId - Secondary color ID
+     */
+    abstract setHeadOverlayColor(ped: number, overlayId: number, colorType: number, colorId: number, secondColorId: number): void;
+    /**
+     * Sets the ped's hair color.
+     *
+     * @param ped - Ped entity handle
+     * @param colorId - Primary hair color ID
+     * @param highlightColorId - Highlight color ID
+     */
+    abstract setHairColor(ped: number, colorId: number, highlightColorId: number): void;
+    /**
+     * Sets the ped's eye color.
+     *
+     * @param ped - Ped entity handle
+     * @param index - Eye color index (0-31)
+     */
+    abstract setEyeColor(ped: number, index: number): void;
+    /**
+     * Adds a decoration (tattoo) to the ped.
+     *
+     * @param ped - Ped entity handle
+     * @param collectionHash - Collection name hash
+     * @param overlayHash - Overlay name hash
+     */
+    abstract addDecoration(ped: number, collectionHash: number, overlayHash: number): void;
+    /**
+     * Clears all decorations (tattoos) from the ped.
+     *
+     * @param ped - Ped entity handle
+     */
+    abstract clearDecorations(ped: number): void;
+    /**
+     * Gets the drawable variation for a component.
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @returns Drawable index
+     */
+    abstract getDrawableVariation(ped: number, componentId: number): number;
+    /**
+     * Gets the texture variation for a component.
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @returns Texture index
+     */
+    abstract getTextureVariation(ped: number, componentId: number): number;
+    /**
+     * Gets the prop index for a prop slot.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @returns Prop drawable index (-1 if none)
+     */
+    abstract getPropIndex(ped: number, propId: number): number;
+    /**
+     * Gets the prop texture index.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @returns Prop texture index
+     */
+    abstract getPropTextureIndex(ped: number, propId: number): number;
+    /**
+     * Gets the number of drawable variations for a component.
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @returns Number of available drawables
+     */
+    abstract getNumDrawableVariations(ped: number, componentId: number): number;
+    /**
+     * Gets the number of texture variations for a component drawable.
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @param drawable - Drawable index
+     * @returns Number of available textures
+     */
+    abstract getNumTextureVariations(ped: number, componentId: number, drawable: number): number;
+    /**
+     * Gets the number of drawable variations for a prop.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @returns Number of available prop drawables
+     */
+    abstract getNumPropDrawableVariations(ped: number, propId: number): number;
+    /**
+     * Gets the number of texture variations for a prop drawable.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @param drawable - Drawable index
+     * @returns Number of available textures
+     */
+    abstract getNumPropTextureVariations(ped: number, propId: number, drawable: number): number;
+    /**
+     * Gets the number of overlay values for an overlay type.
+     *
+     * @param overlayId - Overlay ID (0-12)
+     * @returns Number of available overlay variations
+     */
+    abstract getNumOverlayValues(overlayId: number): number;
+    /**
+     * Gets the number of hair colors available.
+     *
+     * @returns Number of hair colors
+     */
+    abstract getNumHairColors(): number;
+    /**
+     * Gets the number of makeup colors available.
+     *
+     * @returns Number of makeup colors
+     */
+    abstract getNumMakeupColors(): number;
+}

package/dist/adapters/contracts/IPedAppearanceClient.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPedAppearanceClient = void 0;
+/**
+ * Client-side ped appearance operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM ped appearance natives for client-side operations.
+ * Allows the runtime to work without direct FiveM dependencies.
+ *
+ * Most appearance natives are client-only (headBlend, faceFeatures, overlays, tattoos).
+ * This adapter provides a unified interface for all appearance operations.
+ */
+class IPedAppearanceClient {
+}
+exports.IPedAppearanceClient = IPedAppearanceClient;

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

@@ -0,0 +1,45 @@
+/**
+ * Server-side ped appearance operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM ped appearance natives for server-side operations.
+ * Server-side has limited appearance control compared to client.
+ *
+ * Only components and props can be set from the server.
+ * HeadBlend, face features, overlays, and tattoos must be applied client-side.
+ */
+export declare abstract class IPedAppearanceServer {
+    /**
+     * Sets a ped's component variation (clothing, hair, etc.).
+     *
+     * @param ped - Ped entity handle
+     * @param componentId - Component ID (0-11)
+     * @param drawable - Drawable index
+     * @param texture - Texture index
+     * @param palette - Palette ID (usually 2)
+     */
+    abstract setComponentVariation(ped: number, componentId: number, drawable: number, texture: number, palette: number): void;
+    /**
+     * Sets a ped's prop (hat, glasses, etc.).
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID (0-7)
+     * @param drawable - Drawable index
+     * @param texture - Texture index
+     * @param attach - Whether to attach the prop
+     */
+    abstract setPropIndex(ped: number, propId: number, drawable: number, texture: number, attach: boolean): void;
+    /**
+     * Clears a ped's prop.
+     *
+     * @param ped - Ped entity handle
+     * @param propId - Prop ID to clear (0-7)
+     */
+    abstract clearProp(ped: number, propId: number): void;
+    /**
+     * Sets the ped to default component variation.
+     *
+     * @param ped - Ped entity handle
+     */
+    abstract setDefaultComponentVariation(ped: number): void;
+}

package/dist/adapters/contracts/IPedAppearanceServer.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPedAppearanceServer = void 0;
+/**
+ * Server-side ped appearance operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM ped appearance natives for server-side operations.
+ * Server-side has limited appearance control compared to client.
+ *
+ * Only components and props can be set from the server.
+ * HeadBlend, face features, overlays, and tattoos must be applied client-side.
+ */
+class IPedAppearanceServer {
+}
+exports.IPedAppearanceServer = IPedAppearanceServer;

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

@@ -0,0 +1,5 @@
+import { Vector3 } from '../../kernel';
+export declare abstract class IPlayerInfo {
+    abstract getPlayerName(clientId: number): string | null;
+    abstract getPlayerPosition(clientId: number): Vector3 | undefined;
+}

package/dist/adapters/contracts/IPlayerInfo.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPlayerInfo = void 0;
+class IPlayerInfo {
+}
+exports.IPlayerInfo = IPlayerInfo;

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

@@ -0,0 +1,73 @@
+/**
+ * Server-side player operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM player natives for server-side operations.
+ * Allows the runtime to work without direct FiveM dependencies.
+ */
+export declare abstract class IPlayerServer {
+    /**
+     * Gets the ped handle for a player.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Ped entity handle
+     */
+    abstract getPed(playerSrc: string): number;
+    /**
+     * Drops (kicks) a player from the server.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @param reason - Kick reason message
+     */
+    abstract drop(playerSrc: string, reason: string): void;
+    /**
+     * Gets a player identifier by type.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @param identifierType - Identifier type (e.g., 'license', 'steam', 'discord')
+     * @returns Identifier string or undefined
+     */
+    abstract getIdentifier(playerSrc: string, identifierType: string): string | undefined;
+    /**
+     * Gets all identifiers for a player.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Array of identifier strings
+     */
+    abstract getIdentifiers(playerSrc: string): string[];
+    /**
+     * Gets the number of player identifiers.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Number of identifiers
+     */
+    abstract getNumIdentifiers(playerSrc: string): number;
+    /**
+     * Gets player name.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Player name
+     */
+    abstract getName(playerSrc: string): string;
+    /**
+     * Gets player ping.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Ping in milliseconds
+     */
+    abstract getPing(playerSrc: string): number;
+    /**
+     * Gets player endpoint (IP:port).
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @returns Endpoint string
+     */
+    abstract getEndpoint(playerSrc: string): string;
+    /**
+     * Sets player routing bucket.
+     *
+     * @param playerSrc - Player source/client ID (as string)
+     * @param bucket - Routing bucket ID
+     */
+    abstract setRoutingBucket(playerSrc: string, bucket: number): void;
+}

package/dist/adapters/contracts/IPlayerServer.js

@@ -0,0 +1,13 @@
+"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/contracts/IResourceInfo.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class IResourceInfo {
+    abstract getCurrentResourceName(): string;
+}

package/dist/adapters/contracts/IResourceInfo.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IResourceInfo = void 0;
+class IResourceInfo {
+}
+exports.IResourceInfo = IResourceInfo;

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

@@ -0,0 +1,10 @@
+/**
+ * Platform-agnostic tick/interval abstraction
+ */
+export declare abstract class ITick {
+    /**
+     * Registers a recurring handler that executes on each tick/interval
+     * @param handler - The function to execute
+     */
+    abstract setTick(handler: () => void | Promise<void>): void;
+}

package/dist/adapters/contracts/ITick.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ITick = void 0;
+/**
+ * Platform-agnostic tick/interval abstraction
+ */
+class ITick {
+}
+exports.ITick = ITick;

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

@@ -0,0 +1,55 @@
+/**
+ * Server-side vehicle operations adapter.
+ *
+ * @remarks
+ * Abstracts FiveM vehicle natives for server-side operations.
+ * Allows the runtime to work without direct FiveM dependencies.
+ */
+export declare abstract class IVehicleServer {
+    /**
+     * Creates a vehicle using server setter (server-authoritative).
+     *
+     * @param modelHash - Vehicle model hash
+     * @param vehicleType - Vehicle type string
+     * @param x - X coordinate
+     * @param y - Y coordinate
+     * @param z - Z coordinate
+     * @param heading - Vehicle heading
+     * @returns Entity handle or 0 on failure
+     */
+    abstract createServerSetter(modelHash: number, vehicleType: string, x: number, y: number, z: number, heading: number): number;
+    /**
+     * Gets vehicle colors.
+     * @returns [primaryColor, secondaryColor]
+     */
+    abstract getColours(handle: number): [number, number];
+    /**
+     * Sets vehicle colors.
+     */
+    abstract setColours(handle: number, primary: number, secondary: number): void;
+    /**
+     * Gets vehicle number plate text.
+     */
+    abstract getNumberPlateText(handle: number): string;
+    /**
+     * Sets vehicle number plate text.
+     */
+    abstract setNumberPlateText(handle: number, text: string): void;
+    /**
+     * Sets vehicle doors locked state.
+     * @param state - 0 = unlocked, 1 = unlocked, 2 = locked, 3 = locked for player, 4 = locked for non-players
+     */
+    abstract setDoorsLocked(handle: number, state: number): void;
+    /**
+     * Gets network ID from entity handle.
+     */
+    abstract getNetworkIdFromEntity(handle: number): number;
+    /**
+     * Gets entity handle from network ID.
+     */
+    abstract getEntityFromNetworkId(networkId: number): number;
+    /**
+     * Checks if network ID exists.
+     */
+    abstract networkIdExists(networkId: number): boolean;
+}

package/dist/adapters/contracts/IVehicleServer.js

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

package/dist/{server/database/adapters → adapters/database}/oxmysql.adapter.d.ts

@@ -7,8 +7,8 @@
  * @see https://github.com/overextended/oxmysql
  * @see https://coxdocs.dev/oxmysql/Functions/transaction
  */
-import { DatabaseContract } from '../database.contract';
-import type { ExecuteResult, InsertResult, TransactionInput, TransactionSharedParams } from '../types';
+import { DatabaseContract } from '../../runtime/server/database/database.contract';
+import { ExecuteResult, InsertResult, TransactionInput, TransactionSharedParams } from '../../runtime/server/database/types';
 /**
  * OxMySQL Database Adapter
  *