@monkvision/inspection-capture-web 4.2.5 → 4.2.6

package/README.md

@@ -67,6 +67,7 @@ export function MonkPhotoCapturePage({ authToken }) {
 | apiConfig                          | ApiConfig                                    | The api config used to communicate with the API. Make sure that the user described in the auth token is the same one as the one that created the inspection provided in the `inspectionId` prop. | ✔️       |                                              |
 | onClose                            | `() => void`                                 | Callback called when the user clicks on the Close button. If this callback is not provided, the button will not be displayed on the screen.                                                      |          |                                              |
 | onComplete                         | `() => void`                                 | Callback called when inspection capture is complete.                                                                                                                                             |          |                                              |
+| onPictureTaken                     | `(picture: MonkPicture) => void`             | Callback called when the user has taken a picture in the Capture process.                                                                                                                        |          |                                              |
 | lang                               | <code>string &#124; null</code>              | The language to be used by this component.                                                                                                                                                       |          | `'en'`                                       |
 | enforceOrientation                 | `DeviceOrientation`                          | Use this prop to enforce a specific device orientation for the Camera screen.                                                                                                                    |          |                                              |
 | maxUploadDurationWarning           | `number`                                     | Max upload duration in milliseconds before showing a bad connection warning to the user. Use `-1` to never display the warning.                                                                  |          | `15000`                                      |

package/lib/PhotoCapture/PhotoCapture.d.ts

@@ -1,6 +1,6 @@
 import { CameraProps } from '@monkvision/camera-web';
 import { MonkApiConfig } from '@monkvision/network';
-import { CameraConfig, CaptureAppConfig, ComplianceOptions, CompressionOptions, Sight } from '@monkvision/types';
+import { CameraConfig, CaptureAppConfig, ComplianceOptions, CompressionOptions, MonkPicture, Sight } from '@monkvision/types';
 import { PhotoCaptureHUDProps } from './PhotoCaptureHUD';
 /**
  * Props of the PhotoCapture component.
@@ -30,6 +30,10 @@ export interface PhotoCaptureProps extends Pick<CameraProps<PhotoCaptureHUDProps
      * Callback called when inspection capture is complete.
      */
     onComplete?: () => void;
+    /**
+     * Callback called when a picture has been taken by the user.
+     */
+    onPictureTaken?: (picture: MonkPicture) => void;
     /**
      * The language to be used by this component.
      *
@@ -41,4 +45,4 @@ export interface PhotoCaptureProps extends Pick<CameraProps<PhotoCaptureHUDProps
      */
     validateButtonLabel?: string;
 }
-export declare function PhotoCapture({ sights, inspectionId, apiConfig, additionalTasks, tasksBySight, startTasksOnComplete, onClose, onComplete, maxUploadDurationWarning, showCloseButton, enableCompliance, enableCompliancePerSight, complianceIssues, complianceIssuesPerSight, customComplianceThresholds, customComplianceThresholdsPerSight, useLiveCompliance, allowSkipRetake, enableAddDamage, sightGuidelines, enableTutorial, allowSkipTutorial, enableSightTutorial, enableSightGuidelines, useAdaptiveImageQuality, lang, enforceOrientation, validateButtonLabel, ...initialCameraConfig }: PhotoCaptureProps): JSX.Element;
+export declare function PhotoCapture({ sights, inspectionId, apiConfig, additionalTasks, tasksBySight, startTasksOnComplete, onClose, onComplete, onPictureTaken, maxUploadDurationWarning, showCloseButton, enableCompliance, enableCompliancePerSight, complianceIssues, complianceIssuesPerSight, customComplianceThresholds, customComplianceThresholdsPerSight, useLiveCompliance, allowSkipRetake, enableAddDamage, sightGuidelines, enableTutorial, allowSkipTutorial, enableSightTutorial, enableSightGuidelines, useAdaptiveImageQuality, lang, enforceOrientation, validateButtonLabel, ...initialCameraConfig }: PhotoCaptureProps): JSX.Element;

package/lib/PhotoCapture/PhotoCapture.js

@@ -42,7 +42,7 @@ var PhotoCaptureScreen;
 })(PhotoCaptureScreen || (PhotoCaptureScreen = {}));
 // No ts-doc for this component : the component exported is PhotoCaptureHOC
 function PhotoCapture(_a) {
-    var sights = _a.sights, inspectionId = _a.inspectionId, apiConfig = _a.apiConfig, additionalTasks = _a.additionalTasks, tasksBySight = _a.tasksBySight, _b = _a.startTasksOnComplete, startTasksOnComplete = _b === void 0 ? true : _b, onClose = _a.onClose, onComplete = _a.onComplete, _c = _a.maxUploadDurationWarning, maxUploadDurationWarning = _c === void 0 ? 15000 : _c, _d = _a.showCloseButton, showCloseButton = _d === void 0 ? false : _d, _e = _a.enableCompliance, enableCompliance = _e === void 0 ? true : _e, enableCompliancePerSight = _a.enableCompliancePerSight, complianceIssues = _a.complianceIssues, complianceIssuesPerSight = _a.complianceIssuesPerSight, customComplianceThresholds = _a.customComplianceThresholds, customComplianceThresholdsPerSight = _a.customComplianceThresholdsPerSight, _f = _a.useLiveCompliance, useLiveCompliance = _f === void 0 ? false : _f, _g = _a.allowSkipRetake, allowSkipRetake = _g === void 0 ? false : _g, _h = _a.enableAddDamage, enableAddDamage = _h === void 0 ? true : _h, sightGuidelines = _a.sightGuidelines, _j = _a.enableTutorial, enableTutorial = _j === void 0 ? types_1.PhotoCaptureTutorialOption.FIRST_TIME_ONLY : _j, _k = _a.allowSkipTutorial, allowSkipTutorial = _k === void 0 ? true : _k, _l = _a.enableSightTutorial, enableSightTutorial = _l === void 0 ? true : _l, _m = _a.enableSightGuidelines, enableSightGuidelines = _m === void 0 ? true : _m, _o = _a.useAdaptiveImageQuality, useAdaptiveImageQuality = _o === void 0 ? true : _o, lang = _a.lang, enforceOrientation = _a.enforceOrientation, validateButtonLabel = _a.validateButtonLabel, initialCameraConfig = __rest(_a, ["sights", "inspectionId", "apiConfig", "additionalTasks", "tasksBySight", "startTasksOnComplete", "onClose", "onComplete", "maxUploadDurationWarning", "showCloseButton", "enableCompliance", "enableCompliancePerSight", "complianceIssues", "complianceIssuesPerSight", "customComplianceThresholds", "customComplianceThresholdsPerSight", "useLiveCompliance", "allowSkipRetake", "enableAddDamage", "sightGuidelines", "enableTutorial", "allowSkipTutorial", "enableSightTutorial", "enableSightGuidelines", "useAdaptiveImageQuality", "lang", "enforceOrientation", "validateButtonLabel"]);
+    var sights = _a.sights, inspectionId = _a.inspectionId, apiConfig = _a.apiConfig, additionalTasks = _a.additionalTasks, tasksBySight = _a.tasksBySight, _b = _a.startTasksOnComplete, startTasksOnComplete = _b === void 0 ? true : _b, onClose = _a.onClose, onComplete = _a.onComplete, onPictureTaken = _a.onPictureTaken, _c = _a.maxUploadDurationWarning, maxUploadDurationWarning = _c === void 0 ? 15000 : _c, _d = _a.showCloseButton, showCloseButton = _d === void 0 ? false : _d, _e = _a.enableCompliance, enableCompliance = _e === void 0 ? true : _e, enableCompliancePerSight = _a.enableCompliancePerSight, complianceIssues = _a.complianceIssues, complianceIssuesPerSight = _a.complianceIssuesPerSight, customComplianceThresholds = _a.customComplianceThresholds, customComplianceThresholdsPerSight = _a.customComplianceThresholdsPerSight, _f = _a.useLiveCompliance, useLiveCompliance = _f === void 0 ? false : _f, _g = _a.allowSkipRetake, allowSkipRetake = _g === void 0 ? false : _g, _h = _a.enableAddDamage, enableAddDamage = _h === void 0 ? true : _h, sightGuidelines = _a.sightGuidelines, _j = _a.enableTutorial, enableTutorial = _j === void 0 ? types_1.PhotoCaptureTutorialOption.FIRST_TIME_ONLY : _j, _k = _a.allowSkipTutorial, allowSkipTutorial = _k === void 0 ? true : _k, _l = _a.enableSightTutorial, enableSightTutorial = _l === void 0 ? true : _l, _m = _a.enableSightGuidelines, enableSightGuidelines = _m === void 0 ? true : _m, _o = _a.useAdaptiveImageQuality, useAdaptiveImageQuality = _o === void 0 ? true : _o, lang = _a.lang, enforceOrientation = _a.enforceOrientation, validateButtonLabel = _a.validateButtonLabel, initialCameraConfig = __rest(_a, ["sights", "inspectionId", "apiConfig", "additionalTasks", "tasksBySight", "startTasksOnComplete", "onClose", "onComplete", "onPictureTaken", "maxUploadDurationWarning", "showCloseButton", "enableCompliance", "enableCompliancePerSight", "complianceIssues", "complianceIssuesPerSight", "customComplianceThresholds", "customComplianceThresholdsPerSight", "useLiveCompliance", "allowSkipRetake", "enableAddDamage", "sightGuidelines", "enableTutorial", "allowSkipTutorial", "enableSightTutorial", "enableSightGuidelines", "useAdaptiveImageQuality", "lang", "enforceOrientation", "validateButtonLabel"]);
     (0, common_1.useI18nSync)(lang);
     var complianceOptions = (0, common_1.useObjectMemo)({
         enableCompliance: enableCompliance,
@@ -107,6 +107,7 @@ function PhotoCapture(_a) {
         addDamageHandle: addDamageHandle,
         uploadQueue: uploadQueue,
         tasksBySight: tasksBySight,
+        onPictureTaken: onPictureTaken,
     });
     var handleOpenGallery = function () {
         setCurrentScreen(PhotoCaptureScreen.GALLERY);

package/lib/PhotoCapture/hooks/usePictureTaken.d.ts

@@ -24,6 +24,10 @@ export interface UseTakePictureParams {
      * will be used.
      */
     tasksBySight?: Record<string, TaskName[]>;
+    /**
+     * User defined callback that can be called when a picture has been taken in the PhotoCapture process.
+     */
+    onPictureTaken?: (picture: MonkPicture) => void;
 }
 /**
  * Callback called when the user has taken a picture.
@@ -32,4 +36,4 @@ export type HandleTakePictureFunction = (picture: MonkPicture) => void;
 /**
  * Custom hook used to generate the callback called when the user has taken a picture to handle picture upload etc.
  */
-export declare function usePictureTaken({ sightState, addDamageHandle, uploadQueue, tasksBySight, }: UseTakePictureParams): HandleTakePictureFunction;
+export declare function usePictureTaken({ sightState, addDamageHandle, uploadQueue, tasksBySight, onPictureTaken, }: UseTakePictureParams): HandleTakePictureFunction;

package/lib/PhotoCapture/hooks/usePictureTaken.js

@@ -8,10 +8,11 @@ var useAddDamageMode_1 = require("./useAddDamageMode");
  * Custom hook used to generate the callback called when the user has taken a picture to handle picture upload etc.
  */
 function usePictureTaken(_a) {
-    var sightState = _a.sightState, addDamageHandle = _a.addDamageHandle, uploadQueue = _a.uploadQueue, tasksBySight = _a.tasksBySight;
+    var sightState = _a.sightState, addDamageHandle = _a.addDamageHandle, uploadQueue = _a.uploadQueue, tasksBySight = _a.tasksBySight, onPictureTaken = _a.onPictureTaken;
     var trackEvent = (0, analytics_1.useAnalytics)().trackEvent;
     return (0, react_1.useCallback)(function (picture) {
         var _a;
+        onPictureTaken === null || onPictureTaken === void 0 ? void 0 : onPictureTaken(picture);
         sightState.setLastPictureTakenUri(picture.uri);
         var upload = addDamageHandle.mode === useAddDamageMode_1.PhotoCaptureMode.SIGHT
             ? {
@@ -39,6 +40,7 @@ function usePictureTaken(_a) {
         uploadQueue.push,
         sightState.takeSelectedSight,
         addDamageHandle.updatePhotoCaptureModeAfterPictureTaken,
+        onPictureTaken,
     ]);
 }
 exports.usePictureTaken = usePictureTaken;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/inspection-capture-web",
-  "version": "4.2.5",
+  "version": "4.2.6",
   "license": "BSD-3-Clause-Clear",
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs inspection capture package for React (web) used to implement the Monk inspection capture workflow",
@@ -28,12 +28,12 @@
     "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
   },
   "dependencies": {
-    "@monkvision/analytics": "4.2.5",
-    "@monkvision/camera-web": "4.2.5",
-    "@monkvision/common": "4.2.5",
-    "@monkvision/common-ui-web": "4.2.5",
-    "@monkvision/network": "4.2.5",
-    "@monkvision/sights": "4.2.5",
+    "@monkvision/analytics": "4.2.6",
+    "@monkvision/camera-web": "4.2.6",
+    "@monkvision/common": "4.2.6",
+    "@monkvision/common-ui-web": "4.2.6",
+    "@monkvision/network": "4.2.6",
+    "@monkvision/sights": "4.2.6",
     "i18next": "^23.4.5",
     "react-i18next": "^13.2.0"
   },
@@ -44,13 +44,13 @@
     "react-router-dom": "^6.22.3"
   },
   "devDependencies": {
-    "@monkvision/eslint-config-base": "4.2.5",
-    "@monkvision/eslint-config-typescript": "4.2.5",
-    "@monkvision/eslint-config-typescript-react": "4.2.5",
-    "@monkvision/jest-config": "4.2.5",
-    "@monkvision/prettier-config": "4.2.5",
-    "@monkvision/test-utils": "4.2.5",
-    "@monkvision/typescript-config": "4.2.5",
+    "@monkvision/eslint-config-base": "4.2.6",
+    "@monkvision/eslint-config-typescript": "4.2.6",
+    "@monkvision/eslint-config-typescript-react": "4.2.6",
+    "@monkvision/jest-config": "4.2.6",
+    "@monkvision/prettier-config": "4.2.6",
+    "@monkvision/test-utils": "4.2.6",
+    "@monkvision/typescript-config": "4.2.6",
     "@testing-library/react": "^12.1.5",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/copyfiles": "^2",
@@ -93,5 +93,5 @@
     "url": "https://github.com/monkvision/monkjs/issues"
   },
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "707896a1d1442de97c52985a00d2e8a590935d71"
+  "gitHead": "0f60c8e33e04a582b60cb0a664ae9b3160c84a51"
 }