🔨 enum validation abstraction

owid · Oct 30, 2023 · e48b3e3 · e48b3e3
1 parent 65df8e9
commit e48b3e3
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 22 deletions.
diff --git a/db/model/Gdoc/rawToEnriched.ts b/db/model/Gdoc/rawToEnriched.ts
@@ -105,6 +105,8 @@ import {
     TableTemplate,
     TableSize,
     EnrichedBlockTableCell,
+    tableSizes,
+    tableTemplates,
 } from "@ourworldindata/utils"
 import { checkIsInternalLink } from "@ourworldindata/components"
 import {
@@ -797,6 +799,13 @@ const parseRecirc = (raw: RawBlockRecirc): EnrichedBlockRecirc => {
     }
 }
 
+function validateRawEnum<T extends string>(
+    validValues: ReadonlyArray<T>,
+    value: unknown
+): value is T {
+    return typeof value === "string" && validValues.includes(value as T)
+}
+
 export const parseTable = (raw: RawBlockTable): EnrichedBlockTable => {
     const createError = (
         error: ParseError,
@@ -813,33 +822,18 @@ export const parseTable = (raw: RawBlockTable): EnrichedBlockTable => {
 
     const parseErrors: ParseError[] = []
 
-    const validTemplates: TableTemplate[] = [
-        "header-row",
-        "header-column",
-        "header-column-row",
-    ]
-    function validateTableTemplate(
-        template: unknown
-    ): template is TableTemplate {
-        return validTemplates.includes(template as TableTemplate)
-    }
-
-    const template = raw.value?.template
-    if (!validateTableTemplate(template))
+    const template = raw.value?.template || "header-row"
+    if (!validateRawEnum(tableTemplates, template))
         return createError({
-            message: `Invalid table template "${template}". Must be one of ${validTemplates.join(
+            message: `Invalid table template "${template}". Must be one of ${tableTemplates.join(
                 ", "
             )}`,
         })
 
-    const validSizes: TableSize[] = ["narrow", "wide"]
-    function validateTableSize(size: unknown): size is TableSize {
-        return validSizes.includes(size as TableSize)
-    }
     const size = raw.value?.size || "narrow"
-    if (!validateTableSize(size))
+    if (!validateRawEnum(tableSizes, size))
         return createError({
-            message: `Invalid table size "${size}". Must be one of ${validSizes.join(
+            message: `Invalid table size "${size}". Must be one of ${tableSizes.join(
                 ", "
             )}`,
         })

diff --git a/packages/@ourworldindata/utils/src/index.ts b/packages/@ourworldindata/utils/src/index.ts
@@ -156,7 +156,9 @@ export {
     type RawBlockText,
     type RawBlockTopicPageIntro,
     type RawBlockUrl,
+    tableTemplates,
     type TableTemplate,
+    tableSizes,
     type TableSize,
     type RawBlockTable,
     type RawBlockTableRow,

diff --git a/packages/@ourworldindata/utils/src/owidTypes.ts b/packages/@ourworldindata/utils/src/owidTypes.ts
@@ -1138,9 +1138,17 @@ export type EnrichedBlockEntrySummary = {
     items: EnrichedBlockEntrySummaryItem[]
 } & EnrichedBlockWithParseErrors
 
-export type TableTemplate = "header-column" | "header-row" | "header-column-row"
+export const tableTemplates = [
+    "header-column",
+    "header-row",
+    "header-column-row",
+] as const
+
+export type TableTemplate = (typeof tableTemplates)[number]
+
+export const tableSizes = ["narrow", "wide"] as const
 
-export type TableSize = "narrow" | "wide"
+export type TableSize = (typeof tableSizes)[number]
 
 export type RawBlockTable = {
     type: "table"