feat: add color to preset (#183)

* add color to preset

* add pattern for validating a hex color (#rrggbb)

* only allow for #rrggbb not #rgb

* add validation for protobuf, add testing of wrong validation

* remove capture group on color schema pattern

Co-authored-by: Evan Hahn <me@evanhahn.com>

* validate color by using the same pattern on the schema instead of an

external library

---------

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

proto/preset/v2.proto

@@ -29,4 +29,5 @@ message Preset_2 {
   repeated bytes fieldIds = 10;
   optional bytes iconId = 11;
   repeated string terms = 12;
+  string color = 13;
 }

schema/preset/v2.json

@@ -93,17 +93,23 @@
       "items": {
         "type": "string"
       }
+    },
+    "color": {
+      "description": "string representation of a color in 24 bit (#rrggbb)",
+      "type": "string",
+      "pattern": "^#[a-fA-F0-9]{6}$"
     }
-  },
-  "required": [
-    "name",
-    "geometry",
-    "tags",
-    "addTags",
-    "removeTags",
-    "fieldIds",
-    "schemaName",
-    "terms"
-  ],
-  "additionalProperties": false
+},
+"required": [
+  "name",
+  "geometry",
+  "tags",
+  "addTags",
+  "removeTags",
+  "fieldIds",
+  "schemaName",
+  "terms",
+  "color"
+],
+"additionalProperties": false
 }

src/lib/encode-conversions.ts

@@ -17,7 +17,12 @@ import {
   type Observation_5_Attachment,
 } from '../proto/observation/v5.js'
 import { ExhaustivenessError, parseVersionId } from './utils.js'
-import { CoreOwnership, type Observation, type Track } from '../index.js'
+import {
+  CoreOwnership,
+  valueSchemas,
+  type Observation,
+  type Track,
+} from '../index.js'
 
 /** Function type for converting a protobuf type of any version for a particular
  * schema name, and returning the most recent JSONSchema type */
@@ -66,6 +71,10 @@ export const convertField: ConvertFunction<'field'> = (mapeoDoc) => {
 }
 
 export const convertPreset: ConvertFunction<'preset'> = (mapeoDoc) => {
+  const colorRegex = valueSchemas.preset.properties.color.pattern
+  if (!mapeoDoc.color.match(colorRegex)) {
+    throw new Error(`invalid color string ${mapeoDoc.color}`)
+  }
   return {
     common: convertCommon(mapeoDoc),
     ...mapeoDoc,

test/fixtures/bad-docs.js

@@ -62,4 +62,25 @@ export const badDocs = [
       ],
     },
   },
+  {
+    text: 'preset with invalid color string',
+    doc: {
+      docId: cachedValues.docId,
+      versionId: cachedValues.versionId,
+      schemaName: 'preset',
+      createdAt: cachedValues.createdAt,
+      updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
+      links: [],
+      name: 'myPreset',
+      geometry: ['point'],
+      tags: {},
+      addTags: {},
+      removeTags: {},
+      fieldIds: [],
+      terms: [],
+      deleted: false,
+      color: '#ff00g1',
+    },
+  },
 ]

test/fixtures/good-docs-completed.js

@@ -140,6 +140,7 @@ export const goodDocsCompleted = [
       },
       fieldIds: cachedValues.fieldIds,
       iconId: cachedValues.iconId,
+      color: '#ff00ff',
       terms: ['imastring'],
       deleted: false,
     },

test/fixtures/good-docs-minimal.js

@@ -75,6 +75,7 @@ export const goodDocsMinimal = [
       fieldIds: [],
       terms: [],
       deleted: false,
+      color: '#ff00ff',
     },
     expected: {},
   },

test/index.test.js

@@ -29,6 +29,15 @@ test('Bad docs throw when encoding', () => {
   }
 })
 
+test(`Bad docs won't validate`, () => {
+  for (const { text, doc } of badDocs) {
+    assert.throws(() => {
+      // @ts-expect-error
+      validate(doc)
+    }, text)
+  }
+})
+
 test('validate bad docs', () => {
   for (const schemaName of Object.keys(currentSchemaVersions)) {
     assert(