hap-cli 0.5.0__py3-none-any.whl

hap_cli/core/worksheet.py

@@ -0,0 +1,403 @@
+"""Worksheet management module for MingDAO HAP."""
+
+from typing import Any, Optional
+
+from hap_cli.core.session import Session
+
+
+def get_worksheet_info(
+    session: Session,
+    worksheet_id: str,
+    app_id: str = "",
+    get_template: bool = False,
+    get_views: bool = False,
+) -> dict[str, Any]:
+    """Get worksheet information.
+
+    Args:
+        session: Active session
+        worksheet_id: Worksheet ID
+        app_id: Optional application ID
+        get_template: Include template controls
+        get_views: Include views
+
+    Returns:
+        Worksheet info dict
+    """
+    data = {
+        "worksheetId": worksheet_id,
+        "getTemplate": get_template,
+        "getViews": get_views,
+    }
+    if app_id:
+        data["appId"] = app_id
+    return session.api_call("Worksheet", "GetWorksheetInfo", data)
+
+
+def get_worksheet_controls(
+    session: Session,
+    worksheet_id: str,
+    app_id: str = "",
+) -> list[dict[str, Any]]:
+    """Get worksheet fields/controls with full metadata (type, options, etc.).
+
+    Args:
+        session: Active session
+        worksheet_id: Worksheet ID
+        app_id: Optional application ID
+
+    Returns:
+        List of control/field definitions
+    """
+    data = {
+        "worksheetId": worksheet_id,
+        "getRelationSearch": True,
+        "resultType": 3,  # Return full control metadata
+    }
+    if app_id:
+        data["appId"] = app_id
+    result = session.api_call("Worksheet", "GetWorksheetControls", data)
+    if isinstance(result, list):
+        return result
+    # Response is double-nested: {code, data: {sourceId, controls: [...]}}
+    if isinstance(result, dict):
+        inner = result.get("data")
+        if isinstance(inner, dict):
+            return inner.get("controls", [])
+        if isinstance(inner, list):
+            return inner
+    return result.get("controls", [])
+
+
+def get_worksheet_views(
+    session: Session,
+    worksheet_id: str,
+    app_id: str = "",
+) -> list[dict[str, Any]]:
+    """Get worksheet views.
+
+    Args:
+        session: Active session
+        worksheet_id: Worksheet ID
+        app_id: Optional application ID
+
+    Returns:
+        List of view definitions
+    """
+    data = {"worksheetId": worksheet_id}
+    if app_id:
+        data["appId"] = app_id
+    result = session.api_call("Worksheet", "GetWorksheetViews", data)
+    if isinstance(result, list):
+        return result
+    return result.get("views", [])
+
+
+# ── Field type constants ─────────────────────────────────────────────────
+
+FIELD_TYPES = {
+    "TEXT": 2,
+    "MOBILE_PHONE": 3,
+    "TELEPHONE": 4,
+    "EMAIL": 5,
+    "NUMBER": 6,
+    "CRED": 7,
+    "MONEY": 8,
+    "FLAT_MENU": 9,
+    "MULTI_SELECT": 10,
+    "DROP_DOWN": 11,
+    "ATTACHMENT": 14,
+    "DATE": 15,
+    "DATE_TIME": 16,
+    "AREA_PROVINCE": 19,
+    "RELATION": 21,
+    "SPLIT_LINE": 22,
+    "AREA_CITY": 23,
+    "AREA_COUNTY": 24,
+    "MONEY_CN": 25,
+    "USER_PICKER": 26,
+    "DEPARTMENT": 27,
+    "SCORE": 28,
+    "RELATE_SHEET": 29,
+    "SHEET_FIELD": 30,
+    "FORMULA_NUMBER": 31,
+    "CONCATENATE": 32,
+    "AUTO_ID": 33,
+    "SUB_LIST": 34,
+    "CASCADER": 35,
+    "SWITCH": 36,
+    "SUBTOTAL": 37,
+    "FORMULA_DATE": 38,
+    "LOCATION": 40,
+    "RICH_TEXT": 41,
+    "SIGNATURE": 42,
+    "OCR": 43,
+    "EMBED": 45,
+    "TIME": 46,
+    "BAR_CODE": 47,
+    "ORG_ROLE": 48,
+    "SEARCH_BTN": 49,
+    "SEARCH": 50,
+    "RELATION_SEARCH": 51,
+    "SECTION": 52,
+    "FORMULA_FUNC": 53,
+}
+
+
+# ── Worksheet CRUD ───────────────────────────────────────────────────────
+
+
+def create_worksheet(
+    session: Session,
+    app_id: str,
+    name: str,
+    project_id: str = "",
+    section_id: str = "",
+) -> dict[str, Any]:
+    """Create a new worksheet."""
+    data: dict[str, Any] = {"appId": app_id, "name": name}
+    if project_id:
+        data["projectId"] = project_id
+    if section_id:
+        data["appSectionId"] = section_id  # API requires appSectionId
+    return session.api_call("AppManagement", "AddWorkSheet", data)
+
+
+def copy_worksheet(
+    session: Session,
+    worksheet_id: str,
+    name: str,
+    app_id: str = "",
+    project_id: str = "",
+    copy_rows: bool = False,
+) -> dict[str, Any]:
+    """Copy a worksheet."""
+    data: dict[str, Any] = {"worksheetId": worksheet_id, "name": name}
+    if app_id:
+        data["appId"] = app_id
+    if project_id:
+        data["projectId"] = project_id
+    data["isCopyRows"] = copy_rows
+    return session.api_call("Worksheet", "CopyWorksheet", data)
+
+
+def update_worksheet(
+    session: Session,
+    worksheet_id: str,
+    alias: str = "",
+    desc: str = "",
+    app_id: str = "",
+) -> dict[str, Any]:
+    """Update worksheet alias and/or description."""
+    result = {}
+    if alias:
+        result = session.api_call(
+            "Worksheet", "UpdateWorksheetAlias",
+            {"worksheetId": worksheet_id, "alias": alias, "appId": app_id},
+        )
+    if desc:
+        result = session.api_call(
+            "Worksheet", "UpdateWorksheetDec",
+            {"worksheetId": worksheet_id, "dec": desc},
+        )
+    return result
+
+
+# ── Field/Control management ─────────────────────────────────────────────
+
+
+def save_controls(
+    session: Session,
+    worksheet_id: str,
+    controls: list[dict[str, Any]],
+) -> dict[str, Any]:
+    """Save the complete controls list for a worksheet (add/update/delete via full replacement).
+
+    Workflow: call get_worksheet_controls() first to get the current list,
+    modify it as needed, then pass the full modified list here.
+
+    Args:
+        session: Active session
+        worksheet_id: Worksheet ID (used as sourceId)
+        controls: Complete list of control definitions (old + new + modified)
+
+    Returns:
+        API response dict
+    """
+    return session.api_call(
+        "Worksheet", "SaveWorksheetControls",
+        {"version": 3, "sourceId": worksheet_id, "controls": controls},
+    )
+
+
+def add_controls(
+    session: Session,
+    worksheet_id: str,
+    controls: list[dict[str, Any]],
+) -> dict[str, Any]:
+    """Add new fields/controls to a worksheet (legacy endpoint)."""
+    return session.api_call(
+        "Worksheet", "AddWorksheetControls",
+        {"worksheetId": worksheet_id, "controls": controls},
+    )
+
+
+# ── View management ──────────────────────────────────────────────────────
+
+
+def save_view(
+    session: Session,
+    worksheet_id: str,
+    name: str,
+    view_type: int = 0,
+    view_id: str = "",
+    config: Optional[dict] = None,
+    app_id: str = "",
+) -> dict[str, Any]:
+    """Create or update a worksheet view."""
+    data: dict[str, Any] = {
+        "worksheetId": worksheet_id,
+        "name": name,
+        "viewType": view_type,
+    }
+    if view_id:
+        data["viewId"] = view_id
+    if config:
+        data.update(config)
+    if app_id:
+        data["appId"] = app_id
+    return session.api_call("Worksheet", "SaveWorksheetView", data)
+
+
+def delete_view(
+    session: Session, worksheet_id: str, view_id: str, app_id: str = "",
+) -> dict[str, Any]:
+    """Delete a worksheet view."""
+    data: dict[str, Any] = {"worksheetId": worksheet_id, "viewId": view_id}
+    if app_id:
+        data["appId"] = app_id
+    return session.api_call("Worksheet", "DeleteWorksheetView", data)
+
+
+def copy_view(
+    session: Session, worksheet_id: str, view_id: str, name: str,
+) -> dict[str, Any]:
+    """Copy a worksheet view."""
+    return session.api_call(
+        "Worksheet", "CopyWorksheetView",
+        {"worksheetId": worksheet_id, "viewId": view_id, "viewName": name},
+    )
+
+
+def sort_views(
+    session: Session, worksheet_id: str, view_ids: list[str],
+) -> dict[str, Any]:
+    """Reorder worksheet views."""
+    return session.api_call(
+        "Worksheet", "SortWorksheetViews",
+        {"worksheetId": worksheet_id, "viewIds": view_ids},
+    )
+
+
+# ── Business Rules ───────────────────────────────────────────────────────
+
+
+def get_control_rules(
+    session: Session, worksheet_id: str, control_id: str = "",
+) -> dict[str, Any]:
+    """Get business rules for worksheet controls."""
+    data: dict[str, Any] = {"worksheetId": worksheet_id}
+    if control_id:
+        data["controlId"] = control_id
+    return session.api_call("Worksheet", "GetControlRules", data)
+
+
+def save_control_rule(
+    session: Session,
+    worksheet_id: str,
+    rules: list[dict[str, Any]],
+    control_id: str = "",
+) -> dict[str, Any]:
+    """Save business rules for worksheet controls."""
+    data: dict[str, Any] = {"worksheetId": worksheet_id, "rules": rules}
+    if control_id:
+        data["controlId"] = control_id
+    return session.api_call("Worksheet", "SaveControlRule", data)
+
+
+# ── Custom Buttons ───────────────────────────────────────────────────────
+
+
+def get_buttons(
+    session: Session, worksheet_id: str,
+) -> dict[str, Any]:
+    """Get custom action buttons for a worksheet."""
+    return session.api_call(
+        "Worksheet", "GetWorksheetBtns", {"worksheetId": worksheet_id},
+    )
+
+
+def save_button(
+    session: Session,
+    worksheet_id: str,
+    btn_data: dict[str, Any],
+    btn_id: str = "",
+) -> dict[str, Any]:
+    """Create or update a custom action button.
+
+    On creation, the API auto-creates a linked workflow.
+    Response 'data' field contains the triggerId (button's workflow trigger ID).
+    """
+    data: dict[str, Any] = {"worksheetId": worksheet_id}
+    if btn_id:
+        data["btnId"] = btn_id
+    data.update(btn_data)
+    return session.api_call("Worksheet", "SaveWorksheetBtn", data)
+
+
+def delete_button(
+    session: Session, worksheet_id: str, btn_id: str,
+) -> dict[str, Any]:
+    """Delete a custom action button."""
+    return session.api_call(
+        "Worksheet", "SaveWorksheetBtn",
+        {"worksheetId": worksheet_id, "btnId": btn_id, "isDelete": True},
+    )
+
+
+# ── Feature Switches ────────────────────────────────────────────────────
+
+
+def get_switches(
+    session: Session, worksheet_id: str,
+) -> dict[str, Any]:
+    """Get feature switches for a worksheet."""
+    return session.api_call(
+        "Worksheet", "GetSwitch", {"worksheetId": worksheet_id},
+    )
+
+
+def edit_switch(
+    session: Session, worksheet_id: str, switch_id: int, value: bool,
+) -> dict[str, Any]:
+    """Edit a single feature switch."""
+    return session.api_call(
+        "Worksheet", "EditSwitch",
+        {"worksheetId": worksheet_id, "state": switch_id, "value": value},
+    )
+
+
+# ── Logs ─────────────────────────────────────────────────────────────────
+
+
+def get_worksheet_logs(
+    session: Session,
+    worksheet_id: str,
+    page_index: int = 1,
+    page_size: int = 50,
+) -> dict[str, Any]:
+    """Get worksheet operation logs."""
+    return session.api_call(
+        "Worksheet", "GetWorksheetOperationLogs",
+        {"worksheetId": worksheet_id, "pageIndex": page_index, "pageSize": page_size},
+    )

hap_cli/hap_cli.py

@@ -0,0 +1,105 @@
+"""Main CLI entry point for hap-cli harness.
+
+Usage:
+    hap [--json] <command> [args...]
+    hap repl
+"""
+
+import cmd
+import shlex
+
+import click
+
+from hap_cli.context import Context, pass_context
+
+# Import command groups
+from hap_cli.commands.config_cmd import config
+from hap_cli.commands.app_cmd import app
+from hap_cli.commands.worksheet_cmd import worksheet
+from hap_cli.commands.record_cmd import record
+from hap_cli.commands.workflow_cmd import workflow
+from hap_cli.commands.node_cmd import node
+from hap_cli.commands.instance_cmd import instance
+from hap_cli.commands.role_cmd import role
+from hap_cli.commands.optionset_cmd import optionset
+from hap_cli.commands.page_cmd import page
+from hap_cli.commands.contact_cmd import contact
+from hap_cli.commands.department_cmd import department
+from hap_cli.commands.post_cmd import post
+from hap_cli.commands.calendar_cmd import calendar
+from hap_cli.commands.chat_cmd import chat
+from hap_cli.commands.group_cmd import group
+from hap_cli.commands.ai_cmd import ai
+from hap_cli.commands.plugin_cmd import plugin
+
+
+@click.group()
+@click.option("--json", "json_mode", is_flag=True, help="Output in JSON format")
+@click.pass_context
+def cli(ctx, json_mode):
+    """CLI harness for MingDAO HAP (hap) - Enterprise no-code platform."""
+    ctx.ensure_object(Context)
+    ctx.obj.json_mode = json_mode
+
+
+# Register command groups
+cli.add_command(config)
+cli.add_command(app)
+cli.add_command(worksheet)
+cli.add_command(record)
+cli.add_command(workflow)
+cli.add_command(node)
+cli.add_command(instance)
+cli.add_command(role)
+cli.add_command(optionset)
+cli.add_command(page)
+cli.add_command(contact)
+cli.add_command(department)
+cli.add_command(post)
+cli.add_command(calendar)
+cli.add_command(chat)
+cli.add_command(group)
+cli.add_command(ai)
+cli.add_command(plugin)
+
+
+# ── REPL ─────────────────────────────────────────────────────────────────
+
+
+class HapREPL(cmd.Cmd):
+    """Interactive REPL for hap-cli."""
+
+    intro = "hap-cli REPL. Type 'help' for commands, 'quit' to exit."
+    prompt = "hap> "
+
+    def default(self, line):
+        """Execute CLI commands."""
+        try:
+            args = shlex.split(line)
+            cli.main(args, standalone_mode=False)
+        except SystemExit:
+            pass
+        except Exception as e:
+            click.echo(f"Error: {e}", err=True)
+
+    def do_quit(self, _arg):
+        """Exit the REPL."""
+        return True
+
+    do_exit = do_quit
+    do_EOF = do_quit
+
+
+@cli.command()
+def repl():
+    """Start interactive REPL mode."""
+    HapREPL().cmdloop()
+
+
+def main():
+    """Entry point for the CLI."""
+    cli()
+
+
+if __name__ == "__main__":
+    main()