@sency/react-native-smkit-ui 2.2.0 → 2.2.2

package/src/SMWorkout.tsx

@@ -1,7 +1,35 @@
-/**
- * Enum representing assessment types.
- * @enum {string}
- */
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+type JsonObject = { [key: string]: JsonValue | undefined };
+
+function withoutUndefined(value: JsonObject): { [key: string]: JsonValue } {
+  return Object.entries(value).reduce<{ [key: string]: JsonValue }>((result, [key, item]) => {
+    if (item !== undefined) {
+      result[key] = item;
+    }
+    return result;
+  }, {});
+}
+
+function serializeGuidanceVideoSegments(
+  segments: Record<string, GuidanceVideoSegment | GuidanceVideoSegmentConfig> | undefined
+): JsonObject | undefined {
+  if (segments === undefined) {
+    return undefined;
+  }
+
+  return Object.entries(segments).reduce<JsonObject>((result, [key, segment]) => {
+    result[key] = segment instanceof GuidanceVideoSegment
+      ? segment.toJSON()
+      : withoutUndefined({
+        kind: segment.kind,
+        startSeconds: segment.startSeconds,
+        endSeconds: segment.endSeconds ?? undefined,
+      });
+    return result;
+  }, {});
+}
+
 export enum AssessmentTypes {
   Fitness = 'fitness',
   Custom = 'custom',
@@ -19,59 +47,39 @@ export enum PauseType {
   Switch = 'switchExercise',
 }
 
-/**
- * Enum representing UI elements that can be displayed during workouts.
- * @enum {string}
- */
 export enum UIElement {
   RepsCounter = 'repsCounter',
   Timer = 'timer',
   GaugeOfMotion = 'gaugeOfMotion',
+  Skeleton = 'skeleton',
+  HoldingPosition = 'holdingPosition',
+  CountdownTimer = 'countdownTimer',
+  QuickMotion = 'quickMotion',
 }
 
-/**
- * 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',
@@ -83,22 +91,49 @@ export enum Language {
   Hebrew = 'he',
 }
 
-/**
- * Enum representing the exercise rep counter prefrence.
- * @enum {string}
- */
 export enum CounterPreferences {
   Default = 'Default',
   PerfectOnly = 'PerfectOnly',
 }
 
-/**
- * Enum representing the workout couser type.
- * @enum {string}
- */
 export enum EndExercisePreferences {
-  Default = 'Default', //on timer end
-  TargetBased = 'TargetBased', //on target reached
+  Default = 'Default',
+  TargetBased = 'TargetBased',
+}
+
+export enum ColorTheme {
+  Blue = 'blue',
+  Green = 'green',
+  Purple = 'purple',
+  Orange = 'orange',
+  Silver = 'silver',
+  Gold = 'gold',
+  Pink = 'pink',
+}
+
+export enum PoseModelChoice {
+  AdaptiveChoice = 'AdaptiveChoice',
+  Prime = 'Prime',
+  Pro = 'Pro',
+  Lite = 'Lite',
+  UltraLite = 'UltraLite',
+  Basic = 'Basic',
+}
+
+export enum PhonePosition {
+  Floor = 'floor',
+  Elevated = 'elevated',
+}
+
+export enum RowingFeedbackLevel {
+  Expert = 'expert',
+  Advanced = 'advanced',
+  Beginner = 'beginner',
+}
+
+export enum GuidanceVideoSegmentKind {
+  Freeze = 'freeze',
+  Play = 'play',
 }
 
 export enum SkeletonPreset {
@@ -181,77 +216,108 @@ export class SkeletonConfig {
   animationDuration?: number;
 }
 
-/**
- * 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;
-  soundtrack: string | null;
-  exercises: SMExercise[];
-  getInFrame: string | null;
-  bodycalFinished: string | null;
-  workoutClosure: string | null;
+export type QuickMotionParams = {
+  validityWindow?: number;
+  checkInterval?: number;
+};
+
+export type GuidanceVideoSegmentConfig = {
+  kind: GuidanceVideoSegmentKind | 'freeze' | 'play';
+  startSeconds: number;
+  endSeconds?: number | null;
+};
+
+export class GuidanceVideoSegment {
+  kind: GuidanceVideoSegmentKind | 'freeze' | 'play';
+  startSeconds: number;
+  endSeconds: number | null;
 
   constructor(
-    id: string | null,
-    name: string | null,
-    workoutIntro: string | null,
-    soundtrack: string | null,
-    exercises: SMExercise[],
-    getInFrame: string | null,
-    bodycalFinished: string | null,
-    workoutClosure: string | null
+    kind: GuidanceVideoSegmentKind | 'freeze' | 'play',
+    startSeconds: number,
+    endSeconds: number | null = null
   ) {
-    this.id = id || null;
-    this.name = name || null;
-    this.workoutIntro = workoutIntro || null;
-    this.soundtrack = soundtrack || null;
-    this.exercises = exercises;
-    this.getInFrame = getInFrame || null;
-    this.bodycalFinished = bodycalFinished || null;
-    this.workoutClosure = workoutClosure || null;
+    this.kind = kind;
+    this.startSeconds = startSeconds;
+    this.endSeconds = endSeconds;
   }
 
-  toJson(): string {
-    return JSON.stringify({
-      id: this.id,
-      name: this.name,
-      workoutIntro: this.workoutIntro,
-      soundtrack: this.soundtrack,
-      exercises: this.exercises,
-      getInFrame: this.getInFrame,
-      bodycalFinished: this.bodycalFinished,
-      workoutClosure: this.workoutClosure,
+  static freeze(at: number): GuidanceVideoSegment {
+    return new GuidanceVideoSegment(GuidanceVideoSegmentKind.Freeze, at, at);
+  }
+
+  static play(from: number, to: number | null = null): GuidanceVideoSegment {
+    return new GuidanceVideoSegment(GuidanceVideoSegmentKind.Play, from, to);
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      kind: this.kind,
+      startSeconds: this.startSeconds,
+      endSeconds: this.endSeconds ?? undefined,
     });
   }
 }
 
-/**
- * Class representing an exercise in a workout.
- */
+export type StretchSetConfigOptions = {
+  enabled?: boolean;
+  restSecondsBetweenStretches?: number;
+  introSoundKey?: string | null;
+  positionDetectors?: string[] | null;
+};
+
+export class StretchSetConfig {
+  enabled: boolean;
+  repetitions: number;
+  secondsPerStretch: number;
+  restSecondsBetweenStretches: number;
+  introSoundKey: string | null;
+  positionDetectors: string[] | null;
+
+  constructor(
+    repetitions: number,
+    secondsPerStretch: number,
+    options: StretchSetConfigOptions = {}
+  ) {
+    this.enabled = options.enabled ?? true;
+    this.repetitions = repetitions;
+    this.secondsPerStretch = secondsPerStretch;
+    this.restSecondsBetweenStretches = options.restSecondsBetweenStretches ?? 3;
+    this.introSoundKey = options.introSoundKey ?? null;
+    this.positionDetectors = options.positionDetectors ?? null;
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      enabled: this.enabled,
+      repetitions: this.repetitions,
+      secondsPerStretch: this.secondsPerStretch,
+      restSecondsBetweenStretches: this.restSecondsBetweenStretches,
+      introSoundKey: this.introSoundKey,
+      positionDetectors: this.positionDetectors,
+    });
+  }
+}
+
+export type ExerciseOptions = {
+  shortIntro?: boolean;
+  quickMotionParams?: QuickMotionParams | null;
+  rowingFeedbackLevel?: RowingFeedbackLevel | number | null;
+  phonePosition?: PhonePosition | null;
+  guidanceMode?: boolean | null;
+  useWideAngleCamera?: boolean | null;
+  playPreExerciseCountdown?: boolean;
+  playRepMilestoneVoice?: boolean;
+  repMilestoneInterval?: number;
+  playSoundOnEachRep?: boolean;
+  adaptiveRomFeedbackEnabled?: boolean;
+  adaptiveRomWarmupReps?: number;
+  guidanceVideoSegments?: Record<string, GuidanceVideoSegment | GuidanceVideoSegmentConfig> | null;
+  stretchSetConfig?: StretchSetConfig | null;
+  side?: string | null;
+};
+
 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;
@@ -260,6 +326,7 @@ export class SMExercise {
   exerciseIntro: string | null;
   exerciseClosure: string | null;
   scoringParams: SMScoringParams | null;
+  options: ExerciseOptions;
 
   constructor(
     prettyName: string | null,
@@ -269,39 +336,55 @@ export class SMExercise {
     uiElements: UIElement[] | null,
     detector: string,
     exerciseClosure: string | null,
-    scoringParams: SMScoringParams | null
+    scoringParams: SMScoringParams | null,
+    options: ExerciseOptions = {}
   ) {
-    this.prettyName = prettyName || null;
-    this.totalSeconds = totalSeconds || null;
-    this.videoInstruction = videoInstruction || null;
-    this.exerciseIntro = exerciseIntro || null;
-    this.uiElements = uiElements || null;
+    this.prettyName = prettyName ?? null;
+    this.totalSeconds = totalSeconds ?? null;
+    this.videoInstruction = videoInstruction ?? null;
+    this.exerciseIntro = exerciseIntro ?? null;
+    this.uiElements = uiElements ?? null;
     this.detector = detector;
-    this.exerciseClosure = exerciseClosure || null;
-    this.scoringParams = scoringParams || null;
+    this.exerciseClosure = exerciseClosure ?? null;
+    this.scoringParams = scoringParams ?? null;
+    this.options = options;
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      name: this.prettyName,
+      prettyName: this.prettyName,
+      totalSeconds: this.totalSeconds,
+      videoInstruction: this.videoInstruction,
+      exerciseIntro: this.exerciseIntro,
+      uiElements: this.uiElements,
+      detector: this.detector,
+      exerciseClosure: this.exerciseClosure,
+      scoringParams: this.scoringParams?.toJSON() ?? null,
+      shortIntro: this.options.shortIntro,
+      quickMotionParams: this.options.quickMotionParams ?? undefined,
+      rowingFeedbackLevel: this.options.rowingFeedbackLevel ?? undefined,
+      phonePosition: this.options.phonePosition ?? undefined,
+      guidanceMode: this.options.guidanceMode ?? undefined,
+      useWideAngleCamera: this.options.useWideAngleCamera ?? undefined,
+      playPreExerciseCountdown: this.options.playPreExerciseCountdown,
+      playRepMilestoneVoice: this.options.playRepMilestoneVoice,
+      repMilestoneInterval: this.options.repMilestoneInterval,
+      playSoundOnEachRep: this.options.playSoundOnEachRep,
+      adaptiveRomFeedbackEnabled: this.options.adaptiveRomFeedbackEnabled,
+      adaptiveRomWarmupReps: this.options.adaptiveRomWarmupReps,
+      guidanceVideoSegments: this.options.guidanceVideoSegments === null
+        ? null
+        : serializeGuidanceVideoSegments(this.options.guidanceVideoSegments),
+      stretchSetConfig: this.options.stretchSetConfig?.toJSON() ?? (this.options.stretchSetConfig === null ? null : undefined),
+      side: this.options.side ?? undefined,
+    });
   }
 }
 
-/**
- * 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} closureFailedSound - Applicable only for ClouserTarget.TargetBased, URL for exercise closure sound If you did not reach clouser target.
-   * @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.
-   */
+export type AssessmentExerciseOptions = ExerciseOptions;
 
+export class SMAssessmentExercise extends SMExercise {
   closureFailedSound: string | null;
   summaryTitle: string | null;
   summarySubTitle: string | null;
@@ -321,9 +404,9 @@ export class SMAssessmentExercise extends SMExercise {
     summaryTitle: string | null,
     summarySubTitle: string | null,
     summaryMainMetricTitle: string | null,
-    summaryMainMetricSubTitle: string | null
+    summaryMainMetricSubTitle: string | null,
+    options: AssessmentExerciseOptions = {}
   ) {
-    // Call the constructor of the parent class (SMExercise)
     super(
       prettyName,
       totalSeconds,
@@ -332,30 +415,108 @@ export class SMAssessmentExercise extends SMExercise {
       uiElements,
       detector,
       exerciseClosure,
-      scoringParams
+      scoringParams,
+      options
     );
 
-    // Set additional properties specific to SMAssessmentExercise
-    this.closureFailedSound = closureFailedSound || null;
-    this.summaryTitle = summaryTitle || null;
-    this.summarySubTitle = summarySubTitle || null;
-    this.summaryMainMetricTitle = summaryMainMetricTitle || null;
-    this.summaryMainMetricSubTitle = summaryMainMetricSubTitle || null;
+    this.closureFailedSound = closureFailedSound ?? null;
+    this.summaryTitle = summaryTitle ?? null;
+    this.summarySubTitle = summarySubTitle ?? null;
+    this.summaryMainMetricTitle = summaryMainMetricTitle ?? null;
+    this.summaryMainMetricSubTitle = summaryMainMetricSubTitle ?? null;
+  }
+
+  override toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      ...super.toJSON(),
+      closureFailedSound: this.closureFailedSound,
+      summaryTitle: this.summaryTitle,
+      summarySubTitle: this.summarySubTitle,
+      summaryMainMetricTitle: this.summaryMainMetricTitle,
+      summaryMainMetricSubTitle: this.summaryMainMetricSubTitle,
+      summaryTitleMainMetric: this.summaryMainMetricTitle,
+      summarySubTitleMainMetric: this.summaryMainMetricSubTitle,
+    });
+  }
+}
+
+export class WorkoutContinuation {
+  introSoundKey: string | null;
+  interactionUnlockSoundKey: string;
+  exercises: SMExercise[];
+
+  constructor(
+    interactionUnlockSoundKey: string,
+    exercises: SMExercise[],
+    introSoundKey: string | null = null
+  ) {
+    this.introSoundKey = introSoundKey ?? null;
+    this.interactionUnlockSoundKey = interactionUnlockSoundKey;
+    this.exercises = exercises;
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      introSoundKey: this.introSoundKey,
+      interactionUnlockSoundKey: this.interactionUnlockSoundKey,
+      exercises: this.exercises.map((exercise) => exercise.toJSON()),
+    });
+  }
+}
+
+export class SMWorkout {
+  id: string | null;
+  name: string | null;
+  workoutIntro: string | null;
+  soundtrack: string | null;
+  exercises: SMExercise[];
+  getInFrame: string | null;
+  bodycalFinished: string | null;
+  workoutClosure: string | null;
+  continuation: WorkoutContinuation | null;
+
+  constructor(
+    id: string | null,
+    name: string | null,
+    workoutIntro: string | null,
+    soundtrack: string | null,
+    exercises: SMExercise[],
+    getInFrame: string | null,
+    bodycalFinished: string | null,
+    workoutClosure: string | null,
+    continuation: WorkoutContinuation | null = null
+  ) {
+    this.id = id ?? null;
+    this.name = name ?? null;
+    this.workoutIntro = workoutIntro ?? null;
+    this.soundtrack = soundtrack ?? null;
+    this.exercises = exercises;
+    this.getInFrame = getInFrame ?? null;
+    this.bodycalFinished = bodycalFinished ?? null;
+    this.workoutClosure = workoutClosure ?? null;
+    this.continuation = continuation ?? null;
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      id: this.id,
+      name: this.name,
+      workoutIntro: this.workoutIntro,
+      soundtrack: this.soundtrack,
+      exercises: this.exercises.map((exercise) => exercise.toJSON()),
+      getInFrame: this.getInFrame,
+      bodycalFinished: this.bodycalFinished,
+      workoutClosure: this.workoutClosure,
+      continuation: this.continuation?.toJSON() ?? (this.continuation === null ? null : undefined),
+    });
+  }
+
+  toJson(): string {
+    return JSON.stringify(this.toJSON());
   }
 }
 
-/**
- * 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;
@@ -371,33 +532,40 @@ export class SMScoringParams {
     targetRom: string | null,
     passCriteria: string[] | null
   ) {
-    this.type = type || null;
-    this.scoreFactor = scoreFactor || null;
-    this.targetTime = targetTime || null;
-    this.targetReps = targetReps || null;
-    this.targetRom = targetRom || null;
-    this.passCriteria = passCriteria || null;
+    this.type = type ?? null;
+    this.scoreFactor = scoreFactor ?? null;
+    this.targetTime = targetTime ?? null;
+    this.targetReps = targetReps ?? null;
+    this.targetRom = targetRom ?? null;
+    this.passCriteria = passCriteria ?? null;
+  }
+
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
+      type: this.type,
+      scoreFactor: this.scoreFactor,
+      targetTime: this.targetTime,
+      targetReps: this.targetReps,
+      targetRom: this.targetRom,
+      passCriteria: this.passCriteria,
+    });
   }
 }
 
-/**
- * Class representing the configuration for a workout program.
- */
+export type WorkoutConfigOptions = {
+  phonePosition?: PhonePosition;
+  shortIntro?: boolean;
+};
+
 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 {Language} language - The session language
-   * @param {string} programID - Unique identifier for the workout program.
-   */
   week: number;
   bodyZone: BodyZone;
   difficultyLevel: WorkoutDifficulty;
   workoutDuration: WorkoutDuration;
   language: Language;
   programID: string;
+  phonePosition: PhonePosition;
+  shortIntro: boolean;
 
   constructor(
     week: number,
@@ -405,7 +573,8 @@ export class WorkoutConfig {
     difficultyLevel: WorkoutDifficulty,
     workoutDuration: WorkoutDuration,
     language: Language,
-    programID: string
+    programID: string,
+    options: WorkoutConfigOptions = {}
   ) {
     this.week = week;
     this.bodyZone = bodyZone;
@@ -413,40 +582,48 @@ export class WorkoutConfig {
     this.workoutDuration = workoutDuration;
     this.language = language;
     this.programID = programID;
+    this.phonePosition = options.phonePosition ?? PhonePosition.Floor;
+    this.shortIntro = options.shortIntro ?? false;
   }
 
-  toJson(): string {
-    return JSON.stringify({
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
       week: this.week,
       bodyZone: this.bodyZone,
       difficultyLevel: this.difficultyLevel,
       workoutDuration: this.workoutDuration,
       language: this.language,
       programID: this.programID,
+      phonePosition: this.phonePosition,
+      shortIntro: this.shortIntro,
     });
   }
+
+  toJson(): string {
+    return JSON.stringify(this.toJSON());
+  }
 }
 
-/**
- * Class representing user data.
- */
 export class UserData {
-  /**
-   * @param {Gender} gender - User's gender.
-   * @param {number} age - User's age.
-   */
   gender: Gender;
   age: number;
+  email: string | null;
 
-  constructor(gender: Gender, age: number) {
+  constructor(gender: Gender, age: number, email: string | null = null) {
     this.gender = gender;
     this.age = age;
+    this.email = email ?? null;
   }
 
-  toJson(): string {
-    return JSON.stringify({
+  toJSON(): { [key: string]: JsonValue } {
+    return withoutUndefined({
       gender: this.gender,
       age: this.age,
+      email: this.email,
     });
   }
+
+  toJson(): string {
+    return JSON.stringify(this.toJSON());
+  }
 }