@monkvision/network 4.0.0

package/lib/src/api/hooks/useInspectionPoll.d.ts

@@ -0,0 +1,34 @@
+import { MonkState } from '@monkvision/common';
+import { ComplianceOptions } from '@monkvision/types';
+import { MonkApiConfig } from '../config';
+/**
+ * Parameters passed to the `useInspectionPoll` hook.
+ */
+export interface UseInspectionPollParams {
+    /**
+     * The ID of the inspection to fetch.
+     */
+    id: string;
+    /**
+     * The delay in milliseconds between each inspection fetch. Note that if the previous API call is still running, a new
+     * one won't be made. Set this value to `null` to stop the API calls.
+     */
+    delay: number | null;
+    /**
+     * The API config used to communicate with the API.
+     */
+    apiConfig: MonkApiConfig;
+    /**
+     * Callback called when the fetch inspection is successful.
+     */
+    onSuccess?: (state: MonkState) => void;
+    /**
+     * Additional options used to configure the compliance locally.
+     */
+    compliance?: ComplianceOptions;
+}
+/**
+ * Custom hook used to fetch an inspection every `delay` milliseconds using the `getInspection` API request. To stop the
+ * hook from making requests, simply pass a `null` vlaue for the `delay` param.
+ */
+export declare function useInspectionPoll({ id, delay, apiConfig, onSuccess, compliance, }: UseInspectionPollParams): void;

package/lib/src/api/hooks/useInspectionPoll.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInspectionPoll = void 0;
+var common_1 = require("@monkvision/common");
+var monitoring_1 = require("@monkvision/monitoring");
+var react_1 = require("../react");
+/**
+ * Custom hook used to fetch an inspection every `delay` milliseconds using the `getInspection` API request. To stop the
+ * hook from making requests, simply pass a `null` vlaue for the `delay` param.
+ */
+function useInspectionPoll(_a) {
+    var id = _a.id, delay = _a.delay, apiConfig = _a.apiConfig, onSuccess = _a.onSuccess, compliance = _a.compliance;
+    var getInspection = (0, react_1.useMonkApi)(apiConfig).getInspection;
+    var handleError = (0, monitoring_1.useMonitoring)().handleError;
+    (0, common_1.useAsyncInterval)(function () { return getInspection({ id: id, compliance: compliance }); }, delay, {
+        onResolve: function (res) { return onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(res.entities); },
+        onReject: handleError,
+    });
+}
+exports.useInspectionPoll = useInspectionPoll;
+//# sourceMappingURL=useInspectionPoll.js.map

package/lib/src/api/hooks/useInspectionPoll.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInspectionPoll.js","sourceRoot":"","sources":["../../../../src/api/hooks/useInspectionPoll.ts"],"names":[],"mappings":";;;AAAA,6CAAiE;AAEjE,qDAAuD;AAEvD,kCAAsC;AA6BtC;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,EAMR;QALxB,EAAE,QAAA,EACF,KAAK,WAAA,EACL,SAAS,eAAA,EACT,SAAS,eAAA,EACT,UAAU,gBAAA;IAEF,IAAA,aAAa,GAAK,IAAA,kBAAU,EAAC,SAAS,CAAC,cAA1B,CAA2B;IACxC,IAAA,WAAW,GAAK,IAAA,0BAAa,GAAE,YAApB,CAAqB;IAExC,IAAA,yBAAgB,EAAC,cAAM,OAAA,aAAa,CAAC,EAAE,EAAE,IAAA,EAAE,UAAU,YAAA,EAAE,CAAC,EAAjC,CAAiC,EAAE,KAAK,EAAE;QAC/D,SAAS,EAAE,UAAC,GAAG,IAAK,OAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,CAAC,QAAQ,CAAC,EAAzB,CAAyB;QAC7C,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;AACL,CAAC;AAdD,8CAcC"}

package/lib/src/api/image/index.d.ts

@@ -0,0 +1 @@
+export * from './requests';

package/lib/src/api/image/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);
+//# sourceMappingURL=index.js.map

package/lib/src/api/image/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/image/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B"}

package/lib/src/api/image/mappers.d.ts

@@ -0,0 +1,3 @@
+import { ComplianceOptions, Image } from '@monkvision/types';
+import { ApiImage } from '../models';
+export declare function mapApiImage(image: ApiImage, inspectionId: string, thumbnailDomain: string, complianceOptions?: ComplianceOptions): Image;

package/lib/src/api/image/mappers.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapApiImage = void 0;
+var types_1 = require("@monkvision/types");
+var utils_1 = require("../utils");
+var DEFAULT_COMPLIANCE_OPTIONS = {
+    enableCompliance: true,
+    complianceIssues: types_1.DEFAULT_COMPLIANCE_ISSUES,
+};
+function getActiveComplianceOptions(sightId, complianceOptions) {
+    var _a, _b, _c, _d;
+    var enableComplianceGlobal = (_a = complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.enableCompliance) !== null && _a !== void 0 ? _a : DEFAULT_COMPLIANCE_OPTIONS.enableCompliance;
+    var enableCompliance = sightId && (complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.enableCompliancePerSight)
+        ? complianceOptions.enableCompliancePerSight.includes(sightId)
+        : enableComplianceGlobal;
+    var complianceIssuesGlobal = (_b = complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.complianceIssues) !== null && _b !== void 0 ? _b : DEFAULT_COMPLIANCE_OPTIONS.complianceIssues;
+    var complianceIssues = sightId && ((_c = complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.complianceIssuesPerSight) === null || _c === void 0 ? void 0 : _c[sightId])
+        ? complianceOptions.complianceIssuesPerSight[sightId]
+        : complianceIssuesGlobal;
+    var customComplianceThresholds = sightId
+        ? (_d = complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.customComplianceThresholdsPerSight) === null || _d === void 0 ? void 0 : _d[sightId]
+        : complianceOptions === null || complianceOptions === void 0 ? void 0 : complianceOptions.customComplianceThresholds;
+    return { enableCompliance: enableCompliance, complianceIssues: complianceIssues, customComplianceThresholds: customComplianceThresholds };
+}
+function getComplianceIssue(thresholdName) {
+    switch (thresholdName) {
+        case 'blurriness':
+            return types_1.ComplianceIssue.BLURRINESS;
+        case 'overexposure':
+            return types_1.ComplianceIssue.OVEREXPOSURE;
+        case 'underexposure':
+            return types_1.ComplianceIssue.UNDEREXPOSURE;
+        case 'lensFlare':
+            return types_1.ComplianceIssue.LENS_FLARE;
+        case 'wetness':
+            return types_1.ComplianceIssue.WETNESS;
+        case 'snowness':
+            return types_1.ComplianceIssue.SNOWNESS;
+        case 'dirtiness':
+            return types_1.ComplianceIssue.DIRTINESS;
+        case 'reflections':
+            return types_1.ComplianceIssue.REFLECTIONS;
+        default:
+            return undefined;
+    }
+}
+function getComplianceScore(thresholdName, complianceResult) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    switch (thresholdName) {
+        case 'blurriness':
+            return (_a = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.image_analysis) === null || _a === void 0 ? void 0 : _a.blurriness;
+        case 'overexposure':
+            return (_b = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.image_analysis) === null || _b === void 0 ? void 0 : _b.overexposure;
+        case 'underexposure':
+            return (_c = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.image_analysis) === null || _c === void 0 ? void 0 : _c.underexposure;
+        case 'lensFlare':
+            return (_d = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.image_analysis) === null || _d === void 0 ? void 0 : _d.lens_flare;
+        case 'wetness':
+            return (_e = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.vehicle_analysis) === null || _e === void 0 ? void 0 : _e.wetness;
+        case 'snowness':
+            return (_f = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.vehicle_analysis) === null || _f === void 0 ? void 0 : _f.snowness;
+        case 'dirtiness':
+            return (_g = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.vehicle_analysis) === null || _g === void 0 ? void 0 : _g.dirtiness;
+        case 'reflections':
+            return (_h = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.vehicle_analysis) === null || _h === void 0 ? void 0 : _h.reflections;
+        case 'zoom':
+            return (_j = complianceResult === null || complianceResult === void 0 ? void 0 : complianceResult.image_analysis) === null || _j === void 0 ? void 0 : _j.zoom;
+        default:
+            return undefined;
+    }
+}
+function applyCustomComplianceThresholds(issues, complianceResult, customComplianceThresholds) {
+    var complianceIssues = issues !== null && issues !== void 0 ? issues : [];
+    if (!customComplianceThresholds) {
+        return complianceIssues;
+    }
+    Object.keys(customComplianceThresholds).forEach(function (key) {
+        var thresholdName = key;
+        var complianceScore = getComplianceScore(thresholdName, complianceResult);
+        if (thresholdName === 'zoom' && complianceScore && customComplianceThresholds.zoom) {
+            complianceIssues = complianceIssues.filter(function (issue) { return ![types_1.ComplianceIssue.TOO_ZOOMED, types_1.ComplianceIssue.NOT_ZOOMED_ENOUGH].includes(issue); });
+            if (complianceScore < customComplianceThresholds.zoom.min) {
+                complianceIssues.push(types_1.ComplianceIssue.TOO_ZOOMED);
+            }
+            else if (complianceScore > customComplianceThresholds.zoom.max) {
+                complianceIssues.push(types_1.ComplianceIssue.NOT_ZOOMED_ENOUGH);
+            }
+            return;
+        }
+        var customThreshold = customComplianceThresholds[thresholdName];
+        var complianceIssue = getComplianceIssue(thresholdName);
+        if (complianceScore && complianceIssue && customThreshold !== undefined) {
+            complianceIssues = complianceIssues.filter(function (issue) { return issue !== complianceIssue; });
+            if (complianceScore < customThreshold) {
+                complianceIssues.push(complianceIssue);
+            }
+        }
+    });
+    return complianceIssues;
+}
+function filterCompliances(issues, validIssues) {
+    return issues.filter(function (issue) { return validIssues.includes(issue); });
+}
+function compareComplianceIssues(a, b) {
+    return types_1.COMPLIANCE_ISSUES_PRIORITY.indexOf(a) - types_1.COMPLIANCE_ISSUES_PRIORITY.indexOf(b);
+}
+function mapCompliance(sightId, complianceResult, complianceOptions) {
+    var _a = getActiveComplianceOptions(sightId, complianceOptions), enableCompliance = _a.enableCompliance, complianceIssues = _a.complianceIssues, customComplianceThresholds = _a.customComplianceThresholds;
+    if (!enableCompliance) {
+        return { status: types_1.ImageStatus.SUCCESS };
+    }
+    if (!complianceResult) {
+        return { status: types_1.ImageStatus.COMPLIANCE_RUNNING };
+    }
+    var newIssuesAfterCustomThresholds = applyCustomComplianceThresholds(complianceResult.compliance_issues, complianceResult, customComplianceThresholds);
+    var filteredCompliances = filterCompliances(newIssuesAfterCustomThresholds, complianceIssues);
+    if (filteredCompliances.length === 0) {
+        return { status: types_1.ImageStatus.SUCCESS };
+    }
+    return {
+        status: types_1.ImageStatus.NOT_COMPLIANT,
+        complianceIssues: filteredCompliances.sort(compareComplianceIssues),
+    };
+}
+function mapApiImage(image, inspectionId, thumbnailDomain, complianceOptions) {
+    var _a, _b, _c;
+    var sightId = (_a = image.additional_data) === null || _a === void 0 ? void 0 : _a.sight_id;
+    var _d = mapCompliance(sightId, image.compliances, complianceOptions), status = _d.status, complianceIssues = _d.complianceIssues;
+    return {
+        id: image.id,
+        entityType: types_1.MonkEntityType.IMAGE,
+        inspectionId: inspectionId,
+        label: (_b = image.additional_data) === null || _b === void 0 ? void 0 : _b.label,
+        sightId: sightId,
+        createdAt: ((_c = image.additional_data) === null || _c === void 0 ? void 0 : _c.created_at)
+            ? Date.parse(image.additional_data.created_at)
+            : undefined,
+        path: image.path,
+        thumbnailPath: (0, utils_1.getThumbnailUrl)(thumbnailDomain, image.path, {
+            height: image.image_height,
+            width: image.image_width,
+        }),
+        width: image.image_width,
+        height: image.image_height,
+        size: image.binary_size,
+        mimetype: image.mimetype,
+        type: image.image_type,
+        subtype: image.image_subtype,
+        status: status,
+        complianceIssues: complianceIssues,
+        siblingKey: image.image_sibling_key,
+        viewpoint: image.viewpoint,
+        detailedViewpoint: image.detailed_viewpoint
+            ? {
+                isExterior: image.detailed_viewpoint.is_exterior,
+                distance: image.detailed_viewpoint.distance,
+                centersOn: image.detailed_viewpoint.centers_on,
+            }
+            : undefined,
+        additionalData: image.additional_data,
+        renderedOutputs: [],
+        views: [],
+    };
+}
+exports.mapApiImage = mapApiImage;
+//# sourceMappingURL=mappers.js.map

package/lib/src/api/image/mappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.js","sourceRoot":"","sources":["../../../../src/api/image/mappers.ts"],"names":[],"mappings":";;;AAAA,2CAa2B;AAE3B,kCAA2C;AAE3C,IAAM,0BAA0B,GAAG;IACjC,gBAAgB,EAAE,IAAI;IACtB,gBAAgB,EAAE,iCAAyB;CAC5C,CAAC;AAEF,SAAS,0BAA0B,CACjC,OAAgB,EAChB,iBAAqC;;IAMrC,IAAM,sBAAsB,GAC1B,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,gBAAgB,mCAAI,0BAA0B,CAAC,gBAAgB,CAAC;IACrF,IAAM,gBAAgB,GACpB,OAAO,KAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,wBAAwB,CAAA;QACpD,CAAC,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC9D,CAAC,CAAC,sBAAsB,CAAC;IAC7B,IAAM,sBAAsB,GAC1B,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,gBAAgB,mCAAI,0BAA0B,CAAC,gBAAgB,CAAC;IACrF,IAAM,gBAAgB,GACpB,OAAO,KAAI,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,wBAAwB,0CAAG,OAAO,CAAC,CAAA;QAC/D,CAAC,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,OAAO,CAAC;QACrD,CAAC,CAAC,sBAAsB,CAAC;IAC7B,IAAM,0BAA0B,GAAG,OAAO;QACxC,CAAC,CAAC,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,kCAAkC,0CAAG,OAAO,CAAC;QAClE,CAAC,CAAC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,0BAA0B,CAAC;IAClD,OAAO,EAAE,gBAAgB,kBAAA,EAAE,gBAAgB,kBAAA,EAAE,0BAA0B,4BAAA,EAAE,CAAC;AAC5E,CAAC;AAED,SAAS,kBAAkB,CACzB,aAA+C;IAE/C,QAAQ,aAAa,EAAE;QACrB,KAAK,YAAY;YACf,OAAO,uBAAe,CAAC,UAAU,CAAC;QACpC,KAAK,cAAc;YACjB,OAAO,uBAAe,CAAC,YAAY,CAAC;QACtC,KAAK,eAAe;YAClB,OAAO,uBAAe,CAAC,aAAa,CAAC;QACvC,KAAK,WAAW;YACd,OAAO,uBAAe,CAAC,UAAU,CAAC;QACpC,KAAK,SAAS;YACZ,OAAO,uBAAe,CAAC,OAAO,CAAC;QACjC,KAAK,UAAU;YACb,OAAO,uBAAe,CAAC,QAAQ,CAAC;QAClC,KAAK,WAAW;YACd,OAAO,uBAAe,CAAC,SAAS,CAAC;QACnC,KAAK,aAAa;YAChB,OAAO,uBAAe,CAAC,WAAW,CAAC;QACrC;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAED,SAAS,kBAAkB,CACzB,aAA+C,EAC/C,gBAA4C;;IAE5C,QAAQ,aAAa,EAAE;QACrB,KAAK,YAAY;YACf,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,0CAAE,UAAU,CAAC;QACtD,KAAK,cAAc;YACjB,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,0CAAE,YAAY,CAAC;QACxD,KAAK,eAAe;YAClB,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,0CAAE,aAAa,CAAC;QACzD,KAAK,WAAW;YACd,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,0CAAE,UAAU,CAAC;QACtD,KAAK,SAAS;YACZ,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,0CAAE,OAAO,CAAC;QACrD,KAAK,UAAU;YACb,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,0CAAE,QAAQ,CAAC;QACtD,KAAK,WAAW;YACd,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,0CAAE,SAAS,CAAC;QACvD,KAAK,aAAa;YAChB,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,0CAAE,WAAW,CAAC;QACzD,KAAK,MAAM;YACT,OAAO,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,0CAAE,IAAI,CAAC;QAChD;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAED,SAAS,+BAA+B,CACtC,MAA4B,EAC5B,gBAA2C,EAC3C,0BAAuD;IAEvD,IAAI,gBAAgB,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IACpC,IAAI,CAAC,0BAA0B,EAAE;QAC/B,OAAO,gBAAgB,CAAC;KACzB;IACD,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;QAClD,IAAM,aAAa,GAAG,GAAuC,CAAC;QAC9D,IAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAC5E,IAAI,aAAa,KAAK,MAAM,IAAI,eAAe,IAAI,0BAA0B,CAAC,IAAI,EAAE;YAClF,gBAAgB,GAAI,gBAAsC,CAAC,MAAM,CAC/D,UAAC,KAAK,IAAK,OAAA,CAAC,CAAC,uBAAe,CAAC,UAAU,EAAE,uBAAe,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAhF,CAAgF,CAC5F,CAAC;YACF,IAAI,eAAe,GAAG,0BAA0B,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzD,gBAAgB,CAAC,IAAI,CAAC,uBAAe,CAAC,UAAU,CAAC,CAAC;aACnD;iBAAM,IAAI,eAAe,GAAG,0BAA0B,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChE,gBAAgB,CAAC,IAAI,CAAC,uBAAe,CAAC,iBAAiB,CAAC,CAAC;aAC1D;YACD,OAAO;SACR;QACD,IAAM,eAAe,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;QAClE,IAAM,eAAe,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAC1D,IAAI,eAAe,IAAI,eAAe,IAAI,eAAe,KAAK,SAAS,EAAE;YACvE,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,KAAK,eAAe,EAAzB,CAAyB,CAAC,CAAC;YACjF,IAAI,eAAe,GAAG,eAAe,EAAE;gBACrC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aACxC;SACF;IACH,CAAC,CAAC,CAAC;IACH,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAgB,EAAE,WAA8B;IACzE,OAAQ,MAA4B,CAAC,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAA3B,CAA2B,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,uBAAuB,CAAC,CAAkB,EAAE,CAAkB;IACrE,OAAO,kCAA0B,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,kCAA0B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC;AAED,SAAS,aAAa,CACpB,OAAgB,EAChB,gBAA4C,EAC5C,iBAAqC;IAK/B,IAAA,KACJ,0BAA0B,CAAC,OAAO,EAAE,iBAAiB,CAAC,EADhD,gBAAgB,sBAAA,EAAE,gBAAgB,sBAAA,EAAE,0BAA0B,gCACd,CAAC;IACzD,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO,EAAE,MAAM,EAAE,mBAAW,CAAC,OAAO,EAAE,CAAC;KACxC;IACD,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO,EAAE,MAAM,EAAE,mBAAW,CAAC,kBAAkB,EAAE,CAAC;KACnD;IACD,IAAM,8BAA8B,GAAG,+BAA+B,CACpE,gBAAgB,CAAC,iBAAiB,EAClC,gBAAgB,EAChB,0BAA0B,CAC3B,CAAC;IACF,IAAM,mBAAmB,GAAG,iBAAiB,CAAC,8BAA8B,EAAE,gBAAgB,CAAC,CAAC;IAChG,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,OAAO,EAAE,MAAM,EAAE,mBAAW,CAAC,OAAO,EAAE,CAAC;KACxC;IACD,OAAO;QACL,MAAM,EAAE,mBAAW,CAAC,aAAa;QACjC,gBAAgB,EAAE,mBAAmB,CAAC,IAAI,CAAC,uBAAuB,CAAC;KACpE,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CACzB,KAAe,EACf,YAAoB,EACpB,eAAuB,EACvB,iBAAqC;;IAErC,IAAM,OAAO,GAAG,MAAA,KAAK,CAAC,eAAe,0CAAE,QAAQ,CAAC;IAC1C,IAAA,KAA+B,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAzF,MAAM,YAAA,EAAE,gBAAgB,sBAAiE,CAAC;IAClG,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,UAAU,EAAE,sBAAc,CAAC,KAAK;QAChC,YAAY,cAAA;QACZ,KAAK,EAAE,MAAA,KAAK,CAAC,eAAe,0CAAE,KAAK;QACnC,OAAO,SAAA;QACP,SAAS,EAAE,CAAA,MAAA,KAAK,CAAC,eAAe,0CAAE,UAAU;YAC1C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC;YAC9C,CAAC,CAAC,SAAS;QACb,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,aAAa,EAAE,IAAA,uBAAe,EAAC,eAAe,EAAE,KAAK,CAAC,IAAI,EAAE;YAC1D,MAAM,EAAE,KAAK,CAAC,YAAY;YAC1B,KAAK,EAAE,KAAK,CAAC,WAAW;SACzB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,WAAW;QACxB,MAAM,EAAE,KAAK,CAAC,YAAY;QAC1B,IAAI,EAAE,KAAK,CAAC,WAAW;QACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,IAAI,EAAE,KAAK,CAAC,UAAuB;QACnC,OAAO,EAAE,KAAK,CAAC,aAAyC;QACxD,MAAM,QAAA;QACN,gBAAgB,kBAAA;QAChB,UAAU,EAAE,KAAK,CAAC,iBAAiB;QACnC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,iBAAiB,EAAE,KAAK,CAAC,kBAAkB;YACzC,CAAC,CAAC;gBACE,UAAU,EAAE,KAAK,CAAC,kBAAkB,CAAC,WAAW;gBAChD,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ;gBAC3C,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,UAEvB;aACd;YACH,CAAC,CAAC,SAAS;QACb,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,eAAe,EAAE,EAAE;QACnB,KAAK,EAAE,EAAE;KACV,CAAC;AACJ,CAAC;AA7CD,kCA6CC"}

package/lib/src/api/image/requests.d.ts

@@ -0,0 +1,141 @@
+import { Dispatch } from 'react';
+import { MonkCreatedOneImageAction } from '@monkvision/common';
+import { ComplianceOptions, Image, MonkPicture, TaskName } from '@monkvision/types';
+import { MonkApiConfig } from '../config';
+import { ApiImage } from '../models';
+import { MonkApiResponse } from '../types';
+/**
+ * The different upload types for inspection images.
+ */
+export declare enum ImageUploadType {
+    /**
+     * Upload type corresponding to a sight image in the PhotoCapture process (beauty shot image).
+     */
+    BEAUTY_SHOT = "beauty_shot",
+    /**
+     * Upload type corresponding to a close-up picture (add-damage) in the PhotoCapture process, when using the 2-shot
+     * add damage workflow.
+     */
+    CLOSE_UP_2_SHOT = "close_up_2_shot",
+    /**
+     * Upload type corresponding to a video frame in the VideoCapture process.
+     */
+    VIDEO_FRAME = "video_frame"
+}
+/**
+ * Options specififed when adding a beauty shot (normal "sight" image) to an inspection.
+ */
+export interface AddBeautyShotImageOptions {
+    /**
+     * The type of the image upload : `ImageUploadType.BEAUTY_SHOT`;
+     */
+    uploadType: ImageUploadType.BEAUTY_SHOT;
+    /**
+     * The picture to add to the inspection.
+     */
+    picture: MonkPicture;
+    /**
+     * The ID of the inspection to add the image to.
+     */
+    inspectionId: string;
+    /**
+     * The ID of the sight of the image.
+     */
+    sightId: string;
+    /**
+     * The list of tasks to run for this image.
+     */
+    tasks: TaskName[];
+    /**
+     * Boolean indicating if a thumbnail request will be sent when addImage is called.
+     */
+    useThumbnailCaching?: boolean;
+    /**
+     * Additional options used to configure the compliance locally.
+     */
+    compliance?: ComplianceOptions;
+}
+/**
+ * Options specififed when adding a close up (an "add damage" image) to an inspection using the 2-shot process.
+ */
+export interface Add2ShotCloseUpImageOptions {
+    /**
+     * The type of the image upload : `ImageUploadType.CLOSE_UP_2_SHOT`;
+     */
+    uploadType: ImageUploadType.CLOSE_UP_2_SHOT;
+    /**
+     * The picture to add to the inspection.
+     */
+    picture: MonkPicture;
+    /**
+     * The ID of the inspection to add the image to.
+     */
+    inspectionId: string;
+    /**
+     * This parameter is used to link two close up pictures together. In the 2-shot process, you first upload a zoomed-out
+     * picture of the damage, and then a close-up zoomed picture. In order to link these two pictures together, you need
+     * to specify the same `siblingKey` parameter when uploading them. This key must be unique per pair of pictures in the
+     * same inspection.
+     */
+    siblingKey: string;
+    /**
+     * Boolean indicating if this picture is the first picture or the second picture of the 2-shot process.
+     */
+    firstShot: boolean;
+    /**
+     * Boolean indicating if a thumbnail request will be sent when addImage is called.
+     */
+    useThumbnailCaching?: boolean;
+    /**
+     * Additional options used to configure the compliance locally.
+     */
+    compliance?: ComplianceOptions;
+}
+/**
+ * Options specififed when adding a video frame to a VideoCapture inspection.
+ */
+export interface AddVideoFrameOptions {
+    /**
+     * The type of the image upload : `ImageUploadType.VIDEO_FRAME`;
+     */
+    uploadType: ImageUploadType.VIDEO_FRAME;
+    /**
+     * The picture to add to the inspection.
+     */
+    picture: MonkPicture;
+    /**
+     * The ID of the inspection to add the video frame to.
+     */
+    inspectionId: string;
+    /**
+     * The index of the frame in the video. This index starts at 0 and increases by 1 for each video frame uploaded.
+     */
+    frameIndex: number;
+    /**
+     * The duration (in milliseconds) between this video frame capture time and the previous one. For the first frame of
+     * the video, this value is equal to 0.
+     */
+    timestamp: number;
+}
+/**
+ * Union type describing the different options that can be specified when adding a picture to an inspection.
+ */
+export type AddImageOptions = AddBeautyShotImageOptions | Add2ShotCloseUpImageOptions | AddVideoFrameOptions;
+/**
+ * Type definition for the result of the `addImage` API request.
+ */
+export interface AddImageResponse {
+    /**
+     * The image object that has been created.
+     */
+    image: Image;
+}
+/**
+ * Add a new image to an inspection.
+ *
+ * @param options Upload options for the image.
+ * @param config The API config.
+ * @param [dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ */
+export declare function addImage(options: AddImageOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkCreatedOneImageAction>): Promise<MonkApiResponse<AddImageResponse, ApiImage>>;