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

package/dist/adapters/contracts/client/IGtaPedAppearanceBridge.d.ts

@@ -0,0 +1,26 @@
+import { HeadBlendData } from '../../../kernel/shared/player-appearance.types';
+export declare abstract class IGtaPedAppearanceBridge {
+    abstract setComponentVariation(ped: number, componentId: number, drawable: number, texture: number, palette: number): void;
+    abstract setPropIndex(ped: number, propId: number, drawable: number, texture: number, attach: boolean): void;
+    abstract clearProp(ped: number, propId: number): void;
+    abstract setDefaultComponentVariation(ped: number): void;
+    abstract setHeadBlendData(ped: number, data: HeadBlendData): void;
+    abstract setFaceFeature(ped: number, index: number, scale: number): void;
+    abstract setHeadOverlay(ped: number, overlayId: number, index: number, opacity: number): void;
+    abstract setHeadOverlayColor(ped: number, overlayId: number, colorType: number, colorId: number, secondColorId: number): void;
+    abstract setHairColor(ped: number, colorId: number, highlightColorId: number): void;
+    abstract setEyeColor(ped: number, index: number): void;
+    abstract addDecoration(ped: number, collectionHash: number, overlayHash: number): void;
+    abstract clearDecorations(ped: number): void;
+    abstract getDrawableVariation(ped: number, componentId: number): number;
+    abstract getTextureVariation(ped: number, componentId: number): number;
+    abstract getPropIndex(ped: number, propId: number): number;
+    abstract getPropTextureIndex(ped: number, propId: number): number;
+    abstract getNumDrawableVariations(ped: number, componentId: number): number;
+    abstract getNumTextureVariations(ped: number, componentId: number, drawable: number): number;
+    abstract getNumPropDrawableVariations(ped: number, propId: number): number;
+    abstract getNumPropTextureVariations(ped: number, propId: number, drawable: number): number;
+    abstract getNumOverlayValues(overlayId: number): number;
+    abstract getNumHairColors(): number;
+    abstract getNumMakeupColors(): number;
+}

package/dist/adapters/contracts/client/IGtaPedAppearanceBridge.js

@@ -0,0 +1,2 @@
+export class IGtaPedAppearanceBridge {
+}

package/dist/adapters/contracts/client/camera/IClientCameraPort.d.ts

@@ -0,0 +1,107 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+/**
+ * Euler rotation used by scripted camera implementations.
+ */
+export interface ClientCameraRotation {
+    x: number;
+    y: number;
+    z: number;
+}
+/**
+ * Complete transform payload for a scripted camera.
+ */
+export interface ClientCameraTransform {
+    position: Vector3;
+    rotation?: ClientCameraRotation;
+    fov?: number;
+}
+/**
+ * Options for creating a new scripted camera.
+ */
+export interface ClientCameraCreateOptions {
+    camName?: string;
+    active?: boolean;
+    transform?: ClientCameraTransform;
+}
+/**
+ * Options for enabling or disabling camera rendering.
+ */
+export interface ClientCameraRenderOptions {
+    ease?: boolean;
+    easeTimeMs?: number;
+}
+/**
+ * Shake parameters for a scripted camera.
+ */
+export interface ClientCameraShakeOptions {
+    type: string;
+    amplitude: number;
+}
+/**
+ * Intent-oriented client camera port.
+ *
+ * The framework asks for high-level camera actions through this port and the
+ * active adapter decides how those actions are achieved for the runtime.
+ */
+export declare abstract class IClientCameraPort {
+    /**
+     * Creates a new scripted camera and returns its runtime handle.
+     */
+    abstract create(options?: ClientCameraCreateOptions): number;
+    /**
+     * Activates or deactivates a specific camera.
+     */
+    abstract setActive(camera: number, active: boolean): void;
+    /**
+     * Enables or disables scripted camera rendering.
+     */
+    abstract render(enable: boolean, options?: ClientCameraRenderOptions): void;
+    /**
+     * Destroys a single scripted camera.
+     */
+    abstract destroy(camera: number, destroyActiveCamera?: boolean): void;
+    /**
+     * Destroys every scripted camera controlled by the adapter/runtime.
+     */
+    abstract destroyAll(destroyActiveCamera?: boolean): void;
+    /**
+     * Applies a transform to a camera.
+     */
+    abstract setTransform(camera: number, transform: ClientCameraTransform): void;
+    /**
+     * Updates only the position of a camera.
+     */
+    abstract setPosition(camera: number, position: Vector3): void;
+    /**
+     * Updates only the rotation of a camera.
+     */
+    abstract setRotation(camera: number, rotation: ClientCameraRotation, rotationOrder?: number): void;
+    /**
+     * Updates only the field of view of a camera.
+     */
+    abstract setFov(camera: number, fov: number): void;
+    /**
+     * Makes the camera point at a world position.
+     */
+    abstract pointAtCoords(camera: number, position: Vector3): void;
+    /**
+     * Makes the camera point at an entity with an optional offset.
+     */
+    abstract pointAtEntity(camera: number, entity: number, offset?: Vector3): void;
+    /**
+     * Stops any pointing target on the camera.
+     */
+    abstract stopPointing(camera: number): void;
+    /**
+     * Interpolates from one camera to another.
+     */
+    abstract interpolate(fromCamera: number, toCamera: number, durationMs: number, easeLocation?: boolean, easeRotation?: boolean): void;
+    /**
+     * Starts a camera shake effect.
+     */
+    abstract shake(camera: number, options: ClientCameraShakeOptions): void;
+    /**
+     * Stops any active shake effect on a camera.
+     */
+    abstract stopShaking(camera: number, stopImmediately?: boolean): void;
+}

package/dist/adapters/contracts/client/camera/IClientCameraPort.js

@@ -0,0 +1,8 @@
+/**
+ * Intent-oriented client camera port.
+ *
+ * The framework asks for high-level camera actions through this port and the
+ * active adapter decides how those actions are achieved for the runtime.
+ */
+export class IClientCameraPort {
+}

package/dist/adapters/contracts/client/camera/index.d.ts

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

package/dist/adapters/contracts/client/camera/index.js

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

package/dist/adapters/contracts/client/index.d.ts

@@ -0,0 +1,11 @@
+export * from './camera';
+export * from './IClientLogConsole';
+export * from './IClientLocalPlayerBridge';
+export * from './IClientPlatformBridge';
+export * from './IClientRuntimeBridge';
+export * from './IGtaPedAppearanceBridge';
+export * from './ped';
+export * from './progress';
+export * from './spawn';
+export * from './ui';
+export * from './vehicle';

package/dist/adapters/contracts/client/index.js

@@ -0,0 +1,11 @@
+export * from './camera';
+export * from './IClientLogConsole';
+export * from './IClientLocalPlayerBridge';
+export * from './IClientPlatformBridge';
+export * from './IClientRuntimeBridge';
+export * from './IGtaPedAppearanceBridge';
+export * from './ped';
+export * from './progress';
+export * from './spawn';
+export * from './ui';
+export * from './vehicle';

package/dist/adapters/contracts/client/ped/IClientPedPort.d.ts

@@ -0,0 +1,62 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+/**
+ * High-level options for spawning a ped.
+ */
+export interface ClientPedSpawnOptions {
+    model: string;
+    position: Vector3;
+    heading?: number;
+    networked?: boolean;
+    missionEntity?: boolean;
+    relationshipGroup?: string;
+    blockEvents?: boolean;
+}
+/**
+ * High-level animation request for a ped.
+ */
+export interface ClientPedAnimationOptions {
+    dict: string;
+    anim: string;
+    blendInSpeed?: number;
+    blendOutSpeed?: number;
+    duration?: number;
+    flags?: number;
+    playbackRate?: number;
+}
+/**
+ * Intent-oriented client ped port.
+ */
+export declare abstract class IClientPedPort {
+    /** Spawns a ped and returns its runtime handle. */
+    abstract spawn(options: ClientPedSpawnOptions): Promise<number>;
+    /** Deletes a ped handle if it exists. */
+    abstract delete(handle: number): void;
+    /** Returns whether a ped handle exists. */
+    abstract exists(handle: number): boolean;
+    /** Plays an animation on a ped. */
+    abstract playAnimation(handle: number, options: ClientPedAnimationOptions): Promise<void>;
+    /** Stops the current animation/task on a ped. */
+    abstract stopAnimation(handle: number): void;
+    /** Stops the current animation/task immediately on a ped. */
+    abstract stopAnimationImmediately(handle: number): void;
+    /** Freezes or unfreezes a ped. */
+    abstract freeze(handle: number, freeze: boolean): void;
+    /** Sets invincibility for a ped. */
+    abstract setInvincible(handle: number, invincible: boolean): void;
+    /** Gives a weapon to a ped. */
+    abstract giveWeapon(handle: number, weapon: string, ammo?: number, hidden?: boolean, forceInHand?: boolean): void;
+    /** Removes all weapons from a ped. */
+    abstract removeAllWeapons(handle: number): void;
+    /** Returns the closest ped to the local player. */
+    abstract getClosest(radius?: number, excludeLocalPlayer?: boolean): number | null;
+    /** Returns nearby ped handles. */
+    abstract getNearby(position: Vector3, radius: number, excludeEntity?: number): number[];
+    /** Makes a ped look at an entity. */
+    abstract lookAtEntity(handle: number, entity: number, duration?: number): void;
+    /** Makes a ped look at coordinates. */
+    abstract lookAtCoords(handle: number, position: Vector3, duration?: number): void;
+    /** Makes a ped walk to coordinates. */
+    abstract walkTo(handle: number, position: Vector3, speed?: number): void;
+    /** Sets basic combat intent flags for a ped. */
+    abstract setCombatAttributes(handle: number, canFight: boolean, canUseCover?: boolean): void;
+}

package/dist/adapters/contracts/client/ped/IClientPedPort.js

@@ -0,0 +1,5 @@
+/**
+ * Intent-oriented client ped port.
+ */
+export class IClientPedPort {
+}

package/dist/adapters/contracts/client/ped/index.d.ts

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

package/dist/adapters/contracts/client/ped/index.js

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

package/dist/adapters/contracts/client/progress/IClientProgressPort.d.ts

@@ -0,0 +1,53 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+/**
+ * Progress task options used by client adapters.
+ */
+export interface ClientProgressOptions {
+    label: string;
+    duration: number;
+    useCircular?: boolean;
+    canCancel?: boolean;
+    disableControls?: boolean;
+    disableMovement?: boolean;
+    disableCombat?: boolean;
+    animation?: {
+        dict: string;
+        anim: string;
+        flags?: number;
+    };
+    prop?: {
+        model: string;
+        bone: number;
+        offset: Vector3;
+        rotation: Vector3;
+    };
+}
+/**
+ * Runtime snapshot for an active progress task.
+ */
+export interface ClientProgressState {
+    active: boolean;
+    progress: number;
+    label: string;
+    startTime: number;
+    duration: number;
+    options: ClientProgressOptions;
+}
+/**
+ * Intent-oriented client progress port.
+ *
+ * Adapters own the platform-specific implementation for task animations,
+ * props, controls, and HUD rendering while the framework exposes a stable API.
+ */
+export declare abstract class IClientProgressPort {
+    /** Starts a progress task and resolves to true when completed. */
+    abstract start(options: ClientProgressOptions): Promise<boolean>;
+    /** Cancels the active task if one exists. */
+    abstract cancel(): void;
+    /** Returns whether a task is active. */
+    abstract isActive(): boolean;
+    /** Returns the current progress percentage. */
+    abstract getProgress(): number;
+    /** Returns the active task snapshot. */
+    abstract getState(): ClientProgressState | null;
+}

package/dist/adapters/contracts/client/progress/IClientProgressPort.js

@@ -0,0 +1,8 @@
+/**
+ * Intent-oriented client progress port.
+ *
+ * Adapters own the platform-specific implementation for task animations,
+ * props, controls, and HUD rendering while the framework exposes a stable API.
+ */
+export class IClientProgressPort {
+}

package/dist/adapters/contracts/client/progress/index.d.ts

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

package/dist/adapters/contracts/client/progress/index.js

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

package/dist/adapters/contracts/client/spawn/IClientSpawnBridge.d.ts

@@ -0,0 +1,6 @@
+import { IClientSpawnPort } from './IClientSpawnPort';
+/**
+ * @deprecated Use IClientSpawnPort for new runtime integrations.
+ */
+export declare abstract class IClientSpawnBridge extends IClientSpawnPort {
+}

package/dist/adapters/contracts/client/spawn/IClientSpawnBridge.js

@@ -0,0 +1,6 @@
+import { IClientSpawnPort } from './IClientSpawnPort';
+/**
+ * @deprecated Use IClientSpawnPort for new runtime integrations.
+ */
+export class IClientSpawnBridge extends IClientSpawnPort {
+}

package/dist/adapters/contracts/client/spawn/IClientSpawnPort.d.ts

@@ -0,0 +1,19 @@
+import type { RespawnRequest, SpawnExecutionResult, SpawnRequest, TeleportRequest } from './types';
+export declare abstract class IClientSpawnPort {
+    /**
+     * Waits until the runtime reports that spawning can safely occur.
+     */
+    abstract waitUntilReady(timeoutMs?: number): Promise<void>;
+    /**
+     * Performs a full local-player spawn.
+     */
+    abstract spawn(request: SpawnRequest): Promise<SpawnExecutionResult>;
+    /**
+     * Performs a respawn flow for the local player.
+     */
+    abstract respawn(request: RespawnRequest): Promise<SpawnExecutionResult>;
+    /**
+     * Repositions the local player without a full spawn sequence.
+     */
+    abstract teleport(request: TeleportRequest): Promise<void>;
+}

package/dist/adapters/contracts/client/spawn/IClientSpawnPort.js

@@ -0,0 +1,2 @@
+export class IClientSpawnPort {
+}

package/dist/adapters/contracts/client/spawn/index.d.ts

@@ -0,0 +1,4 @@
+export * from './IClientSpawnPort';
+export * from './IClientSpawnBridge';
+export * from './types';
+export * from './types';

package/dist/adapters/contracts/client/spawn/index.js

@@ -0,0 +1,4 @@
+export * from './IClientSpawnPort';
+export * from './IClientSpawnBridge';
+export * from './types';
+export * from './types';

package/dist/adapters/contracts/client/spawn/types.d.ts

@@ -0,0 +1,17 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+export interface SpawnRequest {
+    position: Vector3;
+    model: string;
+    heading?: number;
+}
+export interface SpawnExecutionResult {
+    localPlayerHandle?: number;
+}
+export interface TeleportRequest {
+    position: Vector3;
+    heading?: number;
+}
+export interface RespawnRequest {
+    position: Vector3;
+    heading?: number;
+}

package/dist/adapters/contracts/client/ui/IClientBlipBridge.d.ts

@@ -0,0 +1,25 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+export interface ClientBlipOptions {
+    icon?: number;
+    sprite?: number;
+    color?: number;
+    scale?: number;
+    shortRange?: boolean;
+    label?: string;
+    alpha?: number;
+    route?: boolean;
+    routeColor?: number;
+    visible?: boolean;
+}
+export interface ClientBlipDefinition extends ClientBlipOptions {
+    position?: Vector3;
+    entity?: number;
+    radius?: number;
+}
+export declare abstract class IClientBlipBridge {
+    abstract create(id: string, definition: ClientBlipDefinition): void;
+    abstract update(id: string, patch: Partial<ClientBlipDefinition>): boolean;
+    abstract exists(id: string): boolean;
+    abstract remove(id: string): boolean;
+    abstract clear(): void;
+}

package/dist/adapters/contracts/client/ui/IClientBlipBridge.js

@@ -0,0 +1,2 @@
+export class IClientBlipBridge {
+}

package/dist/adapters/contracts/client/ui/IClientMarkerBridge.d.ts

@@ -0,0 +1,31 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+export interface ClientMarkerOptions {
+    variant?: number;
+    type?: number;
+    size?: Vector3;
+    scale?: Vector3;
+    visible?: boolean;
+    bob?: boolean;
+    bobUpAndDown?: boolean;
+    faceCamera?: boolean;
+    rotate?: boolean;
+    drawOnEnts?: boolean;
+    color?: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+}
+export interface ClientMarkerDefinition extends ClientMarkerOptions {
+    position: Vector3;
+    rotation?: Vector3;
+}
+export declare abstract class IClientMarkerBridge {
+    abstract create(id: string, definition: ClientMarkerDefinition): void;
+    abstract update(id: string, patch: Partial<ClientMarkerDefinition>): boolean;
+    abstract remove(id: string): boolean;
+    abstract exists(id: string): boolean;
+    abstract clear(): void;
+    abstract draw(definition: ClientMarkerDefinition): void;
+}

package/dist/adapters/contracts/client/ui/IClientMarkerBridge.js

@@ -0,0 +1,2 @@
+export class IClientMarkerBridge {
+}

package/dist/adapters/contracts/client/ui/IClientNotificationBridge.d.ts

@@ -0,0 +1,21 @@
+import type { Vector3 } from '../../../../kernel/utils/vector3';
+export type ClientNotificationKind = 'feed' | 'typed' | 'advanced' | 'help' | 'subtitle' | 'floating';
+export interface ClientNotificationDefinition {
+    kind: ClientNotificationKind;
+    message: string;
+    title?: string;
+    subtitle?: string;
+    type?: 'info' | 'success' | 'warning' | 'error';
+    blink?: boolean;
+    duration?: number;
+    beep?: boolean;
+    looped?: boolean;
+    flash?: boolean;
+    saveToBrief?: boolean;
+    backgroundColor?: number;
+    worldPosition?: Vector3;
+}
+export declare abstract class IClientNotificationBridge {
+    abstract show(definition: ClientNotificationDefinition): void;
+    abstract clear(scope?: 'help' | 'subtitle' | 'all'): void;
+}

package/dist/adapters/contracts/client/ui/IClientNotificationBridge.js

@@ -0,0 +1,2 @@
+export class IClientNotificationBridge {
+}

package/dist/adapters/contracts/client/ui/index.d.ts

@@ -0,0 +1,4 @@
+export * from './IClientBlipBridge';
+export * from './IClientMarkerBridge';
+export * from './IClientNotificationBridge';
+export * from './webview';

package/dist/adapters/contracts/client/ui/index.js

@@ -0,0 +1,4 @@
+export * from './IClientBlipBridge';
+export * from './IClientMarkerBridge';
+export * from './IClientNotificationBridge';
+export * from './webview';

package/dist/adapters/contracts/client/ui/webview/IClientWebViewBridge.d.ts

@@ -0,0 +1,14 @@
+import type { WebViewCapabilities, WebViewDefinition, WebViewFocusOptions, WebViewMessage } from './types';
+export declare abstract class IClientWebViewBridge {
+    abstract getCapabilities(): WebViewCapabilities;
+    abstract create(definition: WebViewDefinition): void;
+    abstract destroy(viewId: string): void;
+    abstract exists(viewId: string): boolean;
+    abstract show(viewId: string): void;
+    abstract hide(viewId: string): void;
+    abstract focus(viewId: string, options?: WebViewFocusOptions): void;
+    abstract blur(viewId: string): void;
+    abstract markAsChat(viewId: string): void;
+    abstract send(viewId: string, event: string, payload: unknown): void;
+    abstract onMessage(handler: (message: WebViewMessage) => void | Promise<void>): () => void;
+}

package/dist/adapters/contracts/client/ui/webview/IClientWebViewBridge.js

@@ -0,0 +1,2 @@
+export class IClientWebViewBridge {
+}

package/dist/adapters/contracts/client/ui/webview/index.d.ts

@@ -0,0 +1,2 @@
+export * from './IClientWebViewBridge';
+export * from './types';

package/dist/adapters/contracts/client/ui/webview/index.js

@@ -0,0 +1,2 @@
+export * from './IClientWebViewBridge';
+export * from './types';

package/dist/adapters/contracts/client/ui/webview/types.d.ts

@@ -0,0 +1,27 @@
+export interface WebViewCapabilities {
+    supportsFocus: boolean;
+    supportsCursor: boolean;
+    supportsInputPassthrough: boolean;
+    supportsBidirectionalMessaging: boolean;
+    supportsExecute: boolean;
+    supportsHeadless: boolean;
+    supportsChatMode: boolean;
+}
+export interface WebViewDefinition {
+    id: string;
+    url: string;
+    visible?: boolean;
+    focused?: boolean;
+    cursor?: boolean;
+    inputPassthrough?: boolean;
+    chatMode?: boolean;
+}
+export interface WebViewFocusOptions {
+    cursor?: boolean;
+    inputPassthrough?: boolean;
+}
+export interface WebViewMessage {
+    viewId: string;
+    event: string;
+    payload: unknown;
+}