howler-api 4.0.0.dev1176__tar.gz → 4.0.0.dev1182__tar.gz

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.0.0.dev1176
+Version: 4.0.0.dev1182
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/actions/add_to_bundle.py

@@ -6,6 +6,7 @@ from howler.actions import check_hit_limit
 from howler.common.exceptions import NotFoundException
 from howler.common.loader import datastore
 from howler.odm.models.action import VALID_TRIGGERS
+from howler.odm.models.case import CaseItemTypes
 from howler.odm.models.user import User
 from howler.services import bundle_compat_service, case_service
 from howler.utils.str_utils import sanitize_lucene_query
@@ -36,8 +37,8 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
         ]
 
     try:
-        case_id = bundle_compat_service.find_case_for_bundle(bundle_id)
-        if case_id is None:
+        case = bundle_compat_service.find_case_for_bundle(bundle_id)
+        if case is None:
             report.append(
                 {
                     "query": query,
@@ -69,16 +70,19 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
             )
             return report
 
+        folder = case_service.get_parent_from_path(case, "hits", create_if_missing=True)
+
         added = []
         skipped = []
         for hit in matching_hits:
-            child_label = f"hits/{hit.howler.analytic} ({hit.howler.id})"
+            name = f"{hit.howler.analytic} ({hit.howler.id})"
             try:
                 case_service.append_case_item(
-                    case_id,
-                    item_type="hit",
+                    case,
+                    item_type=CaseItemTypes.HIT,
+                    item_name=name,
                     item_value=hit.howler.id,
-                    item_path=child_label,
+                    item_parent=folder.id if folder else None,
                 )
                 added.append(hit.howler.id)
             except Exception:

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/actions/add_to_case.py

@@ -10,7 +10,7 @@ from howler.services import case_service
 OPERATION_ID = "add_to_case"
 
 
-def execute(
+def execute(  # noqa: C901
     query: str,
     case_id: Optional[str] = None,
     path: str = "related",
@@ -24,7 +24,7 @@ def execute(
         case_id (str): The ID of the case to add the alerts to.
         path (str): The path within the case at which to place the alerts. Defaults to "related".
         title_template (str): A Mustache-compatible template string used to generate each item's
-            path suffix (title). The hit's fields are available as template variables.
+            name. The hit's fields are available as template variables.
             Defaults to "{{howler.analytic}} ({{howler.id}})".
     """
     if not case_id:
@@ -39,7 +39,8 @@ def execute(
 
     ds = datastore()
 
-    if ds.case.get(case_id) is None:
+    case = ds.case.get(case_id)
+    if case is None:
         return [
             {
                 "query": query,
@@ -65,19 +66,23 @@ def execute(
     skipped = []
     added = []
 
-    normalized_path = path.rstrip("/")
-
     for hit in hits:
-        hit_data = hit.as_primitives()
-        title = chevron.render(title_template, hit_data)
-        item_path = f"{normalized_path}/{title}" if normalized_path else title
+        title = chevron.render(title_template, hit.as_primitives())
+        item_path = f"{path.rstrip('/')}/{title}" if path else title
+        try:
+            path, name = item_path.rsplit("/", maxsplit=1)
+        except ValueError:
+            name = item_path
 
         try:
+            parent = case_service.get_parent_from_path(case, path, create_if_missing=True)
+
             case_service.append_case_item(
-                case_id,
+                case,
                 item_type="hit",
                 item_value=hit.howler.id,
-                item_path=item_path,
+                item_name=name,
+                item_parent=parent.id if parent else None,
             )
             added.append(hit.howler.id)
         except InvalidDataException as e:

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/actions/remove_from_bundle.py

@@ -36,8 +36,8 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
         ]
 
     try:
-        case_id = bundle_compat_service.find_case_for_bundle(bundle_id)
-        if case_id is None:
+        case = bundle_compat_service.find_case_for_bundle(bundle_id)
+        if case is None:
             report.append(
                 {
                     "query": query,
@@ -69,19 +69,20 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
             )
             return report
 
-        # Get the case to check which hits are actually in it
-        case = ds.case.get(case_id)
-        if case is None:
+        # Refresh case from datastore to ensure latest state
+        refreshed_case = ds.case.get(case.case_id)
+        if refreshed_case is None:
             report.append(
                 {
                     "query": query,
                     "outcome": "error",
                     "title": "Case Not Found",
-                    "message": f"Associated case {case_id} no longer exists.",
+                    "message": f"Associated case {case.case_id} no longer exists.",
                 }
             )
             return report
 
+        case = refreshed_case
         case_item_values = {item.value for item in case.items}
         values_to_remove = [h.howler.id for h in matching_hits if h.howler.id in case_item_values]
         skipped_ids = [h.howler.id for h in matching_hits if h.howler.id not in case_item_values]
@@ -107,7 +108,10 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
             )
             return report
 
-        case_service.remove_case_items(case_id, values_to_remove)
+        # remove_case_items expects item UUIDs (CaseItem.id), not hit value strings.
+        value_set = set(values_to_remove)
+        item_ids_to_remove = [item.id for item in case.items if item.value in value_set]
+        case_service.remove_case_items(case, item_ids_to_remove)
 
         report.append(
             {

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/api/v2/case.py

@@ -7,7 +7,7 @@ from howler.common.loader import datastore
 from howler.common.logging import get_logger
 from howler.common.swagger import generate_swagger_docs
 from howler.datastore.exceptions import DataStoreException
-from howler.odm.models.case import CaseItem
+from howler.odm.models.case import Case, CaseItem
 from howler.odm.models.user import User
 from howler.security import api_login
 from howler.services import case_service
@@ -221,9 +221,10 @@ def append_item(id: str, user: User, **kwargs):  # noqa: C901
 
     Data Block:
     {
-        "type": "hit",            # Type of item to append: "hit", "event", "case", "table", "lead", or "reference"
-        "value": "item-id-123"    # The ID or reference value for the item,
-        "path": "example/path/Title"
+        "type": "hit",                  # Type of item: hit, event, case, folder, markdown, reference, table, or lead
+        "value": "item-id-123",         # The ID or reference value for the item
+        "parent": "folder-uuid"         # Optional: parent folder item ID (null for root)
+        "path": "example/path/Title"    # Optional: path to create the item at (will ensure path exists)
     }
 
     Result Example:
@@ -236,15 +237,25 @@ def append_item(id: str, user: User, **kwargs):  # noqa: C901
     except UnsupportedMediaType:
         return bad_request(err="Invalid JSON body")
 
-    for field in ["value", "type", "path"]:
+    if not body or not isinstance(body, dict):
+        return bad_request(err="Request body must be a JSON object.")
+
+    for field in ["value", "type", "name"]:
         if field not in body:
             return bad_request(err=f"CaseItem '{field}' is required")
 
     try:
+        if path := body.pop("path", None):
+            parent = case_service.get_parent_from_path(id, path)
+
+            body["parent"] = parent.id if parent else None
+
         return ok(case_service.append_case_item(id, item=CaseItem(body)))
     except DataStoreException as e:
         logger.exception("Save Error")
         return internal_error(err=str(e))
+    except NotFoundException as e:
+        return not_found(err=str(e))
     except InvalidDataException as e:
         return bad_request(err=str(e))
 
@@ -267,7 +278,8 @@ def delete_item(case_id: str, **kwargs):
 
     Data Block:
     {
-        "values": ["item-id-123", "item-id-456"]   # The values of the items to delete
+        "ids": ["uuid-1", "uuid-2"],   # The UUIDs of the items to delete
+        "force": false                 # Optional: force-delete non-empty folders
     }
 
     Result Example:
@@ -277,15 +289,21 @@ def delete_item(case_id: str, **kwargs):
     """
     body = request.json
 
-    if not body or not isinstance(body, dict) or "values" not in body:
-        return bad_request(err="Request body must be a JSON object with a 'values' field.")
+    if not body or not isinstance(body, dict):
+        return bad_request(err="Request body must be a JSON object.")
 
-    values = body["values"]
-    if not isinstance(values, list) or not values:
-        return bad_request(err="'values' must be a non-empty list.")
+    force = body.get("force", False)
+    if not isinstance(force, bool):
+        return bad_request(err="'force' must be a boolean.")
+
+    ids = body.get("ids")
+    if not ids or not isinstance(ids, list):
+        return bad_request(err="'ids' must be a non-empty list.")
+    elif not all(isinstance(item_id, str) for item_id in ids):
+        return bad_request(err="All items in 'ids' must be strings.")
 
     try:
-        return ok(case_service.remove_case_items(case_id, values))
+        return ok(case_service.remove_case_items(case_id, ids, force=force))
     except DataStoreException as e:
         logger.exception("Save Error")
         return internal_error(err=str(e))
@@ -297,10 +315,9 @@ def delete_item(case_id: str, **kwargs):
 @case_api.route("/<case_id>/items", methods=["PUT"])
 @api_login(required_priv=["R", "W"])
 def rename_item(case_id: str, **kwargs):
-    """Rename (re-path) an item within a case
+    """Move an item within a case
 
-    Updates the path of a single item identified by its value. The new path must
-    not already be used by another item in the case.
+    Updates the parent of a single item identified by its id.
 
     Variables:
     case_id       => The id of the case to modify
@@ -310,8 +327,9 @@ def rename_item(case_id: str, **kwargs):
 
     Data Block:
     {
-        "value": "item-id-123",          # The value of the item to rename
-        "new_path": "folder/New Name"    # The new path for the item
+        "id": "uuid-of-item",       # The UUID of the item to update
+        "parent": "uuid-or-null",   # Move: the UUID of the target folder, or null for root
+        "name": "Display Name"      # Rename: the new display name for the item
     }
 
     Result Example:
@@ -324,12 +342,22 @@ def rename_item(case_id: str, **kwargs):
     if not body or not isinstance(body, dict):
         return bad_request(err="Request body must be a JSON object.")
 
-    for field in ["value", "new_path"]:
-        if field not in body:
-            return bad_request(err=f"'{field}' is required.")
+    if "id" not in body:
+        return bad_request(err="'id' is required.")
 
+    item_id = body["id"]
     try:
-        return ok(case_service.rename_case_item(case_id, item_value=body["value"], new_path=body["new_path"]))
+        result: Case | None = None
+        if "name" in body:
+            result = case_service.rename_case_item(case_id, item_id, body["name"])
+
+        if "parent" in body:
+            result = case_service.move_case_item(case_id, item_id, body["parent"])
+
+        if not result:
+            return bad_request(err="At least one of 'name' or 'parent' is required.")
+
+        return ok(result)
     except DataStoreException as e:
         logger.exception("Save Error")
         return internal_error(err=str(e))

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/datastore/collection.py

@@ -836,11 +836,11 @@ class ESCollection(Generic[ModelType]):
                     alias_actions.append({"remove_index": {"index": new_name}})
                     self.with_retries(self.datastore.client.indices.update_aliases, actions=alias_actions)
 
-                    if self.with_retries(self.datastore.client.indices.exists, index=new_name):
+                    if bool(self.with_retries(self.datastore.client.indices.exists, index=new_name)):
                         logger.warning("Deleting reindex target %s", new_name)
                         self.with_retries(self.datastore.client.indices.delete, index=new_name)
                 finally:
-                    if self.with_retries(self.datastore.client.indices.exists, index=index):
+                    if bool(self.with_retries(self.datastore.client.indices.exists, index=index)):
                         logger.warning("Unblock writes to the index")
                         self.with_retries(
                             self.datastore.client.indices.put_settings,
@@ -848,7 +848,7 @@ class ESCollection(Generic[ModelType]):
                             settings=write_unblock_settings,
                         )
             except Exception:
-                if source_writes_blocked and self.with_retries(self.datastore.client.indices.exists, index=index):
+                if source_writes_blocked and bool(self.with_retries(self.datastore.client.indices.exists, index=index)):
                     logger.warning("Unblock writes to source index %s after failed reindex", index)
                     self.with_retries(
                         self.datastore.client.indices.put_settings,
@@ -1233,7 +1233,7 @@ class ESCollection(Generic[ModelType]):
             return self.normalize(data, as_obj=as_obj), version
         return self.normalize(data, as_obj=as_obj)
 
-    def save(self, key, data, version=None, refresh=None):
+    def save(self, key, data, version=None, refresh: Literal["true", "false", "wait_for"] | None = None):
         """Save to document to the datastore using the key as its document id.
 
         The document data will be normalized before being saved in the datastore.
@@ -1241,6 +1241,9 @@ class ESCollection(Generic[ModelType]):
         :param key: ID of the document to save
         :param data: raw data or instance of the model class to save as the document
         :param version: version of the document to save over, if the version check fails this will raise an exception
+        :param refresh: 'true' | 'false' | 'wait_for' | None
+             Whether to refresh the datastore before returning. 'wait_for' will wait for the change to be visible
+             in search.
         :return: True if the document was saved properly
         """
         if " " in key:

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/odm/mixins.py

@@ -9,7 +9,7 @@ Elasticsearch datastore without boilerplate.
 from __future__ import annotations
 
 from operator import attrgetter
-from typing import Generic, TypeVar, overload
+from typing import Generic, Literal, TypeVar, overload
 
 from howler.common.exceptions import HowlerRuntimeError
 from howler.common.loader import datastore
@@ -82,7 +82,7 @@ class DatastoreMixin(Generic[ModelType]):
         """
         return datastore()
 
-    def save(self) -> bool:
+    def save(self, refresh: Literal["true", "false", "wait_for"] = "wait_for") -> bool:
         """Persist the current model instance to the datastore.
 
         Determines the target index from the lowercase class name, extracts the
@@ -94,4 +94,4 @@ class DatastoreMixin(Generic[ModelType]):
         id_field = self.__class__._Model__id_field  # type: ignore[attr-defined]
         current_id = attrgetter(id_field)(self)
 
-        return self.ds[index_name].save(current_id, self)
+        return self.ds[index_name].save(current_id, self, refresh=refresh)

{howler_api-4.0.0.dev1176 → howler_api-4.0.0.dev1182}/howler/odm/models/case.py

@@ -7,7 +7,7 @@ from howler.odm.constants import CaseEscalation, Status
 from howler.odm.mixins import DatastoreMixin
 from howler.utils.compat import StrEnum
 
-CASE_ITEM_TYPES = {"event", "hit", "case", "lead", "reference"}
+CASE_ITEM_TYPES = {"event", "hit", "case", "lead", "reference", "folder", "markdown"}
 
 RULE_INDEX_TYPES = {"hit", "event"}
 
@@ -43,6 +43,8 @@ class CaseItemTypes(StrEnum):
             validation by analysts.
         REFERENCE: An external reference such as a URL, document, or resource that
             provides additional context or evidence.
+        FOLDER: An organizational folder for grouping case items hierarchically.
+        MARKDOWN: A markdown document whose value contains the markdown content directly.
     """
 
     EVENT = "event"
@@ -51,6 +53,8 @@ class CaseItemTypes(StrEnum):
     CASE = "case"
     LEAD = "lead"
     REFERENCE = "reference"
+    FOLDER = "folder"
+    MARKDOWN = "markdown"
 
 
 @odm.model(index=True, store=True, description="Log definition.")
@@ -73,11 +77,19 @@ class CaseLog(odm.Model):
         super().__init__(data, *args, **kwargs)
 
 
-@odm.model(index=True, store=True, description="A path-scoped item included in a case.")
+@odm.model(index=True, store=True, description="An item included in a case.")
 class CaseItem(odm.Model):
-    path: str = odm.Keyword(description="Path of the item in the case hierarchy.", default="")
+    id: str = odm.UUID(description="Unique identifier for this item.")
+    parent: Optional[str] = odm.Optional(
+        odm.Keyword(description="ID of the parent folder item, or null for root-level items."),
+        default=None,
+    )
+    name: Optional[str] = odm.Optional(
+        odm.Keyword(description="Display name for the item. Optional; the UI falls back to value when absent."),
+        default=None,
+    )
     type: str = odm.Enum(values=CaseItemTypes, description="Type of case item.")
-    value: str = odm.Keyword(description="String reference value for the item (ID, URL, or token).")
+    value: str = odm.Keyword(description="String reference value for the item (ID, URL, or token), or markdown.")
     visible: bool = odm.Boolean(default=True, description="Whether the item is visible/accessible in the frontend.")
     classification: Optional[str] = odm.Optional(
         odm.Classification(
@@ -88,6 +100,17 @@ class CaseItem(odm.Model):
         )
     )
 
+    def __init__(self, data: dict = None, *args, **kwargs):
+        # Enforce: case items must be root-level (parent=null).
+        if data and data.get("type") == CaseItemTypes.CASE and data.get("parent") is not None:
+            raise HowlerValueError("Case items must be root-level (parent must be null)")
+
+        # Set value equal to name for folder items
+        if data and data.get("type") == CaseItemTypes.FOLDER:
+            data["value"] = data.get("name")
+
+        super().__init__(data, *args, **kwargs)
+
 
 @odm.model(index=True, store=True, description="Rule used to place/query data into case paths.")
 class CaseRule(odm.Model):
@@ -131,7 +154,7 @@ class CaseTask(odm.Model):
     complete: bool = odm.Boolean(default=False, description="Whether the task is complete.")
     assignment: str | None = odm.Keyword(description="Assigned discipline or user ID.", optional=True)
     summary: str = odm.Text(description="Task summary.")
-    path: str = odm.Keyword(description="Associated case item path.", optional=True)
+    item: str = odm.Keyword(description="Associated case item id.", optional=True)
 
 
 @odm.model(index=True, store=True, description="Enrichment annotations associated with a case path.")