fix: allow table-row type to have both cells (#267)

contentful · Sep 15, 2021 · ec40598 · ec40598
1 parent 3800ad5
commit ec40598
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 188 deletions.
diff --git a/packages/rich-text-types/src/nodeTypes.ts b/packages/rich-text-types/src/nodeTypes.ts
@@ -157,38 +157,28 @@ export interface EntryHyperlink extends Inline {
 }
 
 export interface TableCell extends Block {
-  nodeType: BLOCKS.TABLE_CELL;
+  nodeType: BLOCKS.TABLE_HEADER_CELL | BLOCKS.TABLE_CELL;
   data: {
     colspan?: number;
     rowspan?: number;
   };
   content: Paragraph[];
 }
 
-export interface TableHeaderCell extends Block {
+export interface TableHeaderCell extends TableCell {
   nodeType: BLOCKS.TABLE_HEADER_CELL;
-  data: {
-    colspan?: number;
-    rowspan?: number;
-  };
-  content: Paragraph[];
 }
 
+// An abstract table row can have both table cell types
+
 export interface TableRow extends Block {
   nodeType: BLOCKS.TABLE_ROW;
   data: EmptyNodeData;
   content: TableCell[];
 }
 
-// A helper type to only allow all cells in a row to be header cells
-interface TableHeaderRow extends Block {
-  nodeType: BLOCKS.TABLE_ROW;
-  data: EmptyNodeData;
-  content: TableHeaderCell[];
-}
-
 export interface Table extends Block {
   nodeType: BLOCKS.TABLE;
   data: EmptyNodeData;
-  content: TableRow[] | [TableHeaderRow, ...Array<TableRow>];
+  content: TableRow[];
 }
diff --git a/packages/rich-text-types/src/schemaConstraints.ts b/packages/rich-text-types/src/schemaConstraints.ts
@@ -71,6 +71,13 @@ export const LIST_ITEM_BLOCKS: TopLevelBlockEnum[] = [
   BLOCKS.EMBEDDED_ASSET,
 ];
 
+export const TABLE_BLOCKS = [
+  BLOCKS.TABLE,
+  BLOCKS.TABLE_ROW,
+  BLOCKS.TABLE_CELL,
+  BLOCKS.TABLE_HEADER_CELL,
+];
+
 /**
  * Array of all void block types
  */
@@ -85,7 +92,7 @@ export const CONTAINERS = {
   [BLOCKS.LIST_ITEM]: LIST_ITEM_BLOCKS,
   [BLOCKS.QUOTE]: [BLOCKS.PARAGRAPH],
   [BLOCKS.TABLE]: [BLOCKS.TABLE_ROW],
-  [BLOCKS.TABLE_ROW]: [BLOCKS.TABLE_CELL],
+  [BLOCKS.TABLE_ROW]: [BLOCKS.TABLE_CELL, BLOCKS.TABLE_HEADER_CELL],
   [BLOCKS.TABLE_CELL]: [BLOCKS.PARAGRAPH],
   [BLOCKS.TABLE_HEADER_CELL]: [BLOCKS.PARAGRAPH],
 };
diff --git a/packages/rich-text-types/src/schemas/__test__/__snapshots__/schemas.test.ts.snap b/packages/rich-text-types/src/schemas/__test__/__snapshots__/schemas.test.ts.snap
@@ -2820,26 +2820,10 @@ Object {
       "additionalProperties": false,
       "properties": Object {
         "content": Object {
-          "anyOf": Array [
-            Object {
-              "items": Object {
-                "$ref": "#/definitions/TableRow",
-              },
-              "type": "array",
-            },
-            Object {
-              "additionalItems": Object {
-                "$ref": "#/definitions/TableRow",
-              },
-              "items": Array [
-                Object {
-                  "$ref": "#/definitions/TableHeaderRow",
-                },
-              ],
-              "minItems": 1,
-              "type": "array",
-            },
-          ],
+          "items": Object {
+            "$ref": "#/definitions/TableRow",
+          },
+          "type": "array",
         },
         "data": Object {
           "properties": Object {},
@@ -2883,40 +2867,6 @@ Object {
         "nodeType": Object {
           "enum": Array [
             "table-cell",
-          ],
-          "type": "string",
-        },
-      },
-      "required": Array [
-        "content",
-        "data",
-        "nodeType",
-      ],
-      "type": "object",
-    },
-    "TableHeaderCell": Object {
-      "additionalProperties": false,
-      "properties": Object {
-        "content": Object {
-          "items": Object {
-            "$ref": "#/definitions/Paragraph",
-          },
-          "type": "array",
-        },
-        "data": Object {
-          "additionalProperties": false,
-          "properties": Object {
-            "colspan": Object {
-              "type": "number",
-            },
-            "rowspan": Object {
-              "type": "number",
-            },
-          },
-          "type": "object",
-        },
-        "nodeType": Object {
-          "enum": Array [
             "table-header-cell",
           ],
           "type": "string",
@@ -2929,33 +2879,6 @@ Object {
       ],
       "type": "object",
     },
-    "TableHeaderRow": Object {
-      "additionalProperties": false,
-      "properties": Object {
-        "content": Object {
-          "items": Object {
-            "$ref": "#/definitions/TableHeaderCell",
-          },
-          "type": "array",
-        },
-        "data": Object {
-          "properties": Object {},
-          "type": "object",
-        },
-        "nodeType": Object {
-          "enum": Array [
-            "table-row",
-          ],
-          "type": "string",
-        },
-      },
-      "required": Array [
-        "content",
-        "data",
-        "nodeType",
-      ],
-      "type": "object",
-    },
     "TableRow": Object {
       "additionalProperties": false,
       "properties": Object {
@@ -3136,6 +3059,7 @@ Object {
         "nodeType": Object {
           "enum": Array [
             "table-cell",
+            "table-header-cell",
           ],
           "type": "string",
         },
@@ -3464,6 +3388,7 @@ Object {
         "nodeType": Object {
           "enum": Array [
             "table-cell",
+            "table-header-cell",
           ],
           "type": "string",
         },

diff --git a/packages/rich-text-types/src/schemas/generated/table-cell.json b/packages/rich-text-types/src/schemas/generated/table-cell.json
@@ -5,10 +5,11 @@
       "type": "object",
       "properties": {
         "nodeType": {
-          "type": "string",
           "enum": [
-            "table-cell"
-          ]
+            "table-cell",
+            "table-header-cell"
+          ],
+          "type": "string"
         },
         "data": {
           "type": "object",

diff --git a/packages/rich-text-types/src/schemas/generated/table-row.json b/packages/rich-text-types/src/schemas/generated/table-row.json
@@ -32,10 +32,11 @@
       "type": "object",
       "properties": {
         "nodeType": {
-          "type": "string",
           "enum": [
-            "table-cell"
-          ]
+            "table-cell",
+            "table-header-cell"
+          ],
+          "type": "string"
         },
         "data": {
           "type": "object",

diff --git a/packages/rich-text-types/src/schemas/generated/table.json b/packages/rich-text-types/src/schemas/generated/table.json
@@ -15,26 +15,10 @@
           "properties": {}
         },
         "content": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/TableRow"
-              }
-            },
-            {
-              "type": "array",
-              "items": [
-                {
-                  "$ref": "#/definitions/TableHeaderRow"
-                }
-              ],
-              "minItems": 1,
-              "additionalItems": {
-                "$ref": "#/definitions/TableRow"
-              }
-            }
-          ]
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TableRow"
+          }
         }
       },
       "additionalProperties": false,
@@ -75,10 +59,11 @@
       "type": "object",
       "properties": {
         "nodeType": {
-          "type": "string",
           "enum": [
-            "table-cell"
-          ]
+            "table-cell",
+            "table-header-cell"
+          ],
+          "type": "string"
         },
         "data": {
           "type": "object",
@@ -225,68 +210,6 @@
     "NodeData": {
       "additionalProperties": true,
       "type": "object"
-    },
-    "TableHeaderRow": {
-      "type": "object",
-      "properties": {
-        "nodeType": {
-          "type": "string",
-          "enum": [
-            "table-row"
-          ]
-        },
-        "data": {
-          "type": "object",
-          "properties": {}
-        },
-        "content": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/TableHeaderCell"
-          }
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "content",
-        "data",
-        "nodeType"
-      ]
-    },
-    "TableHeaderCell": {
-      "type": "object",
-      "properties": {
-        "nodeType": {
-          "type": "string",
-          "enum": [
-            "table-header-cell"
-          ]
-        },
-        "data": {
-          "type": "object",
-          "properties": {
-            "colspan": {
-              "type": "number"
-            },
-            "rowspan": {
-              "type": "number"
-            }
-          },
-          "additionalProperties": false
-        },
-        "content": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/Paragraph"
-          }
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "content",
-        "data",
-        "nodeType"
-      ]
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"