react-native-pointr 10.7.0 → 10.7.1

package/src/actions/index.ts

@@ -4,7 +4,7 @@
  * @module commands
  */
 
-import { PTRActionType } from '../constants';
+import { PTRActionType, PTRActionParamKeys as Keys } from '../constants';
 
 /**
  * Base class for all Pointr SDK actions
@@ -15,6 +15,18 @@ export abstract class PTRAction {
   constructor(type: PTRActionType) {
     this.type = type;
   }
+
+  /**
+   * Payload serialized into the native `action` prop.
+   *
+   * Keys are taken from {@link PTRActionParamKeys} rather than from the class
+   * field names, so a field rename here can never silently stop matching the
+   * key Android and iOS read. Undefined values are dropped by JSON.stringify,
+   * which the native side relies on to detect optional parameters.
+   */
+  toPayload(): Record<string, unknown> {
+    return { [Keys.TYPE]: this.type };
+  }
 }
 
 /**
@@ -32,6 +44,15 @@ export class PTRFocusMapAction extends PTRAction {
     this.building = building;
     this.level = level;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.BUILDING]: this.building,
+      [Keys.LEVEL]: this.level,
+    };
+  }
 }
 
 /**
@@ -46,6 +67,14 @@ export class PTRHighlightPoiAction extends PTRAction {
     this.site = site;
     this.poi = poi;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.POI]: this.poi,
+    };
+  }
 }
 
 /**
@@ -63,6 +92,15 @@ export class PTRDisplayRouteAction extends PTRAction {
     this.fromPoi = fromPoi;
     this.toPoi = toPoi;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.FROM_POI]: this.fromPoi,
+      [Keys.TO_POI]: this.toPoi,
+    };
+  }
 }
 
 /**
@@ -77,6 +115,14 @@ export class PTRStartWayfindingAction extends PTRAction {
     this.site = site;
     this.poi = poi;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.POI]: this.poi,
+    };
+  }
 }
 
 /**
@@ -105,6 +151,17 @@ export class PTRMarkMyCarAction extends PTRAction {
     this.shouldShowPopup = shouldShowPopup;
     this.animationType = animationType;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.BUILDING]: this.building,
+      [Keys.LEVEL]: this.level,
+      [Keys.SHOULD_SHOW_POPUP]: this.shouldShowPopup,
+      [Keys.ANIMATION_TYPE]: this.animationType,
+    };
+  }
 }
 
 /**
@@ -125,6 +182,15 @@ export class PTRShowMyCarAction extends PTRAction {
     this.shouldShowPopup = shouldShowPopup;
     this.animationType = animationType;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.SHOULD_SHOW_POPUP]: this.shouldShowPopup,
+      [Keys.ANIMATION_TYPE]: this.animationType,
+    };
+  }
 }
 
 /**
@@ -148,6 +214,16 @@ export class PTRFocusCoordinateAction extends PTRAction {
     this.longitude = longitude;
     this.levelIndex = levelIndex;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.LATITUDE]: this.latitude,
+      [Keys.LONGITUDE]: this.longitude,
+      [Keys.LEVEL_INDEX]: this.levelIndex,
+    };
+  }
 }
 
 /**
@@ -168,4 +244,12 @@ export class PTRHighlightCategoryAction extends PTRAction {
     this.site = site;
     this.categoryIds = categoryIds;
   }
+
+  override toPayload(): Record<string, unknown> {
+    return {
+      ...super.toPayload(),
+      [Keys.SITE]: this.site,
+      [Keys.CATEGORY_IDS]: this.categoryIds,
+    };
+  }
 }

package/src/components/index.tsx

@@ -102,11 +102,13 @@ interface NativePTRMapWidgetProps extends PTRMapWidgetProps {}
  */
 /**
  * Serialize a PTRAction to the JSON string expected by the native action prop.
+ *
+ * The payload keys come from the action's `toPayload()`, which builds them from
+ * the shared {@link PTRActionParamKeys} constants — never from the class field
+ * names — so the keys always match those Android and iOS read.
  */
 function serializeCommand(action: PTRAction): string {
-  const base = { type: action.type, ...(action as any) };
-  // Remove the 'type' key duplication from spread then re-add cleanly
-  return JSON.stringify(base);
+  return JSON.stringify(action.toPayload());
 }
 
 export const PTRMapWidget = forwardRef<any, PTRMapWidgetProps>(

package/src/constants/bridgeKeys.ts

@@ -0,0 +1,127 @@
+/**
+ * Every string that crosses the JS <-> native boundary when an action is sent
+ * to the map widget: action type discriminators, `action` / `sdkConfig` payload
+ * keys and view-manager command names.
+ *
+ * Nothing here may be hard-coded anywhere else — a key renamed on one side only
+ * fails silently (the native side reads an empty string), so all three sides
+ * read them from a constants file:
+ *
+ *   TypeScript  src/constants/bridgeKeys.ts                        (this file)
+ *   Android     android/src/main/java/com/pointr/PTRBridgeKeys.kt
+ *   iOS         ios/PTRBridgeKeys.swift
+ *
+ * Changing a value here means changing it in the other two files as well.
+ *
+ * @module constants/bridgeKeys
+ */
+
+/**
+ * Discriminator written to the `type` field of the serialized `action` prop.
+ */
+export enum PTRActionType {
+  /** Focus the map on a site, building or level */
+  FOCUS_MAP = 'focusMap',
+  /** Highlight a single POI */
+  HIGHLIGHT_POI = 'highlightPoi',
+  /** Draw a static route between two POIs */
+  DISPLAY_ROUTE = 'displayRoute',
+  /** Start live wayfinding to a destination POI */
+  START_WAYFINDING = 'startWayfinding',
+  /** Mark the parked car location */
+  MARK_MY_CAR = 'markMyCar',
+  /** Show the previously marked car location */
+  SHOW_MY_CAR = 'showMyCar',
+  /** Focus the map on a geographic coordinate */
+  FOCUS_COORDINATE = 'focusCoordinate',
+  /** Highlight POIs of one or more categories */
+  HIGHLIGHT_CATEGORY = 'highlightCategory',
+}
+
+/**
+ * Field names of the JSON payload carried by the `action` view prop.
+ * JS writes them, Android and iOS read them back out.
+ */
+export const PTRActionParamKeys = {
+  /** Action discriminator — one of {@link PTRActionType} */
+  TYPE: 'type',
+  /** Site external identifier */
+  SITE: 'site',
+  /** Building external identifier */
+  BUILDING: 'building',
+  /** Level index used by focusMap / markMyCar */
+  LEVEL: 'level',
+  /** POI external identifier — destination for highlightPoi and startWayfinding */
+  POI: 'poi',
+  /** Source POI external identifier for displayRoute */
+  FROM_POI: 'fromPoi',
+  /** Destination POI external identifier for displayRoute */
+  TO_POI: 'toPoi',
+  /** Whether the car popup is shown */
+  SHOULD_SHOW_POPUP: 'shouldShowPopup',
+  /** Animation applied to the car marker */
+  ANIMATION_TYPE: 'animationType',
+  /** Latitude for focusCoordinate */
+  LATITUDE: 'latitude',
+  /** Longitude for focusCoordinate */
+  LONGITUDE: 'longitude',
+  /** Level index for focusCoordinate */
+  LEVEL_INDEX: 'levelIndex',
+  /** Category identifiers for highlightCategory */
+  CATEGORY_IDS: 'categoryIds',
+} as const;
+
+export type PTRActionParamKey =
+  (typeof PTRActionParamKeys)[keyof typeof PTRActionParamKeys];
+
+/**
+ * Field names of the JSON payload carried by the `sdkConfig` view prop.
+ */
+export const PTRSdkConfigKeys = {
+  /** Client identifier issued by Pointr */
+  CLIENT_ID: 'clientId',
+  /** License key issued by Pointr */
+  LICENSE_KEY: 'licenseKey',
+  /** Base URL of the Pointr environment */
+  BASE_URL: 'baseUrl',
+  /** Persona identifier applied to the SDK params */
+  PERSONA_ID: 'personaId',
+  /** Log level ordinal */
+  LOG_LEVEL: 'logLevel',
+} as const;
+
+export type PTRSdkConfigKey =
+  (typeof PTRSdkConfigKeys)[keyof typeof PTRSdkConfigKeys];
+
+/**
+ * View-manager command names used by the imperative `executeMapAction` path.
+ * JS dispatches them, Android matches them in `receiveCommand` and iOS exports
+ * them as `@objc` methods — the names must match on all three sides.
+ */
+export const PTRCommandNames = {
+  /** Focus the map on a site */
+  FOCUS_SITE: 'site',
+  /** Focus the map on a building */
+  FOCUS_BUILDING: 'building',
+  /** Focus the map on a level */
+  FOCUS_LEVEL: 'level',
+  /** Highlight a POI */
+  HIGHLIGHT_POI: 'poi',
+  /** Draw a static route between two POIs */
+  DISPLAY_ROUTE: 'displayRoute',
+  /** Start live wayfinding */
+  START_WAYFINDING: 'startWayfinding',
+  /** Mark the car at site level */
+  MARK_MY_CAR_FOR_SITE: 'markMyCarForSite',
+  /** Mark the car at a specific level */
+  MARK_MY_CAR_FOR_LEVEL: 'markMyCarForLevel',
+  /** Show the marked car at site level */
+  SHOW_MY_CAR_FOR_SITE: 'myCarForSite',
+  /** Focus the map on a coordinate */
+  FOCUS_COORDINATE: 'coordinate',
+  /** Highlight a category */
+  HIGHLIGHT_CATEGORY: 'highlightCategory',
+} as const;
+
+export type PTRCommandName =
+  (typeof PTRCommandNames)[keyof typeof PTRCommandNames];

package/src/constants/index.ts

@@ -3,6 +3,21 @@
  * @module constants
  */
 
+// Strings shared with the native side (action types, payload keys, command
+// names) live in ./bridgeKeys so that TypeScript, Kotlin and Swift all read
+// them from a constants file instead of repeating literals.
+export {
+  PTRActionType,
+  PTRActionParamKeys,
+  PTRSdkConfigKeys,
+  PTRCommandNames,
+} from './bridgeKeys';
+export type {
+  PTRActionParamKey,
+  PTRSdkConfigKey,
+  PTRCommandName,
+} from './bridgeKeys';
+
 /**
  * Log levels for the Pointr SDK
  */
@@ -73,20 +88,6 @@ export const PTREvents = {
   ON_MAP_WIDGET_DID_END_LOADING: 'onMapWidgetDidEndLoading',
 } as const;
 
-/**
- * Action types supported by the Pointr SDK
- */
-export enum PTRActionType {
-  FOCUS_MAP = 'focusMap',
-  HIGHLIGHT_POI = 'highlightPoi',
-  DISPLAY_ROUTE = 'displayRoute',
-  START_WAYFINDING = 'startWayfinding',
-  MARK_MY_CAR = 'markMyCar',
-  SHOW_MY_CAR = 'showMyCar',
-  FOCUS_COORDINATE = 'focusCoordinate',
-  HIGHLIGHT_CATEGORY = 'highlightCategory',
-}
-
 /**
  * Wayfinding mode controlling accessible vs standard routing
  */

package/src/index.tsx

@@ -36,6 +36,18 @@ export {
   PTRWayfindingEventType,
 } from './constants';
 
+// Strings shared with the native side — see src/constants/bridgeKeys.ts
+export {
+  PTRActionParamKeys,
+  PTRSdkConfigKeys,
+  PTRCommandNames,
+} from './constants';
+export type {
+  PTRActionParamKey,
+  PTRSdkConfigKey,
+  PTRCommandName,
+} from './constants';
+
 // ─── React Hooks ───────────────────────────────────────────────────────────────
 export {
   usePointrSdk,

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

@@ -1,17 +0,0 @@
-package com.pointr
-
-import androidx.annotation.StringDef
-
-@StringDef(value = [PTRMapWidgetActionType.FOCUS_MAP, PTRMapWidgetActionType.HIGHLIGHT_POI, PTRMapWidgetActionType.DISPLAY_ROUTE, PTRMapWidgetActionType.START_WAYFINDING, PTRMapWidgetActionType.MARK_MY_CAR, PTRMapWidgetActionType.SHOW_MY_CAR, PTRMapWidgetActionType.FOCUS_COORDINATE, PTRMapWidgetActionType.HIGHLIGHT_CATEGORY])
-annotation class PTRMapWidgetActionType {
-    companion object {
-        const val FOCUS_MAP = "focusMap"
-        const val HIGHLIGHT_POI = "highlightPoi"
-        const val DISPLAY_ROUTE = "displayRoute"
-        const val START_WAYFINDING = "startWayfinding"
-        const val MARK_MY_CAR = "markMyCar"
-        const val SHOW_MY_CAR = "showMyCar"
-        const val FOCUS_COORDINATE = "focusCoordinate"
-        const val HIGHLIGHT_CATEGORY = "highlightCategory"
-    }
-}