chore: move type out of docRef and call it docRefType (#208)

* move type out of `docRef` and call it `refType` * rename `refType` to `docRefType`, make it an enum valid types are every schema except `coreOwnership`, `icon` and `translation` --------- Co-authored-by: Tomás Ciccola <tciccola@digital-democracy.com>
digidem · Aug 5, 2024 · 46353a9 · 46353a9
1 parent 1662480
commit 46353a9
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 10 deletions.
diff --git a/proto/translation/v1.proto b/proto/translation/v1.proto
@@ -21,7 +21,17 @@ message Translation_1 {
   message DocRef {
     bytes docId = 1;
     VersionId_1 versionId = 2;
-    string type = 3;
   }
+  enum DocRefType {
+    type_unspecified = 0;
+    deviceInfo = 1;
+    preset = 2;
+    field = 3;
+    observation = 4;
+    projectSettings = 5;
+    role = 6;
+    track = 7;
+  }
+  DocRefType docRefType = 7;
 
 }
diff --git a/schema/translation/v1.json b/schema/translation/v1.json
@@ -19,13 +19,24 @@
         "versionId": {
           "description": "core discovery id (hex-encoded 32-byte buffer) and core index number, separated by '/'",
           "type": "string"
-        },
-        "type": {
-          "description": "type of the element that this translation references",
-          "type": "string"
         }
       },
-      "required": ["docId", "versionId", "type"]
+      "required": ["docId", "versionId"]
+    },
+    "docRefType": {
+      "description": "type of the element that this translation references",
+      "type": "string",
+      "enum": [
+        "type_unspecified",
+        "deviceInfo",
+        "preset",
+        "field",
+        "observation",
+        "projectSettings",
+        "role",
+        "track",
+        "UNRECOGNIZED"
+      ]
     },
     "propertyRef": {
       "type": "string",
@@ -47,6 +58,7 @@
   "required": [
     "schemaName",
     "docRef",
+    "docRefType",
     "propertyRef",
     "languageCode",
     "regionCode",

diff --git a/src/lib/decode-conversions.ts b/src/lib/decode-conversions.ts
@@ -245,7 +245,6 @@ export const convertTranslation: ConvertFunction<'translation'> = (
     docRef: {
       docId: message.docRef.docId.toString('hex'),
       versionId: getVersionId(message.docRef.versionId),
-      type: message.docRef.type,
     },
   }
 }

diff --git a/src/lib/encode-conversions.ts b/src/lib/encode-conversions.ts
@@ -207,7 +207,6 @@ export const convertTranslation: ConvertFunction<'translation'> = (
     docRef: {
       docId: Buffer.from(mapeoDoc.docRef.docId, 'hex'),
       versionId: parseVersionId(mapeoDoc.docRef.versionId),
-      type: mapeoDoc.docRef.type,
     },
   }
 }

diff --git a/test/fixtures/good-docs-completed.js b/test/fixtures/good-docs-completed.js
@@ -269,8 +269,8 @@ export const goodDocsCompleted = [
       docRef: {
         docId: cachedValues.refs.docId,
         versionId: cachedValues.refs.versionId,
-        type: 'preset',
       },
+      docRefType: 'preset',
       propertyRef: 'terms[0]',
       languageCode: 'es',
       regionCode: 'AR',

diff --git a/test/fixtures/good-docs-minimal.js b/test/fixtures/good-docs-minimal.js
@@ -174,8 +174,8 @@ export const goodDocsMinimal = [
       docRef: {
         docId: cachedValues.refs.docId,
         versionId: cachedValues.refs.versionId,
-        type: 'field',
       },
+      docRefType: 'field',
       propertyRef: 'label',
       languageCode: 'qu',
       regionCode: 'PE',