@sency/react-native-smkit-ui 0.1.0 → 0.1.1-snapshot-1

package/README.md

@@ -1,31 +1,201 @@
-# react-native-smkit-ui
+# [react-native-smkit-ui demo](https://github.com/sency-ai/smkit-sdk)
 
-smkit-ui-library
+1. [ Installation ](#inst)
+2. [ Setup ](#setup)
+3. [ Configure ](#conf)
+4. [ Start ](#start)
+5. [ Data ](#data)
 
-## Installation
+<a name="inst"></a>
+## 1. Installation
+1. run `npm install @sency/react-native-smkit-ui`
 
-```sh
-npm install smkit-ui-library
+2. Update *Podfile* in `iOS` folder:
 ```
+[1] add the source to the top of your Podfile.
+source 'https://bitbucket.org/sency-ios/sency_ios_sdk.git'
+source 'https://github.com/CocoaPods/Specs.git'
 
-## Usage
+[2] add use_frameworks! commend to your target
+target 'YOUR_TARGET' do
+  use_frameworks!
+```
+
+3. Run `NO_FLIPPER=1 pod install` to install the necessary pods.
+
+## 2. Setup <a name="setup"></a>
+
+### iOS
+Add camera permission request to `Info.plist`
+```Xml
+<key>NSCameraUsageDescription</key>
+<string>Camera access is needed</string>
+```
+
+### Android
+In order to integrate SMKitUI you need to import the smkitui dependency
+Add on project level build.gradle:
+ ```groovy
+allprojects {
+    maven {
+        url "https://artifacts.sency.ai/artifactory/release/"
+    }
+}
+```
+
+#### FBJNI
+
+Both React Native and SencyMotion use **fbjni**. For example, the versions for SMKitUI that are used for
+development are:
+
+React Native (<= 0.64) uses fbjni **0.0.2**
+SMKitUI uses fbjni **0.2.2**.
+Therefore we need to exclude fbjbi on app level build.gradle:
+ ```groovy
+dependencies {
+  ...
+  implementation('com.sency.smkitui:smkitui:$latest_version'){
+    exclude group: 'com.facebook.fbjni', module: 'fbjni-java-only'
+  }
+  ...
+}
+```
+
+## 3. Configure <a name="conf"></a>
 
 ```js
-import { multiply } from 'smkit-ui-library';
+[1] First import configure
+import { configure } from '@sency/react-native-smkit-ui-dev/src/index.tsx';
+
+[2] then call the configure function with your auth key
+try{
+  var res = await configure("YOUR_AUTH_KEY");
+ }catch (e) {
+  console.error(e);
+}
+```
+
+To reduce wait time we recommend to call `configure` on app launch.
 
-// ...
+**⚠️ smkit_ui_library will not work if you don't first call configure.**
 
-const result = await multiply(3, 7);
+## 4. Start <a name="start"></a>
+
+1. Import the sdk
+```js
+import { startAssessment, startCustomWorkout, AssessmentTypes } from '@sency/react-native-smkit-ui-dev/src/index.tsx';
+import SMKitUI from '@sency/react-native-smkit-ui-dev/src/SMKitUIView.tsx';
+import * as SMWorkoutLibrary from '@sency/react-native-smkit-ui-dev/src/SMWorkout.tsx';
 ```
 
-## Contributing
+2. Add `SMKitUI` view:
+```js
+return (
+  <View style={styles.centeredView}>
+    <SMKitUI/>
+  </View>
+);
+```
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+#### [Start Assessment](https://github.com/sency-ai/smkit-sdk/blob/main/AI-Fitness-Assessment.md)
+**startAssessment** starts one of Sency's blueprint assessments.
+```js
+async function startFitnessAssessment(){
+  try{
+    var result = await startAssessment(AssessmentTypes.Fitness);
+    console.log(result.summary);
+    console.log(result.didFinish);
+  }catch(e) {
+    console.error(e);
+  }
+}
+```
+> Check out [this info page](https://github.com/sency-ai/smkit-sdk/blob/main/AI-Fitness-Assessment.md) if you want to learn more about **Sency's AI Fitness Assessment**
+
+### Start Custom Workout
+**startWorkout** starts a custom workout.
+```js
+async function startSMKitUICustomWorkout(){
+  try{
+    // list of exercies
+    var exercises = [
+      new SMWorkoutLibrary.SMExercise(
+        name: "First Exercise", // => name:string | null
+        35,                     // => totalSeconds: number | null
+        5,                      // => introSeconds: number | null
+        null,                   // => videoInstruction: string | null (url for a video)
+        null,                   // => exerciseIntro: string | null (url for a sound)
+        [SMWorkoutLibrary.UIElement.RepsCounter, SMWorkoutLibrary.UIElement.Timer], // => uiElements: UIElement[] | null
+        "HighKnees", // => detector: string
+        true, // => repBased: boolean | null
+        null, // => exerciseClosure: string | null (url for a sound)
+        13, // => targetReps: number | null
+        20, // => targetTime: number | null
+        0.3 // => scoreFactor: number | null
+      ),
+      new SMWorkoutLibrary.SMExercise(
+        "Second Exercise", // => name:string | null
+        25, // => totalSeconds: number | null
+        5, // => introSeconds: number | null
+        null, // => videoInstruction: string | null (url for a video)
+        null, // => exerciseIntro: string | null (url for a sound)
+        [SMWorkoutLibrary.UIElement.GaugeOfMotion, SMWorkoutLibrary.UIElement.Timer], // => uiElements: UIElement[] | null
+        "SquatRegularOverheadStatic", // => detector: string
+        false, // => repBased: boolean | null
+        null, // => exerciseClosure: string | null (url for a sound)
+        null, // => targetReps: number | null
+        20, // => targetTime: number | null
+        0.3 // => scoreFactor: number | null
+      ),
+    ];
 
-## License
+    var workout = new SMWorkoutLibrary.SMWorkout(
+      "50", // => id: string | null
+      "demo workout",// => name: string | null
+      null, // => workoutIntro: string | null (url for a sound)
+      null, // => soundtrack: string | null (url for a sound)
+      exercises, // => exercises: SMExercise[]
+      null, // =>  getInFrame: string | null (url for a sound)
+      null, // =>  bodycalFinished: string | null (url for a sound)
+      null // =>  workoutClosure: string | null (url for a sound)
+      );
+    var result = await startCustomWorkout(workout);
+    console.log(result.summary);
+    console.log(result.didFinish);
+  }catch(e){
+    console.error(e);
+  }
+}
+```
 
-MIT
+### Start Program
+**startWorkoutProgram** starts a workout program according to your WorkoutConfig.
+```js
+  async function startSMKitUIProgram(){
+    try{
+      //WorkoutConfig
+      var config = new SMWorkoutLibrary.WorkoutConfig(
+        3, // => week: number
+        SMWorkoutLibrary.BodyZone.FullBody, // => bodyZone: BodyZone
+        SMWorkoutLibrary.WorkoutDifficulty.HighDifficulty, // => difficultyLevel: WorkoutDifficulty
+        SMWorkoutLibrary.WorkoutDuration.Short, // =>   workoutDuration: WorkoutDuration
+        "YOUR_PROGRAM_ID" // =>   programID: string
+      );
+      var result = await startWorkoutProgram(config);
+      console.log(result.summary);
+      console.log(result.didFinish);
+    }catch(e){
+      console.error(e);
+    }
+  }
+}
+```
 
----
+## Available Data Types <a name="data"></a>
+#### `AssessmentTypes`
+| Name                |
+|---------------------|
+| Fitness             |
+| Custom              |
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+Having issues? [Contact us](mailto:support@sency.ai) and let us know what the problem is.

package/android/build.gradle

@@ -92,7 +92,7 @@ dependencies {
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  implementation "com.sency.smkit:0.1.0"
+  compileOnly("com.sency.smkitui:smkitui:${SMKitUI_Version}")
 
   // Moshi JSON library
   def moshi = "1.15.0"

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

@@ -8,6 +8,7 @@ import com.facebook.react.bridge.ReactMethod
 import com.sency.smbase.core.listener.ConfigurationResult
 import com.sency.smkitui.SMKitUI
 import com.sency.smkitui.listener.SMKitUIWorkoutListener
+import com.sency.smkitui.model.ExerciseData
 import com.sency.smkitui.model.WorkoutSummaryData
 import com.smkituilibrary.mapper.toSMWorkout
 import com.smkituilibrary.mapper.toWorkoutConfig
@@ -25,7 +26,7 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
   private var resultPromise: Promise? = null
   private val moshi: Moshi by lazy { moshi() }
 
-  override fun getName(): String = "SmkitUiLibrary"
+  override fun getName(): String = "SMKitUIManager"
 
   override fun handleWorkoutErrors(error: Error) {
     resultPromise?.reject("Workout Exercise Error", error)
@@ -39,6 +40,10 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
     sendResult(summary, didFinish = false)
   }
 
+  override fun exerciseDidFinish(data: ExerciseData) {
+    println(data)
+  }
+
   @ReactMethod
   fun configure(key: String, promise: Promise) {
     smKitUI = SMKitUI.Configuration(reactApplicationContext)
@@ -84,7 +89,7 @@ class SmkitUiLibraryModule(reactContext: ReactApplicationContext) :
       val adapter = moshi.adapter(SMKitWorkoutConfig::class.java)
       val smKitWorkoutConfig = adapter.fromJson(jsonArguments) ?: return
 
-      smKitUI?.startWorkoutFromProgram(
+      smKitUI?.startWorkoutProgram(
         workoutConfig = smKitWorkoutConfig.toWorkoutConfig(),
         listener = this,
       )

package/ios/SMKitUIManager.swift

@@ -113,7 +113,7 @@ extension SMKitUIManager:SMKitUIWorkoutDelegate{
         }
         do{
             let result:[String:Any] = [
-                "summary": try data.json(),
+                "summary": try data.toStringJson(),
                 "didFinish": didFinish
             ]
             onWorkoutDidFinish(result)

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

@@ -1,3 +1,4 @@
-import * as React from 'react';
-export default function App(): React.JSX.Element;
+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

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../example/src/App.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,MAAM,CAAC,OAAO,UAAU,GAAG,sBAM1B"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../example/src/App.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAmB,MAAM,OAAO,CAAC;AAKxC,QAAA,MAAM,GAAG,yBAoIR,CAAA;AA4BD,eAAe,GAAG,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sency/react-native-smkit-ui",
-  "version": "0.1.0",
+  "version": "0.1.1-snapshot-1",
   "description": "react-native-smkit-ui",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -44,7 +44,7 @@
     "url": "git+https://sency-motion-sdk.document360.io.git"
   },
   "author": "Sency <Ofer.g@sency.ai> (https://github.com/sency-ai/smkit-ui-react-native-demo)",
-  "license": "Other",
+  "license": "SEE LICENSE IN LICENCE",
   "bugs": {
     "url": "contact@sency.ai"
   },

package/react-native-smkit-ui.podspec

@@ -15,7 +15,7 @@ Pod::Spec.new do |s|
   s.source       = { :git => "https://sency-motion-sdk.document360.io.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,mm,swift}"
-  s.dependency "SMKitUI" ,'0.1.4'
+  s.dependency "SMKitUI" ,'0.1.5'
 
   # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
   # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.