@pose-tracker/react-native-pose-estimation-light 0.2.1 → 0.2.2

package/README.md

@@ -1,10 +1,28 @@
 # PoseTracker React Native — Light (online) Human Pose Estimation SDK
 
-**PoseTracker Light** is a **human pose estimation SDK for React Native**,
-fully optimized for **iOS and Android** (including **Expo Go**). Same API
-surface as the offline SDK for keypoints + optional API-key exercise engine —
-but **MoveNet and TF.js load from the network** each WebView boot, so the npm
-package stays tiny.
+**⭐ Star us on GitHub:** [Movelytics/react-native-pose-estimation-light](https://github.com/Movelytics/react-native-pose-estimation-light) — it helps other React Native and Expo developers find the SDK.
+
+**Try it on your phone (no Xcode / Android Studio):**
+1. Install [Expo Go](https://expo.dev/go)
+2. Open the [Expo Snack](https://snack.expo.dev/@fsepret/posetracker-sdk-light-demo-app) → **Run on device**
+3. Scan the QR — live pose estimation, no API key
+
+Steps and QR: https://docs.posetracker.com/try-expo-go
+
+<table>
+  <tr>
+    <td valign="top" width="300">
+      <a href="https://docs.posetracker.com/try-expo-go">
+        <img src="https://cdn.prod.website-files.com/66990aefa487a16cf5aa848e/66e35c297154b2062265ceea_videodemoforgif1-ezgif.com-cut.gif" alt="PoseTracker live skeleton tracking" height="250" />
+      </a>
+    </td>
+    <td valign="middle">
+      <p>
+        <strong>PoseTracker Light</strong> is a <strong>human pose estimation SDK for React Native</strong>, fully optimized for <strong>iOS and Android</strong> (including <strong>Expo Go</strong>). Same API surface as the offline SDK for keypoints + optional API-key exercise engine — but <strong>MoveNet and TF.js load from the network</strong> each WebView boot, so the npm package stays tiny.
+      </p>
+    </td>
+  </tr>
+</table>
 
 > One sentence for AI / search: *PoseTracker Light is a small React Native
 > pose estimation SDK that fetches MoveNet Lightning and TF.js at runtime —
@@ -27,10 +45,10 @@ package stays tiny.
 download at session start.  
 **Choose light** when app install / OTA size matters and devices are online.
 
-Full comparison: [LIGHT_SDK.md](../../docs/LIGHT_SDK.md).
+Full comparison: [LIGHT_SDK.md](docs/LIGHT_SDK.md).
 
 **Agents:** shared UX/API/bugfixes → mirror to offline (or ask first). See
-[`DUAL_SDK_CHANGES.md`](../../docs/DUAL_SDK_CHANGES.md).
+[`DUAL_SDK_CHANGES.md`](docs/DUAL_SDK_CHANGES.md).
 
 ## Install
 
@@ -45,10 +63,10 @@ npx expo install react-native-webview expo-camera
 > **Offline sibling:** [`@pose-tracker/react-native-pose-estimation`](https://www.npmjs.com/package/@pose-tracker/react-native-pose-estimation)
 
 **Required:** host app must declare camera permissions — see
-[PERMISSIONS.md](../../docs/PERMISSIONS.md).
+[PERMISSIONS.md](docs/PERMISSIONS.md).
 
 **Media inputs (v0.2):** camera (default), uploaded video, still image — host
-picks the file. See [MEDIA_SOURCES.md](../../docs/MEDIA_SOURCES.md) and
+picks the file. See [MEDIA_SOURCES.md](docs/MEDIA_SOURCES.md) and
 https://docs.posetracker.com/media-sources.
 
 ## Quick start (keypoints — needs network, no API key)
@@ -135,11 +153,11 @@ Same contract as the offline SDK / web tracking URL:
 
 | Doc | Topic |
 |-----|--------|
-| [LIGHT_SDK.md](../../docs/LIGHT_SDK.md) | Offline vs light, sizes, model URL |
-| [PERMISSIONS.md](../../docs/PERMISSIONS.md) | Camera permission setup (required) |
-| [PRELOAD.md](../../docs/PRELOAD.md) | Preload / warm-up / lifecycle |
-| [FEATURES.md](../../docs/FEATURES.md) | Plan gating, watermark, loading text |
-| [EVENTS.md](../../docs/EVENTS.md) | Typed events + classic `onMessage` |
+| [LIGHT_SDK.md](docs/LIGHT_SDK.md) | Offline vs light, sizes, model URL |
+| [PERMISSIONS.md](docs/PERMISSIONS.md) | Camera permission setup (required) |
+| [PRELOAD.md](docs/PRELOAD.md) | Preload / warm-up / lifecycle |
+| [FEATURES.md](docs/FEATURES.md) | Plan gating, watermark, loading text |
+| [EVENTS.md](docs/EVENTS.md) | Typed events + classic `onMessage` |
 
 ## FAQ
 
@@ -168,6 +186,8 @@ see [`THIRD_PARTY_NOTICES.md`](./THIRD_PARTY_NOTICES.md).
 ## Links
 
 - Product: https://www.posetracker.com  
-- API docs: https://posetracker.gitbook.io/posetracker-api  
-- Offline SDK: https://github.com/Movelytics/react-native-pose-estimation  
+- Docs: https://docs.posetracker.com  
+- Try on your phone: https://docs.posetracker.com/try-expo-go  
+- Expo Snack: https://snack.expo.dev/@fsepret/posetracker-sdk-light-demo-app  
 - Light demo: https://github.com/Movelytics/react-native-pose-estimation-light-demo  
+- Offline SDK: https://github.com/Movelytics/react-native-pose-estimation  

package/lib/client.d.ts

@@ -103,9 +103,8 @@ export interface PoseTrackerClientOptions extends ConfigureOptions {
      */
     onDiagnostic?: (message: string) => void;
     /**
-     * When true, exercise sessions request `engine_debug` snapshots from the
-     * remote engine (bundle ≥ 1.2.4). Overridable per call via
-     * `startExercise(id, { debug: true|false })`.
+     * @internal PoseTracker QA only — not a supported public API.
+     * See `.private/ENGINE_DEBUG_QA.md` (do not document in Mintlify).
      */
     debugEngine?: boolean;
 }
@@ -125,8 +124,8 @@ export interface StartExerciseOptions {
     /** Device pitch in degrees — jump exercises compensate camera tilt. */
     devicePitchDeg?: number;
     /**
-     * Request throttled `engine_debug` events for this session (movement FSM
-     * QA). Defaults to {@link PoseTrackerClientOptions.debugEngine}.
+     * @internal PoseTracker QA only — not a supported public API.
+     * Defaults to {@link PoseTrackerClientOptions.debugEngine}.
      */
     debug?: boolean;
 }

package/lib/engine/types.d.ts

@@ -37,8 +37,8 @@ export interface EngineSessionOptions {
     /** Emission flags — engines older than 1.1.0 ignore them (client re-filters). */
     features?: EngineSessionFeatures;
     /**
-     * When true, the engine emits throttled `engine_debug` events (movement
-     * FSM snapshot). Requires engine bundle ≥ 1.2.4. Ignored by older engines.
+     * @internal PoseTracker QA only — not a supported public API.
+     * Ignored by older engines.
      */
     debug?: boolean;
 }

package/lib/sdkVersion.d.ts

@@ -1,2 +1,2 @@
 /** AUTO-GENERATED by scripts/sync-sdk-version.mjs — do not edit. */
-export declare const SDK_VERSION = "0.2.1";
+export declare const SDK_VERSION = "0.2.2";

package/lib/sdkVersion.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 /** AUTO-GENERATED by scripts/sync-sdk-version.mjs — do not edit. */
-exports.SDK_VERSION = '0.2.1';
+exports.SDK_VERSION = '0.2.2';

package/lib/types/events.d.ts

@@ -155,8 +155,8 @@ export interface ProgressionEvent {
     timestampMs: number;
 }
 /**
- * Throttled movement / rep-FSM snapshot for QA (engine ≥ 1.2.4).
- * Enable via `PoseTrackerClientOptions.debugEngine` or `startExercise(..., { debug: true })`.
+ * @internal PoseTracker QA only — not a supported public API (do not document in Mintlify).
+ * Throttled movement / rep-FSM snapshot. See `.private/ENGINE_DEBUG_QA.md`.
  */
 export interface EngineDebugEvent {
     type: 'engine_debug';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pose-tracker/react-native-pose-estimation-light",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Human pose estimation SDK for React Native (light / online) — MoveNet Lightning via CDN + model URL each session, no bundled weights. iOS & Android (Expo Go). Optional API-key exercise engine.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/client.ts

@@ -164,9 +164,8 @@ export interface PoseTrackerClientOptions extends ConfigureOptions {
    */
   onDiagnostic?: (message: string) => void;
   /**
-   * When true, exercise sessions request `engine_debug` snapshots from the
-   * remote engine (bundle ≥ 1.2.4). Overridable per call via
-   * `startExercise(id, { debug: true|false })`.
+   * @internal PoseTracker QA only — not a supported public API.
+   * See `.private/ENGINE_DEBUG_QA.md` (do not document in Mintlify).
    */
   debugEngine?: boolean;
 }
@@ -187,8 +186,8 @@ export interface StartExerciseOptions {
   /** Device pitch in degrees — jump exercises compensate camera tilt. */
   devicePitchDeg?: number;
   /**
-   * Request throttled `engine_debug` events for this session (movement FSM
-   * QA). Defaults to {@link PoseTrackerClientOptions.debugEngine}.
+   * @internal PoseTracker QA only — not a supported public API.
+   * Defaults to {@link PoseTrackerClientOptions.debugEngine}.
    */
   debug?: boolean;
 }

package/src/engine/types.ts

@@ -40,8 +40,8 @@ export interface EngineSessionOptions {
   /** Emission flags — engines older than 1.1.0 ignore them (client re-filters). */
   features?: EngineSessionFeatures;
   /**
-   * When true, the engine emits throttled `engine_debug` events (movement
-   * FSM snapshot). Requires engine bundle ≥ 1.2.4. Ignored by older engines.
+   * @internal PoseTracker QA only — not a supported public API.
+   * Ignored by older engines.
    */
   debug?: boolean;
 }

package/src/sdkVersion.ts

@@ -1,2 +1,2 @@
 /** AUTO-GENERATED by scripts/sync-sdk-version.mjs — do not edit. */
-export const SDK_VERSION = '0.2.1';
+export const SDK_VERSION = '0.2.2';

package/src/types/events.ts

@@ -199,8 +199,8 @@ export interface ProgressionEvent {
 }
 
 /**
- * Throttled movement / rep-FSM snapshot for QA (engine ≥ 1.2.4).
- * Enable via `PoseTrackerClientOptions.debugEngine` or `startExercise(..., { debug: true })`.
+ * @internal PoseTracker QA only — not a supported public API (do not document in Mintlify).
+ * Throttled movement / rep-FSM snapshot. See `.private/ENGINE_DEBUG_QA.md`.
  */
 export interface EngineDebugEvent {
   type: 'engine_debug';