react-native-pointr 9.9.0 → 10.1.0

package/src/hooks/usePointrSdk.ts

@@ -21,15 +21,22 @@ export function usePointrSdk(config?: PTRConfiguration) {
         setIsInitialized(true);
         setState(pointrSdk.getState());
 
-        pointrSdk.start(() => {
-          setState(PTRState.RUNNING);
-          setIsStarted(true);
-        });
+        pointrSdk
+          .start()
+          .then(() => {
+            setState(PTRState.RUNNING);
+            setIsStarted(true);
+          })
+          .catch((err: Error) => {
+            setState(PTRState.ERROR);
+            setError(err);
+          });
       } catch (err) {
         setError(err as Error);
       }
     }
-  }, [config, isInitialized]);
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
 
   return {
     sdk: pointrSdk,

package/src/index.tsx

@@ -6,8 +6,8 @@ const LINKING_ERROR =
   '- You rebuilt the app after installing the package\n' +
   '- You are not using Expo Go\n';
 
-const PTRNativePointrLibrary = NativeModules.PTRNativePointrLibrary
-  ? NativeModules.PTRNativePointrLibrary
+const PTRNativeLibrary = NativeModules.PTRNativeLibrary
+  ? NativeModules.PTRNativeLibrary
   : new Proxy(
       {},
       {
@@ -17,30 +17,26 @@ const PTRNativePointrLibrary = NativeModules.PTRNativePointrLibrary
       }
     );
 
-// Export the native library as default (backwards compatibility)
-export default PTRNativePointrLibrary;
+// Default export kept for backward compatibility
+export default PTRNativeLibrary;
 
-// ============================================================================
-// NEW API - Recommended for new projects
-// ============================================================================
-
-// Core API
+// ─── Core API ──────────────────────────────────────────────────────────────────
 export { PointrSdk, pointrSdk } from './api/PointrSdk';
-export {
-  executeMapCommand,
-} from './api/MapWidgetApi';
+export { executeMapAction } from './api/MapWidgetApi';
 
-// Constants and Enums
+// ─── Constants & Enums ─────────────────────────────────────────────────────────
 export {
   PTRLogLevel,
   PTRState,
   PTRAnimationType,
-  PTRCommandType,
+  PTRActionType,
   PTREvents,
   PTRErrorMessages,
+  PTRWayfindingMode,
+  PTRWayfindingEventType,
 } from './constants';
 
-// React Hooks
+// ─── React Hooks ───────────────────────────────────────────────────────────────
 export {
   usePointrSdk,
   usePointrPosition,
@@ -48,39 +44,34 @@ export {
   usePointrGeofence,
   usePointrBuildingClick,
   usePointrSiteClick,
+  usePointrGeofences,
 } from './hooks';
 
-// Components
+// ─── Components ────────────────────────────────────────────────────────────────
 export { PTRMapWidget } from './components';
 export type { PTRMapWidgetProps } from './components';
 
-// Commands (new refactored version)
+// ─── Actions ───────────────────────────────────────────────────────────────────
 export {
-  PTRCommand,
-  PTRSiteCommand,
-  PTRBuildingCommand,
-  PTRLevelCommand,
-  PTRPoiCommand,
-  PTRPathCommand,
-  PTRStaticPathCommand,
-  PTRStaticWayfindingCommand,
-  PTRMarkMyCarLevelCommand,
-  PTRMarkMyCarSiteCommand,
-  PTRShowMyCarSiteCommand,
-  PTRStartAndFocusCommand,
-  isPTRSiteCommand,
-  isPTRBuildingCommand,
-  isPTRLevelCommand,
-  isPTRPoiCommand,
-  isPTRPathCommand,
-  isPTRStaticPathCommand,
-} from './commands';
-
-// Types
+  PTRAction,
+  PTRFocusMapAction,
+  PTRHighlightPoiAction,
+  PTRDisplayRouteAction,
+  PTRStartWayfindingAction,
+  PTRMarkMyCarAction,
+  PTRShowMyCarAction,
+  PTRFocusCoordinateAction,
+  PTRHighlightCategoryAction as PTRCategoryFilterAction,
+} from './actions';
+
+// ─── Types ─────────────────────────────────────────────────────────────────────
 export type {
   PTRConfiguration,
   PTRMapWidgetConfiguration,
   PTRStateCallback,
+} from './types/config';
+
+export type {
   PTRPositionEvent,
   PTRBuildingClickEvent,
   PTRSiteClickEvent,
@@ -88,41 +79,18 @@ export type {
   PTRGeofence,
   PTRGeofenceNotification,
   PTRMapCommandResponse,
-} from './types';
-
-export { PTRGeofenceEventType } from './types';
+} from './types/events';
 
-// ============================================================================
-// LEGACY API - Maintained for backwards compatibility
-// ============================================================================
+export { PTRGeofenceEventType } from './types/events';
 
-// Export POI Manager functions (legacy)
-export { getPois } from './managers/PTRPoiManager';
-
-// Export Map Widget utilities (legacy)
-export { showMapWidget } from './PTRMapWidgetUtils';
-
-// Legacy command exports (still works but new code should use ./commands)
-export {
-  PTRCommandType as LegacyPTRCommandType,
-  PTRCommand as LegacyPTRCommand,
-  PTRSiteCommand as LegacyPTRSiteCommand,
-  PTRBuildingCommand as LegacyPTRBuildingCommand,
-  PTRLevelCommand as LegacyPTRLevelCommand,
-  PTRPoiCommand as LegacyPTRPoiCommand,
-  PTRPathCommand as LegacyPTRPathCommand,
-  PTRStaticPathCommand as LegacyPTRStaticPathCommand,
-  PTRStaticWayfindingCommand as LegacyPTRStaticWayfindingCommand,
-  PTRMarkMyCarLevelCommand as LegacyPTRMarkMyCarLevelCommand,
-  PTRMarkMyCarSiteCommand as LegacyPTRMarkMyCarSiteCommand,
-  PTRShowMyCarSiteCommand as LegacyPTRShowMyCarSiteCommand,
-  PTRStartAndFocusCommand as LegacyPTRStartAndFocusCommand,
-} from './PTRCommand';
-
-// Export all existing types (maintained for backwards compatibility)
 export type { PTRPoi, PTRPoiAttributes } from './types/PTRPoi';
 export type { PTRPosition } from './types/PTRPosition';
 export type { PTRWayfindingEvent } from './types/PTRWayfindingEvent';
+export type {
+  PTRSite,
+  PTRBuilding,
+  PTRLevel,
+} from './types/PTRSite';
 export type {
   PTRGeometry,
   PTRGeoPoint,
@@ -135,5 +103,4 @@ export type {
 } from './types/PTRGeometry';
 
 // Re-export native module reference
-export { PTRNativePointrLibrary };
-
+export { PTRNativeLibrary };

package/src/managers/PTRPoiManager.ts

@@ -1,7 +1,7 @@
 import { NativeModules } from 'react-native';
 import { PTRPoi } from '../types/PTRPoi';
 
-const { PTRNativePointrLibrary } = NativeModules;
+const { PTRNativeLibrary } = NativeModules;
 
 /**
  * Get all Points of Interest (POIs) for a specific site
@@ -11,7 +11,7 @@ const { PTRNativePointrLibrary } = NativeModules;
  */
 export async function getPois(siteId: string): Promise<PTRPoi[]> {
   try {
-    const pois = await PTRNativePointrLibrary.getPois(siteId);
+    const pois = await PTRNativeLibrary.getPois(siteId);
     return pois as PTRPoi[];
   } catch (error) {
     console.error('Failed to get POIs:', error);

package/src/types/PTRPoi.ts

@@ -35,8 +35,11 @@ export interface PTRPoi {
   /** Display name of the POI */
   name: string;
   
-  /** POI type code (e.g., "lobby", "room", "building-outline") */
-  typeCode: string;
+  /** Main POI type (e.g., "lobby", "room", "building-outline") */
+  mainType: string;
+
+  /** Optional sub-type for finer classification within the main type */
+  subType?: string;
   
   /** Geographic position with site, building, and level information */
   position: PTRPosition;

package/src/types/PTRPosition.ts

@@ -4,19 +4,29 @@
 export interface PTRPosition {
   /** Latitude */
   lat: number;
-  
+  /** Latitude (alias for `lat`) */
+  latitude?: number;
+
   /** Longitude */
   lon: number;
-  
+  /** Longitude (alias for `lon`) */
+  longitude?: number;
+
   /** Whether the position is valid */
   isValid: boolean;
-  
+
   /** Site identifier */
   sid: string;
-  
+  /** Site identifier (alias for `sid`) */
+  siteId?: string;
+
   /** Building identifier */
   bid: string;
-  
+  /** Building identifier (alias for `bid`) */
+  buildingId?: string;
+
   /** Level index */
   lvl: number;
+  /** Level index (alias for `lvl`) */
+  levelIndex?: number;
 }

package/src/types/PTRSite.ts

@@ -0,0 +1,46 @@
+/**
+ * Site, Building and Level data structures returned by the Pointr SDK
+ * @module types/PTRSite
+ */
+
+/**
+ * A floor / level within a building
+ */
+export interface PTRLevel {
+  /** Internal level identifier */
+  readonly identifier: string;
+  /** External (customer-facing) level identifier */
+  readonly externalIdentifier: string;
+  /** Human-readable level name */
+  readonly name: string;
+  /** Zero-based index of the level */
+  readonly index: number;
+}
+
+/**
+ * A building within a site
+ */
+export interface PTRBuilding {
+  /** Internal building identifier */
+  readonly identifier: string;
+  /** External (customer-facing) building identifier */
+  readonly externalIdentifier: string;
+  /** Human-readable building name */
+  readonly name: string;
+  /** Levels available in this building */
+  readonly levels: PTRLevel[];
+}
+
+/**
+ * A Pointr site (venue / campus)
+ */
+export interface PTRSite {
+  /** Internal site identifier */
+  readonly identifier: string;
+  /** External (customer-facing) site identifier */
+  readonly externalIdentifier: string;
+  /** Human-readable site name */
+  readonly name: string;
+  /** Buildings within this site */
+  readonly buildings: PTRBuilding[];
+}

package/src/types/PTRWayfindingEvent.ts

@@ -1,18 +1,22 @@
 import { PTRPoi } from './PTRPoi';
+import { PTRWayfindingEventType } from '../constants';
 
 /**
  * Wayfinding event data structure
  * Fired during wayfinding operations to track navigation state
  */
 export interface PTRWayfindingEvent {
-  /** 
-   * Event type:
-   * -1 = Cancelled (user cancelled the navigation)
-   * 0 = Started (wayfinding navigation has started)
-   * 1 = Ended (user completed or closed the navigation)
+  /**
+   * Event type describing the wayfinding lifecycle.
+   * Use {@link PTRWayfindingEventType} enum values for comparisons.
+   *
+   * For backward compatibility the value is the numeric raw value of the enum:
+   * -1 = CANCELLED, 0 = STARTED, 1 = ENDED
    */
-  type: number;
-  
+  type: PTRWayfindingEventType;
+
   /** Destination Point of Interest */
   poi: PTRPoi;
 }
+
+export { PTRWayfindingEventType };

package/src/types/config.ts

@@ -53,5 +53,6 @@ export interface PTRMapWidgetConfiguration {
 
 /**
  * Callback function for SDK state changes
+ * @deprecated Use the Promise returned by {@link PTRSdk.start} instead.
  */
 export type PTRStateCallback = (state: string) => void;

package/src/types/events.ts

@@ -104,3 +104,4 @@ export interface PTRMapCommandResponse {
   /** Error message if command failed */
   readonly error?: string;
 }
+

package/src/types/index.ts

@@ -23,6 +23,7 @@ export { PTRGeofenceEventType } from './events';
 export type { PTRPoi, PTRPoiAttributes } from './PTRPoi';
 export type { PTRPosition } from './PTRPosition';
 export type { PTRWayfindingEvent } from './PTRWayfindingEvent';
+export { PTRWayfindingEventType } from './PTRWayfindingEvent';
 export type {
   PTRGeometry,
   PTRGeoPoint,
@@ -33,3 +34,6 @@ export type {
   PTRGeoMultiPolygon,
   PTRGeoCircle,
 } from './PTRGeometry';
+
+// Export site / building / level types
+export type { PTRSite, PTRBuilding, PTRLevel } from './PTRSite';

package/android/src/main/java/com/pointr/PTRMapWidgetCommandType.kt

@@ -1,20 +0,0 @@
-package com.pointr
-
-import androidx.annotation.StringDef
-
-@StringDef(value = [PTRMapWidgetCommandType.SITE, PTRMapWidgetCommandType.BUILDING, PTRMapWidgetCommandType.LEVEL, PTRMapWidgetCommandType.POI, PTRMapWidgetCommandType.PATH, PTRMapWidgetCommandType.STATIC_PATH, PTRMapWidgetCommandType.STATIC_WAYFINDING, PTRMapWidgetCommandType.START_AND_FOCUS])
-annotation class PTRMapWidgetCommandType {
-    companion object {
-        const val SITE = "site"
-        const val BUILDING = "building"
-        const val LEVEL = "level"
-        const val POI = "poi"
-        const val PATH = "path"
-        const val STATIC_PATH = "staticPath"
-        const val STATIC_WAYFINDING = "staticWayfinding"
-        const val MARK_MY_CAR_LEVEL = "markMyCarForLevel"
-        const val MARK_MY_CAR_SITE = "markMyCarForSite"
-        const val SHOW_MY_CAR_SITE = "showMyCarForSite"
-        const val START_AND_FOCUS = "startAndFocus"
-    }
-}

package/src/PTRCommand.ts

@@ -1,153 +0,0 @@
-/**
- * Command types supported by the Pointr SDK
- */
-export enum PTRCommandType {
-    SITE = "site",
-    BUILDING = "building",
-    LEVEL = "level",
-    POI = "poi",
-    PATH = "path",
-    STATIC_PATH = "staticPath",
-    STATIC_WAYFINDING = "staticWayfinding",
-    MARK_MY_CAR_LEVEL = "markMyCarForLevel",
-    MARK_MY_CAR_SITE = "markMyCarForSite",
-    SHOW_MY_CAR_SITE = "showMyCarForSite",
-    START_AND_FOCUS = "startAndFocus"
-}
-/**
- * Base class for all Pointr SDK commands
- * @param type - the command type
- */
-export abstract class PTRCommand {
-    constructor(public type: PTRCommandType = PTRCommandType.SITE) { }
-}
-/**
- * Command to show a site
- * @param site - the site to show
- */
-export class PTRSiteCommand extends PTRCommand {
-    constructor(public site: string) {
-        super(PTRCommandType.SITE);
-    }
-}
-/**
- * Command to show a building
- * @param site - the site to show
- * @param building - the building to show
- */
-export class PTRBuildingCommand extends PTRCommand {
-    constructor(public site: string, public building: string) {
-        super(PTRCommandType.BUILDING);
-    }
-}
-/**
- * Command to show a level
- * @param site - the site to show
- * @param building - the building to show
- * @param level - the level to show
- */
-export class PTRLevelCommand extends PTRCommand {
-    constructor(public site: string, public building: string, public level: number) {
-        super(PTRCommandType.LEVEL);
-    }
-}
-/**
- * Command to show a POI
- * @param site - the site that has the POI
- * @param poi - the POI to show
- */
-export class PTRPoiCommand extends PTRCommand {
-    constructor(public site: string, public poi: string) {
-        super(PTRCommandType.POI);
-    }
-}
-/**
- * Command to show a path
- * @param site - the site that has the POI
- * @param poi - the POI to show the path to from the current location
- */
-export class PTRPathCommand extends PTRCommand {
-    constructor(public site: string, public poi: string) {
-        super(PTRCommandType.PATH);
-    }
-}
-/**
- * Command to show a static path
- * @param site - the site that has the POIs
- * @param fromPoi - the POI to start the path from
- * @param toPoi - the POI to end the path at
- */
-export class PTRStaticPathCommand extends PTRCommand {
-    constructor(public site: string, public fromPoi: string, public toPoi: string) {
-        super(PTRCommandType.STATIC_PATH);
-    }
-}
-
-/**
- * Command to show static wayfinding using PTRMapWidgetStaticWayfindingAction
- * @param site - the site that has the POIs
- * @param sourcePoi - the source POI location to start the path from
- * @param destinationPoi - the destination POI location to end the path at
- */
-export class PTRStaticWayfindingCommand extends PTRCommand {
-    constructor(public site: string, public sourcePoi: string, public destinationPoi: string) {
-        super(PTRCommandType.STATIC_WAYFINDING);
-    }
-}
-
-/**
- * Command to show mark my car details
- * @param site - the site to show mark my car details
- * @param building - the building to show mark my car details
- * @param level - the level to show mark my car details
- * @param shouldShowPopup - flag to show popup or not
- * @param animationType - animation type to show map loading
- */
-export class PTRMarkMyCarLevelCommand extends PTRCommand {
-    constructor(public site: string, public building: string, public level: number, public shouldShowPopup: boolean = true, public animationType: number = 1) {
-        super(PTRCommandType.MARK_MY_CAR_LEVEL);
-    }
-}
-
-/**
- * Command to show mark my car details
- * @param site - the site to show mark my car details
- * @param shouldShowPopup - flag to show popup or not
- * @param animationType - animation type to show map loading
- */
-export class PTRMarkMyCarSiteCommand extends PTRCommand {
-    constructor(public site: string, public shouldShowPopup: boolean = true, public animationType: number = 1) {
-        super(PTRCommandType.MARK_MY_CAR_SITE);
-    }
-}
-
-/**
- * Command to show my car details
- * @param site - the site to show my car details
- * @param shouldShowPopup - flag to show popup or not
- * @param animationType - animation type to show map loading
- */
-export class PTRShowMyCarSiteCommand extends PTRCommand {
-    constructor(public site: string, public shouldShowPopup: boolean = true, public animationType: number = 1) {
-        super(PTRCommandType.SHOW_MY_CAR_SITE);
-    }
-}
-
-/**
- * Command to start the SDK and focus on a location using an existing PTR command
- * This command is not a PTRCommand itself, but wraps SDK initialization with a focus command
- * @param clientId - the client ID for SDK initialization
- * @param licenseKey - the license key for SDK initialization  
- * @param baseUrl - the base URL for SDK initialization
- * @param logLevel - the log level for SDK initialization
- * @param command - the PTR command to execute after SDK initialization (PTRSiteCommand, PTRBuildingCommand, PTRLevelCommand, or PTRPoiCommand)
- */
-export class PTRStartAndFocusCommand {
-    constructor(
-        public clientId: string,
-        public licenseKey: string,
-        public baseUrl: string,
-        public logLevel: number = 4,
-        public command: PTRSiteCommand | PTRBuildingCommand | PTRLevelCommand | PTRPoiCommand
-    ) {}
-}

package/src/api/index.ts

@@ -1,9 +0,0 @@
-/**
- * API utilities for the Pointr SDK
- * @module api
- */
-
-export { PointrSdk, pointrSdk } from './PointrSdk';
-export {
-  executeMapCommand,
-} from './MapWidgetApi';