@open-core/framework 1.0.1-beta.1

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

@@ -0,0 +1,4 @@
+export * from './core';
+export * from './ui';
+export * from './world';
+export * from './streaming';

package/dist/client/services/index.js

@@ -0,0 +1,24 @@
+"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 });
+// Core services
+__exportStar(require("./core"), exports);
+// UI services
+__exportStar(require("./ui"), exports);
+// World services
+__exportStar(require("./world"), exports);
+// Streaming services
+__exportStar(require("./streaming"), exports);

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

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

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./streaming.service"), exports);

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

@@ -0,0 +1,165 @@
+export interface StreamingRequest {
+    type: 'model' | 'animDict' | 'ptfx' | 'texture' | 'audio';
+    asset: string;
+    loaded: boolean;
+    hash?: number;
+}
+/**
+ * Service for managing asset streaming (models, animations, particles, etc.).
+ */
+export declare class StreamingService {
+    private loadedAssets;
+    /**
+     * Request and load a model.
+     *
+     * @param model - Model name or hash
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the model was loaded successfully
+     */
+    requestModel(model: string | number, timeout?: number): Promise<boolean>;
+    /**
+     * Check if a model is loaded.
+     *
+     * @param model - Model name or hash
+     */
+    isModelLoaded(model: string | number): boolean;
+    /**
+     * Release a loaded model.
+     *
+     * @param model - Model name or hash
+     */
+    releaseModel(model: string | number): void;
+    /**
+     * Check if a model is valid and exists in the game files.
+     *
+     * @param model - Model name or hash
+     */
+    isModelValid(model: string | number): boolean;
+    /**
+     * Check if a model is a vehicle.
+     *
+     * @param model - Model name or hash
+     */
+    isModelVehicle(model: string | number): boolean;
+    /**
+     * Check if a model is a ped.
+     *
+     * @param model - Model name or hash
+     */
+    isModelPed(model: string | number): boolean;
+    /**
+     * Request and load an animation dictionary.
+     *
+     * @param dict - Animation dictionary name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the dictionary was loaded successfully
+     */
+    requestAnimDict(dict: string, timeout?: number): Promise<boolean>;
+    /**
+     * Check if an animation dictionary is loaded.
+     *
+     * @param dict - Animation dictionary name
+     */
+    isAnimDictLoaded(dict: string): boolean;
+    /**
+     * Release a loaded animation dictionary.
+     *
+     * @param dict - Animation dictionary name
+     */
+    releaseAnimDict(dict: string): void;
+    /**
+     * Request and load a particle effect asset.
+     *
+     * @param asset - PTFX asset name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the asset was loaded successfully
+     */
+    requestPtfxAsset(asset: string, timeout?: number): Promise<boolean>;
+    /**
+     * Check if a PTFX asset is loaded.
+     *
+     * @param asset - PTFX asset name
+     */
+    isPtfxAssetLoaded(asset: string): boolean;
+    /**
+     * Release a loaded PTFX asset.
+     *
+     * @param asset - PTFX asset name
+     */
+    releasePtfxAsset(asset: string): void;
+    /**
+     * Start a particle effect at a position.
+     *
+     * @param asset - PTFX asset name
+     * @param effectName - Effect name within the asset
+     * @param position - World position
+     * @param rotation - Rotation
+     * @param scale - Scale
+     * @param looped - Whether to loop
+     * @returns The particle effect handle
+     */
+    startParticleEffect(asset: string, effectName: string, position: {
+        x: number;
+        y: number;
+        z: number;
+    }, rotation?: {
+        x: number;
+        y: number;
+        z: number;
+    }, scale?: number, looped?: boolean): Promise<number>;
+    /**
+     * Stop a looped particle effect.
+     *
+     * @param handle - Particle effect handle
+     */
+    stopParticleEffect(handle: number): void;
+    /**
+     * Request and load a texture dictionary.
+     *
+     * @param dict - Texture dictionary name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the dictionary was loaded successfully
+     */
+    requestTextureDict(dict: string, timeout?: number): Promise<boolean>;
+    /**
+     * Check if a texture dictionary is loaded.
+     *
+     * @param dict - Texture dictionary name
+     */
+    isTextureDictLoaded(dict: string): boolean;
+    /**
+     * Release a loaded texture dictionary.
+     *
+     * @param dict - Texture dictionary name
+     */
+    releaseTextureDict(dict: string): void;
+    /**
+     * Request and load a script audio bank.
+     *
+     * @param audioBank - Audio bank name
+     * @param networked - Whether the audio should be networked
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the audio bank was loaded successfully
+     */
+    requestAudioBank(audioBank: string, networked?: boolean, _timeout?: number): Promise<boolean>;
+    /**
+     * Release a loaded audio bank.
+     *
+     * @param audioBank - Audio bank name
+     */
+    releaseAudioBank(audioBank: string): void;
+    /**
+     * Get all currently loaded assets.
+     */
+    getLoadedAssets(): StreamingRequest[];
+    /**
+     * Release all loaded assets.
+     */
+    releaseAll(): void;
+    /**
+     * Get hash key for a string.
+     *
+     * @param str - String to hash
+     */
+    getHash(str: string): number;
+}

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

@@ -0,0 +1,341 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingService = void 0;
+const tsyringe_1 = require("tsyringe");
+/**
+ * Service for managing asset streaming (models, animations, particles, etc.).
+ */
+let StreamingService = class StreamingService {
+    constructor() {
+        this.loadedAssets = new Map();
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Model Loading
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Request and load a model.
+     *
+     * @param model - Model name or hash
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the model was loaded successfully
+     */
+    async requestModel(model, timeout = 10000) {
+        var _a;
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        const key = `model:${hash}`;
+        // Already loaded
+        if ((_a = this.loadedAssets.get(key)) === null || _a === void 0 ? void 0 : _a.loaded) {
+            return true;
+        }
+        // Check if valid
+        if (!IsModelInCdimage(hash) || !IsModelValid(hash)) {
+            return false;
+        }
+        RequestModel(hash);
+        const startTime = GetGameTimer();
+        while (!HasModelLoaded(hash)) {
+            if (GetGameTimer() - startTime > timeout) {
+                return false;
+            }
+            await new Promise((r) => setTimeout(r, 0));
+        }
+        this.loadedAssets.set(key, { type: 'model', asset: String(model), loaded: true, hash });
+        return true;
+    }
+    /**
+     * Check if a model is loaded.
+     *
+     * @param model - Model name or hash
+     */
+    isModelLoaded(model) {
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        return HasModelLoaded(hash);
+    }
+    /**
+     * Release a loaded model.
+     *
+     * @param model - Model name or hash
+     */
+    releaseModel(model) {
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        SetModelAsNoLongerNeeded(hash);
+        this.loadedAssets.delete(`model:${hash}`);
+    }
+    /**
+     * Check if a model is valid and exists in the game files.
+     *
+     * @param model - Model name or hash
+     */
+    isModelValid(model) {
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        return IsModelInCdimage(hash) && IsModelValid(hash);
+    }
+    /**
+     * Check if a model is a vehicle.
+     *
+     * @param model - Model name or hash
+     */
+    isModelVehicle(model) {
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        return IsModelAVehicle(hash);
+    }
+    /**
+     * Check if a model is a ped.
+     *
+     * @param model - Model name or hash
+     */
+    isModelPed(model) {
+        const hash = typeof model === 'string' ? GetHashKey(model) : model;
+        return IsModelAPed(hash);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Animation Dictionary Loading
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Request and load an animation dictionary.
+     *
+     * @param dict - Animation dictionary name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the dictionary was loaded successfully
+     */
+    async requestAnimDict(dict, timeout = 10000) {
+        var _a;
+        const key = `anim:${dict}`;
+        // Already loaded
+        if ((_a = this.loadedAssets.get(key)) === null || _a === void 0 ? void 0 : _a.loaded) {
+            return true;
+        }
+        RequestAnimDict(dict);
+        const startTime = GetGameTimer();
+        while (!HasAnimDictLoaded(dict)) {
+            if (GetGameTimer() - startTime > timeout) {
+                return false;
+            }
+            await new Promise((r) => setTimeout(r, 0));
+        }
+        this.loadedAssets.set(key, { type: 'animDict', asset: dict, loaded: true });
+        return true;
+    }
+    /**
+     * Check if an animation dictionary is loaded.
+     *
+     * @param dict - Animation dictionary name
+     */
+    isAnimDictLoaded(dict) {
+        return HasAnimDictLoaded(dict);
+    }
+    /**
+     * Release a loaded animation dictionary.
+     *
+     * @param dict - Animation dictionary name
+     */
+    releaseAnimDict(dict) {
+        RemoveAnimDict(dict);
+        this.loadedAssets.delete(`anim:${dict}`);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Particle Effects (PTFX) Loading
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Request and load a particle effect asset.
+     *
+     * @param asset - PTFX asset name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the asset was loaded successfully
+     */
+    async requestPtfxAsset(asset, timeout = 10000) {
+        var _a;
+        const key = `ptfx:${asset}`;
+        // Already loaded
+        if ((_a = this.loadedAssets.get(key)) === null || _a === void 0 ? void 0 : _a.loaded) {
+            return true;
+        }
+        RequestNamedPtfxAsset(asset);
+        const startTime = GetGameTimer();
+        while (!HasNamedPtfxAssetLoaded(asset)) {
+            if (GetGameTimer() - startTime > timeout) {
+                return false;
+            }
+            await new Promise((r) => setTimeout(r, 0));
+        }
+        this.loadedAssets.set(key, { type: 'ptfx', asset, loaded: true });
+        return true;
+    }
+    /**
+     * Check if a PTFX asset is loaded.
+     *
+     * @param asset - PTFX asset name
+     */
+    isPtfxAssetLoaded(asset) {
+        return HasNamedPtfxAssetLoaded(asset);
+    }
+    /**
+     * Release a loaded PTFX asset.
+     *
+     * @param asset - PTFX asset name
+     */
+    releasePtfxAsset(asset) {
+        RemoveNamedPtfxAsset(asset);
+        this.loadedAssets.delete(`ptfx:${asset}`);
+    }
+    /**
+     * Start a particle effect at a position.
+     *
+     * @param asset - PTFX asset name
+     * @param effectName - Effect name within the asset
+     * @param position - World position
+     * @param rotation - Rotation
+     * @param scale - Scale
+     * @param looped - Whether to loop
+     * @returns The particle effect handle
+     */
+    async startParticleEffect(asset, effectName, position, rotation = { x: 0, y: 0, z: 0 }, scale = 1.0, looped = false) {
+        await this.requestPtfxAsset(asset);
+        UseParticleFxAssetNextCall(asset);
+        if (looped) {
+            return StartParticleFxLoopedAtCoord(effectName, position.x, position.y, position.z, rotation.x, rotation.y, rotation.z, scale, false, false, false, false);
+        }
+        else {
+            return StartParticleFxNonLoopedAtCoord(effectName, position.x, position.y, position.z, rotation.x, rotation.y, rotation.z, scale, false, false, false);
+        }
+    }
+    /**
+     * Stop a looped particle effect.
+     *
+     * @param handle - Particle effect handle
+     */
+    stopParticleEffect(handle) {
+        StopParticleFxLooped(handle, false);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Texture Dictionary Loading
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Request and load a texture dictionary.
+     *
+     * @param dict - Texture dictionary name
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the dictionary was loaded successfully
+     */
+    async requestTextureDict(dict, timeout = 10000) {
+        var _a;
+        const key = `texture:${dict}`;
+        // Already loaded
+        if ((_a = this.loadedAssets.get(key)) === null || _a === void 0 ? void 0 : _a.loaded) {
+            return true;
+        }
+        RequestStreamedTextureDict(dict, true);
+        const startTime = GetGameTimer();
+        while (!HasStreamedTextureDictLoaded(dict)) {
+            if (GetGameTimer() - startTime > timeout) {
+                return false;
+            }
+            await new Promise((r) => setTimeout(r, 0));
+        }
+        this.loadedAssets.set(key, { type: 'texture', asset: dict, loaded: true });
+        return true;
+    }
+    /**
+     * Check if a texture dictionary is loaded.
+     *
+     * @param dict - Texture dictionary name
+     */
+    isTextureDictLoaded(dict) {
+        return HasStreamedTextureDictLoaded(dict);
+    }
+    /**
+     * Release a loaded texture dictionary.
+     *
+     * @param dict - Texture dictionary name
+     */
+    releaseTextureDict(dict) {
+        SetStreamedTextureDictAsNoLongerNeeded(dict);
+        this.loadedAssets.delete(`texture:${dict}`);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Audio Loading
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Request and load a script audio bank.
+     *
+     * @param audioBank - Audio bank name
+     * @param networked - Whether the audio should be networked
+     * @param timeout - Maximum wait time in ms
+     * @returns Whether the audio bank was loaded successfully
+     */
+    async requestAudioBank(audioBank, networked = false, _timeout = 10000) {
+        var _a;
+        const key = `audio:${audioBank}`;
+        // Already loaded
+        if ((_a = this.loadedAssets.get(key)) === null || _a === void 0 ? void 0 : _a.loaded) {
+            return true;
+        }
+        const success = RequestScriptAudioBank(audioBank, networked);
+        if (!success)
+            return false;
+        this.loadedAssets.set(key, { type: 'audio', asset: audioBank, loaded: true });
+        return true;
+    }
+    /**
+     * Release a loaded audio bank.
+     *
+     * @param audioBank - Audio bank name
+     */
+    releaseAudioBank(audioBank) {
+        ReleaseScriptAudioBank();
+        this.loadedAssets.delete(`audio:${audioBank}`);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Utility Methods
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Get all currently loaded assets.
+     */
+    getLoadedAssets() {
+        return Array.from(this.loadedAssets.values());
+    }
+    /**
+     * Release all loaded assets.
+     */
+    releaseAll() {
+        for (const asset of this.loadedAssets.values()) {
+            switch (asset.type) {
+                case 'model':
+                    if (asset.hash)
+                        SetModelAsNoLongerNeeded(asset.hash);
+                    break;
+                case 'animDict':
+                    RemoveAnimDict(asset.asset);
+                    break;
+                case 'ptfx':
+                    RemoveNamedPtfxAsset(asset.asset);
+                    break;
+                case 'texture':
+                    SetStreamedTextureDictAsNoLongerNeeded(asset.asset);
+                    break;
+                case 'audio':
+                    ReleaseScriptAudioBank();
+                    break;
+            }
+        }
+        this.loadedAssets.clear();
+    }
+    /**
+     * Get hash key for a string.
+     *
+     * @param str - String to hash
+     */
+    getHash(str) {
+        return GetHashKey(str);
+    }
+};
+exports.StreamingService = StreamingService;
+exports.StreamingService = StreamingService = __decorate([
+    (0, tsyringe_1.injectable)()
+], StreamingService);

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

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

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./notification.service"), exports);
+__exportStar(require("./textui.service"), exports);
+__exportStar(require("./progress.service"), exports);

package/dist/client/services/ui/notification.service.d.ts

@@ -0,0 +1,76 @@
+export type NotificationType = 'info' | 'success' | 'warning' | 'error';
+export interface AdvancedNotificationOptions {
+    /** Notification title */
+    title: string;
+    /** Notification subtitle */
+    subtitle?: string;
+    /** Message text */
+    message: string;
+    /** Texture dictionary for the icon */
+    textureDict?: string;
+    /** Texture name for the icon */
+    textureName?: string;
+    /** Icon type (1-7) */
+    iconType?: number;
+    /** Flash the notification */
+    flash?: boolean;
+    /** Save to brief (map menu) */
+    saveToBrief?: boolean;
+    /** Background color index */
+    backgroundColor?: number;
+}
+/**
+ * Service for displaying native GTA V notifications.
+ */
+export declare class NotificationService {
+    /**
+     * Show a simple notification on screen.
+     *
+     * @param message - The message to display
+     * @param blink - Whether the notification should blink
+     */
+    show(message: string, blink?: boolean): void;
+    /**
+     * Show a notification with a type indicator using throbber icons.
+     *
+     * @param message - The message to display
+     * @param type - The notification type
+     */
+    showWithType(message: string, type?: NotificationType): void;
+    /**
+     * Show an advanced notification with picture/icon.
+     *
+     * @param options - Advanced notification options
+     */
+    showAdvanced(options: AdvancedNotificationOptions): void;
+    /**
+     * Show a help notification (appears at top-left).
+     *
+     * @param message - The help message
+     * @param duration - How long to show in milliseconds (-1 for indefinite)
+     * @param beep - Play a beep sound
+     * @param looped - Keep showing until cleared
+     */
+    showHelp(message: string, duration?: number, beep?: boolean, looped?: boolean): void;
+    /**
+     * Clear all help messages.
+     */
+    clearHelp(): void;
+    /**
+     * Show a subtitle (centered at bottom of screen).
+     *
+     * @param message - The subtitle text
+     * @param duration - Duration in milliseconds
+     */
+    showSubtitle(message: string, duration?: number): void;
+    /**
+     * Clear the current subtitle.
+     */
+    clearSubtitle(): void;
+    /**
+     * Show a floating help text above the player's head.
+     *
+     * @param message - The message to display
+     */
+    showFloatingHelp(message: string): void;
+}