@pose-tracker/pose-estimation-web 0.1.0

package/LICENSE

@@ -0,0 +1,41 @@
+PoseTracker Web SDK
+Copyright (c) 2024–2026 Movelytics SAS. All rights reserved.
+
+PROPRIETARY SOFTWARE LICENSE
+
+This package published under the @pose-tracker scope (the "Software") is
+proprietary to Movelytics SAS ("Licensor").
+
+1. Grant of use
+   Subject to a valid PoseTracker account and applicable product terms
+   (including free-tier limits and paid plans), Licensor grants you a
+   non-exclusive, non-transferable, revocable license to install and use the
+   Software in your applications to access PoseTracker services and browser
+   pose estimation features as documented.
+
+2. Restrictions
+   Except as expressly permitted in writing by Licensor, you may not:
+   - sell, sublicense, or redistribute the Software as a competing SDK or
+     standalone pose-estimation product;
+   - remove or obscure proprietary notices, branding, or watermarks required
+     by your plan;
+   - reverse engineer the remote movement engine or proprietary pipeline
+     beyond what applicable law permits;
+   - use the Software in violation of PoseTracker Terms of Service or
+     applicable law.
+
+3. Third-party components
+   The Software uses third-party components (including TensorFlow.js and the
+   MoveNet model) under their own licenses. See THIRD_PARTY_NOTICES.md.
+   Those licenses are not overridden by this LICENSE.
+
+4. No warranty
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL
+   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+   LIABILITY ARISING FROM THE SOFTWARE OR ITS USE.
+
+5. Commercial terms
+   Paid plans, API keys, usage limits, and support are governed by your
+   PoseTracker agreement and https://www.posetracker.com terms.

package/README.md

@@ -0,0 +1,91 @@
+# `@pose-tracker/pose-estimation-web`
+
+Vanilla browser pose estimation (MoveNet / BlazePose / custom `modelUrl`) +
+remote exercise engine after `configure(apiToken)`.
+
+Default model:
+`https://app.posetracker.com/scripts/tmp_model_to_remove.json`
+
+## Install (npm)
+
+```bash
+npm install @pose-tracker/pose-estimation-web @tensorflow/tfjs
+# Optional — BlazePose in bundlers (React / Vite). Vanilla IIFE can use CDN.
+npm install @tensorflow-models/pose-detection
+```
+
+```ts
+import { createPoseTracker } from '@pose-tracker/pose-estimation-web';
+
+const pt = createPoseTracker({ model: 'movenet' });
+pt.mount('#root');
+await pt.start();
+pt.on('keypoints', (e) => console.log(e.keypoints));
+
+// BlazePose (peer or CDN window.poseDetection / auto-inject):
+await pt.setModel('blazepose');
+```
+
+## Script tag (CDN)
+
+The IIFE build exposes a **`PoseTracker`** global (`PoseTracker.createPoseTracker`, …).
+
+**Load TensorFlow.js first**, then the SDK. Order matters.
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>PoseTracker</title>
+    <!-- 1) TensorFlow.js (peer — required before PoseTracker) -->
+    <script src="https://cdn.jsdelivr.net/npm/@tensorflow/tfjs@4.22.0/dist/tf.min.js"></script>
+    <!-- 2) PoseTracker IIFE (jsDelivr / unpkg both work) -->
+    <script src="https://cdn.jsdelivr.net/npm/@pose-tracker/pose-estimation-web@0.1.0/dist/pose-tracker.global.js"></script>
+  </head>
+  <body>
+    <div id="root" style="width: 100%; height: 100vh; background: #111"></div>
+    <script>
+      const pt = PoseTracker.createPoseTracker({
+        model: 'movenet',
+        drawSkeleton: true,
+      });
+      pt.mount('#root');
+      pt.start().catch(console.error);
+      pt.on('keypoints', (e) => console.log(e.keypoints.length));
+    </script>
+  </body>
+</html>
+```
+
+Equivalent unpkg URL:
+
+```text
+https://unpkg.com/@pose-tracker/pose-estimation-web@0.1.0/dist/pose-tracker.global.js
+```
+
+Omitting `/dist/...` also works — `package.json` `jsdelivr` / `unpkg` fields point at the IIFE.
+
+### Optional BlazePose (CDN)
+
+Preload pose-detection after TF.js (or omit — the SDK can inject the same CDN URL):
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@tensorflow-models/pose-detection@2.1.3/dist/pose-detection.min.js"></script>
+```
+
+### Global API (IIFE)
+
+| Global | Notes |
+|--------|--------|
+| `PoseTracker.createPoseTracker(options?)` | Main factory |
+| `PoseTracker.PoseCamera` / mount helpers | Camera helper |
+| `PoseTracker.configure` | Standalone configure helper |
+| `PoseTracker.DEFAULT_MOVENET_LIGHTNING_URL` | Default model URL |
+| `PoseTracker.SDK_VERSION` / `SDK_NAME` | Package identity |
+
+BlazePose maps to the same COCO-17 `keypoints` event shape as MoveNet (extra
+face/hand/foot landmarks dropped). It is heavier than MoveNet Lightning.
+
+See monorepo root README for exercises + examples.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,17 @@
+# Third-party notices
+
+## TensorFlow.js
+
+- Copyright: Google LLC and TensorFlow authors
+- License: Apache License 2.0 — https://www.apache.org/licenses/LICENSE-2.0
+
+## MoveNet SinglePose Lightning (model weights)
+
+- Copyright: Google LLC
+- License: Apache License 2.0 — https://www.apache.org/licenses/LICENSE-2.0
+- Hub: https://tfhub.dev/google/movenet/singlepose/lightning/4
+
+## @tensorflow-models/pose-detection (optional BlazePose)
+
+- Copyright: Google LLC
+- License: Apache License 2.0 — https://www.apache.org/licenses/LICENSE-2.0