add iconRef to preset schema, fix type errors (#203)

Co-authored-by: Tomás Ciccola <tciccola@digital-democracy.com>

schema/preset/v1.json

@@ -94,6 +94,21 @@
         "required": ["docId", "versionId"]
       }
     },
+    "iconRef": {
+      "type": "object",
+      "description": "References to the icon that this preset is related to.",
+      "properties": {
+        "docId": {
+          "description": "hex-encoded id of the element that this observation references",
+          "type": "string"
+        },
+        "versionId": {
+          "description": "core discovery id (hex-encoded 32-byte buffer) and core index number, separated by '/'",
+          "type": "string"
+        }
+      },
+      "required": ["docId", "versionId"]
+    },
     "terms": {
       "description": "Synonyms or related terms (used for search)",
       "type": "array",

src/lib/decode-conversions.ts

@@ -137,6 +137,16 @@ export const convertPreset: ConvertFunction<'preset'> = (
       geomType !== 'UNRECOGNIZED'
   )
 
+  let iconRef
+  if (rest.iconRef) {
+    // iconRef is not required property on the schema, but if it does exist, then a versionId must be present
+    if (!rest.iconRef.versionId)
+      throw new Error('found iconRef on preset but is missing versionId')
+    iconRef = {
+      docId: rest.iconRef.docId.toString('hex'),
+      versionId: getVersionId(rest.iconRef.versionId),
+    }
+  }
   return {
     ...jsonSchemaCommon,
     ...rest,
@@ -151,6 +161,7 @@ export const convertPreset: ConvertFunction<'preset'> = (
         versionId: getVersionId(versionId),
       }
     }),
+    iconRef,
   }
 }
 

src/lib/encode-conversions.ts

@@ -75,6 +75,15 @@ export const convertPreset: ConvertFunction<'preset'> = (mapeoDoc) => {
   if (!mapeoDoc.color.match(colorRegex)) {
     throw new Error(`invalid color string ${mapeoDoc.color}`)
   }
+
+  let iconRef
+  if (mapeoDoc.iconRef) {
+    iconRef = {
+      docId: Buffer.from(mapeoDoc.iconRef.docId, 'hex'),
+      versionId: parseVersionId(mapeoDoc.iconRef.versionId),
+    }
+  }
+
   return {
     common: convertCommon(mapeoDoc),
     ...mapeoDoc,
@@ -85,6 +94,7 @@ export const convertPreset: ConvertFunction<'preset'> = (mapeoDoc) => {
       docId: Buffer.from(docId, 'hex'),
       versionId: parseVersionId(versionId),
     })),
+    iconRef,
   }
 }