@ingissa/navcore-simulator 1.0.7 → 1.0.9

package/README.md

@@ -1,5 +1,7 @@
 # @ingissa/navcore-simulator
 
+[Site officiel](https://navcore-web.vercel.app/)
+
 > Headless GPS simulation engine for the NavCore ecosystem.
 > Works in **Node.js** (CI), **React Native**, and any JavaScript environment.
 

package/dist/index.d.mts

@@ -0,0 +1,87 @@
+import { SimSession, SimulatorConfig, Scenario, SimPosition, SimLocationObject } from './node.mjs';
+export { Coordinate, EngineState, ExportFormat, FleetReport, FleetSimulator, GpxParseResult, GpxParser, NoiseEngine, NoiseProfile, RouteWalker, ScenarioInjector, SessionRecorder, SimLocationCoords, SimulatorEngine, VehicleProfile, WalkerPosition } from './node.mjs';
+import { Coordinate } from '@ingissa/navcore-core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * useSimulator — React Native hook wrapping SimulatorEngine.
+ *
+ * Drop-in replacement for useGpsSimulator.
+ * All engine logic lives in SimulatorEngine — this hook is purely a thin
+ * React adapter with no business logic of its own.
+ *
+ * BEFORE (current Go4Exams code):
+ *   const simGps = useGpsSimulator(route, isNavigating, speedMultiplier)
+ *
+ * AFTER:
+ *   const { position, controls, session, isRecording } = useSimulator({
+ *     routeGeometry: route,
+ *     active: isNavigating,
+ *     config: { speedKmh: 50, noiseProfile: NoiseEngine.STANDARD },
+ *   })
+ */
+
+interface UseSimulatorOptions {
+    /** Route geometry to simulate along */
+    routeGeometry: Coordinate[] | null;
+    /** Whether the simulation should be active */
+    active: boolean;
+    /** Engine configuration (all fields optional) */
+    config?: Partial<Omit<SimulatorConfig, 'routeGeometry' | 'onPositionUpdate' | 'onRouteComplete'>>;
+    /** Pre-registered scenarios */
+    scenarios?: Scenario[];
+    /** Called when a scenario fires */
+    onScenarioFired?: (scenario: Scenario) => void;
+    /** Called when the route simulation finishes */
+    onRouteComplete?: () => void;
+}
+interface SimulatorControls$1 {
+    pause: () => void;
+    resume: () => void;
+    seek: (geometryIndex: number) => void;
+    setSpeed: (multiplier: 1 | 2 | 4 | 8) => void;
+}
+interface SessionControls {
+    start: (sessionId?: string) => void;
+    stop: () => SimSession | null;
+}
+interface UseSimulatorResult {
+    /** Current simulated position — null when inactive */
+    position: SimPosition | null;
+    /** Conforms to Expo LocationObject (null when inactive) */
+    location: SimLocationObject | null;
+    /** Alias for location conforming to Expo LocationObject */
+    rawLocation: SimLocationObject | null;
+    /** Playback controls */
+    controls: SimulatorControls$1;
+    /** Recording controls */
+    session: SessionControls;
+    /** Whether a recording is in progress */
+    isRecording: boolean;
+}
+declare function useSimulator(options: UseSimulatorOptions): UseSimulatorResult;
+
+interface ScenarioLogEntry {
+    ts: number;
+    name: string;
+    type: string;
+}
+interface SimulatorControlsProps {
+    simulator: SimulatorControls$1;
+    session?: SessionControls;
+    style?: 'minimal' | 'full' | 'floating';
+    showScenarioLog?: boolean;
+    showSessionRecorder?: boolean;
+    scenarioLog?: ScenarioLogEntry[];
+    /** Current speed multiplier (controlled externally) */
+    currentSpeed?: 1 | 2 | 4 | 8;
+    /** Current engine state */
+    engineState?: 'idle' | 'running' | 'paused' | 'complete';
+    isRecording?: boolean;
+    onExportSession?: (session: SimSession) => void;
+    /** Additional style for the root container */
+    containerStyle?: object;
+}
+declare function SimulatorControls({ simulator, session, style, showScenarioLog, showSessionRecorder, scenarioLog, currentSpeed, engineState, isRecording, onExportSession, containerStyle, }: SimulatorControlsProps): react_jsx_runtime.JSX.Element;
+
+export { Scenario, type ScenarioLogEntry, SimLocationObject, SimPosition, SimSession, SimulatorConfig, SimulatorControls, useSimulator };

package/dist/{simulator/src/react-native/useSimulator.d.ts → index.d.ts}

@@ -1,3 +1,8 @@
+import { SimSession, SimulatorConfig, Scenario, SimPosition, SimLocationObject } from './node.js';
+export { Coordinate, EngineState, ExportFormat, FleetReport, FleetSimulator, GpxParseResult, GpxParser, NoiseEngine, NoiseProfile, RouteWalker, ScenarioInjector, SessionRecorder, SimLocationCoords, SimulatorEngine, VehicleProfile, WalkerPosition } from './node.js';
+import { Coordinate } from '@ingissa/navcore-core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
 /**
  * useSimulator — React Native hook wrapping SimulatorEngine.
  *
@@ -15,9 +20,8 @@
  *     config: { speedKmh: 50, noiseProfile: NoiseEngine.STANDARD },
  *   })
  */
-import type { SimPosition, SimulatorConfig, SimSession, Scenario, SimLocationObject } from '../core/types';
-import type { Coordinate } from '@ingissa/navcore-core';
-export interface UseSimulatorOptions {
+
+interface UseSimulatorOptions {
     /** Route geometry to simulate along */
     routeGeometry: Coordinate[] | null;
     /** Whether the simulation should be active */
@@ -31,17 +35,17 @@ export interface UseSimulatorOptions {
     /** Called when the route simulation finishes */
     onRouteComplete?: () => void;
 }
-export interface SimulatorControls {
+interface SimulatorControls$1 {
     pause: () => void;
     resume: () => void;
     seek: (geometryIndex: number) => void;
     setSpeed: (multiplier: 1 | 2 | 4 | 8) => void;
 }
-export interface SessionControls {
+interface SessionControls {
     start: (sessionId?: string) => void;
     stop: () => SimSession | null;
 }
-export interface UseSimulatorResult {
+interface UseSimulatorResult {
     /** Current simulated position — null when inactive */
     position: SimPosition | null;
     /** Conforms to Expo LocationObject (null when inactive) */
@@ -49,11 +53,35 @@ export interface UseSimulatorResult {
     /** Alias for location conforming to Expo LocationObject */
     rawLocation: SimLocationObject | null;
     /** Playback controls */
-    controls: SimulatorControls;
+    controls: SimulatorControls$1;
     /** Recording controls */
     session: SessionControls;
     /** Whether a recording is in progress */
     isRecording: boolean;
 }
-export declare function useSimulator(options: UseSimulatorOptions): UseSimulatorResult;
-//# sourceMappingURL=useSimulator.d.ts.map
+declare function useSimulator(options: UseSimulatorOptions): UseSimulatorResult;
+
+interface ScenarioLogEntry {
+    ts: number;
+    name: string;
+    type: string;
+}
+interface SimulatorControlsProps {
+    simulator: SimulatorControls$1;
+    session?: SessionControls;
+    style?: 'minimal' | 'full' | 'floating';
+    showScenarioLog?: boolean;
+    showSessionRecorder?: boolean;
+    scenarioLog?: ScenarioLogEntry[];
+    /** Current speed multiplier (controlled externally) */
+    currentSpeed?: 1 | 2 | 4 | 8;
+    /** Current engine state */
+    engineState?: 'idle' | 'running' | 'paused' | 'complete';
+    isRecording?: boolean;
+    onExportSession?: (session: SimSession) => void;
+    /** Additional style for the root container */
+    containerStyle?: object;
+}
+declare function SimulatorControls({ simulator, session, style, showScenarioLog, showSessionRecorder, scenarioLog, currentSpeed, engineState, isRecording, onExportSession, containerStyle, }: SimulatorControlsProps): react_jsx_runtime.JSX.Element;
+
+export { Scenario, type ScenarioLogEntry, SimLocationObject, SimPosition, SimSession, SimulatorConfig, SimulatorControls, useSimulator };