Merge pull request #375 from monkvision/feature/custom-drivably-events

feat: Added custom events for Drivably

Author: souyahia-monk

packages/camera/src/components/Capture/capture.js

@@ -93,6 +93,8 @@ const Capture = forwardRef(({
   onWarningMessage,
   onReady,
   onRetakeAll,
+  onRetakeNeeded,
+  onSkipRetake,
   onStartUploadPicture,
   onFinishUploadPicture,
   orientationBlockerProps,
@@ -331,6 +333,8 @@ const Capture = forwardRef(({
           onComplianceCheckFinish={onComplianceCheckFinish}
           onComplianceCheckStart={onComplianceCheckStart}
           onRetakeAll={onRetakeAll}
+          onSkipRetake={onSkipRetake}
+          onRetakeNeeded={onRetakeNeeded}
           task={task}
           mapTasksToSights={mapTasksToSights}
           inspectionId={inspectionId}
@@ -479,8 +483,10 @@ Capture.propTypes = {
   onPictureUploaded: PropTypes.func,
   onReady: PropTypes.func,
   onRetakeAll: PropTypes.func,
+  onRetakeNeeded: PropTypes.func,
   onSettingsChange: PropTypes.func,
   onSightsChange: PropTypes.func,
+  onSkipRetake: PropTypes.func,
   onStartUploadPicture: PropTypes.func,
   onUploadsChange: PropTypes.func,
   onWarningMessage: PropTypes.func,
@@ -575,6 +581,7 @@ Capture.defaultProps = {
   onComplianceChange: () => {},
   onSettingsChange: () => {},
   onSightsChange: () => {},
+  onSkipRetake: () => {},
   onUploadsChange: () => {},
   onComplianceCheckFinish: () => {},
   onComplianceCheckStart: () => {},
@@ -583,6 +590,7 @@ Capture.defaultProps = {
   onReady: () => {},
   onStartUploadPicture: () => {},
   onRetakeAll: () => {},
+  onRetakeNeeded: () => {},
   orientationBlockerProps: null,
   primaryColor: '#FFF',
   resolutionOptions: undefined,

packages/camera/src/components/UploadCenter/index.js

@@ -61,6 +61,8 @@ export default function UploadCenter({
   onComplianceCheckFinish,
   onComplianceCheckStart,
   onRetakeAll,
+  onRetakeNeeded,
+  onSkipRetake,
   checkComplianceAsync,
   inspectionId,
   task,
@@ -125,6 +127,37 @@ export default function UploadCenter({
     onComplianceCheckStart();
   }, [onComplianceCheckStart]);
 
+  const statEventsData = useMemo(() => ({
+    retakesNeeded: ids.length,
+    compliances: Object.entries(compliance.state)
+      .filter(([key]) => ids.includes(key))
+      .map(([, value]) => ({
+        sightId: value?.id,
+        error: value?.error,
+        result: {
+          coverage360: {
+            isCompliant: value?.result?.data?.compliances?.coverage_360?.is_compliant,
+            reasons: value?.result?.data?.compliances?.coverage_360?.reasons,
+            status: value?.result?.data?.compliances?.coverage_360?.status,
+          },
+          image_quality_assessment: {
+            isCompliant: value?.result?.data?.compliances?.image_quality_assessment?.is_compliant,
+            reasons: value?.result?.data?.compliances?.image_quality_assessment?.reasons,
+            status: value?.result?.data?.compliances?.image_quality_assessment?.status,
+          },
+          zoom_level: {
+            isCompliant: value?.result?.data?.compliances?.zoom_level?.is_compliant,
+            reasons: value?.result?.data?.compliances?.zoom_level?.reasons,
+            status: value?.result?.data?.compliances?.zoom_level?.status,
+          },
+        },
+      })),
+  }), [ids, compliance.state]);
+
+  useEffect(() => {
+    onRetakeNeeded(statEventsData);
+  }, [ids.length, onRetakeNeeded]);
+
   // END EFFECTS //
   // RENDERING //
 
@@ -204,6 +237,7 @@ export default function UploadCenter({
           color={colors.actions.secondary}
           onPress={(e) => {
             log(['[Click] Skip retaking photo']);
+            onSkipRetake(statEventsData);
             onComplianceCheckFinish(e);
           }}
           disabled={isSubmitting || hasAllRejected
@@ -266,6 +300,8 @@ UploadCenter.propTypes = {
   onComplianceCheckFinish: PropTypes.func,
   onComplianceCheckStart: PropTypes.func,
   onRetakeAll: PropTypes.func,
+  onRetakeNeeded: PropTypes.func,
+  onSkipRetake: PropTypes.func,
   Sentry: PropTypes.any,
   sights: PropTypes.objectOf(PropTypes.any).isRequired,
   task: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
@@ -277,6 +313,8 @@ UploadCenter.defaultProps = {
   onComplianceCheckStart: () => {},
   checkComplianceAsync: () => {},
   onRetakeAll: () => {},
+  onRetakeNeeded: () => {},
+  onSkipRetake: () => {},
   inspectionId: null,
   isSubmitting: false,
   mapTasksToSights: [],

src/screens/InspectionCapture/index.js

@@ -214,7 +214,6 @@ export default function InspectionCapture() {
         onComplianceCheckFinish={() => setSuccess(true)}
         colors={colors}
         Sentry={Sentry}
-
       />
       <Notice />
     </View>

website/docs/js/api/components/Capture.md

@@ -357,6 +357,44 @@ Will call a function when pressing `retakeAll` button inside the Upload Center (
 const handleRetakeAll = () => console.log('Retaking all...');
 ```
 
+## onRetakeNeeded and onSkipRetake
+`PropTypes.func`
+
+onRetakeNeeded : Will call a function when the number of pictures to be retaken changes inside the Upload Center (picture quality check screen).
+onSkipRetake : Will call a function when pressing the skip retake button inside the Upload Center (picture quality check screen).
+
+```js
+const onRetakeNeeded = (result) => console.log(result);
+const onSkipRetake = (result) => console.log(result);
+/**
+ * Result :
+ * {
+ *   retakesNeeded, // The number of pictures to be retaken
+ *   compliances: [{ // Array of compliance results
+ *     sightId, // The id of the picture sight
+ *     error, // The error if there is one
+ *     result: { // The result of the compliance check
+ *       coverage360: { // Compliance result for the car coverage check
+ *         isCompliant, // Is it compliant
+ *         reasons, // Array of reasons is it is not compliant
+ *         status, // Status of the compliance check
+ *       },
+ *       image_quality_assessment: { // Compliance result for the image quality check
+ *         isCompliant, // Is it compliant
+ *         reasons, // Array of reasons is it is not compliant
+ *         status, // Status of the compliance check
+ *       },
+ *       zoom_level: {  // Compliance result for the zoom level check
+ *         isCompliant, // Is it compliant
+ *         reasons, // Array of reasons is it is not compliant
+ *         status, // Status of the compliance check
+ *       },
+ *     },
+ *   }],
+ * }
+ */
+```
+
 ## onStartUploadPicture
 `PropTypes.func`