@monkvision/inspection-capture-web 4.5.6 → 4.6.0

package/lib/VideoCapture/VideoCaptureHOC.js

@@ -0,0 +1,45 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VideoCaptureHOC = void 0;
+var jsx_runtime_1 = require("react/jsx-runtime");
+var common_1 = require("@monkvision/common");
+var i18n_1 = require("../i18n");
+var VideoCapture_1 = require("./VideoCapture");
+/**
+ * The VideoCapture component is a ready-to-use, single page component that implements a Camera app and lets the user
+ * record a video of their vehicle in order to add them to an already created Monk inspection. In order to use this
+ * component, you first need to generate an Auth0 authentication token, and create an inspection using the Monk Api.
+ * When creating the inspection, don't forget to set the tasks statuses to `NOT_STARTED`. This component will handle the
+ * starting of the tasks at the end of the capturing process. You can then pass the inspection ID, the api config (with
+ * the auth token) and everything will be handled automatically for you.
+ *
+ * @example
+ * import { VideoCapture } from '@monkvision/inspection-capture-web';
+ *
+ * export function VideoCaptureScreen({ inspectionId, apiConfig }: VideoCaptureScreenProps) {
+ *   const { i18n } = useTranslation();
+ *
+ *   return (
+ *     <VideoCapture
+ *       inspectionId={inspectionId}
+ *       apiConfig={apiConfig}
+ *       onComplete={() => { / * Navigate to another page * / }}
+ *       lang={i18n.language}
+ *     />
+ *   );
+ * }
+ */
+exports.VideoCaptureHOC = (0, common_1.i18nWrap)(function VideoCaptureHOC(props) {
+    return ((0, jsx_runtime_1.jsx)(common_1.MonkProvider, { children: (0, jsx_runtime_1.jsx)(VideoCapture_1.VideoCapture, __assign({}, props)) }));
+}, i18n_1.i18nInspectionCaptureWeb);

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureHUD.d.ts

@@ -0,0 +1,44 @@
+import { Dispatch, SetStateAction } from 'react';
+import { CameraHUDProps } from '@monkvision/camera-web';
+import { MonkApiConfig } from '@monkvision/network';
+import { LoadingState } from '@monkvision/common';
+import { DeviceRotation, VideoCaptureAppConfig } from '@monkvision/types';
+import { FastMovementsDetectionHandle, UseVideoRecordingParams } from '../hooks';
+/**
+ * Props accepted by the VideoCaptureHUD component.
+ */
+export interface VideoCaptureHUDProps extends CameraHUDProps, Pick<UseVideoRecordingParams, 'minRecordingDuration'>, Pick<VideoCaptureAppConfig, 'enforceOrientation'>, Pick<DeviceRotation, 'alpha'>, Pick<FastMovementsDetectionHandle, 'fastMovementsWarning' | 'onWarningDismiss'> {
+    /**
+     * The ID of the inspection to add the video frames to.
+     */
+    inspectionId: string;
+    /**
+     * 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.
+     */
+    apiConfig: MonkApiConfig;
+    /**
+     * The maximum number of retries for failed image uploads.
+     */
+    maxRetryCount: number;
+    /**
+     * Boolean indicating if the video is currently recording or not.
+     */
+    isRecording: boolean;
+    /**
+     * Callback called when setting the `isRecording` state.
+     */
+    setIsRecording: Dispatch<SetStateAction<boolean>>;
+    /**
+     * The loading state for the start task feature.
+     */
+    startTasksLoading: LoadingState;
+    /**
+     * Callback called when the inspection capture is complete.
+     */
+    onComplete?: () => void;
+}
+/**
+ * HUD component displayed on top of the camera preview for the VideoCapture process.
+ */
+export declare function VideoCaptureHUD({ handle, cameraPreview, inspectionId, apiConfig, isRecording, setIsRecording, enforceOrientation, alpha, fastMovementsWarning, onWarningDismiss, maxRetryCount, minRecordingDuration, startTasksLoading, onComplete, }: VideoCaptureHUDProps): JSX.Element;

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureHUD.js

@@ -0,0 +1,158 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VideoCaptureHUD = void 0;
+var jsx_runtime_1 = require("react/jsx-runtime");
+var react_1 = require("react");
+var common_ui_web_1 = require("@monkvision/common-ui-web");
+var react_i18next_1 = require("react-i18next");
+var network_1 = require("@monkvision/network");
+var monitoring_1 = require("@monkvision/monitoring");
+var VideoCaptureHUD_styles_1 = require("./VideoCaptureHUD.styles");
+var VideoCaptureTutorial_1 = require("./VideoCaptureTutorial");
+var VideoCaptureRecording_1 = require("./VideoCaptureRecording");
+var hooks_1 = require("../hooks");
+var VideoCaptureProcessing_1 = require("../VideoCaptureProcessing");
+var components_1 = require("../../components");
+var SCREENSHOT_INTERVAL_MS = 200;
+var FRAME_SELECTION_INTERVAL_MS = 1000;
+var VideoCaptureHUDScreen;
+(function (VideoCaptureHUDScreen) {
+    VideoCaptureHUDScreen["TUTORIAL"] = "tutorial";
+    VideoCaptureHUDScreen["RECORDING"] = "recording";
+    VideoCaptureHUDScreen["PROCESSING"] = "processing";
+})(VideoCaptureHUDScreen || (VideoCaptureHUDScreen = {}));
+function getFastMovementsWarningMessage(type) {
+    switch (type) {
+        case hooks_1.FastMovementType.WALKING_TOO_FAST:
+            return 'video.recording.fastMovementsDialog.walkingTooFast';
+        case hooks_1.FastMovementType.PHONE_SHAKING:
+            return 'video.recording.fastMovementsDialog.phoneShaking';
+        default:
+            return '';
+    }
+}
+function getTooltipLabel(tooltip) {
+    switch (tooltip) {
+        case hooks_1.VideoRecordingTooltip.START:
+            return 'video.recording.tooltip.start';
+        case hooks_1.VideoRecordingTooltip.END:
+            return 'video.recording.tooltip.end';
+        default:
+            return undefined;
+    }
+}
+/**
+ * HUD component displayed on top of the camera preview for the VideoCapture process.
+ */
+function VideoCaptureHUD(_a) {
+    var _this = this;
+    var handle = _a.handle, cameraPreview = _a.cameraPreview, inspectionId = _a.inspectionId, apiConfig = _a.apiConfig, isRecording = _a.isRecording, setIsRecording = _a.setIsRecording, enforceOrientation = _a.enforceOrientation, alpha = _a.alpha, fastMovementsWarning = _a.fastMovementsWarning, onWarningDismiss = _a.onWarningDismiss, maxRetryCount = _a.maxRetryCount, minRecordingDuration = _a.minRecordingDuration, startTasksLoading = _a.startTasksLoading, onComplete = _a.onComplete;
+    var _b = (0, react_1.useState)(VideoCaptureHUDScreen.TUTORIAL), screen = _b[0], setScreen = _b[1];
+    var t = (0, react_i18next_1.useTranslation)().t;
+    var handleError = (0, monitoring_1.useMonitoring)().handleError;
+    var _c = (0, hooks_1.useVehicleWalkaround)({ alpha: alpha }), walkaroundPosition = _c.walkaroundPosition, startWalkaround = _c.startWalkaround;
+    var addImage = (0, network_1.useMonkApi)(apiConfig).addImage;
+    var _d = (0, hooks_1.useVideoUploadQueue)({
+        apiConfig: apiConfig,
+        inspectionId: inspectionId,
+        maxRetryCount: maxRetryCount,
+    }), uploadedFrames = _d.uploadedFrames, totalUploadingFrames = _d.totalUploadingFrames, onFrameSelected = _d.onFrameSelected;
+    var _e = (0, hooks_1.useFrameSelection)({
+        handle: handle,
+        frameSelectionInterval: FRAME_SELECTION_INTERVAL_MS,
+        onFrameSelected: onFrameSelected,
+    }), processedFrames = _e.processedFrames, totalProcessingFrames = _e.totalProcessingFrames, onCaptureVideoFrame = _e.onCaptureVideoFrame;
+    var _f = (0, hooks_1.useVideoRecording)({
+        isRecording: isRecording,
+        setIsRecording: setIsRecording,
+        screenshotInterval: SCREENSHOT_INTERVAL_MS,
+        minRecordingDuration: minRecordingDuration,
+        enforceOrientation: enforceOrientation,
+        walkaroundPosition: walkaroundPosition,
+        startWalkaround: startWalkaround,
+        onCaptureVideoFrame: onCaptureVideoFrame,
+        onRecordingComplete: function () { return setScreen(VideoCaptureHUDScreen.PROCESSING); },
+    }), isRecordingPaused = _f.isRecordingPaused, onClickRecordVideo = _f.onClickRecordVideo, onDiscardDialogKeepRecording = _f.onDiscardDialogKeepRecording, onDiscardDialogDiscardVideo = _f.onDiscardDialogDiscardVideo, isDiscardDialogDisplayed = _f.isDiscardDialogDisplayed, recordingDurationMs = _f.recordingDurationMs, pauseRecording = _f.pauseRecording, resumeRecording = _f.resumeRecording, tooltip = _f.tooltip;
+    var handleTakePictureClick = function () { return __awaiter(_this, void 0, void 0, function () {
+        var picture, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 3, , 4]);
+                    return [4 /*yield*/, handle.takePicture()];
+                case 1:
+                    picture = _a.sent();
+                    return [4 /*yield*/, addImage({
+                            uploadType: network_1.ImageUploadType.VIDEO_MANUAL_PHOTO,
+                            inspectionId: inspectionId,
+                            picture: picture,
+                        })];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    handleError(err_1);
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); };
+    (0, react_1.useEffect)(function () {
+        if (fastMovementsWarning) {
+            pauseRecording();
+        }
+        else {
+            resumeRecording();
+        }
+    }, [fastMovementsWarning, pauseRecording, resumeRecording]);
+    return ((0, jsx_runtime_1.jsxs)("div", __assign({ style: VideoCaptureHUD_styles_1.styles['container'] }, { children: [cameraPreview, (0, jsx_runtime_1.jsxs)("div", __assign({ style: VideoCaptureHUD_styles_1.styles['hudContainer'] }, { children: [screen === VideoCaptureHUDScreen.TUTORIAL && ((0, jsx_runtime_1.jsx)(VideoCaptureTutorial_1.VideoCaptureTutorial, { onClose: function () { return setScreen(VideoCaptureHUDScreen.RECORDING); } })), screen === VideoCaptureHUDScreen.RECORDING && ((0, jsx_runtime_1.jsx)(VideoCaptureRecording_1.VideoCaptureRecording, { walkaroundPosition: isRecording || isRecordingPaused ? walkaroundPosition : 0, isRecording: isRecording, isRecordingPaused: isRecordingPaused, recordingDurationMs: recordingDurationMs, onClickRecordVideo: onClickRecordVideo, onClickTakePicture: handleTakePictureClick, tooltip: t(getTooltipLabel(tooltip)) })), screen === VideoCaptureHUDScreen.PROCESSING && ((0, jsx_runtime_1.jsx)(VideoCaptureProcessing_1.VideoCaptureProcessing, { inspectionId: inspectionId, processedFrames: processedFrames, totalProcessingFrames: totalProcessingFrames, uploadedFrames: uploadedFrames, totalUploadingFrames: totalUploadingFrames, loading: startTasksLoading, onComplete: onComplete }))] })), (0, jsx_runtime_1.jsx)(common_ui_web_1.BackdropDialog, { show: isDiscardDialogDisplayed, message: t('video.recording.discardDialog.message'), confirmLabel: t('video.recording.discardDialog.keepRecording'), cancelLabel: t('video.recording.discardDialog.discardVideo'), onConfirm: onDiscardDialogKeepRecording, onCancel: onDiscardDialogDiscardVideo }), (0, jsx_runtime_1.jsx)(common_ui_web_1.BackdropDialog, { show: fastMovementsWarning !== null, message: t(getFastMovementsWarningMessage(fastMovementsWarning)), confirmLabel: t('video.recording.fastMovementsDialog.confirm'), onConfirm: onWarningDismiss, showCancelButton: false, dialogIcon: 'warning-outline', dialogIconPrimaryColor: 'caution' }), (0, jsx_runtime_1.jsx)(components_1.OrientationEnforcer, { orientation: enforceOrientation })] })));
+}
+exports.VideoCaptureHUD = VideoCaptureHUD;

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureHUD.styles.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.styles = void 0;
+exports.styles = {
+    container: {
+        width: '100%',
+        height: '100%',
+        position: 'relative',
+    },
+    hudContainer: {
+        position: 'absolute',
+        inset: '0 0 0 0',
+    },
+};

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureRecording/VideoCaptureRecording.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { VideoCaptureRecordingProps } from './VideoCaptureRecording.types';
+/**
+ * HUD used in recording mode displayed on top of the camera in the VideoCaputre process.
+ */
+export declare function VideoCaptureRecording({ walkaroundPosition, isRecording, isRecordingPaused, recordingDurationMs, onClickRecordVideo, onClickTakePicture, tooltip, }: VideoCaptureRecordingProps): JSX.Element;

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureRecording/VideoCaptureRecording.js

@@ -0,0 +1,38 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VideoCaptureRecording = void 0;
+var jsx_runtime_1 = require("react/jsx-runtime");
+var common_ui_web_1 = require("@monkvision/common-ui-web");
+var VideoCaptureRecordingStyles_1 = require("./VideoCaptureRecordingStyles");
+function formatRecordingDuration(durationMs) {
+    var totalSeconds = Math.floor(durationMs / 1000);
+    var totalMinutes = Math.floor(totalSeconds / 60);
+    var remainingSeconds = totalSeconds % 60;
+    return "".concat(totalMinutes.toString().padStart(2, '0'), ":").concat(remainingSeconds
+        .toString()
+        .padStart(2, '0'));
+}
+/**
+ * HUD used in recording mode displayed on top of the camera in the VideoCaputre process.
+ */
+function VideoCaptureRecording(_a) {
+    var walkaroundPosition = _a.walkaroundPosition, isRecording = _a.isRecording, isRecordingPaused = _a.isRecordingPaused, recordingDurationMs = _a.recordingDurationMs, onClickRecordVideo = _a.onClickRecordVideo, onClickTakePicture = _a.onClickTakePicture, tooltip = _a.tooltip;
+    var _b = (0, VideoCaptureRecordingStyles_1.useVideoCaptureRecordingStyles)({ isRecording: isRecording }), container = _b.container, indicators = _b.indicators, recordingDuration = _b.recordingDuration, controls = _b.controls, takePictureFlash = _b.takePictureFlash, walkaroundIndicator = _b.walkaroundIndicator, showTakePictureFlash = _b.showTakePictureFlash, tooltipPosition = _b.tooltipPosition;
+    var handleTakePictureClick = function () {
+        showTakePictureFlash();
+        onClickTakePicture === null || onClickTakePicture === void 0 ? void 0 : onClickTakePicture();
+    };
+    return ((0, jsx_runtime_1.jsxs)("div", __assign({ style: container }, { children: [(0, jsx_runtime_1.jsx)("div", __assign({ style: indicators }, { children: (isRecording || isRecordingPaused) && ((0, jsx_runtime_1.jsx)("div", __assign({ style: recordingDuration }, { children: formatRecordingDuration(recordingDurationMs) }))) })), (0, jsx_runtime_1.jsxs)("div", __assign({ style: controls }, { children: [(0, jsx_runtime_1.jsx)("div", __assign({ style: walkaroundIndicator, "data-testid": 'walkaround-indicator-container' }, { children: (0, jsx_runtime_1.jsx)(common_ui_web_1.VehicleWalkaroundIndicator, { alpha: walkaroundPosition }) })), (0, jsx_runtime_1.jsx)(common_ui_web_1.RecordVideoButton, { isRecording: isRecording, onClick: onClickRecordVideo, tooltip: tooltip, tooltipPosition: tooltipPosition }), (0, jsx_runtime_1.jsx)(common_ui_web_1.TakePictureButton, { onClick: handleTakePictureClick, disabled: !isRecording })] })), (0, jsx_runtime_1.jsx)("div", { style: takePictureFlash })] })));
+}
+exports.VideoCaptureRecording = VideoCaptureRecording;

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureRecording/VideoCaptureRecording.types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Props accepted by the VideoCaptureRecording component.
+ */
+export interface VideoCaptureRecordingProps {
+    /**
+     * The rotation of the user aroundn the vehicle in deg.
+     */
+    walkaroundPosition: number;
+    /**
+     * Boolean indicating if the video is currently recording or not.
+     */
+    isRecording: boolean;
+    /**
+     * Boolean indicating if the video recording is paused or not.
+     */
+    isRecordingPaused: boolean;
+    /**
+     * The total duration (in milliseconds) of the current video recording.
+     */
+    recordingDurationMs: number;
+    /**
+     * Callback called when the user clicks on the record video button.
+     */
+    onClickRecordVideo?: () => void;
+    /**
+     * Callback called when the user clicks on the take picture button.
+     */
+    onClickTakePicture?: () => void;
+    /**
+     * The tooltip to display on top of the recording button.
+     */
+    tooltip?: string;
+}

package/lib/VideoCapture/VideoCaptureHUD/VideoCaptureRecording/VideoCaptureRecording.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });