@wayq/beekon-rn 0.0.1

package/src/types/config.ts

@@ -0,0 +1,42 @@
+import type { Preset } from './preset';
+
+/**
+ * Foreground service notification config — required when running on Android
+ * because Android 8+ requires a persistent notification while a foreground
+ * service is active. Ignored on iOS.
+ */
+export type AndroidNotificationConfig = {
+  /** NotificationChannel id (Android 8+). */
+  channelId: string;
+  /** User-visible channel display name. */
+  channelName: string;
+  /** Foreground notification id. Must be > 0. */
+  notificationId: number;
+  /** Notification title shown in the status bar. */
+  title: string;
+  /** Notification body text. */
+  text: string;
+  /**
+   * Drawable resource name for the notification icon (e.g. `ic_notification`).
+   * Resolved at runtime via `Resources.getIdentifier()` against the host app's
+   * `res/drawable*` folders. Pass the resource name without extension or
+   * `R.drawable.` prefix.
+   */
+  smallIconResName: string;
+};
+
+export type BeekonConfig = {
+  /** Sampling preset. Default: `'balanced'`. */
+  preset?: Preset;
+  /** Override the preset's distance gate (meters). */
+  distanceFilterMeters?: number;
+  /** Override the preset's interval (milliseconds). */
+  intervalMillis?: number;
+  /**
+   * Required when running on Android. Ignored on iOS. The plugin throws
+   * `NOT_CONFIGURED` if missing on Android.
+   */
+  androidNotification?: AndroidNotificationConfig;
+  /** Optional license key. Reserved for future use. */
+  licenseKey?: string;
+};

package/src/types/position.ts

@@ -0,0 +1,23 @@
+/**
+ * A single location fix as emitted by the native SDK after gating. Fields map
+ * 1:1 to `com.wayq.beekon.Position` on Android and `Beekon.Position` on iOS.
+ *
+ * The SDK does NOT smooth or filter positions beyond the gate — values are
+ * forwarded as the OS provider reported them (raw passthrough).
+ */
+export type Position = {
+  /** Latitude in degrees, WGS-84. */
+  lat: number;
+  /** Longitude in degrees, WGS-84. */
+  lng: number;
+  /** Horizontal accuracy in meters (1-sigma). */
+  accuracy: number;
+  /** Speed in m/s. May be 0 if the OS provider doesn't supply it. */
+  speed: number;
+  /** Bearing in degrees clockwise from true north. */
+  bearing: number;
+  /** Altitude in meters above the WGS-84 ellipsoid. */
+  altitude: number;
+  /** Time the OS provider reported this fix (not when JS received it). */
+  timestamp: Date;
+};

package/src/types/preset.ts

@@ -0,0 +1,11 @@
+/**
+ * Sampling preset. Determines the gating interval and distance threshold the
+ * native SDK uses before emitting a position. Per `docs/REQUIREMENTS.md`:
+ *
+ * | Preset    | Interval | Distance | Battery (typical) |
+ * |-----------|----------|----------|-------------------|
+ * | saver     | 60_000ms | 150 m    | 3–8%              |
+ * | balanced  | 30_000ms | 100 m    | 5–10%             |
+ * | precision | 10_000ms | 30 m     | 15–25%            |
+ */
+export type Preset = 'saver' | 'balanced' | 'precision';

package/src/types/state.ts

@@ -0,0 +1,16 @@
+/**
+ * Why tracking is paused. Names match the native `PauseReason` enum on both
+ * platforms byte-for-byte.
+ */
+export type PauseReason = 'permissionRevoked' | 'locationDisabled' | 'unknown';
+
+/**
+ * Tracking state. Mirrors the native `BeekonState` sealed hierarchy on both
+ * platforms. Use the `kind` field as a discriminator.
+ */
+export type BeekonState =
+  | { kind: 'idle' }
+  | { kind: 'starting' }
+  | { kind: 'tracking' }
+  | { kind: 'paused'; reason: PauseReason }
+  | { kind: 'stopped' };