@monkvision/camera-web 4.0.0

package/lib/Camera/hooks/useCameraPreview.js

@@ -0,0 +1,57 @@
+"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.useCameraPreview = void 0;
+var monitoring_1 = require("@monkvision/monitoring");
+var react_1 = require("react");
+var common_1 = require("@monkvision/common");
+var utils_1 = require("./utils");
+var useUserMedia_1 = require("./useUserMedia");
+/**
+ * Custom hook used to initialize and handle the camera preview. It initializes the camera stream based on the given
+ * configuration, and provides a handle to manage the camera such as the ref to the video element etc.
+ */
+function useCameraPreview(config) {
+    var ref = (0, react_1.useRef)(null);
+    var windowDimensions = (0, common_1.useWindowDimensions)();
+    var handleError = (0, monitoring_1.useMonitoring)().handleError;
+    var userMediaResult = (0, useUserMedia_1.useUserMedia)((0, utils_1.getMediaConstraints)(config), ref);
+    var previewDimensions = (0, react_1.useMemo)(function () {
+        if (!windowDimensions || !userMediaResult.dimensions) {
+            return null;
+        }
+        var windowAspectRatio = windowDimensions.width / windowDimensions.height;
+        var streamAspectRatio = userMediaResult.dimensions.width / userMediaResult.dimensions.height;
+        return windowAspectRatio >= streamAspectRatio
+            ? {
+                width: windowDimensions.height * streamAspectRatio,
+                height: windowDimensions.height,
+            }
+            : {
+                width: windowDimensions.width,
+                height: windowDimensions.width / streamAspectRatio,
+            };
+    }, [windowDimensions, userMediaResult.dimensions]);
+    (0, react_1.useEffect)(function () {
+        if (userMediaResult.stream && ref.current) {
+            ref.current.srcObject = userMediaResult.stream;
+            ref.current.onloadedmetadata = function () {
+                var _a;
+                (_a = ref.current) === null || _a === void 0 ? void 0 : _a.play().catch(handleError);
+            };
+        }
+    }, [userMediaResult.stream]);
+    return (0, react_1.useMemo)(function () { return (__assign({ ref: ref, previewDimensions: previewDimensions }, userMediaResult)); }, [previewDimensions, userMediaResult]);
+}
+exports.useCameraPreview = useCameraPreview;
+//# sourceMappingURL=useCameraPreview.js.map

package/lib/Camera/hooks/useCameraPreview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCameraPreview.js","sourceRoot":"","sources":["../../../src/Camera/hooks/useCameraPreview.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,qDAAuD;AACvD,+BAA8D;AAE9D,6CAAyD;AACzD,iCAA4D;AAC5D,+CAA+D;AAgB/D;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,MAAoB;IACnD,IAAM,GAAG,GAAG,IAAA,cAAM,EAAmB,IAAI,CAAC,CAAC;IAC3C,IAAM,gBAAgB,GAAG,IAAA,4BAAmB,GAAE,CAAC;IACvC,IAAA,WAAW,GAAK,IAAA,0BAAa,GAAE,YAApB,CAAqB;IACxC,IAAM,eAAe,GAAG,IAAA,2BAAY,EAAC,IAAA,2BAAmB,EAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;IAEvE,IAAM,iBAAiB,GAAG,IAAA,eAAO,EAAC;QAChC,IAAI,CAAC,gBAAgB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACpD,OAAO,IAAI,CAAC;SACb;QACD,IAAM,iBAAiB,GAAG,gBAAgB,CAAC,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC;QAC3E,IAAM,iBAAiB,GAAG,eAAe,CAAC,UAAU,CAAC,KAAK,GAAG,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC;QAE/F,OAAO,iBAAiB,IAAI,iBAAiB;YAC3C,CAAC,CAAC;gBACE,KAAK,EAAE,gBAAgB,CAAC,MAAM,GAAG,iBAAiB;gBAClD,MAAM,EAAE,gBAAgB,CAAC,MAAM;aAChC;YACH,CAAC,CAAC;gBACE,KAAK,EAAE,gBAAgB,CAAC,KAAK;gBAC7B,MAAM,EAAE,gBAAgB,CAAC,KAAK,GAAG,iBAAiB;aACnD,CAAC;IACR,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;IAEnD,IAAA,iBAAS,EAAC;QACR,IAAI,eAAe,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;YACzC,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC;YAC/C,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG;;gBAC7B,MAAA,GAAG,CAAC,OAAO,0CAAE,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;YACzC,CAAC,CAAC;SACH;IACH,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7B,OAAO,IAAA,eAAO,EACZ,cAAM,OAAA,YACJ,GAAG,KAAA,EACH,iBAAiB,mBAAA,IACd,eAAe,EAClB,EAJI,CAIJ,EACF,CAAC,iBAAiB,EAAE,eAAe,CAAC,CACrC,CAAC;AACJ,CAAC;AAzCD,4CAyCC"}

package/lib/Camera/hooks/useCameraScreenshot.d.ts

@@ -0,0 +1,31 @@
+import { RefObject } from 'react';
+import { PixelDimensions } from '@monkvision/types';
+import { InternalCameraMonitoringConfig } from '../monitoring';
+/**
+ * Configuration parameters for the `useCameraScreenshot` hook.
+ */
+export interface CameraScreenshotConfig {
+    /**
+     * The ref to the video element to take screenshots of.
+     */
+    videoRef: RefObject<HTMLVideoElement>;
+    /**
+     * The ref to the canvas element used to draw the screenshots
+     */
+    canvasRef: RefObject<HTMLCanvasElement>;
+    /**
+     * The dimensions of the screenshot.
+     */
+    dimensions: PixelDimensions | null;
+}
+/**
+ * Callback used to take a screenshot.
+ *
+ * @return A ImageData object that contains the raw pixel's data.
+ */
+export type TakeScreenshotFunction = (monitoring: InternalCameraMonitoringConfig) => ImageData;
+/**
+ * Custom hook used to take screenshots of a video element. This hook is aimed to be used in pair with a `<canvas>`
+ * element referenced by the returned ref.
+ */
+export declare function useCameraScreenshot({ videoRef, canvasRef, dimensions, }: CameraScreenshotConfig): TakeScreenshotFunction;

package/lib/Camera/hooks/useCameraScreenshot.js

@@ -0,0 +1,66 @@
+"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.useCameraScreenshot = void 0;
+var react_1 = require("react");
+var monitoring_1 = require("@monkvision/monitoring");
+var monitoring_2 = require("../monitoring");
+var utils_1 = require("./utils");
+function startScreenshotMeasurement(monitoring, dimensions) {
+    var _a;
+    var _b, _c;
+    (_b = monitoring.transaction) === null || _b === void 0 ? void 0 : _b.startMeasurement(monitoring_2.ScreenshotMeasurement.operation, {
+        data: monitoring.data,
+        tags: __assign((_a = {}, _a[monitoring_2.ScreenshotMeasurement.outputResolutionTagName] = dimensions
+            ? "".concat(dimensions.width, "x").concat(dimensions.height)
+            : 'null', _a), ((_c = monitoring.tags) !== null && _c !== void 0 ? _c : {})),
+        description: monitoring_2.ScreenshotMeasurement.description,
+    });
+}
+function stopScreenshotMeasurement(monitoringConfig, status) {
+    var _a;
+    (_a = monitoringConfig.transaction) === null || _a === void 0 ? void 0 : _a.stopMeasurement(monitoring_2.ScreenshotMeasurement.operation, status);
+}
+function setScreeshotSizeMeasurement(monitoring, image) {
+    var _a;
+    var imageSizeBytes = image.data.length;
+    (_a = monitoring.transaction) === null || _a === void 0 ? void 0 : _a.setMeasurement(monitoring_2.ScreenshotSizeMeasurement.name, imageSizeBytes, 'byte');
+}
+/**
+ * Custom hook used to take screenshots of a video element. This hook is aimed to be used in pair with a `<canvas>`
+ * element referenced by the returned ref.
+ */
+function useCameraScreenshot(_a) {
+    var videoRef = _a.videoRef, canvasRef = _a.canvasRef, dimensions = _a.dimensions;
+    return (0, react_1.useCallback)(function (monitoring) {
+        startScreenshotMeasurement(monitoring, dimensions);
+        var context = (0, utils_1.getCanvasHandle)(canvasRef, function () {
+            return stopScreenshotMeasurement(monitoring, monitoring_1.TransactionStatus.UNKNOWN_ERROR);
+        }).context;
+        if (!dimensions) {
+            stopScreenshotMeasurement(monitoring, monitoring_1.TransactionStatus.UNKNOWN_ERROR);
+            throw new Error('Unable to take a picture because the video stream has no dimension.');
+        }
+        if (!videoRef.current) {
+            stopScreenshotMeasurement(monitoring, monitoring_1.TransactionStatus.UNKNOWN_ERROR);
+            throw new Error('Unable to take a picture because the video element is null.');
+        }
+        context.drawImage(videoRef.current, 0, 0, dimensions.width, dimensions.height);
+        var imageData = context.getImageData(0, 0, dimensions.width, dimensions.height);
+        setScreeshotSizeMeasurement(monitoring, imageData);
+        stopScreenshotMeasurement(monitoring, monitoring_1.TransactionStatus.OK);
+        return imageData;
+    }, [dimensions]);
+}
+exports.useCameraScreenshot = useCameraScreenshot;
+//# sourceMappingURL=useCameraScreenshot.js.map

package/lib/Camera/hooks/useCameraScreenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCameraScreenshot.js","sourceRoot":"","sources":["../../../src/Camera/hooks/useCameraScreenshot.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,+BAA+C;AAC/C,qDAA2D;AAE3D,4CAIuB;AACvB,iCAA0C;AA2B1C,SAAS,0BAA0B,CACjC,UAA0C,EAC1C,UAAkC;;;IAElC,MAAA,UAAU,CAAC,WAAW,0CAAE,gBAAgB,CAAC,kCAAqB,CAAC,SAAS,EAAE;QACxE,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,IAAI,wBACD,kCAAqB,CAAC,uBAAuB,IAAG,UAAU;YACzD,CAAC,CAAC,UAAG,UAAU,CAAC,KAAK,cAAI,UAAU,CAAC,MAAM,CAAE;YAC5C,CAAC,CAAC,MAAM,OACP,CAAC,MAAA,UAAU,CAAC,IAAI,mCAAI,EAAE,CAAC,CAC3B;QACD,WAAW,EAAE,kCAAqB,CAAC,WAAW;KAC/C,CAAC,CAAC;AACL,CAAC;AAED,SAAS,yBAAyB,CAChC,gBAAgD,EAChD,MAAyB;;IAEzB,MAAA,gBAAgB,CAAC,WAAW,0CAAE,eAAe,CAAC,kCAAqB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,2BAA2B,CAClC,UAA0C,EAC1C,KAAgB;;IAEhB,IAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;IACzC,MAAA,UAAU,CAAC,WAAW,0CAAE,cAAc,CAAC,sCAAyB,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;AACjG,CAAC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,EAIX;QAHvB,QAAQ,cAAA,EACR,SAAS,eAAA,EACT,UAAU,gBAAA;IAEV,OAAO,IAAA,mBAAW,EAChB,UAAC,UAA0C;QACzC,0BAA0B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC3C,IAAA,OAAO,GAAK,IAAA,uBAAe,EAAC,SAAS,EAAE;YAC7C,OAAA,yBAAyB,CAAC,UAAU,EAAE,8BAAiB,CAAC,aAAa,CAAC;QAAtE,CAAsE,CACvE,QAFc,CAEb;QACF,IAAI,CAAC,UAAU,EAAE;YACf,yBAAyB,CAAC,UAAU,EAAE,8BAAiB,CAAC,aAAa,CAAC,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACrB,yBAAyB,CAAC,UAAU,EAAE,8BAAiB,CAAC,aAAa,CAAC,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAChF;QACD,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/E,IAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAClF,2BAA2B,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACnD,yBAAyB,CAAC,UAAU,EAAE,8BAAiB,CAAC,EAAE,CAAC,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC,EACD,CAAC,UAAU,CAAC,CACb,CAAC;AACJ,CAAC;AA3BD,kDA2BC"}

package/lib/Camera/hooks/useCompression.d.ts

@@ -0,0 +1,24 @@
+import { CompressionOptions, MonkPicture } from '@monkvision/types';
+import { RefObject } from 'react';
+import { InternalCameraMonitoringConfig } from '../monitoring';
+/**
+ * Params given to the useCompression hooks.
+ */
+export interface UseCompressionParams {
+    /**
+     * The ref to the canvas element used to draw and compress the image.
+     */
+    canvasRef: RefObject<HTMLCanvasElement>;
+    /**
+     * The compression options.
+     */
+    options: CompressionOptions;
+}
+/**
+ * Function used to compress images and create DataURI objects.
+ */
+export type CompressFunction = (image: ImageData, monitoring: InternalCameraMonitoringConfig) => Promise<MonkPicture>;
+/**
+ * Custom hook used to manage the camera <canvas> element used to take video screenshots and encode images.
+ */
+export declare function useCompression({ canvasRef, options }: UseCompressionParams): CompressFunction;

package/lib/Camera/hooks/useCompression.js

@@ -0,0 +1,126 @@
+"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.useCompression = void 0;
+var monitoring_1 = require("@monkvision/monitoring");
+var react_1 = require("react");
+var monitoring_2 = require("../monitoring");
+var utils_1 = require("./utils");
+function startCompressionMeasurement(monitoring, options, image) {
+    var _a;
+    var _b, _c;
+    (_b = monitoring.transaction) === null || _b === void 0 ? void 0 : _b.startMeasurement(monitoring_2.CompressionMeasurement.operation, {
+        data: monitoring.data,
+        tags: __assign((_a = {}, _a[monitoring_2.CompressionMeasurement.formatTagName] = options.format, _a[monitoring_2.CompressionMeasurement.qualityTagName] = options.quality, _a[monitoring_2.CompressionMeasurement.dimensionsTagName] = "".concat(image.width, "x").concat(image.height), _a), ((_c = monitoring.tags) !== null && _c !== void 0 ? _c : {})),
+        description: monitoring_2.CompressionMeasurement.description,
+    });
+}
+function stopCompressionMeasurement(monitoring, status) {
+    var _a;
+    (_a = monitoring.transaction) === null || _a === void 0 ? void 0 : _a.stopMeasurement(monitoring_2.CompressionMeasurement.operation, status);
+}
+function setCustomMeasurements(monitoring, image, picture) {
+    var _a, _b;
+    var imageSizeBytes = image.data.length;
+    var pictureSizeBytes = picture.blob.size;
+    (_a = monitoring.transaction) === null || _a === void 0 ? void 0 : _a.setMeasurement(monitoring_2.CompressionSizeRatioMeasurement.name, pictureSizeBytes / imageSizeBytes, 'ratio');
+    (_b = monitoring.transaction) === null || _b === void 0 ? void 0 : _b.setMeasurement(monitoring_2.PictureSizeMeasurement.name, pictureSizeBytes, 'byte');
+}
+function compressUsingBrowser(image, canvasRef, options) {
+    var _a = (0, utils_1.getCanvasHandle)(canvasRef), canvas = _a.canvas, context = _a.context;
+    context.putImageData(image, 0, 0);
+    return new Promise(function (resolve, reject) {
+        canvas.toBlob(function (blob) {
+            if (!blob) {
+                reject(new Error('Unable to convert canvas to Blob, toBlob() returned null.'));
+            }
+            else {
+                resolve({
+                    blob: blob,
+                    uri: URL.createObjectURL(blob),
+                    mimetype: options.format,
+                    width: image.width,
+                    height: image.height,
+                });
+            }
+        }, options.format, options.quality);
+    });
+}
+/**
+ * Custom hook used to manage the camera <canvas> element used to take video screenshots and encode images.
+ */
+function useCompression(_a) {
+    var _this = this;
+    var canvasRef = _a.canvasRef, options = _a.options;
+    return (0, react_1.useCallback)(function (image, monitoring) { return __awaiter(_this, void 0, void 0, function () {
+        var picture, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    startCompressionMeasurement(monitoring, options, image);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, compressUsingBrowser(image, canvasRef, options)];
+                case 2:
+                    picture = _a.sent();
+                    setCustomMeasurements(monitoring, image, picture);
+                    stopCompressionMeasurement(monitoring, monitoring_1.TransactionStatus.OK);
+                    return [2 /*return*/, picture];
+                case 3:
+                    err_1 = _a.sent();
+                    stopCompressionMeasurement(monitoring, monitoring_1.TransactionStatus.UNKNOWN_ERROR);
+                    throw err_1;
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); }, [options.format, options.quality]);
+}
+exports.useCompression = useCompression;
+//# sourceMappingURL=useCompression.js.map

package/lib/Camera/hooks/useCompression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCompression.js","sourceRoot":"","sources":["../../../src/Camera/hooks/useCompression.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAA2D;AAE3D,+BAA+C;AAC/C,4CAKuB;AACvB,iCAA0C;AAwB1C,SAAS,2BAA2B,CAClC,UAA0C,EAC1C,OAA2B,EAC3B,KAAgB;;;IAEhB,MAAA,UAAU,CAAC,WAAW,0CAAE,gBAAgB,CAAC,mCAAsB,CAAC,SAAS,EAAE;QACzE,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,IAAI,wBACD,mCAAsB,CAAC,aAAa,IAAG,OAAO,CAAC,MAAM,KACrD,mCAAsB,CAAC,cAAc,IAAG,OAAO,CAAC,OAAO,KACvD,mCAAsB,CAAC,iBAAiB,IAAG,UAAG,KAAK,CAAC,KAAK,cAAI,KAAK,CAAC,MAAM,CAAE,OACzE,CAAC,MAAA,UAAU,CAAC,IAAI,mCAAI,EAAE,CAAC,CAC3B;QACD,WAAW,EAAE,mCAAsB,CAAC,WAAW;KAChD,CAAC,CAAC;AACL,CAAC;AAED,SAAS,0BAA0B,CACjC,UAA0C,EAC1C,MAAyB;;IAEzB,MAAA,UAAU,CAAC,WAAW,0CAAE,eAAe,CAAC,mCAAsB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,qBAAqB,CAC5B,UAA0C,EAC1C,KAAgB,EAChB,OAAoB;;IAEpB,IAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;IACzC,IAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAC3C,MAAA,UAAU,CAAC,WAAW,0CAAE,cAAc,CACpC,4CAA+B,CAAC,IAAI,EACpC,gBAAgB,GAAG,cAAc,EACjC,OAAO,CACR,CAAC;IACF,MAAA,UAAU,CAAC,WAAW,0CAAE,cAAc,CAAC,mCAAsB,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAChG,CAAC;AAED,SAAS,oBAAoB,CAC3B,KAAgB,EAChB,SAAuC,EACvC,OAA2B;IAErB,IAAA,KAAsB,IAAA,uBAAe,EAAC,SAAS,CAAC,EAA9C,MAAM,YAAA,EAAE,OAAO,aAA+B,CAAC;IACvD,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACjC,MAAM,CAAC,MAAM,CACX,UAAC,IAAI;YACH,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,CAAC,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC,CAAC;aAChF;iBAAM;gBACL,OAAO,CAAC;oBACN,IAAI,MAAA;oBACJ,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC;oBAC9B,QAAQ,EAAE,OAAO,CAAC,MAAM;oBACxB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,MAAM,EAAE,KAAK,CAAC,MAAM;iBACrB,CAAC,CAAC;aACJ;QACH,CAAC,EACD,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,OAAO,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,EAA4C;IAA3E,iBAgBC;QAhBgC,SAAS,eAAA,EAAE,OAAO,aAAA;IACjD,OAAO,IAAA,mBAAW,EAChB,UAAO,KAAgB,EAAE,UAA0C;;;;;oBACjE,2BAA2B,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;;;;oBAEtC,qBAAM,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,EAAA;;oBAA/D,OAAO,GAAG,SAAqD;oBACrE,qBAAqB,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;oBAClD,0BAA0B,CAAC,UAAU,EAAE,8BAAiB,CAAC,EAAE,CAAC,CAAC;oBAC7D,sBAAO,OAAO,EAAC;;;oBAEf,0BAA0B,CAAC,UAAU,EAAE,8BAAiB,CAAC,aAAa,CAAC,CAAC;oBACxE,MAAM,KAAG,CAAC;;;;SAEb,EACD,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAClC,CAAC;AACJ,CAAC;AAhBD,wCAgBC"}

package/lib/Camera/hooks/useTakePicture.d.ts

@@ -0,0 +1,32 @@
+import { MonkPicture } from '@monkvision/types';
+import { CameraMonitoringConfig, InternalCameraMonitoringConfig } from '../monitoring';
+import { CompressFunction } from './useCompression';
+import { UserMediaResult } from './useUserMedia';
+/**
+ * Type definition for the parameters of the useTakePicture hook.
+ */
+export interface UseTakePictureParams extends Pick<UserMediaResult, 'availableCameraDevices' | 'selectedCameraDeviceId'> {
+    /**
+     * Callback used to compress the screenshot taken by the takeScreenshot function.
+     */
+    compress: CompressFunction;
+    /**
+     * Callback used to take the screenshot of the camera video stream.
+     */
+    takeScreenshot: (monitoring: InternalCameraMonitoringConfig) => ImageData;
+    /**
+     * Event handler called when a picture has been taken.
+     */
+    onPictureTaken?: (picture: MonkPicture) => void;
+    /**
+     * The optional custom monitoring configuration that can be passed to the Camera component.
+     */
+    monitoring?: CameraMonitoringConfig;
+}
+/**
+ * Custom hook used by the Camera component to create the take picture function.
+ */
+export declare function useTakePicture({ compress, takeScreenshot, onPictureTaken, monitoring, availableCameraDevices, selectedCameraDeviceId, }: UseTakePictureParams): {
+    takePicture: () => Promise<MonkPicture>;
+    isLoading: boolean;
+};

package/lib/Camera/hooks/useTakePicture.js

@@ -0,0 +1,100 @@
+"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.useTakePicture = void 0;
+var monitoring_1 = require("@monkvision/monitoring");
+var common_1 = require("@monkvision/common");
+var react_1 = require("react");
+var monitoring_2 = require("../monitoring");
+function createTakePictureTransactionData(_a) {
+    var monitoring = _a.monitoring, availableCameraDevices = _a.availableCameraDevices, selectedCameraDeviceId = _a.selectedCameraDeviceId;
+    return __assign(__assign({}, monitoring === null || monitoring === void 0 ? void 0 : monitoring.data), { availableCameras: availableCameraDevices.map(function (deviceInfo) { return "".concat(deviceInfo.label, " (").concat(deviceInfo.deviceId, ")"); }), selectedCameraId: selectedCameraDeviceId });
+}
+/**
+ * Custom hook used by the Camera component to create the take picture function.
+ */
+function useTakePicture(_a) {
+    var _this = this;
+    var compress = _a.compress, takeScreenshot = _a.takeScreenshot, onPictureTaken = _a.onPictureTaken, monitoring = _a.monitoring, availableCameraDevices = _a.availableCameraDevices, selectedCameraDeviceId = _a.selectedCameraDeviceId;
+    var createTransaction = (0, monitoring_1.useMonitoring)().createTransaction;
+    var _b = (0, react_1.useState)(false), isLoading = _b[0], setIsLoading = _b[1];
+    var takePicture = (0, react_1.useCallback)(function () { return __awaiter(_this, void 0, void 0, function () {
+        var data, transaction, childMonitoring, screenshot, picture;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    setIsLoading(true);
+                    data = createTakePictureTransactionData({
+                        monitoring: monitoring,
+                        availableCameraDevices: availableCameraDevices,
+                        selectedCameraDeviceId: selectedCameraDeviceId,
+                    });
+                    transaction = createTransaction(__assign(__assign(__assign({}, monitoring_2.TakePictureTransaction), monitoring), { data: data }));
+                    childMonitoring = {
+                        transaction: transaction,
+                        data: monitoring === null || monitoring === void 0 ? void 0 : monitoring.data,
+                        tags: monitoring === null || monitoring === void 0 ? void 0 : monitoring.tags,
+                    };
+                    screenshot = takeScreenshot(childMonitoring);
+                    return [4 /*yield*/, compress(screenshot, childMonitoring)];
+                case 1:
+                    picture = _a.sent();
+                    transaction.finish();
+                    setIsLoading(false);
+                    if (onPictureTaken) {
+                        onPictureTaken(picture);
+                    }
+                    return [2 /*return*/, picture];
+            }
+        });
+    }); }, [createTransaction, monitoring, takeScreenshot, compress, onPictureTaken]);
+    return (0, common_1.useObjectMemo)({ takePicture: takePicture, isLoading: isLoading });
+}
+exports.useTakePicture = useTakePicture;
+//# sourceMappingURL=useTakePicture.js.map

package/lib/Camera/hooks/useTakePicture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTakePicture.js","sourceRoot":"","sources":["../../../src/Camera/hooks/useTakePicture.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAuD;AACvD,6CAAmD;AAEnD,+BAA8C;AAC9C,4CAIuB;AA2BvB,SAAS,gCAAgC,CAAC,EAOzC;QANC,UAAU,gBAAA,EACV,sBAAsB,4BAAA,EACtB,sBAAsB,4BAAA;IAKtB,6BACK,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,KACnB,gBAAgB,EAAE,sBAAsB,CAAC,GAAG,CAC1C,UAAC,UAAU,IAAK,OAAA,UAAG,UAAU,CAAC,KAAK,eAAK,UAAU,CAAC,QAAQ,MAAG,EAA9C,CAA8C,CAC/D,EACD,gBAAgB,EAAE,sBAAsB,IACxC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,EAOR;IAPvB,iBAmCC;QAlCC,QAAQ,cAAA,EACR,cAAc,oBAAA,EACd,cAAc,oBAAA,EACd,UAAU,gBAAA,EACV,sBAAsB,4BAAA,EACtB,sBAAsB,4BAAA;IAEd,IAAA,iBAAiB,GAAK,IAAA,0BAAa,GAAE,kBAApB,CAAqB;IACxC,IAAA,KAA4B,IAAA,gBAAQ,EAAC,KAAK,CAAC,EAA1C,SAAS,QAAA,EAAE,YAAY,QAAmB,CAAC;IAElD,IAAM,WAAW,GAAG,IAAA,mBAAW,EAAC;;;;;oBAC9B,YAAY,CAAC,IAAI,CAAC,CAAC;oBACb,IAAI,GAAG,gCAAgC,CAAC;wBAC5C,UAAU,YAAA;wBACV,sBAAsB,wBAAA;wBACtB,sBAAsB,wBAAA;qBACvB,CAAC,CAAC;oBACG,WAAW,GAAG,iBAAiB,gCAAM,mCAAsB,GAAK,UAAU,KAAE,IAAI,MAAA,IAAG,CAAC;oBACpF,eAAe,GAAmC;wBACtD,WAAW,aAAA;wBACX,IAAI,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI;wBACtB,IAAI,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI;qBACvB,CAAC;oBACI,UAAU,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;oBACnC,qBAAM,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,EAAA;;oBAArD,OAAO,GAAG,SAA2C;oBAC3D,WAAW,CAAC,MAAM,EAAE,CAAC;oBACrB,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,IAAI,cAAc,EAAE;wBAClB,cAAc,CAAC,OAAO,CAAC,CAAC;qBACzB;oBACD,sBAAO,OAAO,EAAC;;;SAChB,EAAE,CAAC,iBAAiB,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;IAE9E,OAAO,IAAA,sBAAa,EAAC,EAAE,WAAW,aAAA,EAAE,SAAS,WAAA,EAAE,CAAC,CAAC;AACnD,CAAC;AAnCD,wCAmCC"}

package/lib/Camera/hooks/useUserMedia.d.ts

@@ -0,0 +1,122 @@
+import { RefObject } from 'react';
+import { PixelDimensions } from '@monkvision/types';
+/**
+ * Enumeration of the different Native error names that can happen when a stream is invalid.
+ */
+export declare enum InvalidStreamErrorName {
+    /**
+     * The stream had no video track.
+     */
+    NO_VIDEO_TRACK = "NoVideoTrack",
+    /**
+     * The stream had too many video tracks (more than one).
+     */
+    TOO_MANY_VIDEO_TRACKS = "TooManyVideoTracks",
+    /**
+     * The stream's video track had no dimensions.
+     */
+    NO_DIMENSIONS = "NoDimensions"
+}
+/**
+ * The type of errors that the `useUserMedia` hook can return.
+ *
+ * @see useUserMedia
+ */
+export declare enum UserMediaErrorType {
+    /**
+     * The camera stream couldn't be fetched because the web page does not have the permissions to access the camera.
+     */
+    NOT_ALLOWED = "not_allowed",
+    /**
+     * The camera stream was successfully fetched, but it could be processed. This error can happen for the following
+     * reasons :
+     * - The stream did not contain any video track, or contained multiple ones.
+     * - The stream's video track did not have any width or height property defined.
+     */
+    INVALID_STREAM = "invalid_stream",
+    /**
+     * The camera stream was successfully fetched, but was made inactive for some unknown reason. Some known reasons that
+     * could be causing this error are :
+     * - The user revoked the camera access rights of the webpage while the stream was running.
+     * - On Safari, making a call to `navigator.mediaDevices.getUserMedia` will close all other existing streams on the
+     * web page. When using the Monk Camera package, you need to make sure that your app does not call `getUserMedia`
+     * while the camera stream is running. You can take a look at
+     * [this page](https://webrtchacks.com/guide-to-safari-webrtc/) for more reading about this behaviour.
+     */
+    STREAM_INACTIVE = "stream_inactive",
+    /**
+     * Any other error.
+     */
+    OTHER = "other"
+}
+/**
+ * Type definition for the error wrapper that the `useUserMedia` hook can return in case of error. See the
+ * `UserMediaErrorType` enum for details about the type of errors that can be catched.
+ *
+ * @see UserMediaErrorType
+ */
+export interface UserMediaError {
+    /**
+     * The type of error that occurred.
+     */
+    type: UserMediaErrorType;
+    /**
+     * The JavaScript `Error` object containing details about the error.
+     */
+    nativeError: Error | unknown;
+}
+/**
+ * Interface describing the result of the `useUserMedia` hook.
+ *
+ * @see useUserMedia
+ */
+export interface UserMediaResult {
+    /**
+     * The resulting video stream. The stream can be null when not initialized or in case of an error.
+     */
+    stream: MediaStream | null;
+    /**
+     * The dimensions of the resulting camera stream. Note that these dimensions can differ from the ones given in the
+     * stream constraints if they are not supported or available on the current device.
+     */
+    dimensions: PixelDimensions | null;
+    /**
+     * The error details. If no error has occurred, this object will be null.
+     */
+    error: UserMediaError | null;
+    /**
+     * A loading indicator. This field is `true` while the hook is currently fetching the stream or applying new
+     * constraints.
+     */
+    isLoading: boolean;
+    /**
+     * A function used to retry in case of error. If there has been no error, or if the stream is loading, this function
+     * will do nothing. In case of an error, this function resets the state and tries to fetch a camera stream again.
+     */
+    retry: () => void;
+    /**
+     * The list of all available camera devices on the user's phone.
+     */
+    availableCameraDevices: MediaDeviceInfo[];
+    /**
+     * The ID of the selected camera device for picture taking.
+     */
+    selectedCameraDeviceId: string | null;
+}
+/**
+ * React hook that wraps the `navigator.mediaDevices.getUserMedia` browser function in order to add React logic layers
+ * and utility tools :
+ * - Creates an effect for `getUserMedia` that will be run everytime some state parameters are updated.
+ * - Will call `track.applyConstraints` when the video contstraints are updated in order to update the video stream.
+ * - Makes sure that the `getUserMedia` is only called when it needs to be using memoized state.
+ * - Provides various utilities such as error catching, loading information and a retry on failure feature.
+ *
+ * @param constraints The same media constraints you would pass to the `getUserMedia` function. Note that this hook has
+ * been designed for video only, so audio constraints could provoke unexpected behaviour.
+ * @param videoRef The ref to the video element displaying the camera preview stream.
+ * @return The result of this hook contains the resulting video stream, an error object if there has been an error, a
+ * loading indicator and a retry function that tries to get a camera stream again. See the `UserMediaResult` interface
+ * for more information.
+ * @see UserMediaResult
+ */
+export declare function useUserMedia(constraints: MediaStreamConstraints, videoRef: RefObject<HTMLVideoElement>): UserMediaResult;