face-age 2.4.5 → 2.4.7

package/README.md

@@ -381,10 +381,21 @@ faceAge.API.setHistoryData({
   meta: {
     ts: Date.now(),
     image: 'https://example.com/scan.jpg',
+    // Optional; values can use either 0..1 or 0..100.
+    quality: {
+      lightingScore: 0.92, // higher is better
+      brightness: 0.53,    // used to detect lighting mismatch
+      sharpnessScore: 0.88,
+      blur: 0.08,          // lower is better
+      noise: 0.10,         // lower is better
+      confidence: 0.94,
+    },
   },
 });
 ```
 
+When multiple history items are available, opening an analysis exposes a **Compare** tab for comparing it with any older scan. Shared metrics are normalized before comparison. Changes inside a 3-point noise band are treated as stable; optional `meta.quality` values widen that band or mark very low-confidence comparisons as insufficient data.
+
 **Remove a history entry** by reference token. Pass `null` to clear all local history:
 
 ```js
@@ -393,6 +404,65 @@ faceAge.API.removeHistoryItem('analyze_ref_abc123').then((removed) => {
 });
 ```
 
+### Set Comments (Routine Tab)
+
+Populate the customer review/comment carousel shown in the routine tab.
+
+```js
+faceAge.API.setComments([
+  {
+    name: 'Jane Doe',
+    comment: 'My skin feels amazing after just two weeks!', // also accepts: text, body
+    image: 'https://example.com/avatar.jpg',               // optional; also: avatar, photo
+    job_position: 'Verified Buyer',                        // optional; also: jobPosition, position, company
+  },
+]);
+```
+
+Each item requires `name` and at least one of `comment` / `text` / `body`. Comments longer than 280 characters are automatically truncated with a "read more" expand. Returns `true` on success, `false` on error.
+
+---
+
+### Set Shorts (Routine Tab)
+
+Populate the short-form video/image carousel shown in the routine tab.
+
+```js
+faceAge.API.setShorts([
+  {
+    coverImage: 'https://example.com/thumb.jpg', // also: cover_image, cover, image, thumbnail, poster
+    videoUrl: 'https://example.com/clip.mp4',    // optional; also: video_url, video, src
+    link: 'https://example.com/product',         // optional; also: url, href
+    overlayText: 'Morning Routine',              // optional; also: overlay_text, title, text, caption, overlay
+  },
+]);
+```
+
+Each item requires at least one of `coverImage` / `videoUrl`. `javascript:`, `data:`, and `vbscript:` URLs are rejected. Returns `true` on success, `false` on error.
+
+---
+
+### Set Analysis Tab Sort Order
+
+Control the display order of the tabs on the analysis result page (`scan`, `routine`, `recommendations`). Tabs not listed keep their default position after the explicitly ordered ones.
+
+```js
+// Show the routine tab first, then recommendations, then scan
+faceAge.API.setSort(['routine', 'recommendations', 'scan']);
+```
+
+**Accepted tab name aliases:**
+
+| Canonical key | Accepted aliases |
+|---------------|-----------------|
+| `scan` | `scan`, `scan_info`, `scaninfo`, `skin_report`, `skinreport` |
+| `routine` | `routine`, `routines` |
+| `recommendations` | `recommendations`, `recommendation`, `products`, `product` |
+
+The call is live — if the analysis result page is already open it re-orders the tabs immediately. Returns `true` on success, `false` on error.
+
+---
+
 ### Generate PDF Report
 
 Requires PDF access on your Face Age plan.