add ol and ul

Author: abrehamgezahegn

CLAUDE.md

@@ -123,4 +123,8 @@ The TypeScript implementation is in progress, following similar architecture to
 3. The core functionality is focused on:
    - Loading JSON-DOC files into typed objects
    - Validating JSON-DOC files against schemas
-   - Converting between JSON-DOC and other formats
+   - Converting between JSON-DOC and other formats
+
+
+# Code generation guidelines
+- don's assume things, if some things are clear, ask for clarification

python/jsondoc/convert/html.py

@@ -25,6 +25,8 @@
     create_h3_block,
     create_image_block,
     create_numbered_list_item_block,
+    create_unordered_list_block,
+    create_ordered_list_block,
     create_page,
     create_paragraph_block,
     create_quote_block,
@@ -756,15 +758,29 @@ def convert_img(self, el, convert_as_inline):
             )
         )
 
-    def convert_list(self, el, convert_as_inline):
+    def convert_ul(self, el, convert_as_inline):
         """
-        This is applied to <ul> and <ol> tags. We simply return None, because
-        there is no need for a container block for list items in JSON-DOC.
+        This is applied to <ul> tags. Create an unordered_list container block.
+        Children will be processed and added to this container.
         """
-        return None
+        if convert_as_inline:
+            return ConvertOutput(main_object=create_rich_text())
 
-    convert_ul = convert_list
-    convert_ol = convert_list
+        return ConvertOutput(
+            main_object=create_unordered_list_block(typeid=self.options.typeid)
+        )
+
+    def convert_ol(self, el, convert_as_inline):
+        """
+        This is applied to <ol> tags. Create an ordered_list container block.
+        Children will be processed and added to this container.
+        """
+        if convert_as_inline:
+            return ConvertOutput(main_object=create_rich_text())
+
+        return ConvertOutput(
+            main_object=create_ordered_list_block(typeid=self.options.typeid)
+        )
 
     def convert_li(self, el, convert_as_inline):
         parent = el.parent

python/jsondoc/convert/utils.py

@@ -31,6 +31,14 @@
     NumberedListItem,
     NumberedListItemBlock,
 )
+from jsondoc.models.block.types.unordered_list import (
+    UnorderedList,
+    UnorderedListBlock,
+)
+from jsondoc.models.block.types.ordered_list import (
+    OrderedList,
+    OrderedListBlock,
+)
 from jsondoc.models.block.types.paragraph import Paragraph, ParagraphBlock
 from jsondoc.models.block.types.quote import Quote, QuoteBlock
 from jsondoc.models.block.types.rich_text.base import RichTextBase
@@ -205,6 +213,46 @@ def create_numbered_list_item_block(
     )
 
 
+def create_unordered_list_block(
+    children: List[BlockBase] | None = None,
+    id: str | None = None,
+    created_time=None,
+    typeid: bool = False,
+) -> UnorderedListBlock:
+    if id is None:
+        id = generate_block_id(typeid=typeid)
+    if created_time is None:
+        created_time = get_current_time()
+
+    return UnorderedListBlock(
+        id=id,
+        created_time=created_time,
+        unordered_list=UnorderedList(),
+        has_children=children is not None and len(children) > 0,
+        children=children or [],
+    )
+
+
+def create_ordered_list_block(
+    children: List[BlockBase] | None = None,
+    id: str | None = None,
+    created_time=None,
+    typeid: bool = False,
+) -> OrderedListBlock:
+    if id is None:
+        id = generate_block_id(typeid=typeid)
+    if created_time is None:
+        created_time = get_current_time()
+
+    return OrderedListBlock(
+        id=id,
+        created_time=created_time,
+        ordered_list=OrderedList(),
+        has_children=children is not None and len(children) > 0,
+        children=children or [],
+    )
+
+
 def create_code_block(
     code: str | None = None,
     language: str | None = None,

python/jsondoc/models/block/types/ordered_list/__init__.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  ordered_list_schema.json
+#   timestamp: 2024-12-19T10:00:00+00:00
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Literal
+
+from jsondoc.models.block.base import BlockBase
+
+
+class OrderedList(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        arbitrary_types_allowed=True,
+    )
+
+
+class OrderedListBlock(BlockBase):
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+    )
+    type: Literal["ordered_list"] = "ordered_list"
+    ordered_list: OrderedList
+    children: Optional[List[BlockBase]] = None

python/jsondoc/models/block/types/unordered_list/__init__.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  unordered_list_schema.json
+#   timestamp: 2024-12-19T10:00:00+00:00
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Literal
+
+from jsondoc.models.block.base import BlockBase
+
+
+class UnorderedList(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        arbitrary_types_allowed=True,
+    )
+
+
+class UnorderedListBlock(BlockBase):
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+    )
+    type: Literal["unordered_list"] = "unordered_list"
+    unordered_list: UnorderedList
+    children: Optional[List[BlockBase]] = None

python/jsondoc/rules.py

@@ -11,6 +11,8 @@
 from jsondoc.models.block.types.heading_3 import Heading3Block
 from jsondoc.models.block.types.image import ImageBlock
 from jsondoc.models.block.types.numbered_list_item import NumberedListItemBlock
+from jsondoc.models.block.types.unordered_list import UnorderedListBlock
+from jsondoc.models.block.types.ordered_list import OrderedListBlock
 from jsondoc.models.block.types.paragraph import ParagraphBlock
 from jsondoc.models.block.types.quote import QuoteBlock
 from jsondoc.models.block.types.table import TableBlock
@@ -33,6 +35,8 @@
     Heading3Block,
     ImageBlock,
     NumberedListItemBlock,
+    UnorderedListBlock,
+    OrderedListBlock,
     ParagraphBlock,
     QuoteBlock,
     TableBlock,
@@ -53,6 +57,8 @@
     Heading3Block: [],
     ImageBlock: [],
     NumberedListItemBlock: ALL_BLOCK_TYPES,
+    UnorderedListBlock: [BulletedListItemBlock],
+    OrderedListBlock: [NumberedListItemBlock],
     ParagraphBlock: ALL_BLOCK_TYPES,
     QuoteBlock: ALL_BLOCK_TYPES,
     TableBlock: [TableRowBlock],

schema/block/block_schema.json

@@ -12,6 +12,8 @@
         "to_do",
         "bulleted_list_item",
         "numbered_list_item",
+        "unordered_list",
+        "ordered_list",
         "code",
         "column",
         "column_list",
@@ -87,6 +89,38 @@
         "unevaluatedProperties": false
       }
     },
+    {
+      "if": {
+        "properties": { "type": { "const": "unordered_list" } }
+      },
+      "then": {
+        "properties": {
+          "type": { "const": "unordered_list" }
+        },
+        "allOf": [
+          {
+            "$ref": "/block/types/unordered_list/unordered_list_schema.json"
+          }
+        ],
+        "unevaluatedProperties": false
+      }
+    },
+    {
+      "if": {
+        "properties": { "type": { "const": "ordered_list" } }
+      },
+      "then": {
+        "properties": {
+          "type": { "const": "ordered_list" }
+        },
+        "allOf": [
+          {
+            "$ref": "/block/types/ordered_list/ordered_list_schema.json"
+          }
+        ],
+        "unevaluatedProperties": false
+      }
+    },
     {
       "if": {
         "properties": { "type": { "const": "code" } }

schema/block/types/ordered_list/ordered_list_schema.json

@@ -0,0 +1,28 @@
+// Ordered list container block
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "OrderedListBlock",
+  "customBasePath": "jsondoc.models.block.base.BlockBase",
+  "type": "object",
+  "allOf": [{ "$ref": "/block/base/base_schema.json" }],
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "ordered_list",
+      "default": "ordered_list"
+    },
+    "ordered_list": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "/block/block_schema.json"
+      }
+    }
+  },
+  "required": ["type", "ordered_list"],
+  "unevaluatedProperties": false
+}

schema/block/types/unordered_list/unordered_list_schema.json

@@ -0,0 +1,28 @@
+// Unordered list container block
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "UnorderedListBlock",
+  "customBasePath": "jsondoc.models.block.base.BlockBase",
+  "type": "object",
+  "allOf": [{ "$ref": "/block/base/base_schema.json" }],
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "unordered_list",
+      "default": "unordered_list"
+    },
+    "unordered_list": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "/block/block_schema.json"
+      }
+    }
+  },
+  "required": ["type", "unordered_list"],
+  "unevaluatedProperties": false
+}