hap-cli 0.8.14__tar.gz → 0.8.15__tar.gz

{hap_cli-0.8.14 → hap_cli-0.8.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hap-cli
-Version: 0.8.14
+Version: 0.8.15
 Summary: CLI harness for Mingdao HAP - Enterprise no-code platform
 Author: hap-cli
 License: Apache-2.0

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/__init__.py

@@ -1,3 +1,3 @@
 """CLI harness for Mingdao HAP (hap-cli)."""
 
-__version__ = "0.8.14"
+__version__ = "0.8.15"

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/commands/instance_cmd.py

@@ -243,7 +243,11 @@ def instance_retry(ctx, instance_id):
 @click.option("--work-id", "-w", default="", help="Work item ID")
 @pass_context
 def instance_restart(ctx, instance_id, work_id):
-    """Re-initiate a completed/rejected instance."""
+    """Re-initiate a flow the initiator has revoked.
+
+    Use this after the initiator revoked (withdrew) a still-running flow to
+    start it again. It does not apply to flows that already finished.
+    """
     try:
         session = ctx.get_session()
         data = inst_mod.restart_instance(session, instance_id, work_id)
@@ -354,15 +358,24 @@ def instance_batch(ctx, action, type_, process_id, select, instances_json,
 
 
 def _batch_lifecycle_options(fn):
-    """Shared options for end-batch / retry-batch — both take
-    ``RequestStartProcess`` shape (see instanceVersion.js:144)."""
+    """Shared options for end-batch / retry-batch.
+
+    The primary path takes one or more INSTANCE_IDS (the ids shown in the flow
+    history list) as positional arguments — these become ``sources`` and are
+    the only thing the server needs. The ``--app-id`` + ``--all`` + filter
+    options drive the alternative "select all in a worksheet view" mode.
+    """
     decorators = [
-        click.argument("app_id"),
-        click.option("--trigger-id", default="", help="Trigger/button ID"),
-        click.option("--view-id", default="", help="Source view ID"),
-        click.option("--source", "-s", multiple=True, help="Explicit row ID to act on (repeat)"),
-        click.option("--all", "is_all", is_flag=True, default=False, help="Select all matching rows"),
-        click.option("--keywords", default="", help="Search keyword over rows"),
+        click.argument("instance_ids", nargs=-1),
+        click.option("--source", "-s", multiple=True,
+                     help="Instance ID to act on (repeat; merged with positional IDs)"),
+        click.option("--app-id", "app_id", default="",
+                     help="Worksheet ID — only needed with --all to select every matching row"),
+        click.option("--all", "is_all", is_flag=True, default=False,
+                     help="Select all matching rows (requires --app-id)"),
+        click.option("--view-id", default="", help="Source view ID (for --all)"),
+        click.option("--trigger-id", default="", help="Trigger/button ID (for --all)"),
+        click.option("--keywords", default="", help="Search keyword over rows (for --all)"),
         click.option("--filter-controls", default="", help="JSON array of filter conditions"),
         click.option("--fast-filters", default="", help="JSON array of fast filters"),
         click.option("--nav-group-filters", default="", help="JSON array of nav-group filters"),
@@ -376,12 +389,21 @@ def _batch_lifecycle_options(fn):
 
 
 def _resolve_batch_lifecycle_kwargs(
-    source, is_all, keywords,
+    instance_ids, source, app_id, is_all, keywords,
     filter_controls, fast_filters, nav_group_filters, filters_group,
     data_log, push_unique_id,
 ):
+    sources = list(instance_ids) + list(source)
+    if not sources and not is_all:
+        raise click.UsageError(
+            "Provide at least one INSTANCE_ID (or --source), "
+            "or use --all with --app-id to select a whole view."
+        )
+    if is_all and not app_id:
+        raise click.UsageError("--all requires --app-id (the worksheet ID).")
     return {
-        "sources": list(source) if source else None,
+        "app_id": app_id,
+        "sources": sources or None,
         "is_all": is_all,
         "key_words": keywords,
         "filter_controls": _json.loads(filter_controls) if filter_controls else None,
@@ -398,21 +420,27 @@ def _resolve_batch_lifecycle_kwargs(
 @click.option("--yes", "-y", is_flag=True, help="Skip confirmation")
 @pass_context
 def instance_end_batch(
-    ctx, app_id, trigger_id, view_id, source, is_all, keywords,
+    ctx, instance_ids, source, app_id, is_all, view_id, trigger_id, keywords,
     filter_controls, fast_filters, nav_group_filters, filters_group,
     data_log, push_unique_id, yes,
 ):
-    """Terminate instances in bulk (``v1/instance/endInstanceList``)."""
+    """Terminate one or more running flows in bulk.
+
+    Pass the instance IDs from the flow history list as arguments:
+
+        hap approval end-batch <INSTANCE_ID> [<INSTANCE_ID> ...]
+    """
     try:
+        kwargs = _resolve_batch_lifecycle_kwargs(
+            instance_ids, source, app_id, is_all, keywords,
+            filter_controls, fast_filters, nav_group_filters, filters_group,
+            data_log, push_unique_id,
+        )
         if not yes:
             click.confirm("Terminate the matching instances?", abort=True)
         session = ctx.get_session()
-        kwargs = _resolve_batch_lifecycle_kwargs(
-            source, is_all, keywords, filter_controls, fast_filters,
-            nav_group_filters, filters_group, data_log, push_unique_id,
-        )
         data = inst_mod.end_instance_batch(
-            session, app_id, trigger_id=trigger_id, view_id=view_id, **kwargs,
+            session, view_id=view_id, trigger_id=trigger_id, **kwargs,
         )
         ctx.output(data, lambda d: click.echo(f"Batch terminate dispatched: {d}"))
     except Exception as e:
@@ -423,19 +451,25 @@ def instance_end_batch(
 @_batch_lifecycle_options
 @pass_context
 def instance_retry_batch(
-    ctx, app_id, trigger_id, view_id, source, is_all, keywords,
+    ctx, instance_ids, source, app_id, is_all, view_id, trigger_id, keywords,
     filter_controls, fast_filters, nav_group_filters, filters_group,
     data_log, push_unique_id,
 ):
-    """Retry failed instances in bulk (``v1/instance/resetInstanceList``)."""
+    """Retry one or more failed flows in bulk.
+
+    Pass the instance IDs from the flow history list as arguments:
+
+        hap approval retry-batch <INSTANCE_ID> [<INSTANCE_ID> ...]
+    """
     try:
-        session = ctx.get_session()
         kwargs = _resolve_batch_lifecycle_kwargs(
-            source, is_all, keywords, filter_controls, fast_filters,
-            nav_group_filters, filters_group, data_log, push_unique_id,
+            instance_ids, source, app_id, is_all, keywords,
+            filter_controls, fast_filters, nav_group_filters, filters_group,
+            data_log, push_unique_id,
         )
+        session = ctx.get_session()
         data = inst_mod.reset_instance_batch(
-            session, app_id, trigger_id=trigger_id, view_id=view_id, **kwargs,
+            session, view_id=view_id, trigger_id=trigger_id, **kwargs,
         )
         ctx.output(data, lambda d: click.echo(f"Batch retry dispatched: {d}"))
     except Exception as e:

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/commands/role_cmd.py

@@ -69,7 +69,8 @@ def role_create(ctx, app_id, name, desc, permission):
                    "views are fetched and the full permission structure is "
                    "filled in (unspecified fields/views default to allowed).")
 @click.option("--page-permissions", "page_perms_json", default="",
-              help="Page permission JSON: list of {pageId, enable}.")
+              help="Page permission JSON: list of {id, enable}, where 'id' is "
+                   "the custom-page id ('pageId' is also accepted).")
 @click.option("--hide-app-for-members", is_flag=True, default=False,
               help="Hide the app from members of this role.")
 @pass_context

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/core/instance.py

@@ -628,7 +628,12 @@ def restart_instance(
     instance_id: str,
     work_id: str = "",
 ) -> dict[str, Any]:
-    """Re-initiate a rejected/completed instance.
+    """Re-initiate an instance that the initiator has revoked.
+
+    This is the "撤回后重新发起" action (instance/restart, paired with
+    instance/revoke; operation types 13/19 in ExecDialog/StepItem). It applies
+    to an instance the initiator previously revoked while it was still running
+    — NOT to an already-completed or rejected instance.
 
     Args:
         session: Active session
@@ -647,13 +652,22 @@ def restart_instance(
 # ── Batch lifecycle ─────────────────────────────────────────────────────
 #
 # ``endInstanceList`` and ``resetInstanceList`` take a ``RequestStartProcess``
-# payload that describes a selection over a worksheet view (same shape used
-# by worksheet trigger batch ops). Callers either enumerate explicit
-# ``sources`` row ids OR flip ``is_all`` on and describe the filter.
+# payload (instanceVersion.js:144). There are two ways to select the target
+# instances:
+#   1. Explicit ``sources`` = a list of instance ids (the ids returned by the
+#      flow-history list). This is the only shape the frontend ever sends —
+#      HistoryHeader.jsx:95/112 calls ``{sources: [id, ...]}`` with nothing
+#      else. ``appId`` is NOT required and must NOT be injected, otherwise the
+#      server 500s when it is given a value that is not a real worksheet id.
+#   2. ``is_all`` selection over a worksheet view — then ``appId`` (the
+#      worksheet id, named ``appId`` in the schema) plus the filter fields are
+#      required.
+# Therefore ``appId`` and ``isAll`` are only added to the body when they carry
+# meaning; an empty ``appId`` or ``isAll=False`` must not leak into the payload.
 
 
 def _build_request_start_process(
-    app_id: str,
+    app_id: str = "",
     trigger_id: str = "",
     view_id: str = "",
     sources: Optional[list] = None,
@@ -666,11 +680,16 @@ def _build_request_start_process(
     data_log: str = "",
     push_unique_id: str = "",
 ) -> dict[str, Any]:
-    """Assemble a ``RequestStartProcess`` body per instanceVersion.js:144."""
-    data: dict[str, Any] = {
-        "appId": app_id,
-        "isAll": is_all,
-    }
+    """Assemble a ``RequestStartProcess`` body per instanceVersion.js:144.
+
+    ``appId`` is only emitted when non-empty and ``isAll`` only when ``True``;
+    the explicit-``sources`` path (the common case) sends just ``sources``.
+    """
+    data: dict[str, Any] = {}
+    if app_id:
+        data["appId"] = app_id
+    if is_all:
+        data["isAll"] = is_all
     if trigger_id:
         data["triggerId"] = trigger_id
     if view_id:
@@ -696,7 +715,7 @@ def _build_request_start_process(
 
 def end_instance_batch(
     session: Session,
-    app_id: str,
+    app_id: str = "",
     *,
     trigger_id: str = "",
     view_id: str = "",
@@ -712,9 +731,11 @@ def end_instance_batch(
 ) -> dict[str, Any]:
     """Terminate instances in bulk (``v1/instance/endInstanceList``).
 
-    Either pass ``sources`` (explicit row ids) or flip ``is_all=True`` and
-    describe the selection filter via ``filter_controls`` / ``fast_filters``
-    / ``filters_group`` / etc.
+    Either pass ``sources`` (explicit instance ids from the flow-history list)
+    or flip ``is_all=True`` with ``app_id`` (the worksheet id) and describe the
+    selection filter via ``filter_controls`` / ``fast_filters`` /
+    ``filters_group`` / etc. In the common ``sources`` path ``app_id`` is left
+    empty and is not sent.
     """
     data = _build_request_start_process(
         app_id, trigger_id=trigger_id, view_id=view_id,
@@ -728,7 +749,7 @@ def end_instance_batch(
 
 def reset_instance_batch(
     session: Session,
-    app_id: str,
+    app_id: str = "",
     *,
     trigger_id: str = "",
     view_id: str = "",

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/core/role_perm_builder.py

@@ -142,6 +142,27 @@ def complete_worksheet_permission(
     }
 
 
+def _normalize_page_permissions(
+    page_permissions: Optional[list[dict[str, Any]]],
+) -> list[dict[str, Any]]:
+    """Normalize each custom-page permission to the V3 ``{id, enable}`` shape.
+
+    The V3 ``/v3/app/roles`` schema requires ``id`` (the custom-page id) for
+    each entry. ``pageId`` is accepted as a friendly alias and rewritten to
+    ``id`` so both spellings work.
+    """
+    normalized: list[dict[str, Any]] = []
+    for pp in page_permissions or []:
+        if not isinstance(pp, dict):
+            normalized.append(pp)
+            continue
+        entry = dict(pp)
+        if "id" not in entry and "pageId" in entry:
+            entry["id"] = entry.pop("pageId")
+        normalized.append(entry)
+    return normalized
+
+
 def create_role_fine_grained(
     session: Any,
     app_id: str,
@@ -168,7 +189,7 @@ def create_role_fine_grained(
         "permissionScope": 0,
         "hideAppForMembers": hide_app_for_members,
         "worksheetPermissions": complete_ws_perms,
-        "pagePermissions": page_permissions or [],
+        "pagePermissions": _normalize_page_permissions(page_permissions),
     }
     return session.v3_call(
         "POST", "/v3/app/roles", app_id=app_id, body=body,

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/locale/messages.json

@@ -1156,10 +1156,10 @@
       "en": "0=end, 1=active"
     },
     "approval end-batch": {
-      "en": "Terminate instances in bulk (``v1/instance/endInstanceList``)."
+      "en": "Terminate one or more running flows in bulk.\n\nPass the instance IDs from the flow history list as arguments:\n\n    hap approval end-batch <INSTANCE_ID> [<INSTANCE_ID> ...]"
     },
     "approval end-batch --all": {
-      "en": "Select all matching rows"
+      "en": "Select all matching rows (requires --app-id)"
     },
     "approval end-batch --data-log": {
       "en": "Extended trigger context blob"
@@ -1174,7 +1174,7 @@
       "en": "JSON array of custom-page filter groups"
     },
     "approval end-batch --keywords": {
-      "en": "Search keyword over rows"
+      "en": "Search keyword over rows (for --all)"
     },
     "approval end-batch --nav-group-filters": {
       "en": "JSON array of nav-group filters"
@@ -1183,13 +1183,13 @@
       "en": "Client-side push dedup id"
     },
     "approval end-batch --source": {
-      "en": "Explicit row ID to act on (repeat)"
+      "en": "Instance ID to act on (repeat; merged with positional IDs)"
     },
     "approval end-batch --trigger-id": {
-      "en": "Trigger/button ID"
+      "en": "Trigger/button ID (for --all)"
     },
     "approval end-batch --view-id": {
-      "en": "Source view ID"
+      "en": "Source view ID (for --all)"
     },
     "approval forward": {
       "en": "Forward a task to another user."
@@ -1276,7 +1276,7 @@
       "en": "Work item ID"
     },
     "approval restart": {
-      "en": "Re-initiate a completed/rejected instance."
+      "en": "Re-initiate a flow the initiator has revoked.\n\nUse this after the initiator revoked (withdrew) a still-running flow to start it again. It does not apply to flows that already finished."
     },
     "approval restart --work-id": {
       "en": "Work item ID"
@@ -1285,10 +1285,10 @@
       "en": "Retry a failed instance."
     },
     "approval retry-batch": {
-      "en": "Retry failed instances in bulk (``v1/instance/resetInstanceList``)."
+      "en": "Retry one or more failed flows in bulk.\n\nPass the instance IDs from the flow history list as arguments:\n\n    hap approval retry-batch <INSTANCE_ID> [<INSTANCE_ID> ...]"
     },
     "approval retry-batch --all": {
-      "en": "Select all matching rows"
+      "en": "Select all matching rows (requires --app-id)"
     },
     "approval retry-batch --data-log": {
       "en": "Extended trigger context blob"
@@ -1303,7 +1303,7 @@
       "en": "JSON array of custom-page filter groups"
     },
     "approval retry-batch --keywords": {
-      "en": "Search keyword over rows"
+      "en": "Search keyword over rows (for --all)"
     },
     "approval retry-batch --nav-group-filters": {
       "en": "JSON array of nav-group filters"
@@ -1312,13 +1312,13 @@
       "en": "Client-side push dedup id"
     },
     "approval retry-batch --source": {
-      "en": "Explicit row ID to act on (repeat)"
+      "en": "Instance ID to act on (repeat; merged with positional IDs)"
     },
     "approval retry-batch --trigger-id": {
-      "en": "Trigger/button ID"
+      "en": "Trigger/button ID (for --all)"
     },
     "approval retry-batch --view-id": {
-      "en": "Source view ID"
+      "en": "Source view ID (for --all)"
     },
     "approval revoke": {
       "en": "Revoke/withdraw a submitted instance."
@@ -3257,6 +3257,12 @@
     },
     "worksheet view sort": {
       "en": "Reorder worksheet views. Pass view IDs in desired order."
+    },
+    "approval end-batch --app-id": {
+      "en": "Worksheet ID — only needed with --all to select every matching row"
+    },
+    "approval retry-batch --app-id": {
+      "en": "Worksheet ID — only needed with --all to select every matching row"
     }
   }
 }

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/tests/test_core.py

@@ -6710,6 +6710,23 @@ class TestWave6CustomPageCLI:
 class TestApprovalBatchLifecycle:
     """Wave 8 — batch terminate/retry via ``RequestStartProcess`` payload."""
 
+    @patch("hap_cli.core.session.requests.post")
+    def test_end_instance_batch_sources_only(self, mock_post, mock_session):
+        """The common path sends just ``sources`` (instance ids) — no appId /
+        isAll, mirroring HistoryHeader.jsx. Injecting an appId that is not a
+        real worksheet id makes the server 500 (bug #036701)."""
+        mock_post.return_value = _mock_response(True)
+        inst_mod.end_instance_batch(
+            mock_session,
+            sources=["i1", "i2"],
+        )
+        url = mock_post.call_args[0][0]
+        body = mock_post.call_args[1]["json"]
+        assert url.endswith("/v1/instance/endInstanceList")
+        assert body == {"sources": ["i1", "i2"]}
+        assert "appId" not in body
+        assert "isAll" not in body
+
     @patch("hap_cli.core.session.requests.post")
     def test_end_instance_batch_sends_request_start_process(self, mock_post, mock_session):
         mock_post.return_value = _mock_response(True)
@@ -6719,7 +6736,7 @@ class TestApprovalBatchLifecycle:
             trigger_id="btn1",
             view_id="view1",
             sources=["r1", "r2"],
-            is_all=False,
+            is_all=True,
             key_words="urgent",
         )
         url = mock_post.call_args[0][0]
@@ -6729,7 +6746,7 @@ class TestApprovalBatchLifecycle:
         assert body["triggerId"] == "btn1"
         assert body["viewId"] == "view1"
         assert body["sources"] == ["r1", "r2"]
-        assert body["isAll"] is False
+        assert body["isAll"] is True
         assert body["keyWords"] == "urgent"
 
     @patch("hap_cli.core.session.requests.post")
@@ -7025,6 +7042,69 @@ class TestApprovalCLI:
             assert sub in result.output, f"Missing delegation subcommand: {sub}"
 
 
+class TestApprovalBatchLifecycleCLI:
+    """Bug #036701 — end-batch / retry-batch take instance ids positionally
+    and must send only ``sources`` (no appId) so the server does not 500."""
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_end_batch_positional_ids_send_sources_only(self, mock_post, tmp_config):
+        mock_post.return_value = _mock_response(True)
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(
+            cli, ["approval", "end-batch", "i1", "i2", "-y"])
+        assert result.exit_code == 0, result.output
+        url = mock_post.call_args[0][0]
+        body = mock_post.call_args[1]["json"]
+        assert url.endswith("/v1/instance/endInstanceList")
+        assert body == {"sources": ["i1", "i2"]}
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_retry_batch_positional_ids_send_sources_only(self, mock_post, tmp_config):
+        mock_post.return_value = _mock_response(True)
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(
+            cli, ["approval", "retry-batch", "i9"])
+        assert result.exit_code == 0, result.output
+        url = mock_post.call_args[0][0]
+        body = mock_post.call_args[1]["json"]
+        assert url.endswith("/v1/instance/resetInstanceList")
+        assert body == {"sources": ["i9"]}
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_end_batch_requires_a_target(self, mock_post, tmp_config):
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(cli, ["approval", "end-batch", "-y"])
+        assert result.exit_code != 0
+        assert "INSTANCE_ID" in result.output
+        mock_post.assert_not_called()
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_end_batch_all_requires_app_id(self, mock_post, tmp_config):
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(cli, ["approval", "end-batch", "--all", "-y"])
+        assert result.exit_code != 0
+        assert "--app-id" in result.output
+        mock_post.assert_not_called()
+
+    @patch("hap_cli.core.session.requests.post")
+    def test_end_batch_all_mode_sends_appid_and_isall(self, mock_post, tmp_config):
+        mock_post.return_value = _mock_response(True)
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(
+            cli, ["approval", "end-batch", "--all", "--app-id", "ws1", "-y"])
+        assert result.exit_code == 0, result.output
+        body = mock_post.call_args[1]["json"]
+        assert body["appId"] == "ws1"
+        assert body["isAll"] is True
+
+    def test_restart_help_describes_revoke_semantics(self, tmp_config):
+        Session(server_url="https://t.com", auth_token="tok").save()
+        result = CliRunner().invoke(cli, ["approval", "restart", "--help"])
+        assert result.exit_code == 0
+        assert "revoke" in result.output.lower()
+        assert "completed/rejected" not in result.output
+
+
 # ── Friendly auth-error handling ─────────────────────────────────────────
 #
 # The HAP server returns HTTP 401 (or a state=0 body whose message implies
@@ -8809,6 +8889,24 @@ class TestRolePermBuilder:
             assert body["permissionScope"] == 0
             assert body["worksheetPermissions"][0]["id"] == "ws1"
 
+    def test_page_permissions_accept_pageid_alias(self):
+        """Bug #036701 — the V3 schema requires {id, enable} for page perms.
+        Accept the friendly 'pageId' spelling and rewrite it to 'id'."""
+        from hap_cli.core import role_perm_builder as rpb
+        sess = MagicMock()
+        sess.v3_call.return_value = {"data": {"id": "role1"}}
+        rpb.create_role_fine_grained(
+            sess, "app1", "管理员",
+            page_permissions=[
+                {"pageId": "p1", "enable": False},
+                {"id": "p2", "enable": True},
+            ])
+        body = sess.v3_call.call_args.kwargs["body"]
+        assert body["pagePermissions"] == [
+            {"id": "p1", "enable": False},
+            {"id": "p2", "enable": True},
+        ]
+
 
 class TestWorkflowNodeNesting:
     """§2.J branch + approval_block / sub_process nesting. Structural

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli/tests/test_destructive_confirm_cli.py

@@ -144,7 +144,7 @@ class TestLegacyDeleteConfirm:
     @patch("hap_cli.core.session.requests.post")
     def test_end_batch_aborts_without_yes(self, mock_post, tmp_config):
         result = CliRunner().invoke(cli, [
-            "approval", "end-batch", "a1", "--all",
+            "approval", "end-batch", "i1",
         ])
         assert result.exit_code != 0
         assert "Terminate the matching instances?" in result.output

{hap_cli-0.8.14 → hap_cli-0.8.15}/hap_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hap-cli
-Version: 0.8.14
+Version: 0.8.15
 Summary: CLI harness for Mingdao HAP - Enterprise no-code platform
 Author: hap-cli
 License: Apache-2.0