hap-cli 0.5.0__py3-none-any.whl

hap_cli/core/workflow.py

@@ -0,0 +1,556 @@
+"""Workflow process lifecycle management for MingDAO HAP.
+
+Covers: create, delete, update, copy, publish, version history,
+process config, trigger, and process querying.
+"""
+
+from typing import Any, Optional
+
+from hap_cli.core.session import Session
+
+
+# ── Process CRUD ─────────────────────────────────────────────────────────
+
+
+def create_process(
+    session: Session,
+    company_id: str,
+    name: str,
+    relation_id: str = "",
+    relation_type: int = 0,
+    start_event_app_type: int = 1,
+    explain: str = "",
+    icon_name: str = "",
+    icon_color: str = "",
+) -> dict[str, Any]:
+    """Create a new workflow process.
+
+    Args:
+        session: Active session
+        company_id: Organization/project ID
+        name: Process name
+        relation_id: Related app ID
+        relation_type: Relation type (0=app)
+        start_event_app_type: Trigger type (1=worksheet, 5=scheduled, 6=date)
+        explain: Process description
+        icon_name: Icon name
+        icon_color: Icon color hex
+
+    Returns:
+        Created process info with processId
+    """
+    data: dict[str, Any] = {
+        "companyId": company_id,
+        "name": name,
+        "startEventAppType": start_event_app_type,
+    }
+    if relation_id:
+        data["relationId"] = relation_id
+    if relation_type:
+        data["relationType"] = relation_type
+    if explain:
+        data["explain"] = explain
+    if icon_name:
+        data["iconName"] = icon_name
+    if icon_color:
+        data["iconColor"] = icon_color
+    return session.workflow_call("process/add", data)
+
+
+def delete_process(session: Session, process_id: str) -> dict[str, Any]:
+    """Delete a workflow process.
+
+    Args:
+        session: Active session
+        process_id: Process ID to delete
+
+    Returns:
+        Deletion result
+    """
+    return session.workflow_call("process/deleteProcess", {"processId": process_id})
+
+
+def update_process(
+    session: Session,
+    process_id: str,
+    name: str = "",
+    explain: str = "",
+    icon_name: str = "",
+    icon_color: str = "",
+    company_id: str = "",
+) -> dict[str, Any]:
+    """Update workflow process basic info.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        name: New name
+        explain: New description
+        icon_name: New icon
+        icon_color: New color
+        company_id: Organization ID
+
+    Returns:
+        Update result
+    """
+    data: dict[str, Any] = {"processId": process_id}
+    if name:
+        data["name"] = name
+    if explain:
+        data["explain"] = explain
+    if icon_name:
+        data["iconName"] = icon_name
+    if icon_color:
+        data["iconColor"] = icon_color
+    if company_id:
+        data["companyId"] = company_id
+    return session.workflow_call("process/updateProcess", data)
+
+
+def copy_process(
+    session: Session,
+    process_id: str,
+    name: str,
+    sub_process: bool = False,
+) -> dict[str, Any]:
+    """Copy/clone a workflow process.
+
+    Args:
+        session: Active session
+        process_id: Source process ID
+        name: Name for the copy
+        sub_process: Include sub-processes
+
+    Returns:
+        New process info
+    """
+    return session.workflow_call(
+        "process/copyProcess",
+        {"processId": process_id, "name": name, "subProcess": sub_process},
+    )
+
+
+def move_process(
+    session: Session,
+    process_id: str,
+    relation_id: str,
+) -> dict[str, Any]:
+    """Move process to another application.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        relation_id: Target app ID
+
+    Returns:
+        Move result
+    """
+    return session.workflow_call(
+        "process/move",
+        {"processId": process_id, "relationId": relation_id},
+    )
+
+
+def get_process_by_id(session: Session, process_id: str) -> dict[str, Any]:
+    """Get process details by ID.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+
+    Returns:
+        Process detail dict
+    """
+    return session.workflow_call("process/getProcessById", {"id": process_id})
+
+
+# ── Publish & Version ────────────────────────────────────────────────────
+
+
+def publish(
+    session: Session,
+    process_id: str,
+    is_publish: bool = True,
+) -> dict[str, Any]:
+    """Publish or unpublish (enable/disable) a workflow.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        is_publish: True to publish/enable, False to disable
+
+    Returns:
+        Publish result
+    """
+    return session.workflow_call(
+        "process/publish",
+        {"processId": process_id, "isPublish": is_publish},
+    )
+
+
+def get_publish_info(
+    session: Session,
+    process_id: str,
+    instance_id: str = "",
+) -> dict[str, Any]:
+    """Get publish version information.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        instance_id: Optional instance ID
+
+    Returns:
+        Publish info
+    """
+    data: dict[str, Any] = {"processId": process_id}
+    if instance_id:
+        data["instanceId"] = instance_id
+    return session.workflow_call("process/getProcessPublish", data)
+
+
+def get_version_history(
+    session: Session,
+    process_id: str,
+    page_index: int = 1,
+    page_size: int = 20,
+) -> dict[str, Any]:
+    """Get workflow version history.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        page_index: Page number
+        page_size: Items per page
+
+    Returns:
+        Version history list
+    """
+    return session.workflow_call(
+        "process/getHistory",
+        {"processId": process_id, "pageIndex": page_index, "pageSize": page_size},
+    )
+
+
+def rollback_version(session: Session, process_id: str) -> dict[str, Any]:
+    """Rollback to previous version.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+
+    Returns:
+        Rollback result
+    """
+    return session.workflow_call("process/goBack", {"processId": process_id})
+
+
+# ── Process Config ───────────────────────────────────────────────────────
+
+
+def get_process_config(session: Session, process_id: str) -> dict[str, Any]:
+    """Get workflow global configuration.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+
+    Returns:
+        Process config dict
+    """
+    return session.workflow_call("process/getProcessConfig", {"processId": process_id})
+
+
+def save_process_config(
+    session: Session,
+    process_id: str,
+    config: dict[str, Any],
+) -> dict[str, Any]:
+    """Save workflow global configuration.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        config: Configuration dict. Supported keys include:
+            - executeType: Execution type
+            - allowRevoke: Allow initiator to revoke
+            - allowTaskRevoke: Allow approver to revoke
+            - allowUrge: Allow urging
+            - triggerType: Trigger type
+            - triggerView: Trigger view ID
+            - errorInterval: Error retry interval
+            - errorNotifiers: Error notification recipients
+            - processVariables: Process variables list
+            - agents: Agent configurations
+            - defaultAgent: Default agent
+            - required/requiredIds: Required fields
+            - pbcConfig: PBP configuration
+            - And many more (see API docs)
+
+    Returns:
+        Save result
+    """
+    data = {"processId": process_id}
+    data.update(config)
+    return session.workflow_call("process/saveProcessConfig", data)
+
+
+# ── Trigger / Start ─────────────────────────────────────────────────────
+
+
+def start_process_by_id(
+    session: Session,
+    process_id: str,
+    source_id: str = "",
+    fields: Optional[list] = None,
+    debug_events: Optional[list] = None,
+) -> dict[str, Any]:
+    """Manually trigger a workflow by process ID.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        source_id: Source record ID
+        fields: Field values for the trigger
+        debug_events: Debug event data
+
+    Returns:
+        Trigger result with instance info
+    """
+    data: dict[str, Any] = {"processId": process_id}
+    if source_id:
+        data["sourceId"] = source_id
+    if fields:
+        data["fields"] = fields
+    if debug_events:
+        data["debugEvents"] = debug_events
+    return session.workflow_call("process/startProcessById", data)
+
+
+def start_process_by_pbp(
+    session: Session,
+    process_id: str,
+    app_id: str,
+    trigger_id: str = "",
+    title: str = "",
+    controls: Optional[list] = None,
+) -> dict[str, Any]:
+    """Trigger a PBP (Packaged Business Process) workflow.
+
+    Args:
+        session: Active session
+        process_id: Process ID
+        app_id: Application ID
+        trigger_id: Trigger ID
+        title: Instance title
+        controls: Input control values
+
+    Returns:
+        Trigger result
+    """
+    data: dict[str, Any] = {"processId": process_id, "appId": app_id}
+    if trigger_id:
+        data["triggerId"] = trigger_id
+    if title:
+        data["title"] = title
+    if controls:
+        data["controls"] = controls
+    return session.workflow_call("process/startProcessByPBC", data)
+
+
+def start_process(
+    session: Session,
+    app_id: str,
+    trigger_id: str,
+    sources: Optional[list[str]] = None,
+    view_id: str = "",
+    is_all: bool = False,
+) -> dict[str, Any]:
+    """Trigger workflow from worksheet button.
+
+    Args:
+        session: Active session
+        app_id: Application ID
+        trigger_id: Button trigger ID
+        sources: Source record IDs
+        view_id: View ID
+        is_all: Apply to all records in view
+
+    Returns:
+        Trigger result
+    """
+    data: dict[str, Any] = {"appId": app_id, "triggerId": trigger_id}
+    if sources:
+        data["sources"] = sources
+    if view_id:
+        data["viewId"] = view_id
+    if is_all:
+        data["isAll"] = is_all
+    return session.workflow_call("process/startProcess", data)
+
+
+# ── Listing ──────────────────────────────────────────────────────────────
+
+
+def get_process_list(
+    session: Session,
+    relation_id: str,
+    keyword: str = "",
+    page_index: int = 1,
+    page_size: int = 50,
+    process_list_type: int = 0,
+) -> dict[str, Any]:
+    """List workflows for an app.
+
+    Args:
+        session: Active session
+        relation_id: App ID
+        keyword: Search keyword
+        page_index: Page number
+        page_size: Items per page
+        process_list_type: List type filter
+
+    Returns:
+        Dict with list and count
+    """
+    data: dict[str, Any] = {
+        "relationId": relation_id,
+        "pageIndex": page_index,
+        "pageSize": page_size,
+    }
+    if keyword:
+        data["keyWords"] = keyword
+    if process_list_type:
+        data["processListType"] = process_list_type
+    result = session.workflow_call("v1/process/listAll", 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_process_by_company(
+    session: Session,
+    company_id: str,
+    keyword: str = "",
+    enabled: Optional[bool] = None,
+    page_index: int = 1,
+    page_size: int = 50,
+    apk_id: str = "",
+) -> dict[str, Any]:
+    """List all workflows in an organization.
+
+    Args:
+        session: Active session
+        company_id: Organization ID
+        keyword: Search keyword
+        enabled: Filter by enabled status
+        page_index: Page number
+        page_size: Items per page
+        apk_id: Filter by app ID
+
+    Returns:
+        Dict with list and count
+    """
+    data: dict[str, Any] = {
+        "companyId": company_id,
+        "pageIndex": page_index,
+        "pageSize": page_size,
+    }
+    if keyword:
+        data["keyWords"] = keyword
+    if enabled is not None:
+        data["enabled"] = enabled
+    if apk_id:
+        data["apkId"] = apk_id
+    result = session.workflow_call("v1/process/getProcessByCompanyId", 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_process_use_count(
+    session: Session,
+    company_id: str,
+) -> dict[str, Any]:
+    """Get workflow usage statistics.
+
+    Args:
+        session: Active session
+        company_id: Organization ID
+
+    Returns:
+        Usage count info
+    """
+    return session.workflow_call(
+        "v1/process/getProcessUseCount",
+        {"companyId": company_id},
+    )
+
+
+# ── Process Groups ───────────────────────────────────────────────────────
+
+
+def get_group_list(
+    session: Session,
+    relation_id: str,
+) -> list[dict[str, Any]]:
+    """Get workflow groups for an app.
+
+    Args:
+        session: Active session
+        relation_id: App ID
+
+    Returns:
+        List of group dicts
+    """
+    result = session.workflow_call(
+        "processGroup/getGroupList",
+        {"relationId": relation_id},
+    )
+    return result if isinstance(result, list) else result.get("list", [])
+
+
+def create_group(
+    session: Session,
+    relation_id: str,
+    name: str,
+) -> dict[str, Any]:
+    """Create a workflow group.
+
+    Args:
+        session: Active session
+        relation_id: App ID
+        name: Group name
+
+    Returns:
+        Created group info
+    """
+    return session.workflow_call(
+        "processGroup/addGroup",
+        {"relationId": relation_id, "name": name},
+    )
+
+
+def delete_group(
+    session: Session,
+    group_id: str,
+) -> dict[str, Any]:
+    """Delete a workflow group.
+
+    Args:
+        session: Active session
+        group_id: Group ID
+
+    Returns:
+        Deletion result
+    """
+    return session.workflow_call(
+        "processGroup/deleteGroup",
+        {"groupId": group_id},
+    )