Added PORTRAIT_IMAGE custom compliance (#936)

Author: dlymonkai

packages/common/src/i18n/translations/image.ts

@@ -416,4 +416,18 @@ export const complianceIssueLabels: Record<ComplianceIssue, ImageLabels> = {
       nl: 'Zorg ervoor dat de foto van goede kwaliteit is.',
     },
   },
+  [ComplianceIssue.PORTRAIT_IMAGE]: {
+    title: {
+      en: 'Portrait Image',
+      fr: 'Image en mode portrait',
+      de: 'Hochformatbild',
+      nl: 'Portretfoto',
+    },
+    description: {
+      en: 'The picture is in portrait mode, please take it in landscape',
+      fr: 'L’image est en mode portrait, veuillez la prendre en mode paysage',
+      de: 'Das Bild ist im Hochformat, bitte fotografieren Sie im Querformat',
+      nl: 'De foto is in portretstand, neem deze alstublieft in landschapmodus',
+    },
+  },
 };

packages/network/src/api/image/mappers.ts

@@ -10,6 +10,7 @@ import {
   ImageSubtype,
   ImageType,
   MonkEntityType,
+  PixelDimensions,
   VehiclePart,
 } from '@monkvision/types';
 import { ApiImage, ApiImageComplianceResults } from '../models';
@@ -134,6 +135,13 @@ function applyCustomComplianceThresholds(
   return complianceIssues;
 }
 
+function applyCustomCompliances(issues: string[], imageDimensions?: PixelDimensions) {
+  if (imageDimensions && imageDimensions.height > imageDimensions.width) {
+    return [...issues, ComplianceIssue.PORTRAIT_IMAGE];
+  }
+  return issues;
+}
+
 function filterCompliances(issues: string[], validIssues: ComplianceIssue[]): ComplianceIssue[] {
   return (issues as ComplianceIssue[]).filter((issue) => validIssues.includes(issue));
 }
@@ -146,6 +154,7 @@ function mapCompliance(
   sightId?: string,
   complianceResult?: ApiImageComplianceResults,
   complianceOptions?: ComplianceOptions,
+  imageDimensions?: PixelDimensions,
 ): {
   status: ImageStatus;
   complianceIssues?: ComplianceIssue[];
@@ -163,7 +172,11 @@ function mapCompliance(
     complianceResult,
     customComplianceThresholds,
   );
-  const filteredCompliances = filterCompliances(newIssuesAfterCustomThresholds, complianceIssues);
+  const newIssuesAfterCustomCompliances = applyCustomCompliances(
+    newIssuesAfterCustomThresholds,
+    imageDimensions,
+  );
+  const filteredCompliances = filterCompliances(newIssuesAfterCustomCompliances, complianceIssues);
   if (filteredCompliances.length === 0) {
     return { status: ImageStatus.SUCCESS };
   }
@@ -180,7 +193,12 @@ export function mapApiImage(
   complianceOptions?: ComplianceOptions,
 ): Image {
   const sightId = image.additional_data?.sight_id;
-  const { status, complianceIssues } = mapCompliance(sightId, image.compliances, complianceOptions);
+  const { status, complianceIssues } = mapCompliance(
+    sightId,
+    image.compliances,
+    complianceOptions,
+    { width: image.image_width, height: image.image_height },
+  );
   return {
     id: image.id,
     entityType: MonkEntityType.IMAGE,

packages/network/test/api/image/mappers.test.ts

@@ -25,6 +25,7 @@ const EXPECTED_DEFAULT_COMPLIANCE_ISSUES = [
   ComplianceIssue.TOO_ZOOMED,
   ComplianceIssue.NOT_ZOOMED_ENOUGH,
   ComplianceIssue.MISSING,
+  ComplianceIssue.PORTRAIT_IMAGE,
 ];
 
 const EXPECTED_COMPLIANCE_ISSUES_ORDER = [
@@ -39,6 +40,7 @@ const EXPECTED_COMPLIANCE_ISSUES_ORDER = [
   ComplianceIssue.HIDDEN_PARTS,
   ComplianceIssue.MISSING_PARTS,
   ComplianceIssue.WRONG_CENTER_PART,
+  ComplianceIssue.PORTRAIT_IMAGE,
   ComplianceIssue.REFLECTIONS,
   ComplianceIssue.SNOWNESS,
   ComplianceIssue.WETNESS,
@@ -322,6 +324,17 @@ describe('Image API Mappers', () => {
         expect(result.complianceIssues).toEqual(EXPECTED_COMPLIANCE_ISSUES_ORDER);
       });
 
+      it('should properly apply custom compliances', () => {
+        const apiImage = createApiImage();
+        apiImage.image_height = 2000;
+        apiImage.image_width = 500;
+
+        const result = mapApiImage(apiImage, '', '', { enableCompliance: true });
+        console.log('result:', result);
+
+        expect(result.status).toEqual(ImageStatus.NOT_COMPLIANT);
+      });
+
       it('should properly apply custom thresholds', () => {
         const apiImage = createApiImage();
         apiImage.compliances = {

packages/types/src/state/image.ts

@@ -189,13 +189,17 @@ export enum ComplianceIssue {
   INTERIOR_NOT_SUPPORTED = 'interior_not_supported',
   MISSING = 'missing',
   LOW_QUALITY = 'low_quality',
+
+  // Custom issue(s)
+  PORTRAIT_IMAGE = 'portrait_image',
 }
 
 /**
  * The order of priority of compliance issues in the SDK. This array is used to sort compliance issue arrays. The
  * smaller the index, the higher the priority of the compliance issue.
  */
 export const COMPLIANCE_ISSUES_PRIORITY = [
+  // TODO: remove before release
   ComplianceIssue.NO_VEHICLE,
 
   ComplianceIssue.BLURRINESS,
@@ -209,6 +213,7 @@ export const COMPLIANCE_ISSUES_PRIORITY = [
   ComplianceIssue.HIDDEN_PARTS,
   ComplianceIssue.MISSING_PARTS,
   ComplianceIssue.WRONG_CENTER_PART,
+  ComplianceIssue.PORTRAIT_IMAGE,
 
   ComplianceIssue.REFLECTIONS,
   ComplianceIssue.SNOWNESS,
@@ -254,6 +259,7 @@ export const DEFAULT_COMPLIANCE_ISSUES = [
   // ComplianceIssue.INTERIOR_NOT_SUPPORTED,
   ComplianceIssue.MISSING,
   // ComplianceIssue.LOW_QUALITY,
+  ComplianceIssue.PORTRAIT_IMAGE,
 ];
 
 /**