@sency/react-native-smkit-ui 2.2.1 → 2.3.0

package/README.md

@@ -145,10 +145,10 @@ allprojects {
 
 ```gradle
 android {
-    compileSdkVersion 35
+    compileSdkVersion 36
     defaultConfig {
         minSdkVersion 26
-        targetSdkVersion 35
+        targetSdkVersion 36
     }
 }
 ```
@@ -217,9 +217,9 @@ if (cameraPermission === RESULTS.GRANTED) {
 ### Workout Configuration
 
 Customize workouts with:
-- **Body Zones**: Full Body, Upper Body, Lower Body, Core
-- **Difficulty**: Low, Medium, High
-- **Duration**: Short, Medium, Long
+- **Body Zones**: Full Body, Upper Body, Lower Body
+- **Difficulty**: Low, Mid, High
+- **Duration**: Short, Long
 - **Week Number**: For multi-week programs
 
 ---
@@ -240,58 +240,83 @@ await configure('YOUR_API_KEY');
 
 ---
 
-#### `startAssessment(type: AssessmentType, options?: AssessmentOptions): Promise<AssessmentResult>`
+#### `startAssessment(type, showSummary, userData, forceShowUserDataScreen, customAssessmentID, modifications): Promise<{ summary: string; didFinish: boolean }>`
 
 Start a fitness assessment.
 
 ```typescript
-import { startAssessment, AssessmentType } from '@sency/react-native-smkit-ui';
+import { startAssessment, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
 
-const result = await startAssessment(AssessmentType.Fitness, {
-  showSummary: true,
-  customId: 'user-123'
-});
+const userData = new SMWorkoutLibrary.UserData(
+  SMWorkoutLibrary.Gender.Other,
+  35,
+  'user@example.com'
+);
+
+const result = await startAssessment(
+  SMWorkoutLibrary.AssessmentTypes.Fitness,
+  true,
+  userData,
+  false,
+  '',
+  null
+);
 ```
 
 **Parameters:**
-- `type` - The assessment type (Fitness, Body360, Strength, Cardio, Custom)
-- `options` - Optional configuration object
-  - `showSummary` - Display summary after completion (default: true)
-  - `customId` - Custom identifier for the assessment
+- `type` - The assessment type (`Fitness`, `Body360`, `Strength`, `Cardio`, `Custom`)
+- `showSummary` - Display summary after completion
+- `userData` - Optional `SMWorkoutLibrary.UserData`; pass `null` when not needed
+- `forceShowUserDataScreen` - Forces the user data screen even when user data is provided
+- `customAssessmentID` - Custom assessment identifier, or an empty string
+- `modifications` - Optional JSON string with exercise feedback parameter modifications
 
 ---
 
-#### `startWorkoutProgram(config: WorkoutConfig): Promise<WorkoutResult>`
+#### `startWorkoutProgram(config: SMWorkoutLibrary.WorkoutConfig, modifications: string | null): Promise<{ summary: string; didFinish: boolean }>`
 
 Start a workout program with customization options.
 
 ```typescript
-import { startWorkoutProgram, WorkoutConfig, BodyZone, Difficulty, Duration } from '@sency/react-native-smkit-ui';
-
-const config = new WorkoutConfig(
-  week: 1,
-  bodyZone: BodyZone.FullBody,
-  difficulty: Difficulty.Medium,
-  duration: Duration.Medium,
-  programId: 'program-123'
+import { startWorkoutProgram, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
+
+const config = new SMWorkoutLibrary.WorkoutConfig(
+  1,
+  SMWorkoutLibrary.BodyZone.FullBody,
+  SMWorkoutLibrary.WorkoutDifficulty.MidDifficulty,
+  SMWorkoutLibrary.WorkoutDuration.Short,
+  SMWorkoutLibrary.Language.English,
+  'program-123',
+  {
+    shortIntro: true,
+    phonePosition: SMWorkoutLibrary.PhonePosition.Floor,
+  }
 );
 
-const result = await startWorkoutProgram(config);
+const result = await startWorkoutProgram(config, null);
 ```
 
 ---
 
-#### `startCustomAssessment(config: CustomAssessmentConfig): Promise<AssessmentResult>`
+#### `startCustomAssessment(assessment, userData, forceShowUserDataScreen, showSummary, modifications): Promise<{ summary: string; didFinish: boolean }>`
 
 Start a custom assessment (assessment configured by Sency for your specific needs).
 
 ```typescript
-import { startCustomAssessment } from '@sency/react-native-smkit-ui';
+import { startCustomAssessment, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
+
+const assessment = new SMWorkoutLibrary.SMWorkout(
+  'assessment-123',
+  'Mobility Check',
+  null,
+  null,
+  [],
+  null,
+  null,
+  null
+);
 
-const result = await startCustomAssessment({
-  customId: 'assessment-123',
-  showSummary: true
-});
+const result = await startCustomAssessment(assessment, null, false, true, null);
 ```
 
 ---
@@ -303,12 +328,12 @@ const result = await startCustomAssessment({
 Configure which buttons appear in the pause menu during workouts and assessments.
 
 ```typescript
-import { setPauseTypes, PauseType } from '@sency/react-native-smkit-ui';
+import { setPauseTypes, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
 
 await setPauseTypes([
-  PauseType.Resume,
-  PauseType.Skip,
-  PauseType.Quit
+  SMWorkoutLibrary.PauseType.Resume,
+  SMWorkoutLibrary.PauseType.Skip,
+  SMWorkoutLibrary.PauseType.Quit
 ]);
 ```
 
@@ -322,11 +347,11 @@ await setPauseTypes([
 Customize the skeleton visualization style during exercises.
 
 ```typescript
-import { setSkeletonSettings, SkeletonPreset, SkeletonConnectionStyle } from '@sency/react-native-smkit-ui';
+import { setSkeletonSettings, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
 
 await setSkeletonSettings({
-  preset: SkeletonPreset.NeonGlow,
-  connectionStyle: SkeletonConnectionStyle.Solid,
+  preset: SMWorkoutLibrary.SkeletonPreset.NeonGlow,
+  connectionStyle: SMWorkoutLibrary.SkeletonConnectionStyle.Solid,
   dotsOpacity: 1,
   connectionsOpacity: 0.8
 });
@@ -351,7 +376,7 @@ await setInstructionVideoConfig({
 
 #### `setAllowAudioMixing(enabled: boolean): Promise<void>`
 
-Allow SDK audio to mix with external app audio. **(iOS only)**
+Allow SDK audio to mix with external app audio. Supported on iOS and Android native SDKs that expose the control.
 
 ```typescript
 import { setAllowAudioMixing } from '@sency/react-native-smkit-ui';
@@ -363,7 +388,7 @@ await setAllowAudioMixing(true);
 
 #### `setShowExternalAudioControl(enabled: boolean): Promise<void>`
 
-Show an in-session button to switch audio source. **(iOS only)**
+Show an in-session button to switch audio source. Supported on iOS and Android native SDKs that expose the control.
 
 ```typescript
 import { setShowExternalAudioControl } from '@sency/react-native-smkit-ui';
@@ -385,6 +410,124 @@ await setAccuratePoseEstimation(true);
 
 ---
 
+#### Advanced SDK controls
+
+These setters are exported directly from the React Native package and return `Promise<void>` unless noted. Platform-specific methods validate their input and resolve as a no-op on unsupported platforms.
+
+| Method | Purpose |
+|--------|---------|
+| `setColorTheme(theme)` | Applies a native SDK color theme. |
+| `setPlayPhoneCalibrationAudio(enabled)` | Enables phone calibration audio. |
+| `setPlayBodyCalibrationAudio(enabled)` | Enables body calibration audio. |
+| `setStartTimerOnFirstActivity(enabled)` | Starts exercise timers on first detected activity. |
+| `setWorkoutContinuationTimerDuration(seconds)` | Sets the continuation countdown duration. |
+| `setPhoneMovementCountPreventionEnabled(enabled)` | Prevents counting while phone movement is detected. |
+| `setVariationMismatchFeedbackEnabled(enabled)` | Enables variation mismatch feedback. |
+| `setUseDefaultGuidanceMode(enabled)` | Lets native SDK defaults drive guidance mode. |
+| `setGuidanceDebugLogging(enabled)` | Enables native guidance debug logging where supported. |
+| `setEnableButtonTutorial(enabled)` | Shows the button tutorial overlay. |
+| `setButtonTutorialCompletionAudioUri(uri)` | Sets optional tutorial completion audio. |
+| `setShowRowingPhoneCalibration(enabled)` | iOS rowing phone calibration control; Android no-op. |
+| `setFeedbacksUIToExclude(values)` | Hides selected native feedback types from UI. |
+| `setExcludedFeedbacks(values)` | Excludes selected feedbacks where supported. |
+| `setConfigString(value)` | Android native flat config string; iOS no-op. |
+| `clearAdaptiveRomCache()` | Clears adaptive ROM cache where supported. |
+| `quitWorkout()` | Quits the active workout where supported. |
+| `pauseSDK()` / `resumeSDK()` | iOS active-workout pause and resume; Android no-op. |
+| `getSupportedMovements()` | iOS supported movement names; Android returns an empty array. |
+| `getExerciseType(detector)` | iOS exercise type lookup; Android returns an empty string. |
+| `setPoseModelChoice(choice)` | Android pose model choice before configure; iOS no-op. |
+
+```typescript
+import {
+  setColorTheme,
+  setPlayPhoneCalibrationAudio,
+  setPlayBodyCalibrationAudio,
+  setPhoneMovementCountPreventionEnabled,
+  setPoseModelChoice,
+  SMWorkoutLibrary,
+} from '@sency/react-native-smkit-ui';
+
+await setColorTheme(SMWorkoutLibrary.ColorTheme.Green);
+await setPlayPhoneCalibrationAudio(true);
+await setPlayBodyCalibrationAudio(true);
+await setPhoneMovementCountPreventionEnabled(true);
+await setPoseModelChoice(SMWorkoutLibrary.PoseModelChoice.AdaptiveChoice);
+```
+
+Interactive Talk to Jinni is intentionally not exposed by this React Native SDK.
+
+---
+
+#### Advanced custom workout options
+
+`SMExercise`, `SMAssessmentExercise`, and `WorkoutConfig` keep their existing constructor arguments and accept optional trailing options objects for newer native SDK features.
+
+```typescript
+import { startCustomWorkout, SMWorkoutLibrary } from '@sency/react-native-smkit-ui';
+
+const exercise = new SMWorkoutLibrary.SMExercise(
+  'Squat',
+  45,
+  'squat_instruction.mp4',
+  'squat_intro.mp3',
+  [
+    SMWorkoutLibrary.UIElement.RepsCounter,
+    SMWorkoutLibrary.UIElement.Skeleton,
+    SMWorkoutLibrary.UIElement.CountdownTimer,
+  ],
+  'SquatRegular',
+  null,
+  new SMWorkoutLibrary.SMScoringParams(
+    SMWorkoutLibrary.ScoringType.Reps,
+    null,
+    null,
+    12,
+    null,
+    null
+  ),
+  {
+    shortIntro: true,
+    guidanceMode: true,
+    guidanceVideoSegments: {
+      introFreeze: SMWorkoutLibrary.GuidanceVideoSegment.freeze(1.2),
+      demoLoop: SMWorkoutLibrary.GuidanceVideoSegment.play(2.0, 6.5),
+    },
+    playPreExerciseCountdown: true,
+    playSoundOnEachRep: true,
+    playRepMilestoneVoice: true,
+    repMilestoneInterval: 5,
+    adaptiveRomFeedbackEnabled: true,
+    adaptiveRomWarmupReps: 3,
+    stretchSetConfig: new SMWorkoutLibrary.StretchSetConfig(3, 20, {
+      restSecondsBetweenStretches: 5,
+    }),
+  }
+);
+
+const continuation = new SMWorkoutLibrary.WorkoutContinuation(
+  'continue_unlock.mp3',
+  [exercise],
+  'continue_intro.mp3'
+);
+
+const workout = new SMWorkoutLibrary.SMWorkout(
+  'workout-123',
+  'Strength Builder',
+  null,
+  null,
+  [exercise],
+  null,
+  null,
+  null,
+  continuation
+);
+
+await startCustomWorkout(workout, null);
+```
+
+The supported exercise options include `shortIntro`, `quickMotionParams`, `rowingFeedbackLevel`, `phonePosition`, `guidanceMode`, `useWideAngleCamera`, `playPreExerciseCountdown`, `playRepMilestoneVoice`, `repMilestoneInterval`, `playSoundOnEachRep`, `adaptiveRomFeedbackEnabled`, `adaptiveRomWarmupReps`, `guidanceVideoSegments`, `stretchSetConfig`, and `side`.
+
 ## Examples
 
 ### Complete Setup Example
@@ -396,11 +539,7 @@ import {
   configure,
   startAssessment,
   startWorkoutProgram,
-  AssessmentType,
-  BodyZone,
-  Difficulty,
-  Duration,
-  WorkoutConfig
+  SMWorkoutLibrary
 } from '@sency/react-native-smkit-ui';
 
 export default function FitnessApp() {
@@ -421,9 +560,14 @@ export default function FitnessApp() {
 
   const handleFitnessAssessment = async () => {
     try {
-      const result = await startAssessment(AssessmentType.Fitness, {
-        showSummary: true
-      });
+      const result = await startAssessment(
+        SMWorkoutLibrary.AssessmentTypes.Fitness,
+        true,
+        null,
+        false,
+        '',
+        null
+      );
       console.log('Assessment completed:', result);
     } catch (error) {
       console.error('Assessment failed:', error);
@@ -432,13 +576,15 @@ export default function FitnessApp() {
 
   const handleWorkout = async () => {
     try {
-      const config = new WorkoutConfig(
+      const config = new SMWorkoutLibrary.WorkoutConfig(
         1,
-        BodyZone.FullBody,
-        Difficulty.Medium,
-        Duration.Medium
+        SMWorkoutLibrary.BodyZone.FullBody,
+        SMWorkoutLibrary.WorkoutDifficulty.MidDifficulty,
+        SMWorkoutLibrary.WorkoutDuration.Short,
+        SMWorkoutLibrary.Language.English,
+        'program-123'
       );
-      const result = await startWorkoutProgram(config);
+      const result = await startWorkoutProgram(config, null);
       console.log('Workout completed:', result);
     } catch (error) {
       console.error('Workout failed:', error);
@@ -470,14 +616,18 @@ export default function FitnessApp() {
 ```typescript
 const startBody360Assessment = async () => {
   try {
-    const result = await startAssessment(AssessmentType.Body360, {
-      showSummary: true,
-      customId: `user-${Date.now()}`
-    });
+    const result = await startAssessment(
+      SMWorkoutLibrary.AssessmentTypes.Body360,
+      true,
+      null,
+      false,
+      `user-${Date.now()}`,
+      null
+    );
     
-    if (result.success) {
+    if (result.didFinish) {
       console.log('Body360 assessment completed');
-      console.log('Results:', result.data);
+      console.log('Summary:', result.summary);
     }
   } catch (error) {
     console.error('Body360 assessment error:', error);
@@ -490,14 +640,17 @@ const startBody360Assessment = async () => {
 ```typescript
 const startCustomizedWorkout = async () => {
   try {
-    const config = new WorkoutConfig(
-      week: 2,
-      bodyZone: BodyZone.UpperBody,
-      difficulty: Difficulty.High,
-      duration: Duration.Long
+    const config = new SMWorkoutLibrary.WorkoutConfig(
+      2,
+      SMWorkoutLibrary.BodyZone.UpperBody,
+      SMWorkoutLibrary.WorkoutDifficulty.HighDifficulty,
+      SMWorkoutLibrary.WorkoutDuration.Long,
+      SMWorkoutLibrary.Language.English,
+      'program-123',
+      { shortIntro: true }
     );
     
-    const result = await startWorkoutProgram(config);
+    const result = await startWorkoutProgram(config, null);
     console.log('Workout program completed:', result);
   } catch (error) {
     console.error('Workout error:', error);

package/android/build.gradle

@@ -95,11 +95,13 @@ dependencies {
   implementation "com.facebook.react:react-android"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  implementation("com.sency.smkitui:smkitui:1.6.3") {
+  implementation("com.sency.smkitui:smkitui:1.6.6") {
     exclude group: 'com.facebook.fbjni', module: 'fbjni-java-only'
     // // Don't exclude native libraries
     // exclude group: 'com.facebook.react', module: 'react-native'
   }
+  implementation "com.sency.smkit:smkit:1.6.6"
+  implementation "com.sency.smbase.nativeclient:smbase-native-client:1.6.6"
 
   // Gson
   implementation 'com.google.code.gson:gson:2.9.0'