hap-cli 0.5.0__py3-none-any.whl

hap_cli/core/group.py

@@ -0,0 +1,99 @@
+"""Group management for MingDAO HAP."""
+
+from typing import Any, Optional
+
+from hap_cli.core.session import Session
+
+
+def get_groups(
+    session: Session,
+    project_id: str,
+    page_index: int = 1,
+    page_size: int = 50,
+) -> dict[str, Any]:
+    """Get group list."""
+    return session.api_call(
+        "Group", "GetGroups",
+        {"projectId": project_id, "pageIndex": page_index, "pageSize": page_size},
+    )
+
+
+def get_group_info(
+    session: Session,
+    group_id: str,
+) -> dict[str, Any]:
+    """Get group information."""
+    return session.api_call("Group", "GetGroupInfo", {"groupId": group_id})
+
+
+def add_group(
+    session: Session,
+    project_id: str,
+    group_name: str,
+    about: str = "",
+    member_ids: Optional[list[str]] = None,
+) -> dict[str, Any]:
+    """Create a new group."""
+    data: dict[str, Any] = {"projectId": project_id, "groupName": group_name}
+    if about:
+        data["about"] = about
+    if member_ids:
+        data["memberIds"] = member_ids
+    return session.api_call("Group", "AddGroup", data)
+
+
+def remove_group(
+    session: Session,
+    group_id: str,
+) -> dict[str, Any]:
+    """Delete/disband a group."""
+    return session.api_call("Group", "RemoveGroup", {"groupId": group_id})
+
+
+def get_group_users(
+    session: Session,
+    group_id: str,
+    page_index: int = 1,
+    page_size: int = 50,
+) -> dict[str, Any]:
+    """Get members of a group."""
+    return session.api_call(
+        "Group", "GetGroupUsers",
+        {"groupId": group_id, "pageIndex": page_index, "pageSize": page_size},
+    )
+
+
+def remove_user(
+    session: Session,
+    group_id: str,
+    account_id: str,
+) -> dict[str, Any]:
+    """Remove a user from a group."""
+    return session.api_call(
+        "Group", "RemoveUser",
+        {"groupId": group_id, "accountId": account_id},
+    )
+
+
+def update_group_name(
+    session: Session,
+    group_id: str,
+    group_name: str,
+) -> dict[str, Any]:
+    """Update group name."""
+    return session.api_call(
+        "Group", "UpdateGroupName",
+        {"groupId": group_id, "groupName": group_name},
+    )
+
+
+def update_group_about(
+    session: Session,
+    group_id: str,
+    about: str,
+) -> dict[str, Any]:
+    """Update group about/announcement."""
+    return session.api_call(
+        "Group", "UpdateGroupAbout",
+        {"groupId": group_id, "about": about},
+    )

hap_cli/core/instance.py

@@ -0,0 +1,572 @@
+"""Workflow instance and approval management for MingDAO HAP.
+
+Covers: todo lists, instance details, approval operations (pass/reject/forward/sign),
+execution history, batch operations, and instance lifecycle.
+"""
+
+from typing import Any, Optional
+
+from hap_cli.core.session import Session
+
+
+# ── Instance Query ───────────────────────────────────────────────────────
+
+
+def get_todo_count(session: Session) -> dict[str, Any]:
+    """Get count of pending workflow tasks.
+
+    Returns:
+        Counts by type (pending approval, pending fill, pending view)
+    """
+    return session.workflow_call("v1/instance/getTodoCount", {})
+
+
+def get_todo_list(
+    session: Session,
+    page_index: int = 1,
+    page_size: int = 50,
+    type_: int = -1,
+    status: int = 0,
+    keyword: str = "",
+    process_id: str = "",
+    start_app_id: str = "",
+    start_date: str = "",
+    end_date: str = "",
+    apk_id: str = "",
+) -> dict[str, Any]:
+    """Get pending task list.
+
+    Args:
+        session: Active session
+        page_index: Page number
+        page_size: Items per page
+        type_: Task type (-1=all pending, 0=initiated, 3=fill, 4=approval, 5=view)
+        status: Status filter
+        keyword: Search keyword
+        process_id: Filter by process
+        start_app_id: Filter by source app
+        start_date: Start date filter (YYYY-MM-DD)
+        end_date: End date filter (YYYY-MM-DD)
+        apk_id: Filter by app
+
+    Returns:
+        Dict with task list and count
+    """
+    data: dict[str, Any] = {
+        "pageIndex": page_index,
+        "pageSize": page_size,
+        "type": type_,
+    }
+    if status:
+        data["status"] = status
+    if keyword:
+        data["keyword"] = keyword
+    if process_id:
+        data["processId"] = process_id
+    if start_app_id:
+        data["startAppId"] = start_app_id
+    if start_date:
+        data["startDate"] = start_date
+    if end_date:
+        data["endDate"] = end_date
+    if apk_id:
+        data["apkId"] = apk_id
+    result = session.workflow_call("v1/instance/getTodoList", data)
+    if isinstance(result, dict):
+        return {
+            "data": result.get("data", result.get("list", [])),
+            "count": result.get("count", result.get("total", 0)),
+        }
+    return {"data": result, "count": len(result)}
+
+
+def get_instance(session: Session, instance_id: str) -> dict[str, Any]:
+    """Get instance basic info.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+
+    Returns:
+        Instance detail
+    """
+    return session.workflow_call(
+        "instance/getInstance", {"instanceId": instance_id}
+    )
+
+
+def get_instance_detail(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Get instance flow detail (v2).
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Instance flow detail with node statuses
+    """
+    data: dict[str, Any] = {"id": instance_id}
+    if work_id:
+        data["workId"] = work_id
+    return session.workflow_call("v2/instance/get", data)
+
+
+def get_operation_detail(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Get available operations for a task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Operation options (approve, reject, etc.)
+    """
+    data: dict[str, Any] = {"id": instance_id}
+    if work_id:
+        data["workId"] = work_id
+    return session.workflow_call("instance/getOperationDetail", data)
+
+
+def get_operation_history(
+    session: Session,
+    instance_id: str,
+) -> list[dict[str, Any]]:
+    """Get operation history of an instance.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+
+    Returns:
+        List of operation records
+    """
+    result = session.workflow_call(
+        "instance/getOperationHistoryList",
+        {"instanceId": instance_id},
+    )
+    return result if isinstance(result, list) else result.get("list", [])
+
+
+# ── Approval Operations ─────────────────────────────────────────────────
+
+
+def _build_action_data(
+    instance_id: str,
+    work_id: str = "",
+    opinion: str = "",
+    back_node_id: str = "",
+    form_data: Optional[dict] = None,
+    signature: Optional[dict] = None,
+) -> dict[str, Any]:
+    """Build common approval action parameters."""
+    data: dict[str, Any] = {"id": instance_id}
+    if work_id:
+        data["workId"] = work_id
+    if opinion:
+        data["opinion"] = opinion
+    if back_node_id:
+        data["backNodeId"] = back_node_id
+    if form_data:
+        data["formData"] = form_data
+    if signature:
+        data["signature"] = signature
+    return data
+
+
+def approve(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+    opinion: str = "",
+    form_data: Optional[dict] = None,
+    signature: Optional[dict] = None,
+) -> dict[str, Any]:
+    """Approve/pass a workflow task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+        opinion: Approval comment
+        form_data: Form data updates
+        signature: Signature data
+
+    Returns:
+        Approval result
+    """
+    data = _build_action_data(instance_id, work_id, opinion, form_data=form_data, signature=signature)
+    return session.workflow_call("instance/pass", data)
+
+
+def reject(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+    opinion: str = "",
+    back_node_id: str = "",
+    form_data: Optional[dict] = None,
+    signature: Optional[dict] = None,
+) -> dict[str, Any]:
+    """Reject/overrule a workflow task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+        opinion: Rejection reason
+        back_node_id: Node ID to return to (for resubmission)
+        form_data: Form data updates
+        signature: Signature data
+
+    Returns:
+        Rejection result
+    """
+    data = _build_action_data(instance_id, work_id, opinion, back_node_id, form_data, signature)
+    return session.workflow_call("instance/overrule", data)
+
+
+def forward(
+    session: Session,
+    instance_id: str,
+    forward_account_id: str,
+    work_id: str = "",
+    opinion: str = "",
+) -> dict[str, Any]:
+    """Forward/transfer a task to another user.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        forward_account_id: Target user account ID
+        work_id: Work item ID
+        opinion: Forward comment
+
+    Returns:
+        Forward result
+    """
+    data = _build_action_data(instance_id, work_id, opinion)
+    data["forwardAccountId"] = forward_account_id
+    return session.workflow_call("instance/forward", data)
+
+
+def sign_task(
+    session: Session,
+    instance_id: str,
+    forward_account_id: str,
+    before: bool = True,
+    work_id: str = "",
+    opinion: str = "",
+) -> dict[str, Any]:
+    """Add a co-signer to a task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        forward_account_id: Co-signer user ID
+        before: True=sign before current user, False=sign after
+        work_id: Work item ID
+        opinion: Comment
+
+    Returns:
+        Sign result
+    """
+    data = _build_action_data(instance_id, work_id, opinion)
+    data["forwardAccountId"] = forward_account_id
+    data["before"] = before
+    return session.workflow_call("instance/sign", data)
+
+
+def submit(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+    opinion: str = "",
+    form_data: Optional[dict] = None,
+) -> dict[str, Any]:
+    """Submit a fill-in task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+        opinion: Submit comment
+        form_data: Form data
+
+    Returns:
+        Submit result
+    """
+    data = _build_action_data(instance_id, work_id, opinion, form_data=form_data)
+    return session.workflow_call("instance/submit", data)
+
+
+def revoke(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Revoke/withdraw a submitted instance (by initiator).
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Revoke result
+    """
+    return session.workflow_call(
+        "instance/revoke",
+        _build_action_data(instance_id, work_id),
+    )
+
+
+def task_revoke(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Revoke by approver (undo their own approval).
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Revoke result
+    """
+    return session.workflow_call(
+        "instance/taskRevoke",
+        _build_action_data(instance_id, work_id),
+    )
+
+
+def transfer(
+    session: Session,
+    instance_id: str,
+    forward_account_id: str,
+    work_id: str = "",
+    opinion: str = "",
+) -> dict[str, Any]:
+    """Transfer a fill-in task to another user.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        forward_account_id: Target user ID
+        work_id: Work item ID
+        opinion: Comment
+
+    Returns:
+        Transfer result
+    """
+    data = _build_action_data(instance_id, work_id, opinion)
+    data["forwardAccountId"] = forward_account_id
+    return session.workflow_call("instance/transfer", data)
+
+
+def urge(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Send an urge/reminder for a pending task.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Urge result
+    """
+    data: dict[str, Any] = {"id": instance_id, "operationType": 18}
+    if work_id:
+        data["workId"] = work_id
+    return session.workflow_call("instance/operation", data)
+
+
+# ── Batch Operations ────────────────────────────────────────────────────
+
+
+def batch_operation(
+    session: Session,
+    batch_operation_type: int,
+    instance_id: str = "",
+    work_id: str = "",
+    page_index: int = 1,
+    page_size: int = 50,
+    type_: int = -1,
+    apk_id: str = "",
+    process_id: str = "",
+    selects: Optional[list] = None,
+) -> dict[str, Any]:
+    """Batch approve/reject/forward tasks.
+
+    Args:
+        session: Active session
+        batch_operation_type: 4=pass, 5=reject
+        instance_id: Instance ID (for single)
+        work_id: Work item ID
+        page_index: Page
+        page_size: Size
+        type_: Task type filter
+        apk_id: App filter
+        process_id: Process filter
+        selects: Selected item IDs for batch
+
+    Returns:
+        Batch result
+    """
+    data: dict[str, Any] = {
+        "batchOperationType": batch_operation_type,
+        "pageIndex": page_index,
+        "pageSize": page_size,
+        "type": type_,
+    }
+    if instance_id:
+        data["id"] = instance_id
+    if work_id:
+        data["workId"] = work_id
+    if apk_id:
+        data["apkId"] = apk_id
+    if process_id:
+        data["processId"] = process_id
+    if selects:
+        data["selects"] = selects
+    return session.workflow_call("v2/instance/batch", data)
+
+
+# ── Execution History ────────────────────────────────────────────────────
+
+
+def get_history_list(
+    session: Session,
+    process_id: str = "",
+    page_index: int = 1,
+    page_size: int = 50,
+    status: int = 0,
+    title: str = "",
+    start_date: str = "",
+    end_date: str = "",
+    instance_id: str = "",
+) -> dict[str, Any]:
+    """Get workflow execution history.
+
+    Args:
+        session: Active session
+        process_id: Filter by process
+        page_index: Page number
+        page_size: Items per page
+        status: Status filter (1=running, 2=completed, 3=rejected, 4=failed)
+        title: Title search
+        start_date: Start date (YYYY-MM-DD)
+        end_date: End date (YYYY-MM-DD)
+        instance_id: Specific instance ID
+
+    Returns:
+        History list with count
+    """
+    data: dict[str, Any] = {"pageIndex": page_index, "pageSize": page_size}
+    if process_id:
+        data["processId"] = process_id
+    if status:
+        data["status"] = status
+    if title:
+        data["title"] = title
+    if start_date:
+        data["startDate"] = start_date
+    if end_date:
+        data["endDate"] = end_date
+    if instance_id:
+        data["instanceId"] = instance_id
+    result = session.workflow_call("instance/getHistoryList", data)
+    if isinstance(result, dict):
+        return {
+            "data": result.get("data", result.get("list", [])),
+            "count": result.get("count", result.get("total", 0)),
+        }
+    return {"data": result, "count": len(result)}
+
+
+def get_history_detail(
+    session: Session,
+    instance_id: str,
+) -> dict[str, Any]:
+    """Get execution history detail.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+
+    Returns:
+        History detail with node execution info
+    """
+    return session.workflow_call(
+        "instance/getHistoryDetail",
+        {"instanceId": instance_id},
+    )
+
+
+# ── Instance Lifecycle ───────────────────────────────────────────────────
+
+
+def end_instance(session: Session, instance_id: str) -> dict[str, Any]:
+    """Terminate a running instance.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+
+    Returns:
+        Termination result
+    """
+    return session.workflow_call(
+        "v1/instance/endInstance", {"instanceId": instance_id}
+    )
+
+
+def reset_instance(session: Session, instance_id: str) -> dict[str, Any]:
+    """Retry a failed instance.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+
+    Returns:
+        Reset result
+    """
+    return session.workflow_call(
+        "v1/instance/resetInstance", {"instanceId": instance_id}
+    )
+
+
+def restart_instance(
+    session: Session,
+    instance_id: str,
+    work_id: str = "",
+) -> dict[str, Any]:
+    """Re-initiate a rejected/completed instance.
+
+    Args:
+        session: Active session
+        instance_id: Instance ID
+        work_id: Work item ID
+
+    Returns:
+        Restart result
+    """
+    return session.workflow_call(
+        "instance/restart",
+        _build_action_data(instance_id, work_id),
+    )