@wayq/beekon-rn 0.0.3 → 0.0.5

package/lib/typescript/src/types/location.d.ts

@@ -1,17 +1,23 @@
+import type { ActivityType, LocationQuality, LocationTrigger, MotionState } from './enums';
 /**
  * A single location fix as emitted by the native SDK after gating. Fields map
  * 1:1 to `in.wayq.beekon.Location` on Android and `BeekonKit.Location` on iOS.
  *
- * `lat`, `lng`, and `timestamp` are always present. The four optional fields
- * are `null` when the OS did not report a value — the SDK never invents a
- * value to mask absence (e.g. a stationary device returns `bearing === null`,
- * not `0`).
+ * `id`, `latitude`, `longitude`, and `timestamp` are always present. The four
+ * optional numeric fields are `null` when the OS did not report a value — the
+ * SDK never invents a value to mask absence (e.g. a stationary device returns
+ * `bearing === null`, not `0`). `activity` is `null` unless
+ * {@link BeekonConfig.detectActivity} is enabled.
  */
 export type Location = {
+    /** Stable, unique storage id. Used as the dedup key on upload. */
+    id: string;
     /** Latitude in degrees, WGS-84. */
-    lat: number;
+    latitude: number;
     /** Longitude in degrees, WGS-84. */
-    lng: number;
+    longitude: number;
+    /** Time the OS provider reported this fix (not when JS received it). */
+    timestamp: Date;
     /** Horizontal accuracy in meters (1-sigma); `null` if unreported. */
     accuracy: number | null;
     /** Speed in m/s; `null` if unreported. */
@@ -20,7 +26,15 @@ export type Location = {
     bearing: number | null;
     /** Altitude in meters above the WGS-84 ellipsoid; `null` if unreported. */
     altitude: number | null;
-    /** Time the OS provider reported this fix (not when JS received it). */
-    timestamp: Date;
+    /** The gate's quality verdict for this fix. */
+    quality: LocationQuality;
+    /** Why this fix was captured. */
+    trigger: LocationTrigger;
+    /** Device motion when this fix was captured. */
+    motion: MotionState;
+    /** Detected activity, or `null` unless activity detection is enabled. */
+    activity: ActivityType | null;
+    /** `true` if the OS flagged this fix as mock/simulated. */
+    isMock: boolean;
 };
 //# sourceMappingURL=location.d.ts.map

package/lib/typescript/src/types/location.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../../../../src/types/location.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,qEAAqE;IACrE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,qFAAqF;IACrF,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,wEAAwE;IACxE,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC"}
+{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../../../../src/types/location.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,eAAe,EACf,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,SAAS,EAAE,IAAI,CAAC;IAChB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,qFAAqF;IACrF,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,+CAA+C;IAC/C,OAAO,EAAE,eAAe,CAAC;IACzB,iCAAiC;IACjC,OAAO,EAAE,eAAe,CAAC;IACzB,gDAAgD;IAChD,MAAM,EAAE,WAAW,CAAC;IACpB,yEAAyE;IACzE,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,2DAA2D;IAC3D,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC"}

package/lib/typescript/src/types/state.d.ts

@@ -1,15 +1,24 @@
 /**
  * Reason a tracking session ended. Mirrors `StopReason` on both platforms.
  *
- * `'system'` is Android-only — surfaces when the OS terminates the foreground
- * service (memory pressure, force-stop). iOS will never emit `'system'`.
+ * - `'user'` — `Beekon.stop()` was called.
+ * - `'permissionDenied'` — location permission is missing or was revoked
+ *   (user-fixable in Settings).
+ * - `'locationServicesDisabled'` — system-wide location services are off
+ *   (user-fixable in Settings).
+ * - `'locationUnavailable'` — no usable location backend on this device (e.g.
+ *   Google Play Services absent/outdated on Android). Not user-fixable.
+ * - `'system'` — the OS terminated tracking (e.g. foreground-service kill,
+ *   or an unrecoverable internal error).
  */
-export type StopReason = 'user' | 'permissionDenied' | 'locationServicesDisabled' | 'system';
+export type StopReason = 'user' | 'permissionDenied' | 'locationServicesDisabled' | 'locationUnavailable' | 'system';
 /**
  * Tracking state. Mirrors the native `BeekonState` sealed type on both
  * platforms. Use the `kind` field as a discriminator.
  *
- * Lifecycle: `idle → tracking → stopped(reason)`.
+ * Lifecycle: `idle → tracking → stopped(reason)`. `start()` / `stop()` never
+ * throw — this stream is the single source of truth for whether tracking is
+ * active and why it stopped.
  */
 export type BeekonState = {
     kind: 'idle';

package/lib/typescript/src/types/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/types/state.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,kBAAkB,GAClB,0BAA0B,GAC1B,QAAQ,CAAC;AAEb;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/types/state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,kBAAkB,GAClB,0BAA0B,GAC1B,qBAAqB,GACrB,QAAQ,CAAC;AAEb;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC"}

package/lib/typescript/src/types/sync.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Why a server upload failed terminally. Mirrors `SyncFailure` on both
+ * platforms.
+ *
+ * - `'auth'` — `401`/`403`; credentials were rejected. Refresh them (via
+ *   `Beekon.configure()` with new `sync.headers`) and sync resumes.
+ * - `'rejected'` — `400`/`422`; the server rejected the payload. A payload bug;
+ *   it won't self-resolve.
+ */
+export type SyncFailure = 'auth' | 'rejected';
+/**
+ * Upload health, delivered via `Beekon.onSyncStatus()`. Mirrors the native
+ * `SyncStatus` sealed type. Use the `kind` field as a discriminator.
+ *
+ * - `'idle'` — caught up, or sync is not configured.
+ * - `'pending'` — uploading or retrying (healthy).
+ * - `'failed'` — a terminal failure the app must act on.
+ */
+export type SyncStatus = {
+    kind: 'idle';
+} | {
+    kind: 'pending';
+} | {
+    kind: 'failed';
+    reason: SyncFailure;
+};
+//# sourceMappingURL=sync.d.ts.map

package/lib/typescript/src/types/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../../../src/types/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wayq/beekon-rn",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "React Native binding for the Beekon location SDK (Android + iOS).",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -53,15 +53,14 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/wayqteam/beekon.git",
-    "directory": "beekon-rn"
+    "url": "git+https://github.com/wayqteam/beekon-rn.git"
   },
   "author": "wayqteam <wayqteam@users.noreply.github.com> (https://github.com/wayqteam)",
   "license": "SEE LICENSE IN LICENSE.txt",
   "bugs": {
-    "url": "https://github.com/wayqteam/beekon/issues"
+    "url": "https://github.com/wayqteam/beekon-rn/issues"
   },
-  "homepage": "https://github.com/wayqteam/beekon/tree/main/beekon-rn#readme",
+  "homepage": "https://github.com/wayqteam/beekon-rn#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"

package/scripts/fetch-beekonkit.sh

@@ -13,12 +13,12 @@
 
 set -euo pipefail
 
-VERSION="0.0.3"
+VERSION="0.0.5"
 URL="https://github.com/wayqteam/beekon-ios-binary/releases/download/v${VERSION}/BeekonKit.xcframework.zip"
-# TODO(0.0.3): replace with the SHA256 emitted by `scripts/build-xcframework.sh`
-# when the v0.0.3 BeekonKit binary is cut and uploaded. v0.0.3 is the first
-# release with nullable Location fields (accuracy/speed/bearing/altitude).
-EXPECTED_SHA="c2f1990dd7064314deffc4af430839b0c8b7e61851e591c34fb683aed2fff127"
+# SHA256 of the v0.0.5 BeekonKit.xcframework.zip. Matches the SwiftPM
+# `binaryTarget` checksum in beekon-ios-binary's Package.swift at tag v0.0.5
+# (SwiftPM's compute-checksum is the SHA256 of the zip).
+EXPECTED_SHA="437bf493d7de19d8df9599da097be162796a8304eb2d7826cf2505c33d4603f7"
 
 ROOT="$(cd "$(dirname "$0")/.." && pwd)"
 DEST_DIR="${ROOT}/ios/Frameworks"

package/src/NativeBeekonRn.ts

@@ -1,60 +1,150 @@
 /**
- * Codegen TurboModule spec — DO NOT export Wire* types from `src/index.tsx`.
- * The public TS API in `src/beekon.ts` and `src/types/` is what consumers use;
- * mappers in `src/internal/mappers.ts` convert between the two.
+ * Codegen TurboModule spec — the single source React Native's Codegen reads to
+ * generate the native interface. **DO NOT export Wire* types from
+ * `src/index.tsx`.** The public TS API in `src/beekon.ts` and `src/types/` is
+ * what consumers use; mappers in `src/internal/mappers.ts` convert between the
+ * two.
  *
- * Wire types are flat (primitives + nested flat objects) because Codegen's
- * TS-to-Kotlin/ObjC type derivation has limited support for unions and
- * recursive structures. The state variants are encoded as a `type`
- * discriminator string with sibling fields nullable per variant.
+ * Wire types are deliberately **flat** (primitives + flat nested objects +
+ * arrays) because Codegen's TS→Kotlin/ObjC derivation has no support for unions
+ * or recursive structures:
+ *
+ * - **Enums travel as plain `string`** (e.g. `accuracyMode`, `quality`); the
+ *   mappers translate to/from the public string-literal unions with a defensive
+ *   fallback, so an unknown value never crashes a subscriber.
+ * - **Sum types** (`WireState`, `WireSyncStatus`) are a `type` discriminator
+ *   string plus sibling fields nullable per variant.
+ * - **String maps** (`headers`, `extras`) travel as `WireKeyValue[]` pairs —
+ *   Codegen has no portable dictionary type.
+ * - **Timestamps** are epoch-milliseconds; intervals are seconds.
  */
 import type { CodegenTypes, TurboModule } from 'react-native';
 import { TurboModuleRegistry } from 'react-native';
 
-export type WireAndroidNotification = {
+/** A single string map entry — see `headers` / `setExtras`. */
+export type WireKeyValue = {
+  key: string;
+  value: string;
+};
+
+export type WireSyncConfig = {
+  url: string;
+  headers: WireKeyValue[];
+  intervalSeconds: number;
+  batchSize: number;
+};
+
+/** Android-only foreground-service notification overrides. iOS ignores it. */
+export type WireNotificationConfig = {
   title?: string;
   text?: string;
-  smallIconResName?: string;
 };
 
 export type WireConfig = {
-  /** Required at the wire level — the TS facade applies defaults (30 / 100). */
-  intervalSeconds: number;
-  /** Required at the wire level — the TS facade applies defaults (30 / 100). */
-  distanceMeters: number;
-  /** Android-only. iOS native module ignores. */
-  androidNotification?: WireAndroidNotification;
+  /** All fields required at the wire level — the TS facade applies defaults. */
+  minTimeBetweenLocationsSeconds: number;
+  minDistanceBetweenLocationsMeters: number;
+  /** One of: 'high' | 'balanced' | 'low'. */
+  accuracyMode: string;
+  /** One of: 'keepTracking' | 'pause' | 'pauseWithCheckIns'. */
+  whenStationary: string;
+  stationaryRadiusMeters: number;
+  detectActivity: boolean;
+  /** Omitted keeps tracking local-only. */
+  sync?: WireSyncConfig;
+  /** Android-only; the iOS native module ignores it. */
+  notification?: WireNotificationConfig;
 };
 
 export type WireLocation = {
+  id: string;
   lat: number;
   lng: number;
   timestampMs: number;
-  /** `null` when the OS did not report a value (e.g. low-confidence fix). */
+  /** `null` when the OS did not report a value. */
   accuracy: number | null;
   speed: number | null;
   bearing: number | null;
   altitude: number | null;
+  /** One of: 'ok' | 'lowAccuracy' | 'implausibleSpeed'. */
+  quality: string;
+  /** One of: 'interval' | 'motion' | 'checkIn' | 'geofence' | 'manual'. */
+  trigger: string;
+  /** One of: 'moving' | 'stationary' | 'unknown'. */
+  motion: string;
+  /** Activity enum string, or `null` unless activity detection is enabled. */
+  activity: string | null;
+  isMock: boolean;
+};
+
+export type WireGeofence = {
+  id: string;
+  lat: number;
+  lng: number;
+  radiusMeters: number;
+  notifyOnEntry: boolean;
+  notifyOnExit: boolean;
+};
+
+export type WireGeofenceEvent = {
+  id: string;
+  geofenceId: string;
+  /** One of: 'enter' | 'exit'. */
+  type: string;
+  timestampMs: number;
 };
 
 export type WireState = {
   /** One of: 'idle' | 'tracking' | 'stopped'. */
   type: string;
   /**
-   * Only populated when `type === 'stopped'`. One of:
-   * 'user' | 'permissionDenied' | 'locationServicesDisabled' | 'system'.
+   * Only populated when `type === 'stopped'`. One of: 'user' |
+   * 'permissionDenied' | 'locationServicesDisabled' | 'locationUnavailable' |
+   * 'system'.
    */
   stopReason?: string;
 };
 
+export type WireSyncStatus = {
+  /** One of: 'idle' | 'pending' | 'failed'. */
+  type: string;
+  /** Only populated when `type === 'failed'`. One of: 'auth' | 'rejected'. */
+  failure?: string;
+};
+
 export interface Spec extends TurboModule {
-  configure(config: WireConfig): Promise<void>;
+  /**
+   * The config crosses as an untyped object (`ReadableMap` on Android,
+   * `NSDictionary` on iOS) and is parsed natively. Typing it as the nested
+   * {@link WireConfig} struct would force the iOS ObjC++ layer to walk Codegen's
+   * generated C++ structs; the facade still builds a `WireConfig`-shaped value
+   * via `configToWire`, so the shape is enforced upstream.
+   */
+  configure(config: CodegenTypes.UnsafeObject): Promise<void>;
   start(): Promise<void>;
   stop(): Promise<void>;
-  history(fromMs: number, toMs: number): Promise<WireLocation[]>;
+  resumeIfNeeded(): Promise<void>;
+
+  getLocations(fromMs: number, toMs: number): Promise<WireLocation[]>;
+  /**
+   * A negative `beforeMs` deletes all stored locations (the wire encoding of
+   * the public `deleteLocations()` no-argument case). A plain `number` is used
+   * rather than `number | null` for portable Codegen support across platforms.
+   */
+  deleteLocations(beforeMs: number): Promise<number>;
+  pendingUploadCount(): Promise<number>;
+
+  sync(): Promise<void>;
+  setExtras(entries: WireKeyValue[]): Promise<void>;
+
+  addGeofences(geofences: WireGeofence[]): Promise<void>;
+  removeGeofences(ids: string[]): Promise<void>;
+  listGeofences(): Promise<WireGeofence[]>;
 
   readonly onState: CodegenTypes.EventEmitter<WireState>;
   readonly onLocation: CodegenTypes.EventEmitter<WireLocation>;
+  readonly onGeofenceEvent: CodegenTypes.EventEmitter<WireGeofenceEvent>;
+  readonly onSyncStatus: CodegenTypes.EventEmitter<WireSyncStatus>;
 }
 
 export default TurboModuleRegistry.getEnforcing<Spec>('BeekonRn');