@monkvision/network 4.5.6 → 5.0.0

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@monkvision/network",
-    "version": "4.5.5",
+    "version": "4.6.0",
     "license": "BSD-3-Clause-Clear",
     "packageManager": "yarn@3.2.4",
     "description": "MonkJs core package used to communicate with the API",
@@ -28,8 +28,8 @@
         "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
     },
     "dependencies": {
-        "@monkvision/common": "4.5.5",
-        "@monkvision/sights": "4.5.5",
+        "@monkvision/common": "4.6.0",
+        "@monkvision/sights": "4.6.0",
         "jsonwebtoken": "^9.0.2",
         "jwt-decode": "^4.0.0",
         "ky": "^1.2.0",
@@ -42,12 +42,12 @@
         "react-router-dom": "^6.22.3"
     },
     "devDependencies": {
-        "@monkvision/eslint-config-base": "4.5.5",
-        "@monkvision/eslint-config-typescript": "4.5.5",
-        "@monkvision/jest-config": "4.5.5",
-        "@monkvision/prettier-config": "4.5.5",
-        "@monkvision/types": "4.5.5",
-        "@monkvision/typescript-config": "4.5.5",
+        "@monkvision/eslint-config-base": "4.6.0",
+        "@monkvision/eslint-config-typescript": "4.6.0",
+        "@monkvision/jest-config": "4.6.0",
+        "@monkvision/prettier-config": "4.6.0",
+        "@monkvision/types": "4.6.0",
+        "@monkvision/typescript-config": "4.6.0",
         "@types/jest": "^29.2.2",
         "@types/jsonwebtoken": "^9.0.5",
         "@types/node": "^18.11.9",

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

@@ -1,6 +1,6 @@
 import { Dispatch } from 'react';
 import { MonkCreatedOneImageAction } from '@monkvision/common';
-import { ComplianceOptions, Image, MonkPicture, TaskName } from '@monkvision/types';
+import { ComplianceOptions, Image, MonkPicture, TaskName, VehiclePart } from '@monkvision/types';
 import { MonkApiConfig } from '../config';
 import { ApiImage } from '../models';
 import { MonkApiResponse } from '../types';
@@ -17,10 +17,19 @@ export declare enum ImageUploadType {
      * add damage workflow.
      */
     CLOSE_UP_2_SHOT = "close_up_2_shot",
+    /**
+     * Upload type corresponding to a close-up picture (add-damage) in the PhotoCapture process, when using the
+     * part-select-shot add damage workflow.
+     */
+    PART_SELECT_SHOT = "part_select_shot",
     /**
      * Upload type corresponding to a video frame in the VideoCapture process.
      */
-    VIDEO_FRAME = "video_frame"
+    VIDEO_FRAME = "video_frame",
+    /**
+     * Upload type corresponding to a manual photo in the VideoCapture process.
+     */
+    VIDEO_MANUAL_PHOTO = "video_manual_photo"
 }
 /**
  * Options specififed when adding a beauty shot (normal "sight" image) to an inspection.
@@ -91,6 +100,35 @@ export interface Add2ShotCloseUpImageOptions {
      */
     compliance?: ComplianceOptions;
 }
+/**
+ * Options specified when adding a close up (an "add damage" image) to an inspection using the part select process.
+ */
+export interface AddPartSelectCloseUpImageOptions {
+    /**
+     * The type of the image upload : `ImageUploadType.PART_SELECT_SHOT`;
+     */
+    uploadType: ImageUploadType.PART_SELECT_SHOT;
+    /**
+     * The picture to add to the inspection.
+     */
+    picture: MonkPicture;
+    /**
+     * The ID of the inspection to add the image to.
+     */
+    inspectionId: string;
+    /**
+     * List of damage parts chosen by User with part selected wireframe
+     */
+    vehicleParts: VehiclePart[];
+    /**
+     * 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.
  */
@@ -117,10 +155,27 @@ export interface AddVideoFrameOptions {
      */
     timestamp: number;
 }
+/**
+ * Options specififed when adding a manual video photo to a VideoCapture inspection.
+ */
+export interface AddVideoManualPhotoOptions {
+    /**
+     * The type of the image upload : `ImageUploadType.VIDEO_MANUAL_PHOTO`;
+     */
+    uploadType: ImageUploadType.VIDEO_MANUAL_PHOTO;
+    /**
+     * The picture to add to the inspection.
+     */
+    picture: MonkPicture;
+    /**
+     * The ID of the inspection to add the video frame to.
+     */
+    inspectionId: string;
+}
 /**
  * Union type describing the different options that can be specified when adding a picture to an inspection.
  */
-export type AddImageOptions = AddBeautyShotImageOptions | Add2ShotCloseUpImageOptions | AddVideoFrameOptions;
+export type AddImageOptions = AddBeautyShotImageOptions | Add2ShotCloseUpImageOptions | AddVideoFrameOptions | AddVideoManualPhotoOptions | AddPartSelectCloseUpImageOptions;
 /**
  * Type definition for the result of the `addImage` API request.
  */

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

@@ -72,13 +72,22 @@ var ImageUploadType;
      * add damage workflow.
      */
     ImageUploadType["CLOSE_UP_2_SHOT"] = "close_up_2_shot";
+    /**
+     * Upload type corresponding to a close-up picture (add-damage) in the PhotoCapture process, when using the
+     * part-select-shot add damage workflow.
+     */
+    ImageUploadType["PART_SELECT_SHOT"] = "part_select_shot";
     /**
      * Upload type corresponding to a video frame in the VideoCapture process.
      */
     ImageUploadType["VIDEO_FRAME"] = "video_frame";
+    /**
+     * Upload type corresponding to a manual photo in the VideoCapture process.
+     */
+    ImageUploadType["VIDEO_MANUAL_PHOTO"] = "video_manual_photo";
 })(ImageUploadType = exports.ImageUploadType || (exports.ImageUploadType = {}));
 function getImageType(options) {
-    if (options.uploadType === ImageUploadType.CLOSE_UP_2_SHOT) {
+    if ([ImageUploadType.CLOSE_UP_2_SHOT, ImageUploadType.PART_SELECT_SHOT].includes(options.uploadType)) {
         return types_1.ImageType.CLOSE_UP;
     }
     return types_1.ImageType.BEAUTY_SHOT;
@@ -95,6 +104,23 @@ function getImageLabel(options) {
             nl: "Videoframe ".concat(options.frameIndex),
         };
     }
+    if (options.uploadType === ImageUploadType.VIDEO_MANUAL_PHOTO) {
+        return {
+            en: "Video Manual Photo",
+            fr: "Photo Manuelle Vid\u00E9o",
+            de: "Foto Manuell Video",
+            nl: "Foto-handleiding Video",
+        };
+    }
+    if (options.uploadType === ImageUploadType.PART_SELECT_SHOT) {
+        var partsTranslation = options.vehicleParts.map(function (part) { return common_1.vehiclePartLabels[part]; });
+        return {
+            en: "Close Up on ".concat(partsTranslation.map(function (part) { return part.en; }).join(', ')),
+            fr: "Photo Zoom\u00E9e sur ".concat(partsTranslation.map(function (part) { return part.en; }).join(', ')),
+            de: "Gezoomtes an ".concat(partsTranslation.map(function (part) { return part.en; }).join(', ')),
+            nl: "Nabij aan ".concat(partsTranslation.map(function (part) { return part.en; }).join(', ')),
+        };
+    }
     return {
         en: options.firstShot ? 'Close Up (part)' : 'Close Up (damage)',
         fr: options.firstShot ? 'Photo Zoomée (partie)' : 'Photo Zoomée (dégât)',
@@ -144,7 +170,7 @@ function createBeautyShotImageData(options, filetype) {
     };
     return { filename: filename, body: body };
 }
-function createCloseUpImageData(options, filetype) {
+function create2ShotCloseUpImageData(options, filetype) {
     var _a, _b;
     var prefix = options.firstShot ? 'closeup-part' : 'closeup-damage';
     var filename = "".concat(prefix, "-").concat(options.inspectionId, "-").concat(Date.now(), ".").concat(filetype);
@@ -167,6 +193,29 @@ function createCloseUpImageData(options, filetype) {
     };
     return { filename: filename, body: body };
 }
+function createPartSelectCloseUpImageData(options, filetype) {
+    var _a, _b;
+    var filename = "part-select-".concat(options.inspectionId, "-").concat(Date.now(), ".").concat(filetype);
+    var body = {
+        acquisition: {
+            strategy: 'upload_multipart_form_keys',
+            file_key: MULTIPART_KEY_IMAGE,
+        },
+        image_type: types_1.ImageType.CLOSE_UP,
+        tasks: [
+            types_1.TaskName.DAMAGE_DETECTION,
+            {
+                name: types_1.TaskName.COMPLIANCES,
+                wait_for_result: ((_a = options.compliance) === null || _a === void 0 ? void 0 : _a.enableCompliance) && ((_b = options.compliance) === null || _b === void 0 ? void 0 : _b.useLiveCompliance),
+            },
+        ],
+        detailed_viewpoint: {
+            centers_on: options.vehicleParts,
+        },
+        additional_data: getAdditionalData(options),
+    };
+    return { filename: filename, body: body };
+}
 function createVideoFrameData(options, filetype) {
     var filename = "video-frame-".concat(options.frameIndex, ".").concat(filetype);
     var body = {
@@ -179,14 +228,30 @@ function createVideoFrameData(options, filetype) {
     };
     return { filename: filename, body: body };
 }
+function createVideoManualPhotoData(options, filetype) {
+    var filename = "video-manual-photo-".concat(Date.now(), ".").concat(filetype);
+    var body = {
+        acquisition: {
+            strategy: 'upload_multipart_form_keys',
+            file_key: MULTIPART_KEY_IMAGE,
+        },
+        tasks: [types_1.TaskName.DAMAGE_DETECTION],
+        additional_data: getAdditionalData(options),
+    };
+    return { filename: filename, body: body };
+}
 function getAddImageData(options, filetype) {
     switch (options.uploadType) {
         case ImageUploadType.BEAUTY_SHOT:
             return createBeautyShotImageData(options, filetype);
         case ImageUploadType.CLOSE_UP_2_SHOT:
-            return createCloseUpImageData(options, filetype);
+            return create2ShotCloseUpImageData(options, filetype);
+        case ImageUploadType.PART_SELECT_SHOT:
+            return createPartSelectCloseUpImageData(options, filetype);
         case ImageUploadType.VIDEO_FRAME:
             return createVideoFrameData(options, filetype);
+        case ImageUploadType.VIDEO_MANUAL_PHOTO:
+            return createVideoManualPhotoData(options, filetype);
         default:
             throw new Error('Unknown image upload type.');
     }
@@ -276,6 +341,7 @@ function addImage(options, config, dispatch) {
                     body = _a.sent();
                     image = (0, mappers_1.mapApiImage)(body, options.inspectionId, config.thumbnailDomain, options.compliance);
                     if (options.uploadType !== ImageUploadType.VIDEO_FRAME &&
+                        options.uploadType !== ImageUploadType.VIDEO_MANUAL_PHOTO &&
                         options.useThumbnailCaching !== false) {
                         precacheThumbnail(image).catch(function (error) {
                             return console.error("Thumbnail GET request failed: ".concat(error));

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

@@ -72,5 +72,6 @@ export interface ApiImagePost {
     image_subtype?: ApiImageSubType;
     image_sibling_key?: string;
     compliances?: ApiCompliance;
+    detailed_viewpoint?: ApiViewpointComponent;
     additional_data?: ApiImageAdditionalData;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/network",
-  "version": "4.5.6",
+  "version": "5.0.0",
   "license": "BSD-3-Clause-Clear",
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs core package used to communicate with the API",
@@ -28,8 +28,8 @@
     "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
   },
   "dependencies": {
-    "@monkvision/common": "4.5.6",
-    "@monkvision/sights": "4.5.6",
+    "@monkvision/common": "5.0.0",
+    "@monkvision/sights": "5.0.0",
     "jsonwebtoken": "^9.0.2",
     "jwt-decode": "^4.0.0",
     "ky": "^1.2.0",
@@ -42,12 +42,12 @@
     "react-router-dom": "^6.22.3"
   },
   "devDependencies": {
-    "@monkvision/eslint-config-base": "4.5.6",
-    "@monkvision/eslint-config-typescript": "4.5.6",
-    "@monkvision/jest-config": "4.5.6",
-    "@monkvision/prettier-config": "4.5.6",
-    "@monkvision/types": "4.5.6",
-    "@monkvision/typescript-config": "4.5.6",
+    "@monkvision/eslint-config-base": "5.0.0",
+    "@monkvision/eslint-config-typescript": "5.0.0",
+    "@monkvision/jest-config": "5.0.0",
+    "@monkvision/prettier-config": "5.0.0",
+    "@monkvision/types": "5.0.0",
+    "@monkvision/typescript-config": "5.0.0",
     "@types/jest": "^29.2.2",
     "@types/jsonwebtoken": "^9.0.5",
     "@types/node": "^18.11.9",
@@ -84,5 +84,5 @@
     "url": "https://github.com/monkvision/monkjs/issues"
   },
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "c12e283e4abf1f810fdbc924a2d199652b92db30"
+  "gitHead": "6426efb1b64fde310666b5556fc76aeb7c8f2584"
 }