@sency/react-native-smkit-ui 0.2.1 → 0.2.3

package/android/build.gradle

@@ -93,7 +93,7 @@ dependencies {
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  implementation("com.sency.smkitui:smkitui:0.1.9") {
+  implementation("com.sency.smkitui:smkitui:0.2.1") {
     exclude group: 'com.facebook.fbjni', module: 'fbjni-java-only'
   }
 

package/android/src/main/java/com/smkituilibrary/SmkitUiLibraryModule.kt

@@ -9,7 +9,6 @@ import com.sency.smkitui.SMKitUI
 import com.sency.smkitui.listener.SMKitUIConfigurationListener
 import com.sency.smkitui.listener.SMKitUIWorkoutListener
 import com.sency.smkitui.model.ExerciseData
-import com.sency.smkitui.model.SMWorkout
 import com.sency.smkitui.model.WorkoutSummaryData
 import com.sency.smkitui.model.smkitui.Body360
 import com.sency.smkitui.model.smkitui.Custom
@@ -18,6 +17,8 @@ import com.smkituilibrary.mapper.toSMWorkout
 import com.smkituilibrary.mapper.toWorkoutConfig
 import com.smkituilibrary.model.SMKitWorkout
 import com.smkituilibrary.model.SMKitWorkoutConfig
+import com.smkituilibrary.model.SMUserData
+import com.smkituilibrary.model.toUserData
 import com.squareup.moshi.Moshi
 import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
 
@@ -66,15 +67,31 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun startAssessment(type: String, showSummary: Boolean, customAssessmentId: String, promise: Promise) {
+  fun startAssessment(
+    type: String,
+    showSummary: Boolean,
+    userData: String?,
+    forceShowUserDataScreen: Boolean,
+    customAssessmentId: String,
+    promise: Promise,
+  ) {
     this.resultPromise = promise
+
     try {
       val assessmentType = when (type) {
         "fitness" -> Fitness
         "body360" -> Body360
         else -> Custom(customAssessmentId)
       }
-      smKitUI?.startAssessment(listener = listener, assessmentType = assessmentType, userData = null)
+      val user = if(userData == null) null else if (forceShowUserDataScreen) null else {
+        serializeUserData(userData)
+      }
+      smKitUI?.startAssessment(
+        listener = listener,
+        assessmentType = assessmentType,
+        userData = user,
+        showSummary = showSummary
+      )
     } catch (e: Exception) {
       promise.reject("Starting Assessment Failed", e)
     }
@@ -92,10 +109,16 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun startCustomAssessment(jsonArguments: String, promise: Promise) {
+  fun startCustomAssessment(
+    assessmentJson: String,
+    userDataJson: String?,
+    forceShowUserDataScreen: Boolean,
+    showSummary: Boolean,
+    promise: Promise
+  ) {
     try {
-      serializeWorkout(jsonArguments)?.let {
-        smKitUI?.startCustomizedAssessment(workout = it, listener = listener)
+      serializeWorkout(assessmentJson)?.let {
+        smKitUI?.startCustomizedAssessment(workout = it, showSummary = showSummary, listener = listener)
       }
     } catch (e: Exception) {
       promise.reject("Starting Custom Assessment Failed", e)
@@ -105,6 +128,9 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
   private fun serializeWorkout(jsonArguments: String) =
     moshi.adapter(SMKitWorkout::class.java).fromJson(jsonArguments)?.toSMWorkout()
 
+  private fun serializeUserData(jsonArguments: String) =
+    moshi.adapter(SMUserData::class.java).fromJson(jsonArguments)?.toUserData()
+
 
   @ReactMethod
   fun startWorkoutProgram(jsonArguments: String, promise: Promise) {

package/android/src/main/java/com/smkituilibrary/mapper/SMMapper.kt

@@ -44,9 +44,11 @@ private fun SMKitExercise.toSMExercise(): SMExercise = SMExercise(
   repBased = repBased ?: false,
   exerciseClosure = exerciseClosure ?: "",
   scoringParams = scoringParams?.toParams(),
-  summaryTitle = "",
-  summarySubTitle = "",
-  summaryTitleMainMetric = ""
+  summaryTitle = summaryTitle ?: "",
+  summarySubTitle = summarySubTitle ?: "",
+  summaryTitleMainMetric = summaryTitleMainMetric ?: "",
+  summarySubTitleMainMetric = summarySubTitleMainMetric ?: "",
+  side = side
 )
 
 private fun SMKitScoringParams.toParams(): ScoringParams {

package/android/src/main/java/com/smkituilibrary/model/SMKitExercise.kt

@@ -1,6 +1,7 @@
 package com.smkituilibrary.model
 
 import androidx.annotation.Keep
+import com.sency.smkitui.data.entity.ScoringParams
 import com.sency.smkitui.data.entity.UiElement
 
 @Keep
@@ -15,6 +16,11 @@ internal data class SMKitExercise(
   val prettyName: String? = null,
   val exerciseIntro: String? = null,
   val exerciseClosure: String? = null,
+  val summaryTitle: String? = null,
+  val summarySubTitle: String? = null,
+  val summaryTitleMainMetric: String? = null,
+  val summarySubTitleMainMetric: String? = null,
+  val side: String? = null,
 )
 
 @Keep

package/android/src/main/java/com/smkituilibrary/model/SMUserData.kt

@@ -0,0 +1,17 @@
+package com.smkituilibrary.model
+
+import com.sency.smkitui.model.Gender
+import com.sency.smkitui.model.UserData
+
+data class SMUserData(
+  val gender: String,
+  val age: Int,
+)
+
+fun SMUserData.toUserData() : UserData {
+  val g = when(gender) {
+    "Female" -> Gender.Female
+    else -> Gender.Male
+  }
+  return UserData(age, g)
+}

package/lib/commonjs/SMWorkout.js

@@ -4,48 +4,90 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.WorkoutDuration = exports.WorkoutDifficulty = exports.WorkoutConfig = exports.UserData = exports.UIElement = exports.ScoringType = exports.SMWorkout = exports.SMScoringParams = exports.SMExercise = exports.SMAssessmentExercise = exports.Gender = exports.BodyZone = exports.AssessmentTypes = void 0;
+/**
+ * Enum representing assessment types.
+ * @enum {string}
+ */
 let AssessmentTypes = exports.AssessmentTypes = /*#__PURE__*/function (AssessmentTypes) {
   AssessmentTypes["Fitness"] = "fitness";
   AssessmentTypes["Custom"] = "custom";
   AssessmentTypes["Body360"] = "body360";
   return AssessmentTypes;
 }({});
+/**
+ * Enum representing UI elements that can be displayed during workouts.
+ * @enum {string}
+ */
 let UIElement = exports.UIElement = /*#__PURE__*/function (UIElement) {
   UIElement["RepsCounter"] = "repsCounter";
   UIElement["Timer"] = "timer";
   UIElement["GaugeOfMotion"] = "gaugeOfMotion";
   return UIElement;
 }({});
+/**
+ * Enum representing body zones targeted in workouts.
+ * @enum {string}
+ */
 let BodyZone = exports.BodyZone = /*#__PURE__*/function (BodyZone) {
   BodyZone["UpperBody"] = "UpperBody";
   BodyZone["LowerBody"] = "LowerBody";
   BodyZone["FullBody"] = "FullBody";
   return BodyZone;
 }({});
+/**
+ * Enum representing workout difficulty levels.
+ * @enum {string}
+ */
 let WorkoutDifficulty = exports.WorkoutDifficulty = /*#__PURE__*/function (WorkoutDifficulty) {
   WorkoutDifficulty["LowDifficulty"] = "LowDifficulty";
   WorkoutDifficulty["MidDifficulty"] = "MidDifficulty";
   WorkoutDifficulty["HighDifficulty"] = "HighDifficulty";
   return WorkoutDifficulty;
 }({});
+/**
+ * Enum representing workout durations.
+ * @enum {string}
+ */
 let WorkoutDuration = exports.WorkoutDuration = /*#__PURE__*/function (WorkoutDuration) {
   WorkoutDuration["Short"] = "Short";
   WorkoutDuration["Long"] = "Long";
   return WorkoutDuration;
 }({});
+/**
+ * Enum representing different types of scoring methods.
+ * @enum {string}
+ */
 let ScoringType = exports.ScoringType = /*#__PURE__*/function (ScoringType) {
   ScoringType["Rom"] = "rom";
   ScoringType["Time"] = "time";
   ScoringType["Reps"] = "reps";
   return ScoringType;
 }({});
+/**
+ * Enum representing gender options for user data.
+ * @enum {string}
+ */
 let Gender = exports.Gender = /*#__PURE__*/function (Gender) {
   Gender["Female"] = "Female";
   Gender["Male"] = "Male";
   Gender["Other"] = "Rather not say";
   return Gender;
 }({});
+/**
+ * Class representing a workout.
+ */
 class SMWorkout {
+  /**
+   * @param {string | null} id - Unique identifier for the workout.
+   * @param {string | null} name - Name of the workout.
+   * @param {string | null} workoutIntro - URL for workout intro sound.
+   * @param {string | null} soundtrack - URL for soundtrack.
+   * @param {SMExercise[]} exercises - List of exercises included in the workout.
+   * @param {string | null} getInFrame - URL for body cal get in frame sound.
+   * @param {string | null} bodycalFinished - URL for body cal finished sound.
+   * @param {string | null} workoutClosure - URL for workout closure sound.
+   */
+
   constructor(id, name, workoutIntro, soundtrack, exercises, getInFrame, bodycalFinished, workoutClosure) {
     this.id = id || null;
     this.name = name || null;
@@ -69,8 +111,23 @@ class SMWorkout {
     });
   }
 }
+
+/**
+ * Class representing an exercise in a workout.
+ */
 exports.SMWorkout = SMWorkout;
 class SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   */
+
   constructor(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams) {
     this.prettyName = prettyName || null;
     this.totalSeconds = totalSeconds || null;
@@ -82,8 +139,27 @@ class SMExercise {
     this.scoringParams = scoringParams || null;
   }
 }
+
+/**
+ * Class representing an exercise in an assessment.
+ */
 exports.SMExercise = SMExercise;
 class SMAssessmentExercise extends SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   * @param {string | null} summaryTitle - Title for the exercise summary.
+   * @param {string | null} summarySubTitle - Subtitle for the exercise summary.
+   * @param {string | null} summaryMainMetricTitle - Main metric title in the summary.
+   * @param {string | null} summaryMainMetricSubTitle - Main metric subtitle in the summary.
+   */
+
   constructor(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams, summaryTitle, summarySubTitle, summaryMainMetricTitle, summaryMainMetricSubTitle) {
     // Call the constructor of the parent class (SMExercise)
     super(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams);
@@ -95,8 +171,21 @@ class SMAssessmentExercise extends SMExercise {
     this.summaryMainMetricSubTitle = summaryMainMetricSubTitle || null;
   }
 }
+
+/**
+ * Class representing scoring parameters for an exercise.
+ */
 exports.SMAssessmentExercise = SMAssessmentExercise;
 class SMScoringParams {
+  /**
+   * @param {ScoringType | null} type - Type of scoring (e.g., ROM, time, reps).
+   * @param {number | null} scoreFactor - Factor to adjust the score.
+   * @param {number | null} targetTime - Target time for time-based scoring.
+   * @param {number | null} targetReps - Target reps for rep-based scoring.
+   * @param {string | null} targetRom - Range of motion target for ROM-based scoring.
+   * @param {string[] | null} passCriteria - List of criteria required to pass.
+   */
+
   constructor(type, scoreFactor, targetTime, targetReps, targetRom, passCriteria) {
     this.type = type || null;
     this.scoreFactor = scoreFactor || null;
@@ -106,8 +195,20 @@ class SMScoringParams {
     this.passCriteria = passCriteria || null;
   }
 }
+
+/**
+ * Class representing the configuration for a workout program.
+ */
 exports.SMScoringParams = SMScoringParams;
 class WorkoutConfig {
+  /**
+   * @param {number} week - Week number in the program.
+   * @param {BodyZone} bodyZone - Targeted body zone for the workout.
+   * @param {WorkoutDifficulty} difficultyLevel - Difficulty level of the workout.
+   * @param {WorkoutDuration} workoutDuration - Duration of the workout.
+   * @param {string} programID - Unique identifier for the workout program.
+   */
+
   constructor(week, bodyZone, difficultyLevel, workoutDuration, programID) {
     this.week = week;
     this.bodyZone = bodyZone;
@@ -125,8 +226,17 @@ class WorkoutConfig {
     });
   }
 }
+
+/**
+ * Class representing user data.
+ */
 exports.WorkoutConfig = WorkoutConfig;
 class UserData {
+  /**
+   * @param {Gender} gender - User's gender.
+   * @param {number} age - User's age.
+   */
+
   constructor(gender, age) {
     this.gender = gender;
     this.age = age;

package/lib/commonjs/SMWorkout.js.map

@@ -1 +1 @@
-{"version":3,"names":["AssessmentTypes","exports","UIElement","BodyZone","WorkoutDifficulty","WorkoutDuration","ScoringType","Gender","SMWorkout","constructor","id","name","workoutIntro","soundtrack","exercises","getInFrame","bodycalFinished","workoutClosure","toJson","JSON","stringify","SMExercise","prettyName","totalSeconds","videoInstruction","exerciseIntro","uiElements","detector","exerciseClosure","scoringParams","SMAssessmentExercise","summaryTitle","summarySubTitle","summaryMainMetricTitle","summaryMainMetricSubTitle","SMScoringParams","type","scoreFactor","targetTime","targetReps","targetRom","passCriteria","WorkoutConfig","week","bodyZone","difficultyLevel","workoutDuration","programID","UserData","gender","age"],"sourceRoot":"../../src","sources":["SMWorkout.tsx"],"mappings":";;;;;;IAAYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAAA,IAMfE,SAAS,GAAAD,OAAA,CAAAC,SAAA,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAAA,IAMTC,QAAQ,GAAAF,OAAA,CAAAE,QAAA,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AAAA,IAMRC,iBAAiB,GAAAH,OAAA,CAAAG,iBAAA,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAAA,IAMjBC,eAAe,GAAAJ,OAAA,CAAAI,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAAA,IAKfC,WAAW,GAAAL,OAAA,CAAAK,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAAA,IAMXC,MAAM,GAAAN,OAAA,CAAAM,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAMX,MAAMC,SAAS,CAAC;EAUrBC,WAAWA,CACTC,EAAiB,EACjBC,IAAmB,EACnBC,YAA2B,EAC3BC,UAAyB,EACzBC,SAAuB,EACvBC,UAAyB,EACzBC,eAA8B,EAC9BC,cAA6B,EAC7B;IACA,IAAI,CAACP,EAAE,GAAGA,EAAE,IAAI,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,cAAc,GAAGA,cAAc,IAAI,IAAI;EAC9C;EAEAC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBV,EAAE,EAAE,IAAI,CAACA,EAAE;MACXC,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,cAAc,EAAE,IAAI,CAACA;IACvB,CAAC,CAAC;EACJ;AACF;AAAChB,OAAA,CAAAO,SAAA,GAAAA,SAAA;AAEM,MAAMa,UAAU,CAAC;EAUtBZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrC;IACA,IAAI,CAACP,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,gBAAgB,GAAGA,gBAAgB,IAAI,IAAI;IAChD,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;IAC1C,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;EAC5C;AACF;AAAC5B,OAAA,CAAAoB,UAAA,GAAAA,UAAA;AAEM,MAAMS,oBAAoB,SAAST,UAAU,CAAC;EAMnDZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrCE,YAA2B,EAC3BC,eAA8B,EAC9BC,sBAAqC,EACrCC,yBAAwC,EACxC;IACA;IACA,KAAK,CACHZ,UAAU,EACVC,YAAY,EACZC,gBAAgB,EAChBC,aAAa,EACbC,UAAU,EACVC,QAAQ,EACRC,eAAe,EACfC,aACF,CAAC;;IAED;IACA,IAAI,CAACE,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,sBAAsB,GAAGA,sBAAsB,IAAI,IAAI;IAC5D,IAAI,CAACC,yBAAyB,GAAGA,yBAAyB,IAAI,IAAI;EACpE;AACF;AAACjC,OAAA,CAAA6B,oBAAA,GAAAA,oBAAA;AAEM,MAAMK,eAAe,CAAC;EAQ3B1B,WAAWA,CACT2B,IAAwB,EACxBC,WAA0B,EAC1BC,UAAyB,EACzBC,UAAyB,EACzBC,SAAwB,EACxBC,YAA6B,EAC7B;IACA,IAAI,CAACL,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,WAAW,GAAGA,WAAW,IAAI,IAAI;IACtC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS,IAAI,IAAI;IAClC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;EAC1C;AACF;AAACxC,OAAA,CAAAkC,eAAA,GAAAA,eAAA;AAEM,MAAMO,aAAa,CAAC;EAOzBjC,WAAWA,CACTkC,IAAY,EACZC,QAAkB,EAClBC,eAAkC,EAClCC,eAAgC,EAChCC,SAAiB,EACjB;IACA,IAAI,CAACJ,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,SAAS,GAAGA,SAAS;EAC5B;EAEA7B,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBuB,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,SAAS,EAAE,IAAI,CAACA;IAClB,CAAC,CAAC;EACJ;AACF;AAAC9C,OAAA,CAAAyC,aAAA,GAAAA,aAAA;AAEM,MAAMM,QAAQ,CAAC;EAIpBvC,WAAWA,CAACwC,MAAc,EAAEC,GAAW,EAAE;IACvC,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAEAhC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpB6B,MAAM,EAAE,IAAI,CAACA,MAAM;MACnBC,GAAG,EAAE,IAAI,CAACA;IACZ,CAAC,CAAC;EACJ;AACF;AAACjD,OAAA,CAAA+C,QAAA,GAAAA,QAAA","ignoreList":[]}
+{"version":3,"names":["AssessmentTypes","exports","UIElement","BodyZone","WorkoutDifficulty","WorkoutDuration","ScoringType","Gender","SMWorkout","constructor","id","name","workoutIntro","soundtrack","exercises","getInFrame","bodycalFinished","workoutClosure","toJson","JSON","stringify","SMExercise","prettyName","totalSeconds","videoInstruction","exerciseIntro","uiElements","detector","exerciseClosure","scoringParams","SMAssessmentExercise","summaryTitle","summarySubTitle","summaryMainMetricTitle","summaryMainMetricSubTitle","SMScoringParams","type","scoreFactor","targetTime","targetReps","targetRom","passCriteria","WorkoutConfig","week","bodyZone","difficultyLevel","workoutDuration","programID","UserData","gender","age"],"sourceRoot":"../../src","sources":["SMWorkout.tsx"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AAHA,IAIYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAM3B;AACA;AACA;AACA;AAHA,IAIYE,SAAS,GAAAD,OAAA,CAAAC,SAAA,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAMrB;AACA;AACA;AACA;AAHA,IAIYC,QAAQ,GAAAF,OAAA,CAAAE,QAAA,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AAMpB;AACA;AACA;AACA;AAHA,IAIYC,iBAAiB,GAAAH,OAAA,CAAAG,iBAAA,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAM7B;AACA;AACA;AACA;AAHA,IAIYC,eAAe,GAAAJ,OAAA,CAAAI,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAK3B;AACA;AACA;AACA;AAHA,IAIYC,WAAW,GAAAL,OAAA,CAAAK,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAMvB;AACA;AACA;AACA;AAHA,IAIYC,MAAM,GAAAN,OAAA,CAAAM,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAMlB;AACA;AACA;AACO,MAAMC,SAAS,CAAC;EACrB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAUEC,WAAWA,CACTC,EAAiB,EACjBC,IAAmB,EACnBC,YAA2B,EAC3BC,UAAyB,EACzBC,SAAuB,EACvBC,UAAyB,EACzBC,eAA8B,EAC9BC,cAA6B,EAC7B;IACA,IAAI,CAACP,EAAE,GAAGA,EAAE,IAAI,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,cAAc,GAAGA,cAAc,IAAI,IAAI;EAC9C;EAEAC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBV,EAAE,EAAE,IAAI,CAACA,EAAE;MACXC,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,cAAc,EAAE,IAAI,CAACA;IACvB,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AAFAhB,OAAA,CAAAO,SAAA,GAAAA,SAAA;AAGO,MAAMa,UAAU,CAAC;EACtB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAUEZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrC;IACA,IAAI,CAACP,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,gBAAgB,GAAGA,gBAAgB,IAAI,IAAI;IAChD,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;IAC1C,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;EAC5C;AACF;;AAEA;AACA;AACA;AAFA5B,OAAA,CAAAoB,UAAA,GAAAA,UAAA;AAGO,MAAMS,oBAAoB,SAAST,UAAU,CAAC;EACnD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAMEZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrCE,YAA2B,EAC3BC,eAA8B,EAC9BC,sBAAqC,EACrCC,yBAAwC,EACxC;IACA;IACA,KAAK,CACHZ,UAAU,EACVC,YAAY,EACZC,gBAAgB,EAChBC,aAAa,EACbC,UAAU,EACVC,QAAQ,EACRC,eAAe,EACfC,aACF,CAAC;;IAED;IACA,IAAI,CAACE,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,sBAAsB,GAAGA,sBAAsB,IAAI,IAAI;IAC5D,IAAI,CAACC,yBAAyB,GAAGA,yBAAyB,IAAI,IAAI;EACpE;AACF;;AAEA;AACA;AACA;AAFAjC,OAAA,CAAA6B,oBAAA,GAAAA,oBAAA;AAGO,MAAMK,eAAe,CAAC;EAC3B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;;EAQE1B,WAAWA,CACT2B,IAAwB,EACxBC,WAA0B,EAC1BC,UAAyB,EACzBC,UAAyB,EACzBC,SAAwB,EACxBC,YAA6B,EAC7B;IACA,IAAI,CAACL,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,WAAW,GAAGA,WAAW,IAAI,IAAI;IACtC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS,IAAI,IAAI;IAClC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;EAC1C;AACF;;AAGA;AACA;AACA;AAFAxC,OAAA,CAAAkC,eAAA,GAAAA,eAAA;AAGO,MAAMO,aAAa,CAAC;EACzB;AACF;AACA;AACA;AACA;AACA;AACA;;EAOEjC,WAAWA,CACTkC,IAAY,EACZC,QAAkB,EAClBC,eAAkC,EAClCC,eAAgC,EAChCC,SAAiB,EACjB;IACA,IAAI,CAACJ,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,SAAS,GAAGA,SAAS;EAC5B;EAEA7B,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBuB,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,SAAS,EAAE,IAAI,CAACA;IAClB,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AAFA9C,OAAA,CAAAyC,aAAA,GAAAA,aAAA;AAGO,MAAMM,QAAQ,CAAC;EACpB;AACF;AACA;AACA;;EAIEvC,WAAWA,CAACwC,MAAc,EAAEC,GAAW,EAAE;IACvC,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAEAhC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpB6B,MAAM,EAAE,IAAI,CAACA,MAAM;MACnBC,GAAG,EAAE,IAAI,CAACA;IACZ,CAAC,CAAC;EACJ;AACF;AAACjD,OAAA,CAAA+C,QAAA,GAAAA,QAAA","ignoreList":[]}

package/lib/commonjs/index.js

@@ -18,18 +18,58 @@ const SMKitUIManager = _reactNative.NativeModules.SMKitUIManager ? _reactNative.
     throw new Error(LINKING_ERROR);
   }
 });
+
+/**
+ * This function will configure the sdk
+ * @param {string} key - your auth key
+ */
 function configure(key) {
   return SMKitUIManager.configure(key);
 }
+
+/**
+ * start an assessment session.
+ *
+ * @param {SMWorkoutLibrary.AssessmentTypes} type - The type of assessment to start.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment session, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {string} customAssessmentID - A unique identifier for a custom assessment session.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating whether the assessment finished.
+ */
 function startAssessment(type, showSummary = true, userData, forceShowUserDataScreen = false, customAssessmentID) {
   return SMKitUIManager.startAssessment(type, showSummary, userData?.toJson(), forceShowUserDataScreen, customAssessmentID);
 }
+
+/**
+ * Starts a custom workout session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} workout - The custom workout configuration.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout session finished.
+ */
 function startCustomWorkout(workout) {
   return SMKitUIManager.startCustomWorkout(workout.toJson());
 }
+
+/**
+ * Initiates a custom assessment session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} assessment - The assessment configuration for the session.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the assessment finished.
+ */
 function startCustomAssessment(assessment, userData, forceShowUserDataScreen = false, showSummary = true) {
   return SMKitUIManager.startCustomAssessment(assessment.toJson(), userData?.toJson(), forceShowUserDataScreen, showSummary);
 }
+
+/**
+ * Starts a workout program using the provided workout configuration.
+ *
+ * @param {SMWorkoutLibrary.WorkoutConfig} workoutConfig - The configuration for the workout program.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout program finished.
+ */
 function startWorkoutProgram(workoutConfig) {
   return SMKitUIManager.startWorkoutProgram(workoutConfig.toJson());
 }

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","SMKitUIManager","NativeModules","Proxy","get","Error","configure","key","startAssessment","type","showSummary","userData","forceShowUserDataScreen","customAssessmentID","toJson","startCustomWorkout","workout","startCustomAssessment","assessment","startWorkoutProgram","workoutConfig"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAGA,MAAMC,aAAa,GAChB,gFAA+E,GAChFC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,cAAc,GAAGC,0BAAa,CAACD,cAAc,GAC/CC,0BAAa,CAACD,cAAc,GAC5B,IAAIE,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEE,SAASU,SAASA,CAACC,GAAW,EAAmB;EACtD,OAAON,cAAc,CAACK,SAAS,CAACC,GAAG,CAAC;AACtC;AAEO,SAASC,eAAeA,CAC7BC,IAAsC,EACtCC,WAAoB,GAAG,IAAI,EAC3BC,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCC,kBAA0B,EACwB;EAClD,OAAOZ,cAAc,CAACO,eAAe,CACnCC,IAAI,EACJC,WAAW,EACXC,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBC,kBACF,CAAC;AACH;AAEO,SAASE,kBAAkBA,CAChCC,OAAmC,EACe;EAClD,OAAOf,cAAc,CAACc,kBAAkB,CAACC,OAAO,CAACF,MAAM,CAAC,CAAC,CAAC;AAC5D;AAEO,SAASG,qBAAqBA,CACnCC,UAAsC,EACtCP,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCF,WAAoB,GAAG,IAAI,EACuB;EAClD,OAAOT,cAAc,CAACgB,qBAAqB,CACzCC,UAAU,CAACJ,MAAM,CAAC,CAAC,EACnBH,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBF,WACF,CAAC;AACH;AAEO,SAASS,mBAAmBA,CAACC,aAA4C,EAAgD;EAC9H,OAAOnB,cAAc,CAACkB,mBAAmB,CAACC,aAAa,CAACN,MAAM,CAAC,CAAC,CAAC;AACnE","ignoreList":[]}
+{"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","SMKitUIManager","NativeModules","Proxy","get","Error","configure","key","startAssessment","type","showSummary","userData","forceShowUserDataScreen","customAssessmentID","toJson","startCustomWorkout","workout","startCustomAssessment","assessment","startWorkoutProgram","workoutConfig"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAGA,MAAMC,aAAa,GACjB,gFAAgF,GAChFC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,cAAc,GAAGC,0BAAa,CAACD,cAAc,GAC/CC,0BAAa,CAACD,cAAc,GAC5B,IAAIE,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAC;;AAEL;AACA;AACA;AACA;AACO,SAASU,SAASA,CAACC,GAAW,EAAmB;EACtD,OAAON,cAAc,CAACK,SAAS,CAACC,GAAG,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAC7BC,IAAsC,EACtCC,WAAoB,GAAG,IAAI,EAC3BC,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCC,kBAA0B,EACwB;EAClD,OAAOZ,cAAc,CAACO,eAAe,CACnCC,IAAI,EACJC,WAAW,EACXC,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBC,kBACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,kBAAkBA,CAChCC,OAAmC,EACe;EAClD,OAAOf,cAAc,CAACc,kBAAkB,CAACC,OAAO,CAACF,MAAM,CAAC,CAAC,CAAC;AAC5D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,qBAAqBA,CACnCC,UAAsC,EACtCP,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCF,WAAoB,GAAG,IAAI,EACuB;EAClD,OAAOT,cAAc,CAACgB,qBAAqB,CACzCC,UAAU,CAACJ,MAAM,CAAC,CAAC,EACnBH,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBF,WACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASS,mBAAmBA,CACjCC,aAA6C,EACK;EAClD,OAAOnB,cAAc,CAACkB,mBAAmB,CAACC,aAAa,CAACN,MAAM,CAAC,CAAC,CAAC;AACnE","ignoreList":[]}

package/lib/module/SMWorkout.js

@@ -1,45 +1,94 @@
+/**
+ * Enum representing assessment types.
+ * @enum {string}
+ */
 export let AssessmentTypes = /*#__PURE__*/function (AssessmentTypes) {
   AssessmentTypes["Fitness"] = "fitness";
   AssessmentTypes["Custom"] = "custom";
   AssessmentTypes["Body360"] = "body360";
   return AssessmentTypes;
 }({});
+
+/**
+ * Enum representing UI elements that can be displayed during workouts.
+ * @enum {string}
+ */
 export let UIElement = /*#__PURE__*/function (UIElement) {
   UIElement["RepsCounter"] = "repsCounter";
   UIElement["Timer"] = "timer";
   UIElement["GaugeOfMotion"] = "gaugeOfMotion";
   return UIElement;
 }({});
+
+/**
+ * Enum representing body zones targeted in workouts.
+ * @enum {string}
+ */
 export let BodyZone = /*#__PURE__*/function (BodyZone) {
   BodyZone["UpperBody"] = "UpperBody";
   BodyZone["LowerBody"] = "LowerBody";
   BodyZone["FullBody"] = "FullBody";
   return BodyZone;
 }({});
+
+/**
+ * Enum representing workout difficulty levels.
+ * @enum {string}
+ */
 export let WorkoutDifficulty = /*#__PURE__*/function (WorkoutDifficulty) {
   WorkoutDifficulty["LowDifficulty"] = "LowDifficulty";
   WorkoutDifficulty["MidDifficulty"] = "MidDifficulty";
   WorkoutDifficulty["HighDifficulty"] = "HighDifficulty";
   return WorkoutDifficulty;
 }({});
+
+/**
+ * Enum representing workout durations.
+ * @enum {string}
+ */
 export let WorkoutDuration = /*#__PURE__*/function (WorkoutDuration) {
   WorkoutDuration["Short"] = "Short";
   WorkoutDuration["Long"] = "Long";
   return WorkoutDuration;
 }({});
+
+/**
+ * Enum representing different types of scoring methods.
+ * @enum {string}
+ */
 export let ScoringType = /*#__PURE__*/function (ScoringType) {
   ScoringType["Rom"] = "rom";
   ScoringType["Time"] = "time";
   ScoringType["Reps"] = "reps";
   return ScoringType;
 }({});
+
+/**
+ * Enum representing gender options for user data.
+ * @enum {string}
+ */
 export let Gender = /*#__PURE__*/function (Gender) {
   Gender["Female"] = "Female";
   Gender["Male"] = "Male";
   Gender["Other"] = "Rather not say";
   return Gender;
 }({});
+
+/**
+ * Class representing a workout.
+ */
 export class SMWorkout {
+  /**
+   * @param {string | null} id - Unique identifier for the workout.
+   * @param {string | null} name - Name of the workout.
+   * @param {string | null} workoutIntro - URL for workout intro sound.
+   * @param {string | null} soundtrack - URL for soundtrack.
+   * @param {SMExercise[]} exercises - List of exercises included in the workout.
+   * @param {string | null} getInFrame - URL for body cal get in frame sound.
+   * @param {string | null} bodycalFinished - URL for body cal finished sound.
+   * @param {string | null} workoutClosure - URL for workout closure sound.
+   */
+
   constructor(id, name, workoutIntro, soundtrack, exercises, getInFrame, bodycalFinished, workoutClosure) {
     this.id = id || null;
     this.name = name || null;
@@ -63,7 +112,22 @@ export class SMWorkout {
     });
   }
 }
+
+/**
+ * Class representing an exercise in a workout.
+ */
 export class SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   */
+
   constructor(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams) {
     this.prettyName = prettyName || null;
     this.totalSeconds = totalSeconds || null;
@@ -75,7 +139,26 @@ export class SMExercise {
     this.scoringParams = scoringParams || null;
   }
 }
+
+/**
+ * Class representing an exercise in an assessment.
+ */
 export class SMAssessmentExercise extends SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   * @param {string | null} summaryTitle - Title for the exercise summary.
+   * @param {string | null} summarySubTitle - Subtitle for the exercise summary.
+   * @param {string | null} summaryMainMetricTitle - Main metric title in the summary.
+   * @param {string | null} summaryMainMetricSubTitle - Main metric subtitle in the summary.
+   */
+
   constructor(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams, summaryTitle, summarySubTitle, summaryMainMetricTitle, summaryMainMetricSubTitle) {
     // Call the constructor of the parent class (SMExercise)
     super(prettyName, totalSeconds, videoInstruction, exerciseIntro, uiElements, detector, exerciseClosure, scoringParams);
@@ -87,7 +170,20 @@ export class SMAssessmentExercise extends SMExercise {
     this.summaryMainMetricSubTitle = summaryMainMetricSubTitle || null;
   }
 }
+
+/**
+ * Class representing scoring parameters for an exercise.
+ */
 export class SMScoringParams {
+  /**
+   * @param {ScoringType | null} type - Type of scoring (e.g., ROM, time, reps).
+   * @param {number | null} scoreFactor - Factor to adjust the score.
+   * @param {number | null} targetTime - Target time for time-based scoring.
+   * @param {number | null} targetReps - Target reps for rep-based scoring.
+   * @param {string | null} targetRom - Range of motion target for ROM-based scoring.
+   * @param {string[] | null} passCriteria - List of criteria required to pass.
+   */
+
   constructor(type, scoreFactor, targetTime, targetReps, targetRom, passCriteria) {
     this.type = type || null;
     this.scoreFactor = scoreFactor || null;
@@ -97,7 +193,19 @@ export class SMScoringParams {
     this.passCriteria = passCriteria || null;
   }
 }
+
+/**
+ * Class representing the configuration for a workout program.
+ */
 export class WorkoutConfig {
+  /**
+   * @param {number} week - Week number in the program.
+   * @param {BodyZone} bodyZone - Targeted body zone for the workout.
+   * @param {WorkoutDifficulty} difficultyLevel - Difficulty level of the workout.
+   * @param {WorkoutDuration} workoutDuration - Duration of the workout.
+   * @param {string} programID - Unique identifier for the workout program.
+   */
+
   constructor(week, bodyZone, difficultyLevel, workoutDuration, programID) {
     this.week = week;
     this.bodyZone = bodyZone;
@@ -115,7 +223,16 @@ export class WorkoutConfig {
     });
   }
 }
+
+/**
+ * Class representing user data.
+ */
 export class UserData {
+  /**
+   * @param {Gender} gender - User's gender.
+   * @param {number} age - User's age.
+   */
+
   constructor(gender, age) {
     this.gender = gender;
     this.age = age;

package/lib/module/SMWorkout.js.map

@@ -1 +1 @@
-{"version":3,"names":["AssessmentTypes","UIElement","BodyZone","WorkoutDifficulty","WorkoutDuration","ScoringType","Gender","SMWorkout","constructor","id","name","workoutIntro","soundtrack","exercises","getInFrame","bodycalFinished","workoutClosure","toJson","JSON","stringify","SMExercise","prettyName","totalSeconds","videoInstruction","exerciseIntro","uiElements","detector","exerciseClosure","scoringParams","SMAssessmentExercise","summaryTitle","summarySubTitle","summaryMainMetricTitle","summaryMainMetricSubTitle","SMScoringParams","type","scoreFactor","targetTime","targetReps","targetRom","passCriteria","WorkoutConfig","week","bodyZone","difficultyLevel","workoutDuration","programID","UserData","gender","age"],"sourceRoot":"../../src","sources":["SMWorkout.tsx"],"mappings":"AAAA,WAAYA,eAAe,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAM3B,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAMrB,WAAYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AAMpB,WAAYC,iBAAiB,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAM7B,WAAYC,eAAe,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAK3B,WAAYC,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAMvB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAMlB,OAAO,MAAMC,SAAS,CAAC;EAUrBC,WAAWA,CACTC,EAAiB,EACjBC,IAAmB,EACnBC,YAA2B,EAC3BC,UAAyB,EACzBC,SAAuB,EACvBC,UAAyB,EACzBC,eAA8B,EAC9BC,cAA6B,EAC7B;IACA,IAAI,CAACP,EAAE,GAAGA,EAAE,IAAI,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,cAAc,GAAGA,cAAc,IAAI,IAAI;EAC9C;EAEAC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBV,EAAE,EAAE,IAAI,CAACA,EAAE;MACXC,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,cAAc,EAAE,IAAI,CAACA;IACvB,CAAC,CAAC;EACJ;AACF;AAEA,OAAO,MAAMI,UAAU,CAAC;EAUtBZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrC;IACA,IAAI,CAACP,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,gBAAgB,GAAGA,gBAAgB,IAAI,IAAI;IAChD,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;IAC1C,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;EAC5C;AACF;AAEA,OAAO,MAAMC,oBAAoB,SAAST,UAAU,CAAC;EAMnDZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrCE,YAA2B,EAC3BC,eAA8B,EAC9BC,sBAAqC,EACrCC,yBAAwC,EACxC;IACA;IACA,KAAK,CACHZ,UAAU,EACVC,YAAY,EACZC,gBAAgB,EAChBC,aAAa,EACbC,UAAU,EACVC,QAAQ,EACRC,eAAe,EACfC,aACF,CAAC;;IAED;IACA,IAAI,CAACE,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,sBAAsB,GAAGA,sBAAsB,IAAI,IAAI;IAC5D,IAAI,CAACC,yBAAyB,GAAGA,yBAAyB,IAAI,IAAI;EACpE;AACF;AAEA,OAAO,MAAMC,eAAe,CAAC;EAQ3B1B,WAAWA,CACT2B,IAAwB,EACxBC,WAA0B,EAC1BC,UAAyB,EACzBC,UAAyB,EACzBC,SAAwB,EACxBC,YAA6B,EAC7B;IACA,IAAI,CAACL,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,WAAW,GAAGA,WAAW,IAAI,IAAI;IACtC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS,IAAI,IAAI;IAClC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;EAC1C;AACF;AAEA,OAAO,MAAMC,aAAa,CAAC;EAOzBjC,WAAWA,CACTkC,IAAY,EACZC,QAAkB,EAClBC,eAAkC,EAClCC,eAAgC,EAChCC,SAAiB,EACjB;IACA,IAAI,CAACJ,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,SAAS,GAAGA,SAAS;EAC5B;EAEA7B,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBuB,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,SAAS,EAAE,IAAI,CAACA;IAClB,CAAC,CAAC;EACJ;AACF;AAEA,OAAO,MAAMC,QAAQ,CAAC;EAIpBvC,WAAWA,CAACwC,MAAc,EAAEC,GAAW,EAAE;IACvC,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAEAhC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpB6B,MAAM,EAAE,IAAI,CAACA,MAAM;MACnBC,GAAG,EAAE,IAAI,CAACA;IACZ,CAAC,CAAC;EACJ;AACF","ignoreList":[]}
+{"version":3,"names":["AssessmentTypes","UIElement","BodyZone","WorkoutDifficulty","WorkoutDuration","ScoringType","Gender","SMWorkout","constructor","id","name","workoutIntro","soundtrack","exercises","getInFrame","bodycalFinished","workoutClosure","toJson","JSON","stringify","SMExercise","prettyName","totalSeconds","videoInstruction","exerciseIntro","uiElements","detector","exerciseClosure","scoringParams","SMAssessmentExercise","summaryTitle","summarySubTitle","summaryMainMetricTitle","summaryMainMetricSubTitle","SMScoringParams","type","scoreFactor","targetTime","targetReps","targetRom","passCriteria","WorkoutConfig","week","bodyZone","difficultyLevel","workoutDuration","programID","UserData","gender","age"],"sourceRoot":"../../src","sources":["SMWorkout.tsx"],"mappings":"AAAA;AACA;AACA;AACA;AACA,WAAYA,eAAe,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;;AAM3B;AACA;AACA;AACA;AACA,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAMrB;AACA;AACA;AACA;AACA,WAAYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;;AAMpB;AACA;AACA;AACA;AACA,WAAYC,iBAAiB,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;;AAM7B;AACA;AACA;AACA;AACA,WAAYC,eAAe,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;;AAK3B;AACA;AACA;AACA;AACA,WAAYC,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;;AAMvB;AACA;AACA;AACA;AACA,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;;AAMlB;AACA;AACA;AACA,OAAO,MAAMC,SAAS,CAAC;EACrB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAUEC,WAAWA,CACTC,EAAiB,EACjBC,IAAmB,EACnBC,YAA2B,EAC3BC,UAAyB,EACzBC,SAAuB,EACvBC,UAAyB,EACzBC,eAA8B,EAC9BC,cAA6B,EAC7B;IACA,IAAI,CAACP,EAAE,GAAGA,EAAE,IAAI,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,cAAc,GAAGA,cAAc,IAAI,IAAI;EAC9C;EAEAC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBV,EAAE,EAAE,IAAI,CAACA,EAAE;MACXC,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,cAAc,EAAE,IAAI,CAACA;IACvB,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA,OAAO,MAAMI,UAAU,CAAC;EACtB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAUEZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrC;IACA,IAAI,CAACP,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,gBAAgB,GAAGA,gBAAgB,IAAI,IAAI;IAChD,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;IAC1C,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,aAAa,GAAGA,aAAa,IAAI,IAAI;EAC5C;AACF;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,oBAAoB,SAAST,UAAU,CAAC;EACnD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAMEZ,WAAWA,CACTa,UAAyB,EACzBC,YAA2B,EAC3BC,gBAA+B,EAC/BC,aAA4B,EAC5BC,UAA8B,EAC9BC,QAAgB,EAChBC,eAA8B,EAC9BC,aAAqC,EACrCE,YAA2B,EAC3BC,eAA8B,EAC9BC,sBAAqC,EACrCC,yBAAwC,EACxC;IACA;IACA,KAAK,CACHZ,UAAU,EACVC,YAAY,EACZC,gBAAgB,EAChBC,aAAa,EACbC,UAAU,EACVC,QAAQ,EACRC,eAAe,EACfC,aACF,CAAC;;IAED;IACA,IAAI,CAACE,YAAY,GAAGA,YAAY,IAAI,IAAI;IACxC,IAAI,CAACC,eAAe,GAAGA,eAAe,IAAI,IAAI;IAC9C,IAAI,CAACC,sBAAsB,GAAGA,sBAAsB,IAAI,IAAI;IAC5D,IAAI,CAACC,yBAAyB,GAAGA,yBAAyB,IAAI,IAAI;EACpE;AACF;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;;EAQE1B,WAAWA,CACT2B,IAAwB,EACxBC,WAA0B,EAC1BC,UAAyB,EACzBC,UAAyB,EACzBC,SAAwB,EACxBC,YAA6B,EAC7B;IACA,IAAI,CAACL,IAAI,GAAGA,IAAI,IAAI,IAAI;IACxB,IAAI,CAACC,WAAW,GAAGA,WAAW,IAAI,IAAI;IACtC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,UAAU,GAAGA,UAAU,IAAI,IAAI;IACpC,IAAI,CAACC,SAAS,GAAGA,SAAS,IAAI,IAAI;IAClC,IAAI,CAACC,YAAY,GAAGA,YAAY,IAAI,IAAI;EAC1C;AACF;;AAGA;AACA;AACA;AACA,OAAO,MAAMC,aAAa,CAAC;EACzB;AACF;AACA;AACA;AACA;AACA;AACA;;EAOEjC,WAAWA,CACTkC,IAAY,EACZC,QAAkB,EAClBC,eAAkC,EAClCC,eAAgC,EAChCC,SAAiB,EACjB;IACA,IAAI,CAACJ,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACC,SAAS,GAAGA,SAAS;EAC5B;EAEA7B,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpBuB,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,SAAS,EAAE,IAAI,CAACA;IAClB,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,QAAQ,CAAC;EACpB;AACF;AACA;AACA;;EAIEvC,WAAWA,CAACwC,MAAc,EAAEC,GAAW,EAAE;IACvC,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,GAAG,GAAGA,GAAG;EAChB;EAEAhC,MAAMA,CAAA,EAAW;IACf,OAAOC,IAAI,CAACC,SAAS,CAAC;MACpB6B,MAAM,EAAE,IAAI,CAACA,MAAM;MACnBC,GAAG,EAAE,IAAI,CAACA;IACZ,CAAC,CAAC;EACJ;AACF","ignoreList":[]}

package/lib/module/index.js

@@ -8,18 +8,58 @@ const SMKitUIManager = NativeModules.SMKitUIManager ? NativeModules.SMKitUIManag
     throw new Error(LINKING_ERROR);
   }
 });
+
+/**
+ * This function will configure the sdk
+ * @param {string} key - your auth key
+ */
 export function configure(key) {
   return SMKitUIManager.configure(key);
 }
+
+/**
+ * start an assessment session.
+ *
+ * @param {SMWorkoutLibrary.AssessmentTypes} type - The type of assessment to start.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment session, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {string} customAssessmentID - A unique identifier for a custom assessment session.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating whether the assessment finished.
+ */
 export function startAssessment(type, showSummary = true, userData, forceShowUserDataScreen = false, customAssessmentID) {
   return SMKitUIManager.startAssessment(type, showSummary, userData?.toJson(), forceShowUserDataScreen, customAssessmentID);
 }
+
+/**
+ * Starts a custom workout session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} workout - The custom workout configuration.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout session finished.
+ */
 export function startCustomWorkout(workout) {
   return SMKitUIManager.startCustomWorkout(workout.toJson());
 }
+
+/**
+ * Initiates a custom assessment session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} assessment - The assessment configuration for the session.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the assessment finished.
+ */
 export function startCustomAssessment(assessment, userData, forceShowUserDataScreen = false, showSummary = true) {
   return SMKitUIManager.startCustomAssessment(assessment.toJson(), userData?.toJson(), forceShowUserDataScreen, showSummary);
 }
+
+/**
+ * Starts a workout program using the provided workout configuration.
+ *
+ * @param {SMWorkoutLibrary.WorkoutConfig} workoutConfig - The configuration for the workout program.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout program finished.
+ */
 export function startWorkoutProgram(workoutConfig) {
   return SMKitUIManager.startWorkoutProgram(workoutConfig.toJson());
 }

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","SMKitUIManager","Proxy","get","Error","configure","key","startAssessment","type","showSummary","userData","forceShowUserDataScreen","customAssessmentID","toJson","startCustomWorkout","workout","startCustomAssessment","assessment","startWorkoutProgram","workoutConfig"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAGtD,MAAMC,aAAa,GAChB,gFAA+E,GAChFD,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,cAAc,GAAGN,aAAa,CAACM,cAAc,GAC/CN,aAAa,CAACM,cAAc,GAC5B,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEL,OAAO,SAASQ,SAASA,CAACC,GAAW,EAAmB;EACtD,OAAOL,cAAc,CAACI,SAAS,CAACC,GAAG,CAAC;AACtC;AAEA,OAAO,SAASC,eAAeA,CAC7BC,IAAsC,EACtCC,WAAoB,GAAG,IAAI,EAC3BC,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCC,kBAA0B,EACwB;EAClD,OAAOX,cAAc,CAACM,eAAe,CACnCC,IAAI,EACJC,WAAW,EACXC,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBC,kBACF,CAAC;AACH;AAEA,OAAO,SAASE,kBAAkBA,CAChCC,OAAmC,EACe;EAClD,OAAOd,cAAc,CAACa,kBAAkB,CAACC,OAAO,CAACF,MAAM,CAAC,CAAC,CAAC;AAC5D;AAEA,OAAO,SAASG,qBAAqBA,CACnCC,UAAsC,EACtCP,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCF,WAAoB,GAAG,IAAI,EACuB;EAClD,OAAOR,cAAc,CAACe,qBAAqB,CACzCC,UAAU,CAACJ,MAAM,CAAC,CAAC,EACnBH,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBF,WACF,CAAC;AACH;AAEA,OAAO,SAASS,mBAAmBA,CAACC,aAA4C,EAAgD;EAC9H,OAAOlB,cAAc,CAACiB,mBAAmB,CAACC,aAAa,CAACN,MAAM,CAAC,CAAC,CAAC;AACnE","ignoreList":[]}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","SMKitUIManager","Proxy","get","Error","configure","key","startAssessment","type","showSummary","userData","forceShowUserDataScreen","customAssessmentID","toJson","startCustomWorkout","workout","startCustomAssessment","assessment","startWorkoutProgram","workoutConfig"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAGtD,MAAMC,aAAa,GACjB,gFAAgF,GAChFD,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,cAAc,GAAGN,aAAa,CAACM,cAAc,GAC/CN,aAAa,CAACM,cAAc,GAC5B,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;;AAEL;AACA;AACA;AACA;AACA,OAAO,SAASQ,SAASA,CAACC,GAAW,EAAmB;EACtD,OAAOL,cAAc,CAACI,SAAS,CAACC,GAAG,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,IAAsC,EACtCC,WAAoB,GAAG,IAAI,EAC3BC,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCC,kBAA0B,EACwB;EAClD,OAAOX,cAAc,CAACM,eAAe,CACnCC,IAAI,EACJC,WAAW,EACXC,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBC,kBACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,kBAAkBA,CAChCC,OAAmC,EACe;EAClD,OAAOd,cAAc,CAACa,kBAAkB,CAACC,OAAO,CAACF,MAAM,CAAC,CAAC,CAAC;AAC5D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,qBAAqBA,CACnCC,UAAsC,EACtCP,QAA0C,EAC1CC,uBAAgC,GAAG,KAAK,EACxCF,WAAoB,GAAG,IAAI,EACuB;EAClD,OAAOR,cAAc,CAACe,qBAAqB,CACzCC,UAAU,CAACJ,MAAM,CAAC,CAAC,EACnBH,QAAQ,EAAEG,MAAM,CAAC,CAAC,EAClBF,uBAAuB,EACvBF,WACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,mBAAmBA,CACjCC,aAA6C,EACK;EAClD,OAAOlB,cAAc,CAACiB,mBAAmB,CAACC,aAAa,CAACN,MAAM,CAAC,CAAC,CAAC;AACnE","ignoreList":[]}

package/lib/typescript/example/src/App.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+declare const App: () => React.JSX.Element;
+export default App;
+//# sourceMappingURL=App.d.ts.map

package/lib/typescript/example/src/App.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../example/src/App.tsx"],"names":[],"mappings":"AAIM,OAAO,KAA8B,MAAM,OAAO,CAAC;AAgBzD,QAAA,MAAM,GAAG,yBA8NN,CAAA;AAwIH,eAAe,GAAG,CAAC"}

package/lib/typescript/src/SMWorkout.d.ts

@@ -1,38 +1,79 @@
+/**
+ * Enum representing assessment types.
+ * @enum {string}
+ */
 export declare enum AssessmentTypes {
     Fitness = "fitness",
     Custom = "custom",
     Body360 = "body360"
 }
+/**
+ * Enum representing UI elements that can be displayed during workouts.
+ * @enum {string}
+ */
 export declare enum UIElement {
     RepsCounter = "repsCounter",
     Timer = "timer",
     GaugeOfMotion = "gaugeOfMotion"
 }
+/**
+ * Enum representing body zones targeted in workouts.
+ * @enum {string}
+ */
 export declare enum BodyZone {
     UpperBody = "UpperBody",
     LowerBody = "LowerBody",
     FullBody = "FullBody"
 }
+/**
+ * Enum representing workout difficulty levels.
+ * @enum {string}
+ */
 export declare enum WorkoutDifficulty {
     LowDifficulty = "LowDifficulty",
     MidDifficulty = "MidDifficulty",
     HighDifficulty = "HighDifficulty"
 }
+/**
+ * Enum representing workout durations.
+ * @enum {string}
+ */
 export declare enum WorkoutDuration {
     Short = "Short",
     Long = "Long"
 }
+/**
+ * Enum representing different types of scoring methods.
+ * @enum {string}
+ */
 export declare enum ScoringType {
     Rom = "rom",
     Time = "time",
     Reps = "reps"
 }
+/**
+ * Enum representing gender options for user data.
+ * @enum {string}
+ */
 export declare enum Gender {
     Female = "Female",
     Male = "Male",
     Other = "Rather not say"
 }
+/**
+ * Class representing a workout.
+ */
 export declare class SMWorkout {
+    /**
+     * @param {string | null} id - Unique identifier for the workout.
+     * @param {string | null} name - Name of the workout.
+     * @param {string | null} workoutIntro - URL for workout intro sound.
+     * @param {string | null} soundtrack - URL for soundtrack.
+     * @param {SMExercise[]} exercises - List of exercises included in the workout.
+     * @param {string | null} getInFrame - URL for body cal get in frame sound.
+     * @param {string | null} bodycalFinished - URL for body cal finished sound.
+     * @param {string | null} workoutClosure - URL for workout closure sound.
+     */
     id: string | null;
     name: string | null;
     workoutIntro: string | null;
@@ -44,7 +85,20 @@ export declare class SMWorkout {
     constructor(id: string | null, name: string | null, workoutIntro: string | null, soundtrack: string | null, exercises: SMExercise[], getInFrame: string | null, bodycalFinished: string | null, workoutClosure: string | null);
     toJson(): string;
 }
+/**
+ * Class representing an exercise in a workout.
+ */
 export declare class SMExercise {
+    /**
+     * @param {string | null} prettyName - Name of the exercise.
+     * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+     * @param {string | null} videoInstruction - Video instruction URL.
+     * @param {string | null} exerciseIntro - URL for exercise intro sound.
+     * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+     * @param {string} detector - Name of the detector for tracking exercise movement.
+     * @param {string | null} exerciseClosure - URL for exercise closer sound.
+     * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+     */
     detector: string;
     uiElements: UIElement[] | null;
     videoInstruction: string | null;
@@ -55,14 +109,42 @@ export declare class SMExercise {
     scoringParams: SMScoringParams | null;
     constructor(prettyName: string | null, totalSeconds: number | null, videoInstruction: string | null, exerciseIntro: string | null, uiElements: UIElement[] | null, detector: string, exerciseClosure: string | null, scoringParams: SMScoringParams | null);
 }
+/**
+ * Class representing an exercise in an assessment.
+ */
 export declare class SMAssessmentExercise extends SMExercise {
+    /**
+     * @param {string | null} prettyName - Name of the exercise.
+     * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+     * @param {string | null} videoInstruction - Video instruction URL.
+     * @param {string | null} exerciseIntro - URL for exercise intro sound.
+     * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+     * @param {string} detector - Name of the detector for tracking exercise movement.
+     * @param {string | null} exerciseClosure - URL for exercise closer sound.
+     * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+     * @param {string | null} summaryTitle - Title for the exercise summary.
+     * @param {string | null} summarySubTitle - Subtitle for the exercise summary.
+     * @param {string | null} summaryMainMetricTitle - Main metric title in the summary.
+     * @param {string | null} summaryMainMetricSubTitle - Main metric subtitle in the summary.
+     */
     summaryTitle: string | null;
     summarySubTitle: string | null;
     summaryMainMetricTitle: string | null;
     summaryMainMetricSubTitle: string | null;
     constructor(prettyName: string | null, totalSeconds: number | null, videoInstruction: string | null, exerciseIntro: string | null, uiElements: UIElement[] | null, detector: string, exerciseClosure: string | null, scoringParams: SMScoringParams | null, summaryTitle: string | null, summarySubTitle: string | null, summaryMainMetricTitle: string | null, summaryMainMetricSubTitle: string | null);
 }
+/**
+ * Class representing scoring parameters for an exercise.
+ */
 export declare class SMScoringParams {
+    /**
+     * @param {ScoringType | null} type - Type of scoring (e.g., ROM, time, reps).
+     * @param {number | null} scoreFactor - Factor to adjust the score.
+     * @param {number | null} targetTime - Target time for time-based scoring.
+     * @param {number | null} targetReps - Target reps for rep-based scoring.
+     * @param {string | null} targetRom - Range of motion target for ROM-based scoring.
+     * @param {string[] | null} passCriteria - List of criteria required to pass.
+     */
     type: ScoringType | null;
     scoreFactor: number | null;
     targetTime: number | null;
@@ -71,7 +153,17 @@ export declare class SMScoringParams {
     passCriteria: string[] | null;
     constructor(type: ScoringType | null, scoreFactor: number | null, targetTime: number | null, targetReps: number | null, targetRom: string | null, passCriteria: string[] | null);
 }
+/**
+ * Class representing the configuration for a workout program.
+ */
 export declare class WorkoutConfig {
+    /**
+     * @param {number} week - Week number in the program.
+     * @param {BodyZone} bodyZone - Targeted body zone for the workout.
+     * @param {WorkoutDifficulty} difficultyLevel - Difficulty level of the workout.
+     * @param {WorkoutDuration} workoutDuration - Duration of the workout.
+     * @param {string} programID - Unique identifier for the workout program.
+     */
     week: number;
     bodyZone: BodyZone;
     difficultyLevel: WorkoutDifficulty;
@@ -80,7 +172,14 @@ export declare class WorkoutConfig {
     constructor(week: number, bodyZone: BodyZone, difficultyLevel: WorkoutDifficulty, workoutDuration: WorkoutDuration, programID: string);
     toJson(): string;
 }
+/**
+ * Class representing user data.
+ */
 export declare class UserData {
+    /**
+     * @param {Gender} gender - User's gender.
+     * @param {number} age - User's age.
+     */
     gender: Gender;
     age: number;
     constructor(gender: Gender, age: number);

package/lib/typescript/src/SMWorkout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SMWorkout.d.ts","sourceRoot":"","sources":["../../../src/SMWorkout.tsx"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED,oBAAY,SAAS;IACnB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,aAAa,kBAAkB;CAChC;AAED,oBAAY,QAAQ;IAClB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,oBAAY,iBAAiB;IAC3B,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;CAClC;AAED,oBAAY,eAAe;IACzB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,oBAAY,MAAM;IAChB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,mBAAmB;CACzB;AAED,qBAAa,SAAS;IACpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;gBAG5B,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,SAAS,EAAE,UAAU,EAAE,EACvB,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,cAAc,EAAE,MAAM,GAAG,IAAI;IAY/B,MAAM,IAAI,MAAM;CAYjB;AAED,qBAAa,UAAU;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,eAAe,GAAG,IAAI,CAAC;gBAGpC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAC9B,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,aAAa,EAAE,eAAe,GAAG,IAAI;CAWxC;AAED,qBAAa,oBAAqB,SAAQ,UAAU;IAClD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGvC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAC9B,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,aAAa,EAAE,eAAe,GAAG,IAAI,EACrC,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,sBAAsB,EAAE,MAAM,GAAG,IAAI,EACrC,yBAAyB,EAAE,MAAM,GAAG,IAAI;CAoB3C;AAED,qBAAa,eAAe;IAC1B,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAG5B,IAAI,EAAE,WAAW,GAAG,IAAI,EACxB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI;CAShC;AAED,qBAAa,aAAa;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,iBAAiB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;gBAGhB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,iBAAiB,EAClC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,MAAM;IASnB,MAAM,IAAI,MAAM;CASjB;AAED,qBAAa,QAAQ;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;gBAEA,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKvC,MAAM,IAAI,MAAM;CAMjB"}
+{"version":3,"file":"SMWorkout.d.ts","sourceRoot":"","sources":["../../../src/SMWorkout.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,aAAa,kBAAkB;CAChC;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;CAClC;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED;;;GAGG;AACH,oBAAY,MAAM;IAChB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,mBAAmB;CACzB;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB;;;;;;;;;OASG;IACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;gBAG5B,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,SAAS,EAAE,UAAU,EAAE,EACvB,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,cAAc,EAAE,MAAM,GAAG,IAAI;IAY/B,MAAM,IAAI,MAAM;CAYjB;AAED;;GAEG;AACH,qBAAa,UAAU;IACrB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,eAAe,GAAG,IAAI,CAAC;gBAGpC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAC9B,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,aAAa,EAAE,eAAe,GAAG,IAAI;CAWxC;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,UAAU;IAClD;;;;;;;;;;;;;OAaG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGvC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,EAC9B,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,aAAa,EAAE,eAAe,GAAG,IAAI,EACrC,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,sBAAsB,EAAE,MAAM,GAAG,IAAI,EACrC,yBAAyB,EAAE,MAAM,GAAG,IAAI;CAoB3C;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B;;;;;;;OAOG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAG5B,IAAI,EAAE,WAAW,GAAG,IAAI,EACxB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI;CAShC;AAGD;;GAEG;AACH,qBAAa,aAAa;IACxB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,iBAAiB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;gBAGhB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,iBAAiB,EAClC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,MAAM;IASnB,MAAM,IAAI,MAAM;CASjB;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;gBAEA,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKvC,MAAM,IAAI,MAAM;CAMjB"}

package/lib/typescript/src/index.d.ts

@@ -1,17 +1,52 @@
 import * as SMWorkoutLibrary from '../src/SMWorkout';
+/**
+ * This function will configure the sdk
+ * @param {string} key - your auth key
+ */
 export declare function configure(key: string): Promise<string>;
+/**
+ * start an assessment session.
+ *
+ * @param {SMWorkoutLibrary.AssessmentTypes} type - The type of assessment to start.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment session, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {string} customAssessmentID - A unique identifier for a custom assessment session.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating whether the assessment finished.
+ */
 export declare function startAssessment(type: SMWorkoutLibrary.AssessmentTypes, showSummary: boolean | undefined, userData: SMWorkoutLibrary.UserData | null, forceShowUserDataScreen: boolean | undefined, customAssessmentID: string): Promise<{
     summary: string;
     didFinish: boolean;
 }>;
+/**
+ * Starts a custom workout session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} workout - The custom workout configuration.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout session finished.
+ */
 export declare function startCustomWorkout(workout: SMWorkoutLibrary.SMWorkout): Promise<{
     summary: string;
     didFinish: boolean;
 }>;
+/**
+ * Initiates a custom assessment session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} assessment - The assessment configuration for the session.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the assessment finished.
+ */
 export declare function startCustomAssessment(assessment: SMWorkoutLibrary.SMWorkout, userData: SMWorkoutLibrary.UserData | null, forceShowUserDataScreen?: boolean, showSummary?: boolean): Promise<{
     summary: string;
     didFinish: boolean;
 }>;
+/**
+ * Starts a workout program using the provided workout configuration.
+ *
+ * @param {SMWorkoutLibrary.WorkoutConfig} workoutConfig - The configuration for the workout program.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout program finished.
+ */
 export declare function startWorkoutProgram(workoutConfig: SMWorkoutLibrary.WorkoutConfig): Promise<{
     summary: string;
     didFinish: boolean;

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AAmBrD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAEtD;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gBAAgB,CAAC,eAAe,EACtC,WAAW,qBAAgB,EAC3B,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,EAC1C,uBAAuB,qBAAiB,EACxC,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAQlD;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,gBAAgB,CAAC,SAAS,GAClC,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAElD;AAED,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,gBAAgB,CAAC,SAAS,EACtC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,EAC1C,uBAAuB,GAAE,OAAe,EACxC,WAAW,GAAE,OAAc,GAC1B,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAOlD;AAED,wBAAgB,mBAAmB,CAAC,aAAa,EAAC,gBAAgB,CAAC,aAAa,GAAG,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAC,OAAO,CAAA;CAAC,CAAC,CAE/H"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AAmBrD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAEtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gBAAgB,CAAC,eAAe,EACtC,WAAW,EAAE,OAAO,YAAO,EAC3B,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,EAC1C,uBAAuB,EAAE,OAAO,YAAQ,EACxC,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAQlD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,gBAAgB,CAAC,SAAS,GAClC,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAElD;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,gBAAgB,CAAC,SAAS,EACtC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,EAC1C,uBAAuB,GAAE,OAAe,EACxC,WAAW,GAAE,OAAc,GAC1B,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAOlD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,gBAAgB,CAAC,aAAa,GAC5C,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC,CAElD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sency/react-native-smkit-ui",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "react-native-smkit-ui",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",

package/src/SMWorkout.tsx

@@ -1,45 +1,86 @@
+/**
+ * Enum representing assessment types.
+ * @enum {string}
+ */
 export enum AssessmentTypes {
   Fitness = 'fitness',
   Custom = 'custom',
   Body360 = 'body360',
 }
 
+/**
+ * Enum representing UI elements that can be displayed during workouts.
+ * @enum {string}
+ */
 export enum UIElement {
   RepsCounter = 'repsCounter',
   Timer = 'timer',
   GaugeOfMotion = 'gaugeOfMotion',
 }
 
+/**
+ * Enum representing body zones targeted in workouts.
+ * @enum {string}
+ */
 export enum BodyZone {
   UpperBody = 'UpperBody',
   LowerBody = 'LowerBody',
   FullBody = 'FullBody',
 }
 
+/**
+ * Enum representing workout difficulty levels.
+ * @enum {string}
+ */
 export enum WorkoutDifficulty {
   LowDifficulty = 'LowDifficulty',
   MidDifficulty = 'MidDifficulty',
   HighDifficulty = 'HighDifficulty',
 }
 
+/**
+ * Enum representing workout durations.
+ * @enum {string}
+ */
 export enum WorkoutDuration {
   Short = 'Short',
   Long = 'Long',
 }
 
+/**
+ * Enum representing different types of scoring methods.
+ * @enum {string}
+ */
 export enum ScoringType {
   Rom = 'rom',
   Time = 'time',
   Reps = 'reps',
 }
 
+/**
+ * Enum representing gender options for user data.
+ * @enum {string}
+ */
 export enum Gender {
   Female = 'Female',
   Male = 'Male',
   Other = 'Rather not say',
 }
 
+/**
+ * Class representing a workout.
+ */
 export class SMWorkout {
+  /**
+   * @param {string | null} id - Unique identifier for the workout.
+   * @param {string | null} name - Name of the workout.
+   * @param {string | null} workoutIntro - URL for workout intro sound.
+   * @param {string | null} soundtrack - URL for soundtrack.
+   * @param {SMExercise[]} exercises - List of exercises included in the workout.
+   * @param {string | null} getInFrame - URL for body cal get in frame sound.
+   * @param {string | null} bodycalFinished - URL for body cal finished sound.
+   * @param {string | null} workoutClosure - URL for workout closure sound.
+   */
   id: string | null;
   name: string | null;
   workoutIntro: string | null;
@@ -83,7 +124,20 @@ export class SMWorkout {
   }
 }
 
+/**
+ * Class representing an exercise in a workout.
+ */
 export class SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   */
   detector: string;
   uiElements: UIElement[] | null;
   videoInstruction: string | null;
@@ -114,7 +168,24 @@ export class SMExercise {
   }
 }
 
+/**
+ * Class representing an exercise in an assessment.
+ */
 export class SMAssessmentExercise extends SMExercise {
+  /**
+   * @param {string | null} prettyName - Name of the exercise.
+   * @param {number | null} totalSeconds - Duration of the exercise in seconds.
+   * @param {string | null} videoInstruction - Video instruction URL.
+   * @param {string | null} exerciseIntro - URL for exercise intro sound.
+   * @param {UIElement[] | null} uiElements - List of UI elements for this exercise.
+   * @param {string} detector - Name of the detector for tracking exercise movement.
+   * @param {string | null} exerciseClosure - URL for exercise closer sound.
+   * @param {SMScoringParams | null} scoringParams - Parameters for exercise scoring.
+   * @param {string | null} summaryTitle - Title for the exercise summary.
+   * @param {string | null} summarySubTitle - Subtitle for the exercise summary.
+   * @param {string | null} summaryMainMetricTitle - Main metric title in the summary.
+   * @param {string | null} summaryMainMetricSubTitle - Main metric subtitle in the summary.
+   */
   summaryTitle: string | null;
   summarySubTitle: string | null;
   summaryMainMetricTitle: string | null;
@@ -154,7 +225,18 @@ export class SMAssessmentExercise extends SMExercise {
   }
 }
 
+/**
+ * Class representing scoring parameters for an exercise.
+ */
 export class SMScoringParams {
+  /**
+   * @param {ScoringType | null} type - Type of scoring (e.g., ROM, time, reps).
+   * @param {number | null} scoreFactor - Factor to adjust the score.
+   * @param {number | null} targetTime - Target time for time-based scoring.
+   * @param {number | null} targetReps - Target reps for rep-based scoring.
+   * @param {string | null} targetRom - Range of motion target for ROM-based scoring.
+   * @param {string[] | null} passCriteria - List of criteria required to pass.
+   */
   type: ScoringType | null;
   scoreFactor: number | null;
   targetTime: number | null;
@@ -179,7 +261,18 @@ export class SMScoringParams {
   }
 }
 
+
+/**
+ * Class representing the configuration for a workout program.
+ */
 export class WorkoutConfig {
+  /**
+   * @param {number} week - Week number in the program.
+   * @param {BodyZone} bodyZone - Targeted body zone for the workout.
+   * @param {WorkoutDifficulty} difficultyLevel - Difficulty level of the workout.
+   * @param {WorkoutDuration} workoutDuration - Duration of the workout.
+   * @param {string} programID - Unique identifier for the workout program.
+   */
   week: number;
   bodyZone: BodyZone;
   difficultyLevel: WorkoutDifficulty;
@@ -211,7 +304,14 @@ export class WorkoutConfig {
   }
 }
 
+/**
+ * Class representing user data.
+ */
 export class UserData {
+  /**
+   * @param {Gender} gender - User's gender.
+   * @param {number} age - User's age.
+   */
   gender: Gender;
   age: number;
 

package/src/index.tsx

@@ -18,10 +18,24 @@ const SMKitUIManager = NativeModules.SMKitUIManager
       }
     );
 
+/**
+ * This function will configure the sdk
+ * @param {string} key - your auth key
+ */
 export function configure(key: string): Promise<string> {
   return SMKitUIManager.configure(key);
 }
 
+/**
+ * start an assessment session.
+ *
+ * @param {SMWorkoutLibrary.AssessmentTypes} type - The type of assessment to start.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment session, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {string} customAssessmentID - A unique identifier for a custom assessment session.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating whether the assessment finished.
+ */
 export function startAssessment(
   type: SMWorkoutLibrary.AssessmentTypes,
   showSummary: boolean = true,
@@ -38,12 +52,27 @@ export function startAssessment(
   );
 }
 
+/**
+ * Starts a custom workout session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} workout - The custom workout configuration.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout session finished.
+ */
 export function startCustomWorkout(
   workout: SMWorkoutLibrary.SMWorkout
 ): Promise<{ summary: string; didFinish: boolean }> {
   return SMKitUIManager.startCustomWorkout(workout.toJson());
 }
 
+/**
+ * Initiates a custom assessment session.
+ *
+ * @param {SMWorkoutLibrary.SMWorkout} assessment - The assessment configuration for the session.
+ * @param {SMWorkoutLibrary.UserData | null} userData - User data for the assessment, or `null` if no user data is provided.
+ * @param {boolean} [forceShowUserDataScreen=false] - Forces the display of the user data screen even if user data is provided.
+ * @param {boolean} [showSummary=true] - Determines if the summary should be shown after assessment completion.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the assessment finished.
+ */
 export function startCustomAssessment(
   assessment: SMWorkoutLibrary.SMWorkout,
   userData: SMWorkoutLibrary.UserData | null,
@@ -58,6 +87,14 @@ export function startCustomAssessment(
   );
 }
 
-export function startWorkoutProgram(workoutConfig:SMWorkoutLibrary.WorkoutConfig): Promise<{summary: string, didFinish:boolean}>{
+/**
+ * Starts a workout program using the provided workout configuration.
+ *
+ * @param {SMWorkoutLibrary.WorkoutConfig} workoutConfig - The configuration for the workout program.
+ * @returns {Promise<{ summary: string; didFinish: boolean }>} - A promise that resolves with an object containing the summary and a flag indicating if the workout program finished.
+ */
+export function startWorkoutProgram(
+  workoutConfig: SMWorkoutLibrary.WorkoutConfig
+): Promise<{ summary: string; didFinish: boolean }> {
   return SMKitUIManager.startWorkoutProgram(workoutConfig.toJson());
 }