react-native-pointr 9.5.0 → 9.7.0

package/src/index.tsx

@@ -17,18 +17,45 @@ const PTRNativePointrLibrary = NativeModules.PTRNativePointrLibrary
       }
     );
 
-// Export the native library as default
+// Export the native library as default (backwards compatibility)
 export default PTRNativePointrLibrary;
 
-// Export POI Manager functions
-export { getPois } from './PTRPoiManager';
+// ============================================================================
+// NEW API - Recommended for new projects
+// ============================================================================
 
-// Export Map Widget utilities
-export { showMapWidget } from './PTRMapWidgetUtils';
+// Core API
+export { PointrSdk, pointrSdk } from './api/PointrSdk';
+export {
+  executeMapCommand,
+} from './api/MapWidgetApi';
 
-// Export PTR Commands
+// Constants and Enums
 export {
+  PTRLogLevel,
+  PTRState,
+  PTRAnimationType,
   PTRCommandType,
+  PTREvents,
+  PTRErrorMessages,
+} from './constants';
+
+// React Hooks
+export {
+  usePointrSdk,
+  usePointrPosition,
+  usePointrPois,
+  usePointrGeofence,
+  usePointrBuildingClick,
+  usePointrSiteClick,
+} from './hooks';
+
+// Components
+export { PTRMapWidget } from './components';
+export type { PTRMapWidgetProps } from './components';
+
+// Commands (new refactored version)
+export {
   PTRCommand,
   PTRSiteCommand,
   PTRBuildingCommand,
@@ -41,9 +68,58 @@ export {
   PTRMarkMyCarSiteCommand,
   PTRShowMyCarSiteCommand,
   PTRStartAndFocusCommand,
+  isPTRSiteCommand,
+  isPTRBuildingCommand,
+  isPTRLevelCommand,
+  isPTRPoiCommand,
+  isPTRPathCommand,
+  isPTRStaticPathCommand,
+} from './commands';
+
+// Types
+export type {
+  PTRConfiguration,
+  PTRMapWidgetConfiguration,
+  PTRStateCallback,
+  PTRPositionEvent,
+  PTRBuildingClickEvent,
+  PTRSiteClickEvent,
+  PTRGeofenceEvent,
+  PTRGeofence,
+  PTRGeofenceNotification,
+  PTRMapCommandResponse,
+} from './types';
+
+export { PTRGeofenceEventType } from './types';
+
+// ============================================================================
+// LEGACY API - Maintained for backwards compatibility
+// ============================================================================
+
+// 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 types
+// 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';
@@ -57,3 +133,7 @@ export type {
   PTRGeoMultiPolygon,
   PTRGeoCircle,
 } from './types/PTRGeometry';
+
+// Re-export native module reference
+export { PTRNativePointrLibrary };
+

package/src/{PTRPoiManager.ts → managers/PTRPoiManager.ts}

@@ -1,5 +1,5 @@
 import { NativeModules } from 'react-native';
-import { PTRPoi } from './types/PTRPoi';
+import { PTRPoi } from '../types/PTRPoi';
 
 const { PTRNativePointrLibrary } = NativeModules;
 

package/src/types/config.ts

@@ -0,0 +1,57 @@
+/**
+ * Configuration types for the Pointr SDK
+ * @module types/config
+ */
+
+import { PTRLogLevel } from '../constants';
+
+/**
+ * Configuration options for initializing the Pointr SDK
+ */
+export interface PTRConfiguration {
+  /** Client ID provided by Pointr */
+  readonly clientId: string;
+  /** License key provided by Pointr */
+  readonly licenseKey: string;
+  /** Base URL for the Pointr service */
+  readonly baseUrl: string;
+  /** Log level for SDK output (default: ERROR) */
+  readonly logLevel?: PTRLogLevel;
+}
+
+/**
+ * Map widget configuration options
+ */
+export interface PTRMapWidgetConfiguration {
+  /** Show/hide the level selector UI */
+  readonly isLevelSelectorEnabled?: boolean;
+  /** Show/hide the loading view */
+  readonly isLoadingViewEnabled?: boolean;
+  /** Show/hide the map tracking mode button */
+  readonly isMapTrackingModeButtonEnabled?: boolean;
+  /** Show/hide the exit button */
+  readonly isExitButtonEnabled?: boolean;
+  /** Show/hide the splash screen */
+  readonly isSplashScreenEnabled?: boolean;
+  /** Enable/disable the onboarding flow */
+  readonly isOnboardingEnabled?: boolean;
+  /** Show/hide the joystick control */
+  readonly isJoystickEnabled?: boolean;
+  /** Show/hide toast messages */
+  readonly isToastMessagesEnabled?: boolean;
+  /** Show/hide the info button */
+  readonly isInfoButtonEnabled?: boolean;
+  /** Show/hide the location indicator */
+  readonly isLocationIndicatorEnabled?: boolean;
+  /** Automatically pan map to first calculated user position */
+  readonly shouldFocusOnFirstUserPosition?: boolean;
+  /** Enable/disable quick access panel */
+  readonly isQuickAccessEnabled?: boolean;
+  /** Show/hide the app banner */
+  readonly isAppBannerEnabled?: boolean;
+}
+
+/**
+ * Callback function for SDK state changes
+ */
+export type PTRStateCallback = (state: string) => void;

package/src/types/events.ts

@@ -0,0 +1,106 @@
+/**
+ * Event types for the Pointr SDK
+ * @module types/events
+ */
+
+import type { PTRPosition } from './PTRPosition';
+
+/**
+ * Position event payload
+ */
+export interface PTRPositionEvent {
+  /** Geographic position */
+  readonly position: PTRPosition;
+  /** Timestamp of the position calculation */
+  readonly timestamp?: number;
+  /** Accuracy of the position in meters */
+  readonly accuracy?: number;
+}
+
+/**
+ * Building click event payload
+ */
+export interface PTRBuildingClickEvent {
+  /** Site identifier */
+  readonly siteId: string;
+  /** Building identifier */
+  readonly buildingId: string;
+  /** Building name */
+  readonly buildingName?: string;
+}
+
+/**
+ * Site click event payload
+ */
+export interface PTRSiteClickEvent {
+  /** Site identifier */
+  readonly siteId: string;
+  /** Site name */
+  readonly siteName?: string;
+}
+
+/**
+ * Geofence event types
+ */
+export enum PTRGeofenceEventType {
+  /** User entered a geofence */
+  ENTER = 'enter',
+  /** User exited a geofence */
+  EXIT = 'exit',
+  /** User is dwelling in a geofence */
+  DWELL = 'dwell',
+}
+
+/**
+ * Geofence data
+ */
+export interface PTRGeofence {
+  /** Geofence identifier */
+  readonly id: string;
+  /** External identifier */
+  readonly externalId?: string;
+  /** Geofence name */
+  readonly name: string;
+  /** Geofence type */
+  readonly geofenceType: string;
+  /** Position of the geofence */
+  readonly position: PTRPosition;
+}
+
+/**
+ * Geofence notification
+ */
+export interface PTRGeofenceNotification {
+  /** Notification identifier */
+  readonly id: string;
+  /** Notification message */
+  readonly message: string;
+  /** Notification timestamp */
+  readonly timestamp: number;
+}
+
+/**
+ * Geofence event payload
+ */
+export interface PTRGeofenceEvent {
+  /** Event type (enter/exit/dwell) */
+  readonly eventType: PTRGeofenceEventType | string;
+  /** Geofence data */
+  readonly geofence?: PTRGeofence;
+  /** Optional notification */
+  readonly geofenceNotification?: PTRGeofenceNotification;
+  /** Event timestamp (iOS only) */
+  readonly timestamp?: number;
+}
+
+/**
+ * Map command response payload
+ */
+export interface PTRMapCommandResponse {
+  /** Command type that was executed */
+  readonly command: string;
+  /** Site external identifier (for site commands) */
+  readonly siteExternalIdentifier?: string;
+  /** Error message if command failed */
+  readonly error?: string;
+}

package/src/types/index.ts

@@ -0,0 +1,35 @@
+/**
+ * Type definitions for the Pointr SDK
+ * @module types
+ */
+
+// Export configuration types
+export type { PTRConfiguration, PTRMapWidgetConfiguration, PTRStateCallback } from './config';
+
+// Export event types
+export type {
+  PTRPositionEvent,
+  PTRBuildingClickEvent,
+  PTRSiteClickEvent,
+  PTRGeofenceEvent,
+  PTRGeofence,
+  PTRGeofenceNotification,
+  PTRMapCommandResponse,
+} from './events';
+
+export { PTRGeofenceEventType } from './events';
+
+// Export existing types
+export type { PTRPoi, PTRPoiAttributes } from './PTRPoi';
+export type { PTRPosition } from './PTRPosition';
+export type { PTRWayfindingEvent } from './PTRWayfindingEvent';
+export type {
+  PTRGeometry,
+  PTRGeoPoint,
+  PTRGeoLineString,
+  PTRGeoPolygon,
+  PTRGeoMultiPoint,
+  PTRGeoMultiLineString,
+  PTRGeoMultiPolygon,
+  PTRGeoCircle,
+} from './PTRGeometry';

package/.vscode/settings.json

@@ -1,21 +0,0 @@
-{
-    "java.configuration.updateBuildConfiguration": "disabled",
-    "java.compile.nullAnalysis.mode": "automatic",
-    "cSpell.words": [
-        "androidx",
-        "Autoresizing",
-        "datamanager",
-        "deeplink",
-        "EDIP",
-        "nativecore",
-        "nonnull",
-        "Parcelable",
-        "Pathfinding",
-        "pathmanager",
-        "pointrlabs",
-        "Subview",
-        "uimanager",
-        "viewmodels",
-        "wayfinding"
-    ]
-}

package/example/pointr_rn_demo/.bundle/config

@@ -1,2 +0,0 @@
-BUNDLE_PATH: "vendor/bundle"
-BUNDLE_FORCE_RUBY_PLATFORM: 1

package/example/pointr_rn_demo/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: '@react-native',
-};

package/example/pointr_rn_demo/.prettierrc.js

@@ -1,5 +0,0 @@
-module.exports = {
-  arrowParens: 'avoid',
-  singleQuote: true,
-  trailingComma: 'all',
-};

package/example/pointr_rn_demo/.watchmanconfig

@@ -1 +0,0 @@
-{}

package/example/pointr_rn_demo/App.tsx

@@ -1,323 +0,0 @@
-import React, { useRef, useEffect, useState } from 'react';
-import {
-  requireNativeComponent,
-  findNodeHandle,
-  Button,
-  View,
-  ScrollView,
-  NativeSyntheticEvent,
-  NativeModules,
-  NativeEventEmitter
-} from 'react-native';
-import { useSafeAreaInsets } from 'react-native-safe-area-context';
-import {
-  getPois,
-  showMapWidget,
-  PTRSiteCommand,
-  PTRBuildingCommand,
-  PTRLevelCommand,
-  PTRPoiCommand,
-  PTRPathCommand,
-  PTRStaticPathCommand,
-  PTRMarkMyCarLevelCommand,
-  PTRMarkMyCarSiteCommand,
-  PTRShowMyCarSiteCommand,
-  PTRStartAndFocusCommand,
-  type PTRPoi,
-  type PTRWayfindingEvent,
-} from 'react-native-pointr';
-
-interface PTRMapWidgetProps {
-  style?: any;
-  onMapWidgetDidEndLoading?: (event: NativeSyntheticEvent<any>) => void;
-  onWayfindingEvent?: (event: NativeSyntheticEvent<PTRWayfindingEvent>) => void;
-}
-const PTRMapWidget = requireNativeComponent<PTRMapWidgetProps>('PTRMapWidget');
-
-// Create event emitter for Pointr events
-const PTREventEmitter = new NativeEventEmitter(NativeModules.PTRNativePointrLibrary);
-
-function App(): React.JSX.Element {
-  const ref = useRef<any>(null);
-  const [isInitialized, setIsInitialized] = useState(false);
-  const insets = useSafeAreaInsets();
-  
-  // Initialize Pointr library when component mounts
-  useEffect(() => {
-    // Use setTimeout to defer initialization to next tick, preventing blocking
-    const timer = setTimeout(() => {
-      try {
-        console.log('Initializing Pointr library...');
-        
-        // Initialize the Pointr library
-        NativeModules.PTRNativePointrLibrary.initialize(
-          "1ee58e56-fc35-4ec4-b32e-5d49e65fb52d",
-          "af5d9431-56a3-46a9-ae0a-65d9757528d1",
-          "https://sample-app-v9.pointr.cloud",
-          0
-        );
-
-        // Start the Pointr SDK
-        NativeModules.PTRNativePointrLibrary.start((state: string) => {
-          console.log(`Pointr state: ${state}`);
-          setIsInitialized(true);
-        });
-
-      } catch (error) {
-        console.error('Error initializing Pointr:', error);
-        setIsInitialized(true); // Set to true anyway to prevent blocking UI
-      }
-    }, 100);
-
-    return () => clearTimeout(timer);
-  }, []);
-  
-  // Set up geofence event listener
-  useEffect(() => {
-    if (!isInitialized) return;
-    // Subscribe to OnGeofenceEvent
-    const geofenceSubscription = PTREventEmitter.addListener(
-      'OnGeofenceEvent',
-      (geofenceEvent) => {
-        console.log('=== Geofence Event Received ===');
-        // Log the event type
-        console.log(`Event Type: ${geofenceEvent.eventType}`);
-        
-        // Log timestamp if available (iOS only)
-        if (geofenceEvent.timestamp) {
-          console.log(`Timestamp: ${new Date(geofenceEvent.timestamp).toISOString()}`);
-        }
-        
-        // Log geofence information
-        if (geofenceEvent.geofence) {
-          console.log('Geofence Information:');
-          console.log(`  - ID: ${geofenceEvent.geofence.id}`);
-          console.log(`  - External ID: ${geofenceEvent.geofence.externalId}`);
-          console.log(`  - Name: ${geofenceEvent.geofence.name}`);
-          console.log(`  - Type: ${geofenceEvent.geofence.geofenceType}`);
-          console.log(`  - Location: ${geofenceEvent.geofence.position.latitude}, ${geofenceEvent.geofence.position.longitude}`);
-        }
-        
-        // Log notification information if available
-        if (geofenceEvent.geofenceNotification) {
-          console.log('Notification:');
-          console.log(`  - ID: ${geofenceEvent.geofenceNotification.id}`);
-          console.log(`  - Message: ${geofenceEvent.geofenceNotification.message}`);
-          console.log(`  - Timestamp: ${geofenceEvent.geofenceNotification.timestamp}`);
-        }
-        
-        console.log('================================');
-      }
-    );
-
-    const positionSubscription = PTREventEmitter.addListener("OnPositionManagerCalculatedLocation", (location) => {
-      // console.log("Calculated Location: ", location);
-    });
-    
-    // Clean up the subscription when component unmounts
-    return () => {
-      geofenceSubscription.remove();
-      positionSubscription.remove();
-    };
-  }, [isInitialized]);
-
-  const handleWayfindingEvent = (event: NativeSyntheticEvent<PTRWayfindingEvent>) => {
-    const wayfindingEvent = event.nativeEvent;
-    
-    // Determine event type name
-    let eventTypeName: string;
-    switch (wayfindingEvent.type) {
-      case -1:
-        eventTypeName = 'Cancelled';
-        break;
-      case 0:
-        eventTypeName = 'Started';
-        break;
-      case 1:
-        eventTypeName = 'Ended';
-        break;
-      default:
-        eventTypeName = 'Unknown';
-    }
-    
-    console.log('=== Wayfinding Event ===');
-    console.log(`Event Type: ${eventTypeName} (${wayfindingEvent.type})`);
-    console.log('Destination POI:');
-    console.log(`  - Name: ${wayfindingEvent.poi.name}`);
-    console.log(`  - Identifier: ${wayfindingEvent.poi.identifier}`);
-    console.log(`  - External ID: ${wayfindingEvent.poi.externalIdentifier}`);
-    console.log(`  - Type Code: ${wayfindingEvent.poi.typeCode}`);
-    console.log(`  - Position: lat ${wayfindingEvent.poi.position.lat}, lon ${wayfindingEvent.poi.position.lon}, level ${wayfindingEvent.poi.position.lvl}`);
-    console.log('========================');
-  };
-
-  const handleMapWidgetDidEndLoading = (event: NativeSyntheticEvent<any>) => {
-    const ptrCommandResponse = event.nativeEvent;
-    if (ptrCommandResponse.command === "site") {
-      console.log("Map did end loading:", ptrCommandResponse.command, ptrCommandResponse.siteExternalIdentifier, ptrCommandResponse.error);
-      
-      getPois(ptrCommandResponse.siteExternalIdentifier)
-        .then((pois: PTRPoi[]) => {
-          console.log(`POIs fetched: ${pois.length} items`);
-          // Example: Log first POI details
-          if (pois.length > 0) {
-            const firstPoi = pois[0];
-            console.log('First POI:', {
-              name: firstPoi.name,
-              identifier: firstPoi.identifier,
-              typeCode: firstPoi.typeCode,
-              position: firstPoi.position,
-            });
-          }
-        })
-        .catch((error) => {
-          console.error("Error fetching POIs:", error);
-        });
-    } else {
-      console.log("Map did end loading with unknown parameters:", ptrCommandResponse);
-    }
-  };
-
-  const showSite = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRSiteCommand("workplace-portland");
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showBuilding = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRBuildingCommand("workplace-portland", "office-east");
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showLevel = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRLevelCommand("workplace-portland", "office-east", 2);
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showPoi = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRPoiCommand("workplace-portland", "Lobby");
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showPath = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRPathCommand("workplace-portland", "Lobby");
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showStaticPath = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRStaticPathCommand("workplace-portland", "Accessories", "Lobby");
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const markMyCarLevel = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRMarkMyCarLevelCommand("workplace-portland", "office-east", 1, true);
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const markMyCarSite = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRMarkMyCarSiteCommand("workplace-portland", true);
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const showMyCarSite = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      let command = new PTRShowMyCarSiteCommand("workplace-portland", true);
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  const startAndFocusSite = () => {
-    const reactTag = findNodeHandle(ref.current);
-    if (reactTag) {
-      const siteCommand = new PTRSiteCommand("workplace-portland");
-      const command = new PTRStartAndFocusCommand(
-        "1ee58e56-fc35-4ec4-b32e-5d49e65fb52d",
-        "af5d9431-56a3-46a9-ae0a-65d9757528d1",
-        "https://sample-app-v9.pointr.cloud",
-        0,
-        siteCommand
-      );
-      showMapWidget(reactTag, command);
-    } else {
-      console.error("Failed to find node handle for ref");
-    }
-  };
-
-  return (
-    <View style={{ flex: 1 }}>
-      <View style={{ flex: 1, paddingTop: insets.top, paddingLeft: insets.left, paddingRight: insets.right }}>
-        <ScrollView style={{ flex: 1 }} contentContainerStyle={{ padding: 16 }}>
-          <Button title="Show Site" onPress={showSite} />
-          <View style={{ height: 12 }} />
-          <Button title="Show Building" onPress={showBuilding} />
-          <View style={{ height: 12 }} />
-          <Button title="Show Level" onPress={showLevel} />
-          <View style={{ height: 12 }} />
-          <Button title="Show POI" onPress={showPoi} />
-          <View style={{ height: 12 }} />
-          <Button title="Show Path" onPress={showPath} />
-          <View style={{ height: 12 }} />
-          <Button title="Show Static Path" onPress={showStaticPath} />
-          <View style={{ height: 12 }} />
-          <Button title="Mark My Car Level" onPress={markMyCarLevel} />
-          <View style={{ height: 12 }} />
-          <Button title="Mark My Car Site" onPress={markMyCarSite} />
-          <View style={{ height: 12 }} />
-          <Button title="Show My Car Site" onPress={showMyCarSite} />
-          <View style={{ height: 12 }} />
-          <Button title="Start & Focus Site" onPress={startAndFocusSite} />
-        </ScrollView>
-      </View>
-      <PTRMapWidget 
-        ref={ref} 
-        style={{ flex: 4 }} 
-        onMapWidgetDidEndLoading={handleMapWidgetDidEndLoading} 
-        onWayfindingEvent={handleWayfindingEvent}
-      />
-    </View>
-  );
-}
-
-export default App;