@sency/react-native-smkit-ui 0.2.0 → 0.2.2

package/src/SMWorkout.tsx

@@ -1,39 +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;
@@ -77,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;
@@ -108,7 +168,75 @@ 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;
+  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
+  ) {
+    // Call the constructor of the parent class (SMExercise)
+    super(
+      prettyName,
+      totalSeconds,
+      videoInstruction,
+      exerciseIntro,
+      uiElements,
+      detector,
+      exerciseClosure,
+      scoringParams
+    );
+
+    // Set additional properties specific to SMAssessmentExercise
+    this.summaryTitle = summaryTitle || null;
+    this.summarySubTitle = summarySubTitle || null;
+    this.summaryMainMetricTitle = summaryMainMetricTitle || null;
+    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.
+   */
   type: ScoringType | null;
   scoreFactor: number | null;
   targetTime: number | null;
@@ -133,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;
@@ -164,3 +303,27 @@ 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;
+
+  constructor(gender: Gender, age: number) {
+    this.gender = gender;
+    this.age = age;
+  }
+
+  toJson(): string {
+    return JSON.stringify({
+      gender: this.gender,
+      age: this.age,
+    });
+  }
+}

package/src/index.tsx

@@ -18,26 +18,83 @@ 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,
+  showSummary: boolean = true,
+  userData: SMWorkoutLibrary.UserData | null,
+  forceShowUserDataScreen: boolean = false,
   customAssessmentID: string
 ): Promise<{ summary: string; didFinish: boolean }> {
-  return SMKitUIManager.startAssessment(type, showSummary, customAssessmentID);
+  return SMKitUIManager.startAssessment(
+    type,
+    showSummary,
+    userData?.toJson(),
+    forceShowUserDataScreen,
+    customAssessmentID
+  );
 }
 
-export function startCustomWorkout(workout:SMWorkoutLibrary.SMWorkout): 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 function startCustomWorkout(
+  workout: SMWorkoutLibrary.SMWorkout
+): Promise<{ summary: string; didFinish: boolean }> {
   return SMKitUIManager.startCustomWorkout(workout.toJson());
 }
 
-export function startCustomAssessment(assessment:SMWorkoutLibrary.SMWorkout): Promise<{summary: string, didFinish:boolean}>{
-  return SMKitUIManager.startCustomAssessment(assessment.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,
+  forceShowUserDataScreen: boolean = false,
+  showSummary: boolean = true
+): Promise<{ summary: string; didFinish: boolean }> {
+  return SMKitUIManager.startCustomAssessment(
+    assessment.toJson(),
+    userData?.toJson(),
+    forceShowUserDataScreen,
+    showSummary
+  );
 }
 
-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());
 }