avniproject/avni-client#1721 | Add video support for concepts

Author: ombhardwajj

src/Concept.js

@@ -4,14 +4,14 @@ import _ from "lodash";
 import MultipleCodedValues from "./observation/MultipleCodedValues";
 import SingleCodedValue from "./observation/SingleCodedValue";
 import PrimitiveValue from "./observation/PrimitiveValue";
-import Duration from "./Duration";
 import CompositeDuration from "./CompositeDuration";
 import KeyValue from "./application/KeyValue";
 import PhoneNumber from "./PhoneNumber";
 import Identifier from "./Identifier";
 import QuestionGroup from "./observation/QuestionGroup";
 import RepeatableQuestionGroup from "./observation/RepeatableQuestionGroup";
 import ConceptAnswer from "./ConceptAnswer";
+import ConceptMedia from "./ConceptMedia";
 import SchemaNames from "./SchemaNames";
 
 export default class Concept extends BaseEntity {
@@ -35,8 +35,7 @@ export default class Concept extends BaseEntity {
             unit: {type: "string", optional: true},
             keyValues: {type: "list", objectType: SchemaNames.KeyValue},
             voided: {type: "bool", default: false},
-            mediaUrl: {type: "string", optional: true},
-            mediaType: {type: "string", optional: true},
+            media: {type: "list", objectType: "ConceptMedia"},
         },
     };
 
@@ -84,22 +83,33 @@ export default class Concept extends BaseEntity {
         this.that.unit = x;
     }
 
-    get mediaUrl() {
-        return this.that.mediaUrl;
+    getImageMedia() {
+        return this.media ? this.media.filter(m => m.isImage()) : [];
     }
 
-    set mediaUrl(x) {
-        this.that.mediaUrl = x;
+    getVideoMedia() {
+        return this.media ? this.media.filter(m => m.isVideo()) : [];
     }
 
-    get mediaType() {
-        return this.that.mediaType;
+    hasImage() {
+        return this.getImageMedia().length > 0;
     }
 
-    set mediaType(x) {
-        this.that.mediaType = x;
+    hasVideo() {
+        return this.getVideoMedia().length > 0;
     }
 
+    getImageUrl() {
+        const imageMedia = this.getImageMedia();
+        return imageMedia.length > 0 ? imageMedia[0].url : null;
+    }
+
+    getVideoUrl() {
+        const videoMedia = this.getVideoMedia();
+        return videoMedia.length > 0 ? videoMedia[0].url : null;
+    }
+
+
     get name() {
         return this.that.name;
     }
@@ -132,6 +142,14 @@ export default class Concept extends BaseEntity {
         this.that.keyValues = this.fromEntityList(x);
     }
 
+    get media() {
+        return this.toEntityList("media", ConceptMedia);
+    }
+
+    set media(x) {
+        this.that.media = this.fromEntityList(x);
+    }
+
     static keys = {
         isWithinCatchment: 'isWithinCatchment',
         lowestAddressLevelTypeUUIDs: 'lowestAddressLevelTypeUUIDs',
@@ -186,8 +204,12 @@ export default class Concept extends BaseEntity {
         concept.unit = conceptResource.unit;
         concept.voided = conceptResource.voided || false; //This change should be independently deployable irrespective of server
         concept.keyValues = _.map(conceptResource.keyValues, KeyValue.fromResource);
-        concept.mediaUrl = conceptResource.mediaUrl;
-        concept.mediaType = conceptResource.mediaType;
+
+        // Handle media array format from server
+        if (conceptResource.media) {
+            concept.media = _.map(conceptResource.media, ConceptMedia.fromResource);
+        }
+
         return concept;
     }
 
@@ -414,27 +436,13 @@ export default class Concept extends BaseEntity {
         return (keyValue === KeyValue.ContactYesValue);
     }
 
-    isMediaTypeImage() {
-        return this.mediaType === MediaType.Image;
-    }
-
-    hasMediaType() {
-        return !_.isNil(this.mediaType);
-    }
-
-    hasMediaUrl() {
-        return !_.isNil(this.mediaUrl) && this.mediaUrl !== '';
-    }
 
     hasAnswersWithMedia() {
-        return _.some(this.answers, (answer) => answer.concept.hasMediaUrl() || answer.concept.hasMediaType());
+        return _.some(this.answers, (answer) => answer.concept.hasMedia());
     }
 
     hasMedia() {
-        return this.hasMediaUrl() || this.hasMediaType() || this.hasAnswersWithMedia();
+        return this.media && this.media.length > 0 || this.hasAnswersWithMedia();
     }
 }
 
-export const MediaType = {
-    Image: "Image"
-};

src/ConceptMedia.js

@@ -0,0 +1,50 @@
+import BaseEntity from "./BaseEntity";
+import General from "./utility/General";
+
+export default class ConceptMedia extends BaseEntity {
+    static schema = {
+        name: "ConceptMedia",
+        primaryKey: "uuid",
+        properties: {
+            uuid: "string",
+            url: {type: "string", optional: true},
+            type: {type: "string", optional: true},
+        },
+    };
+
+    constructor(that = null) {
+        super(that);
+    }
+
+    get url() {
+        return this.that.url;
+    }
+
+    set url(x) {
+        this.that.url = x;
+    }
+
+    get type() {
+        return this.that.type;
+    }
+
+    set type(x) {
+        this.that.type = x;
+    }
+
+    static fromResource(resource) {
+        const conceptMedia = new ConceptMedia();
+        conceptMedia.uuid = resource.uuid || General.randomUUID();
+        conceptMedia.url = resource.url;
+        conceptMedia.type = resource.type;
+        return conceptMedia;
+    }
+
+    isImage() {
+        return this.type === 'Image';
+    }
+
+    isVideo() {
+        return this.type === 'Video';
+    }
+}

src/Schema.js

@@ -2,6 +2,7 @@ import Settings from "./Settings";
 import LocaleMapping from "./LocaleMapping";
 import Concept from "./Concept";
 import ConceptAnswer from "./ConceptAnswer";
+import ConceptMedia from "./ConceptMedia";
 import Individual from "./Individual";
 import Family from "./Family";
 import AddressLevel, {LocationMapping} from "./AddressLevel";
@@ -97,6 +98,7 @@ const entities = [
     LocaleMapping,
     Settings,
     ConceptAnswer,
+    ConceptMedia,
     Concept,
     EncounterType,
     Gender,
@@ -256,7 +258,7 @@ function createRealmConfig() {
             return doCompact;
         },
         //order is important, should be arranged according to the dependency
-        schemaVersion: 203,
+        schemaVersion: 204,
         onMigration: function (oldDB, newDB) {
             console.log("[AvniModels.Schema]", `Running migration with old schema version: ${oldDB.schemaVersion} and new schema version: ${newDB.schemaVersion}`);
             if (oldDB.schemaVersion === VersionWithEmbeddedMigrationProblem)
@@ -987,6 +989,19 @@ function createRealmConfig() {
                     }
                 });
             }
+            if (oldDB.schemaVersion < 204) {
+                _.forEach(newDB.objects(Concept.schema.name), (concept) => {
+                    if (!concept.media) {
+                        concept.media = [];
+                    }
+                });
+                // Reset EntitySyncStatus for Concept to refetch media URLs
+                _.forEach(newDB.objects(EntitySyncStatus.schema.name), (ess) => {
+                    if (ess.entityName === 'Concept') {
+                        ess.loadedSince = EntitySyncStatus.REALLY_OLD_DATE;
+                    }
+                });
+            }
         },
     };
 }

src/SchemaNames.js

@@ -39,6 +39,7 @@ class SchemaNames {
   static ChecklistItemStatus = "EmbeddedChecklistItemStatus";
   static Comment = "Comment";
   static Concept = "Concept";
+  static ConceptMedia = "ConceptMedia";
   static EntityApprovalStatus = "EntityApprovalStatus";
   static Point = "Point";
 }

src/index.js

@@ -9,6 +9,7 @@ import ChecklistItemStatus from "./ChecklistItemStatus";
 import CompositeDuration from "./CompositeDuration";
 import Concept from "./Concept";
 import ConceptAnswer from "./ConceptAnswer";
+import ConceptMedia from "./ConceptMedia";
 import Duration from "./Duration";
 import Encounter from "./Encounter";
 import EncounterType from "./EncounterType";
@@ -142,6 +143,7 @@ export {
     CompositeDuration,
     Concept,
     ConceptAnswer,
+    ConceptMedia,
     Duration,
     Encounter,
     EncounterType,