@ingissa/navcore-react-native 1.0.8 → 1.0.10

package/dist/index.mjs

@@ -0,0 +1,223 @@
+import { createContext, useRef, useState, useEffect, useMemo, useContext, useCallback, useSyncExternalStore } from 'react';
+import { NavCore } from '@ingissa/navcore-core';
+import { jsx } from 'react/jsx-runtime';
+
+// src/useNavCore.ts
+function useNavCore({
+  gpsCoord,
+  gpsBearing,
+  gpsAccuracy,
+  gpsTimestamp,
+  speed,
+  routeGeometry,
+  instructions,
+  isNavigating,
+  options,
+  resumeAtIndex,
+  outputRef,
+  onDeviation,
+  onRejoin,
+  onInstruction,
+  onArrival,
+  pollRateHz = 30
+}) {
+  const navRef = useRef(null);
+  if (!navRef.current) {
+    navRef.current = new NavCore(options);
+  }
+  const engine = navRef.current;
+  const [state, setState] = useState(() => engine.getState());
+  useEffect(() => {
+    if (!onDeviation) return;
+    const handler = (data) => onDeviation(data);
+    engine.on("deviation", handler);
+    return () => {
+      engine.off("deviation", handler);
+    };
+  }, [engine, onDeviation]);
+  useEffect(() => {
+    if (!onRejoin) return;
+    const handler = (data) => onRejoin(data);
+    engine.on("rejoined", handler);
+    return () => {
+      engine.off("rejoined", handler);
+    };
+  }, [engine, onRejoin]);
+  useEffect(() => {
+    if (!onInstruction) return;
+    const handler = (data) => onInstruction(data);
+    engine.on("instruction", handler);
+    return () => {
+      engine.off("instruction", handler);
+    };
+  }, [engine, onInstruction]);
+  useEffect(() => {
+    if (!onArrival) return;
+    const handler = () => onArrival();
+    engine.on("arrival", handler);
+    return () => {
+      engine.off("arrival", handler);
+    };
+  }, [engine, onArrival]);
+  useEffect(() => {
+    if (routeGeometry && routeGeometry.length >= 2) {
+      engine.setRoute(routeGeometry, instructions);
+    }
+  }, [engine, routeGeometry]);
+  useEffect(() => {
+    if (instructions && instructions.length > 0 && routeGeometry && routeGeometry.length >= 2) {
+      engine.setRoute(routeGeometry, instructions);
+    }
+  }, [engine, instructions]);
+  useEffect(() => {
+    if (!gpsCoord || !isNavigating) return;
+    const gpsUpdate = {
+      coord: gpsCoord,
+      accuracy: gpsAccuracy ?? null,
+      bearing: gpsBearing ?? null,
+      speed,
+      timestamp: gpsTimestamp ?? Date.now()
+    };
+    const nextState = engine.update(gpsUpdate);
+    if (outputRef) {
+      outputRef.current = {
+        coord: nextState.snappedCoord ?? gpsCoord,
+        bearing: nextState.bearing,
+        speed: nextState.currentSpeed
+      };
+    }
+  }, [engine, gpsCoord, gpsAccuracy, gpsBearing, gpsTimestamp, speed, isNavigating, outputRef]);
+  useEffect(() => {
+    if (isNavigating) {
+      engine.startNavigation();
+    }
+  }, [engine, isNavigating]);
+  useEffect(() => {
+    if (!isNavigating) return;
+    const handleUpdate = (updatedState) => {
+      setState(updatedState);
+    };
+    engine.on("update", handleUpdate);
+    setState(engine.getState());
+    return () => {
+      engine.off("update", handleUpdate);
+    };
+  }, [engine, isNavigating]);
+  useEffect(() => {
+    return () => {
+      engine.destroy();
+      navRef.current = null;
+    };
+  }, [engine]);
+  return useMemo(() => ({
+    ...state,
+    engine
+  }), [state, engine]);
+}
+var NavCoreContext = createContext(null);
+function NavCoreProvider({ children, options }) {
+  const engineRef = useRef(null);
+  if (!engineRef.current) {
+    engineRef.current = new NavCore(options);
+  }
+  const value = useMemo(() => ({
+    engine: engineRef.current
+  }), []);
+  return /* @__PURE__ */ jsx(NavCoreContext.Provider, { value, children });
+}
+function useNavCoreContext() {
+  const ctx = useContext(NavCoreContext);
+  if (!ctx) {
+    throw new Error("useNavCoreContext must be used within a <NavCoreProvider>");
+  }
+  return ctx;
+}
+function useNavSelector(selector, customEngine, isEqual = Object.is) {
+  let contextEngine;
+  try {
+    contextEngine = useNavCoreContext().engine;
+  } catch {
+    contextEngine = void 0;
+  }
+  const engine = customEngine ?? contextEngine;
+  if (!engine) {
+    throw new Error("useNavSelector must be provided an engine or used within a NavCoreProvider");
+  }
+  const lastSelectedRef = useRef(void 0);
+  const lastStateRef = useRef(void 0);
+  const getSnapshot = useCallback(() => {
+    const currentState = engine.getState();
+    if (lastStateRef.current === currentState && lastSelectedRef.current !== void 0) {
+      return lastSelectedRef.current;
+    }
+    const nextSelected = selector(currentState);
+    if (lastSelectedRef.current !== void 0 && isEqual(lastSelectedRef.current, nextSelected)) {
+      return lastSelectedRef.current;
+    }
+    lastStateRef.current = currentState;
+    lastSelectedRef.current = nextSelected;
+    return nextSelected;
+  }, [engine, selector, isEqual]);
+  const subscribe = useCallback((onStoreChange) => {
+    engine.on("update", onStoreChange);
+    return () => {
+      engine.off("update", onStoreChange);
+    };
+  }, [engine]);
+  return useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+}
+function useNavInstruction(customEngine) {
+  return useNavSelector(
+    (state) => {
+      if (state.nextInstructionIndex === null) return null;
+      let engine = customEngine;
+      if (!engine) {
+        try {
+          engine = useNavCoreContext().engine;
+        } catch {
+        }
+      }
+      if (!engine) return null;
+      const list = engine.getInstructions();
+      return list[state.nextInstructionIndex] ?? null;
+    },
+    customEngine,
+    (a, b) => a === b || a?.geometryIndex === b?.geometryIndex && a?.instruction === b?.instruction
+  );
+}
+function useNavAlert(customEngine) {
+  return useNavSelector(
+    (state) => state.alertState,
+    customEngine,
+    Object.is
+  );
+}
+function useNavProgress(customEngine) {
+  return useNavSelector(
+    (state) => ({
+      distanceToDestination: state.distanceToDestination,
+      distanceToNextInstruction: state.distanceToNextInstruction,
+      progressIndex: state.progressIndex,
+      routeIndex: state.routeIndex,
+      hasArrived: state.hasArrived
+    }),
+    customEngine,
+    (a, b) => a.distanceToDestination === b.distanceToDestination && a.distanceToNextInstruction === b.distanceToNextInstruction && a.progressIndex === b.progressIndex && a.routeIndex === b.routeIndex && a.hasArrived === b.hasArrived
+  );
+}
+function useNavIsOffRoute(customEngine) {
+  return useNavSelector(
+    (state) => state.isOffRoute,
+    customEngine,
+    Object.is
+  );
+}
+function useNavSpeed(customEngine) {
+  return useNavSelector(
+    (state) => state.currentSpeed,
+    customEngine,
+    Object.is
+  );
+}
+
+export { NavCoreProvider, useNavAlert, useNavCore, useNavCoreContext, useNavInstruction, useNavIsOffRoute, useNavProgress, useNavSelector, useNavSpeed };

package/package.json

@@ -1,54 +1,46 @@
-{
-  "name": "@ingissa/navcore-react-native",
-  "version": "1.0.8",
-  "description": "React Native bindings for the NavCore navigation engine.",
-  "author": "Ingissa <8abnav@gmail.com>",
-  "license": "SEE LICENSE IN LICENSE",
-  "homepage": "https://navcore.dev",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ingissa/navcore-sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/ingissa/navcore-sdk/issues"
-  },
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist",
-    "src",
-    "LICENSE"
-  ],
-  "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "lint": "tsc --noEmit",
-    "prepublishOnly": "npm run build"
-  },
-  "peerDependencies": {
-    "@ingissa/navcore-core": "^1.0.8",
-    "react": ">=18.0.0",
-    "react-native": ">=0.72.0",
-    "react-native-maps": ">=1.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react-native-maps": {
-      "optional": true
-    }
-  },
-  "dependencies": {}
-}
+{
+  "name": "@ingissa/navcore-react-native",
+  "version": "1.0.10",
+  "description": "React Native bindings for the NavCore navigation engine.",
+  "author": "Ingissa <8abnav@gmail.com>",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://navcore-web.vercel.app/",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build --prefix ../.. && node ../../scripts/check-release.mjs"
+  },
+  "peerDependencies": {
+    "@ingissa/navcore-core": "^1.0.10",
+    "react": ">=18.0.0",
+    "react-native": ">=0.72.0",
+    "react-native-maps": ">=1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react-native-maps": {
+      "optional": true
+    }
+  },
+  "dependencies": {}
+}

package/dist/core/src/NavCore.d.ts

@@ -1,142 +0,0 @@
-/**
- * NavCore — Main Orchestrator
- *
- * Fuses all extracted modules into a single engine class.
- * Framework-agnostic; license verification does not require platform crypto APIs.
- *
- * Usage:
- *   const engine = new NavCore({ licenseKey: '...' });
- *   engine.setRoute(routeCoords, instructions);
- *   engine.update(gpsUpdate);
- *   const state = engine.getState();
- */
-import type { Coordinate } from './geo/haversine';
-import { type NavInstruction } from './progress/InstructionResolver';
-import { NavigationFSM } from './off-route/NavigationFSM';
-import { OffRouteFSM } from './off-route/OffRouteFSM';
-import { LicenseManager } from './license/LicenseManager';
-import type { RoutePlan } from './route-plan/RoutePlan';
-export interface NavGpsUpdate {
-    coord: Coordinate;
-    accuracy: number | null;
-    bearing: number | null;
-    speed: number;
-    timestamp: number;
-}
-export interface NavCoreOptions {
-    licenseKey?: string;
-    isDev?: boolean;
-    isCircuit?: boolean;
-    kalmanQ?: number;
-    kalmanRBase?: number;
-    baseCorridorMeters?: number;
-    maxCorridorMeters?: number;
-    arrivalThresholdMeters?: number;
-    bearingSmoothingAlpha?: number;
-}
-export interface NavCoreState {
-    snappedCoord: Coordinate | null;
-    ghostCoord: Coordinate | null;
-    rawGpsCoord: Coordinate | null;
-    bearing: number;
-    rawGpsBearing: number | null;
-    routeIndex: number;
-    anchorRouteIndex: number | null;
-    distanceToRoute: number;
-    corridor: number;
-    confidence: number;
-    isOffRoute: boolean;
-    navFsmState: string;
-    progressIndex: number;
-    hasArrived: boolean;
-    rejoinCandidate: {
-        coord: Coordinate;
-        index: number;
-    } | null;
-    confidenceCone: {
-        center: Coordinate;
-        bearing: number;
-        angle: number;
-        length: number;
-    } | null;
-    alertState: 'NONE' | 'DEVIATING' | 'RECALCULATING' | 'REJOINING' | 'REJOINED';
-    detourMode: 'NONE' | 'FREE' | 'COMMITTED';
-    detourCommitProgress: number;
-    distanceToDestination: number | null;
-    distanceToNextInstruction: number | null;
-    nextInstrIdx: number | null;
-    nextInstructionIndex: number | null;
-    currentSpeed: number;
-    isGpsStale: boolean;
-    gpsAgeMs: number;
-    licenseStatus: string;
-    offRouteState: string;
-    lifecycleState: string;
-    stability?: {
-        oscillation: number;
-        drift: number;
-        jump: number;
-    };
-}
-type EventHandler = (...args: unknown[]) => void;
-export declare class NavCore {
-    private kalman;
-    private snapper;
-    private deadReckoning;
-    private deviationDetector;
-    private lifecycleFSM;
-    private offRouteFSM;
-    private license;
-    private route;
-    private instructions;
-    private forwardCum;
-    private reverseCum;
-    private snappedCoord;
-    private ghostCoord;
-    private rawGpsCoord;
-    private bearing;
-    private rawGpsBearing;
-    private routeIndex;
-    private maxProgressIdx;
-    private prevSegment;
-    private distanceToRoute;
-    private corridor;
-    private prevDistToNext;
-    private currentSpeed;
-    private lastGpsTimestamp;
-    private instrIdx;
-    private linearOffset;
-    private hasArrived;
-    private readonly options;
-    private listeners;
-    constructor(options?: NavCoreOptions);
-    /**
-     * Returns true if the feature is unlocked (dev mode OR valid license).
-     * Emits a one-time console warning when a Pro feature is blocked.
-     */
-    private has;
-    /** Load route geometry and instructions */
-    setRoute(route: ReadonlyArray<Coordinate>, instructions?: ReadonlyArray<NavInstruction>): void;
-    /** Load a provider-normalized route plan without exposing mutable route state. */
-    loadRoute(plan: RoutePlan): void;
-    /** Start navigation */
-    startNavigation(): void;
-    /** Process a GPS update — the main engine tick */
-    update(gps: NavGpsUpdate): NavCoreState;
-    /** Time-advance tick for dead reckoning (call at RAF rate) */
-    tick(nowMs: number): NavCoreState;
-    /** Get the current engine state snapshot */
-    getState(): NavCoreState;
-    /** Destroy the engine */
-    destroy(): void;
-    on(event: string, handler: EventHandler): void;
-    off(event: string, handler: EventHandler): void;
-    private emit;
-    getLicenseManager(): LicenseManager;
-    getRoute(): ReadonlyArray<Coordinate>;
-    getInstructions(): ReadonlyArray<NavInstruction>;
-    getOffRouteFSM(): OffRouteFSM;
-    getLifecycleFSM(): NavigationFSM;
-}
-export {};
-//# sourceMappingURL=NavCore.d.ts.map

package/dist/core/src/NavCore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NavCore.d.ts","sourceRoot":"","sources":["../../../../core/src/NavCore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAUlD,OAAO,EAA0B,KAAK,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAE7F,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAIxD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,UAAU,GAAG,IAAI,CAAC;IAChC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7D,cAAc,EAAE;QACd,MAAM,EAAE,UAAU,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IACT,UAAU,EAAE,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,WAAW,GAAG,UAAU,CAAC;IAC9E,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;IAC1C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,KAAK,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAIjD,qBAAa,OAAO;IAElB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,OAAO,CAAiB;IAGhC,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,YAAY,CAAwB;IAC5C,OAAO,CAAC,UAAU,CAAqC;IACvD,OAAO,CAAC,UAAU,CAAqC;IAGvD,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAkC;IAClD,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,gBAAgB,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,UAAU,CAAkB;IAGpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAGnD,OAAO,CAAC,SAAS,CAA0C;gBAE/C,OAAO,CAAC,EAAE,cAAc;IAwBpC;;;OAGG;IACH,OAAO,CAAC,GAAG;IAQX,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,IAAI;IA8B9F,kFAAkF;IAClF,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAIhC,uBAAuB;IACvB,eAAe,IAAI,IAAI;IAKvB,kDAAkD;IAClD,MAAM,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY;IA8MvC,8DAA8D;IAC9D,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAqBjC,4CAA4C;IAC5C,QAAQ,IAAI,YAAY;IAqFxB,yBAAyB;IACzB,OAAO,IAAI,IAAI;IAef,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAO9C,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAQ/C,OAAO,CAAC,IAAI;IAWZ,iBAAiB,IAAI,cAAc;IACnC,QAAQ,IAAI,aAAa,CAAC,UAAU,CAAC;IACrC,eAAe,IAAI,aAAa,CAAC,cAAc,CAAC;IAChD,cAAc,IAAI,WAAW;IAC7B,eAAe,IAAI,aAAa;CACjC"}