feat!: remove optional fields when unnecessary (#216)

* start changes on required values

* remove duplicate fields on JSONSchema, solve type errors and tests

* make coords optional

* wrong `[(required) = true]` on optional `Coords`

---------

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

proto/common/v1.proto

@@ -7,7 +7,7 @@ import "versionId/v1.proto";
 
 message Common_1 {
   // 32-byte random generated number
-  optional bytes docId = 1 [(required) = true];
+  bytes docId = 1 [(required) = true];
   repeated VersionId_1 links = 2;
   google.protobuf.Timestamp createdAt = 3 [(required) = true];
   google.protobuf.Timestamp updatedAt = 4 [(required) = true];

proto/field/v1.proto

@@ -14,7 +14,7 @@ message Field_1 {
 
   Common_1 common = 1;
 
-  optional string tagKey = 5 [(required) = true];
+  string tagKey = 5 [(required) = true];
   enum Type {
     type_unspecified = 0;
     text = 1;
@@ -23,7 +23,7 @@ message Field_1 {
     selectMultiple = 4;
   }
   Type type = 6 [(required) = true];
-  optional string label = 7 [(required) = true];
+  string label = 7 [(required) = true];
   enum Appearance {
     appearance_unspecified = 0;
     multiline = 1;
@@ -36,7 +36,7 @@ message Field_1 {
     TagValue_1.PrimitiveValue value = 2;
   }
   repeated Option options = 10;
-  optional bool universal = 11;
+  bool universal = 11;
   optional string placeholder = 12;
-  optional string helperText = 13;
+  string helperText = 13;
 }

proto/observation/v1.proto

@@ -15,8 +15,8 @@ message Observation_1 {
 
   Common_1 common = 1;
 
-  optional double lat = 5;
-  optional double lon = 6;
+  double lat = 5;
+  double lon = 6;
 
   // ATTACHMENT
   enum AttachmentType {
@@ -38,7 +38,7 @@ message Observation_1 {
 
   // METADATA
   message Metadata {
-    optional bool manualLocation = 1;
+    bool manualLocation = 1;
 
     message Position {
       google.protobuf.Timestamp timestamp = 1;

proto/preset/v1.proto

@@ -21,7 +21,7 @@ message Preset_1 {
   map<string, TagValue_1> addTags = 8;
   map<string, TagValue_1> removeTags = 9;
   repeated FieldRef fieldRefs = 10;
-  optional IconRef iconRef = 11;
+  IconRef iconRef = 11;
   repeated string terms = 12;
   string color = 13;
 

schema/field/v1.json

@@ -102,6 +102,13 @@
       "type": "string"
     }
   },
-  "required": ["tagKey", "type", "label", "schemaName"],
+  "required": [
+    "tagKey",
+    "type",
+    "label",
+    "schemaName",
+    "universal",
+    "helperText"
+  ],
   "additionalProperties": false
 }

schema/observation/v1.json

@@ -22,6 +22,14 @@
         "coords": {
           "description": "Position details, should be self explanatory. Units in meters",
           "type": "object",
+          "required": [
+            "latitude",
+            "longitude",
+            "altitude",
+            "heading",
+            "speed",
+            "accuracy"
+          ],
           "properties": {
             "latitude": {
               "type": "number"
@@ -179,7 +187,8 @@
           }
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "required": ["manualLocation"]
     },
     "presetRef": {
       "type": "object",
@@ -197,6 +206,6 @@
       "required": ["docId", "versionId"]
     }
   },
-  "required": ["schemaName", "tags", "attachments", "metadata"],
+  "required": ["schemaName", "tags", "attachments", "lat", "lon"],
   "additionalProperties": false
 }

schema/preset/v1.json

@@ -131,7 +131,8 @@
     "fieldRefs",
     "schemaName",
     "terms",
-    "color"
+    "color",
+    "iconRef"
   ],
   "additionalProperties": false
 }

src/lib/decode-conversions.ts

@@ -95,7 +95,7 @@ export const convertObservation: ConvertFunction<'observation'> = (
     ...rest,
     attachments: message.attachments.map(convertAttachment),
     tags: convertTags(message.tags),
-    metadata: message.metadata || {},
+    metadata: message.metadata,
     presetRef,
   }
   return obs
@@ -158,6 +158,8 @@ export const convertPreset: ConvertFunction<'preset'> = (
       docId: rest.iconRef.docId.toString('hex'),
       versionId: getVersionId(rest.iconRef.versionId),
     }
+  } else {
+    throw new Error('missing iconRef for preset')
   }
   return {
     ...jsonSchemaCommon,

src/lib/encode-conversions.ts

@@ -102,7 +102,7 @@ export const convertObservation: ConvertFunction<'observation'> = (
   mapeoDoc
 ) => {
   const attachments = mapeoDoc.attachments.map(convertAttachment)
-  const metadata: Observation_1_Metadata = mapeoDoc.metadata && {
+  const metadata: Observation_1_Metadata | undefined = mapeoDoc.metadata && {
     ...Observation_1_Metadata.fromPartial(mapeoDoc.metadata),
   }
   let presetRef

test/fixtures/good-docs-completed.js

@@ -123,6 +123,7 @@ export const goodDocsCompleted = [
           value: 'somePrimitiveTagValue',
         },
       ],
+      helperText: '',
       deleted: false,
     },
     expected: {},

test/fixtures/good-docs-minimal.js

@@ -21,9 +21,11 @@ export const goodDocsMinimal = [
       updatedAt: cachedValues.updatedAt,
       createdBy: cachedValues.createdBy,
       links: [],
+      lat: 24.0424,
+      lon: 21.0214,
       attachments: [],
       tags: {},
-      metadata: {},
+      metadata: { manualLocation: false },
       deleted: false,
     },
     expected: {},
@@ -61,6 +63,8 @@ export const goodDocsMinimal = [
       label: 'my label',
       type: 'text',
       deleted: false,
+      universal: false,
+      helperText: '',
     },
     expected: {},
   },
@@ -79,6 +83,10 @@ export const goodDocsMinimal = [
       addTags: {},
       removeTags: {},
       fieldRefs: [],
+      iconRef: {
+        docId: cachedValues.refs.docId,
+        versionId: cachedValues.refs.versionId,
+      },
       terms: [],
       deleted: false,
       color: '#ff00ff',