unique-sdk 2026.32.0.dev5__tar.gz → 2026.32.0.dev7__tar.gz

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: unique-sdk
-Version: 2026.32.0.dev5
+Version: 2026.32.0.dev7
 Summary: 
 Author: Martin Fadler, Konstantin Krauss, Andreas Hauri
 Author-email: Martin Fadler <martin.fadler@unique.ch>, Konstantin Krauss <konstantin@unique.ch>, Andreas Hauri <andreas@unique.ch>

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "unique_sdk"
-version = "2026.32.0.dev5"
+version = "2026.32.0.dev7"
 description = ""
 readme = "README.md"
 license = { text = "MIT" }

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/unique_sdk/_api_requestor.py

@@ -194,8 +194,7 @@ class APIRequestor(object):
         )
 
         _util.log_info("Request to Unique", method=method, path=abs_url)
-        _util.log_debug(
-            "Request details",
+        _util.log_request_details(
             data=post_data,
             headers=headers,
             api_version=self.api_version,
@@ -206,7 +205,7 @@ class APIRequestor(object):
         )
 
         _util.log_info("Unique response", path=abs_url, status=rcode)
-        _util.log_debug("Unique response body", body=rcontent)
+        _util.log_response_body(body=rcontent)
 
         if "Request-Id" in rheaders:
             request_id = rheaders["Request-Id"]
@@ -230,11 +229,11 @@ class APIRequestor(object):
         )
 
         _util.log_info("Async request to Unique", method=method, path=abs_url)
-        _util.log_debug(
-            "Async request details",
+        _util.log_request_details(
             data=post_data,
             headers=headers,
             api_version=self.api_version,
+            message="Async request details",
         )
 
         rcontent, rcode, rheaders = await self._client.request_async(
@@ -242,7 +241,7 @@ class APIRequestor(object):
         )
 
         _util.log_info("Unique response", path=abs_url, status=rcode)
-        _util.log_debug("Unique response body", body=rcontent)
+        _util.log_response_body(body=rcontent)
 
         if "Request-Id" in rheaders:
             request_id = rheaders["Request-Id"]
@@ -364,7 +363,8 @@ class APIRequestor(object):
         except Exception as e:
             raise _error.APIError(
                 "Invalid response body from API: %s "
-                "(HTTP response code was %d)" % (rbody, rcode),
+                "(HTTP response code was %d)"
+                % (_util.redacted_body_for_error_message(rbody), rcode),
                 cast(bytes, rbody),
                 rcode,
                 rheaders,
@@ -399,7 +399,7 @@ class APIRequestor(object):
             error_code=status,
             error_type=error_data.get("type"),
             error_message=error_data.get("message"),
-            error_params=error_data.get("params"),
+            error_params=_util.redacted_error_params(error_data.get("params")),
         )
 
         error = cause.get("error", {}) if cause else {}

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/unique_sdk/_util.py

@@ -9,6 +9,7 @@ import random
 import re
 import sys
 import time
+from collections.abc import Mapping
 from functools import wraps
 from typing import (
     Any,
@@ -33,6 +34,8 @@ UNIQUE_LOG = os.environ.get("UNIQUE_LOG")
 
 logger: logging.Logger = logging.getLogger("unique")
 
+_REDACTED = "<redacted>"
+
 
 def _console_log_level():
     if unique_sdk.log in ["debug", "info"]:
@@ -42,6 +45,42 @@ def _console_log_level():
     return None
 
 
+def _insecure_log_payloads_enabled() -> bool:
+    return os.environ.get("INSECURE_UNIQUE_SDK_LOG_PAYLOADS") == "true"
+
+
+def _payload_byte_size(value: Any) -> int:
+    if value is None:
+        return 0
+    if isinstance(value, (bytes, bytearray)):
+        return len(value)
+    if isinstance(value, str):
+        return len(value.encode("utf-8"))
+    return len(str(value).encode("utf-8"))
+
+
+def _headers_for_log(headers: Mapping[str, str] | None) -> dict[str, str] | str | None:
+    """Return headers for debug logs; Authorization is always redacted."""
+    if not _insecure_log_payloads_enabled():
+        return _REDACTED
+    if headers is None:
+        return None
+    try:
+        sanitized = dict(headers)
+    except (TypeError, ValueError):
+        return _REDACTED
+    for key in list(sanitized):
+        if str(key).lower() == "authorization":
+            sanitized[key] = _REDACTED
+    return sanitized
+
+
+def _body_for_log(body: Any) -> Any:
+    if _insecure_log_payloads_enabled():
+        return body
+    return _REDACTED
+
+
 def log_debug(message, **params):
     msg = logfmt(dict(message=message, **params))
     if _console_log_level() == "debug":
@@ -56,6 +95,65 @@ def log_info(message, **params):
     logger.info(msg)
 
 
+def log_request_details(
+    *,
+    data: Any,
+    headers: Mapping[str, str] | None,
+    api_version: str | None,
+    message: str = "Request details",
+) -> None:
+    if _insecure_log_payloads_enabled():
+        log_debug(
+            message,
+            data=data,
+            headers=_headers_for_log(headers),
+            api_version=api_version,
+        )
+        return
+    log_debug(
+        message,
+        data=_REDACTED,
+        headers=_REDACTED,
+        api_version=api_version,
+        payload_bytes=_payload_byte_size(data),
+    )
+
+
+def log_response_body(*, body: Any) -> None:
+    if _insecure_log_payloads_enabled():
+        log_debug("Unique response body", body=body)
+        return
+    log_debug(
+        "Unique response body",
+        body=_body_for_log(body),
+        payload_bytes=_payload_byte_size(body),
+    )
+
+
+def redacted_body_for_error_message(body: Any) -> Any:
+    """Body representation safe to embed in exception *messages*.
+
+    Exception messages surface at ERROR (retry logs, tracebacks) regardless
+    of LOG_LEVEL, so the raw body must not be embedded unless the insecure
+    opt-in is set. The full body stays available programmatically on the
+    exception's ``http_body`` attribute.
+    """
+    if _insecure_log_payloads_enabled():
+        return body
+    return f"<redacted {_payload_byte_size(body)} bytes>"
+
+
+def redacted_error_params(params: Any) -> Any:
+    """Error ``params`` for the INFO-level 'Unique error received' log.
+
+    API validation errors commonly echo submitted values in ``params``, so
+    they are redacted unless the insecure opt-in is set.
+    """
+    if params is None or _insecure_log_payloads_enabled():
+        return params
+    return _REDACTED
+
+
 def logfmt(props):
     def fmt(key, val):
         # Handle case where val is a bytes or bytesarray

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/unique_sdk/cli/cli.py

@@ -1373,7 +1373,8 @@ def elicit_ask(
 @click.option(
     "--mode",
     type=click.Choice(["FORM", "URL"], case_sensitive=False),
-    required=True,
+    default="FORM",
+    show_default=True,
     help="Elicitation display mode.",
 )
 @click.option(

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/unique_sdk/cli/shell.py

@@ -97,7 +97,7 @@ OVERVIEW_HELP = textwrap.dedent("""\
         --placeholder-text <text>      Text on the placeholder thinking step
         --cleanup collapse|delete      How to tear down the placeholder
       elicit create <message> [opts] Fire-and-forget create
-        --mode FORM|URL                Display mode (required)
+        --mode FORM|URL                Display mode (default: FORM)
         --tool-name / -t <name>        Tool label (required)
         --schema <json>                JSON schema (FORM mode)
         --url <url>                    External URL (URL mode)
@@ -811,7 +811,7 @@ class UniqueShell(cmd.Cmd):
           --tool-name / -t <name>      Tool label shown in the UI
           --schema <json>              JSON schema for form fields
           --url <url>                  External URL (create with --mode URL)
-          --mode FORM|URL              Display mode (create only, required)
+          --mode FORM|URL              Display mode (create only, default: FORM)
           --chat-id / -c <id>          Associated chat ID
           --message-id / -m <id>       Associated message ID
           --expires-in <seconds>       Auto-expire the request (create only)
@@ -1033,18 +1033,15 @@ class UniqueShell(cmd.Cmd):
         message = opts["message"]
         if not message:
             self._print(
-                "Usage: elicit create <message> --mode FORM|URL --tool-name <name> [options]"
+                "Usage: elicit create <message> [--mode FORM|URL] --tool-name <name> [options]"
             )
             return
-        if not opts["mode"]:
-            self._print("Error: --mode is required (FORM or URL).")
-            return
         if not opts["tool_name"]:
             self._print("Error: --tool-name / -t is required.")
             return
 
         create_kwargs: dict[str, Any] = {
-            "mode": opts["mode"],
+            "mode": opts["mode"] or "FORM",
             "message": message,
             "tool_name": opts["tool_name"],
             "schema": opts["schema"],

{unique_sdk-2026.32.0.dev5 → unique_sdk-2026.32.0.dev7}/unique_sdk/cli/skills/unique-cli-elicitation/SKILL.md

@@ -161,22 +161,19 @@ unique-cli elicit ask "Which report format do you want?" \
 
 Always use this before `rm`, `rmdir -r`, mass uploads, or anything irreversible.
 
+Use an **empty-properties schema** — the UI's Confirm/Cancel buttons ARE the
+consent. Do **not** add a boolean `confirm` field: the button and the checkbox
+are two separate signals, and a user who presses Confirm with the box unchecked
+would show as **Accepted** in the UI while you would read `confirm: false` and
+wrongly treat it as declined.
+
 ```bash
-unique-cli elicit ask "Confirm deleting /Archive/2024 and everything inside it" \
+unique-cli elicit ask "Permanently delete /Archive/2024 and everything inside it? Confirming deletes it immediately — this cannot be undone." \
   --chat-id "$UNIQUE_CHAT_ID" \
-  --schema '{
-    "type": "object",
-    "properties": {
-      "confirm": {
-        "type": "boolean",
-        "description": "Tick to permanently delete"
-      }
-    },
-    "required": ["confirm"]
-  }'
+  --schema '{"type": "object", "properties": {}}'
 ```
 
-Proceed **only** if the response contains `"confirm": true`. Treat `DECLINED`, `CANCELLED`, `EXPIRED`, or `confirm: false` all as "do not proceed" -- tell the user you stopped and return control.
+Proceed **only** if the `Status:` is `ACCEPTED`. Treat `DECLINED`, `CANCELLED`, or `EXPIRED` all as "do not proceed" -- tell the user you stopped and return control. Put everything the user needs to decide into the message text, since the form has no fields.
 
 ### Structured form (multiple fields)
 
@@ -201,7 +198,9 @@ The table below documents `elicit ask`'s flags. `elicit create` takes the
 same `--chat-id`, `--message-id`, `--tool-name`, `--schema`, `--metadata`,
 and `--assistant-id` flags, but uses `--expires-in <seconds>` instead of
 `--timeout`/`--poll-interval` (those two apply only to `elicit wait`, which
-you call separately in the polling pattern).
+you call separately in the polling pattern). `elicit create` also takes
+`--mode FORM|URL` (default: `FORM` — you only need to pass it for URL
+elicitations).
 
 | Option | Short | Default | Description |
 |--------|-------|---------|-------------|
@@ -296,7 +295,7 @@ esac
 
 - Always set `"required"` for fields you actually need -- this guarantees the user cannot submit an empty form.
 - Use `enum` for closed choices so the UI can render a selector.
-- Use `"type": "boolean"` for confirmations; treat `true` as "go ahead", everything else as "stop".
+- For pure yes/no confirmations use an **empty-properties schema** (`{"type": "object", "properties": {}}`) and gate on `Status: ACCEPTED` — never add a boolean `confirm` field (the Confirm button and the checkbox are two separate signals that can disagree). Reserve `"type": "boolean"` for genuine data fields where `false` is a valid answer the user can still submit with Confirm (e.g. `include_appendix`).
 - Add short `description` strings -- they are shown as help text next to each field.
 - Keep schemas small. Ask at most 5 questions in a single elicitation; if you need more, split the flow so the user is not confused by an oversized form.