makea-cli 0.2.17__tar.gz → 0.2.19__tar.gz

{makea_cli-0.2.17 → makea_cli-0.2.19}/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.2.19
+
+- `admin create rule` and `admin update rule` take `--valid-until YYYY-MM-DD`:
+  the day the rule ends (a closure, a temporary arrangement). From the day
+  after, it is in no prompt and does nothing; `playbook-preview` lists it as
+  "Ended". `--valid-until none` on update removes the end date. Needs the
+  backend from 3c1dc4e4.
+
+## 0.2.18
+
+New: see why a playbook rule did not reach Beeboo, and what a rule said
+before. Both need the backend's playbook trace and revisions (ca0469d1).
+
+- `admin get playbook-preview -u <user> [--product <id>] [--surface …]`: the
+  block one AI surface would get, and in `excluded[]` every rule read that
+  stays out with its reason (waiting for the brand, paused, only for other
+  product types, narrowed to another factory, over budget…). `--rule <id>`
+  answers for one rule only; `--supplier` previews a factory's playbook.
+- `admin get rule-history <rule_id>`: every revision of one rule, with who
+  changed it and why, and `superseded_chain` to the rule that replaced it.
+
 ## 0.2.17
 
 New: an admin can make and run shipping orders from the CLI. `create

{makea_cli-0.2.17 → makea_cli-0.2.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: makea-cli
-Version: 0.2.17
+Version: 0.2.19
 Summary: Makea admin CLI (browser login + Makea admin HTTP API)
 Requires-Python: >=3.10
 Requires-Dist: click<9,>=8.1
@@ -112,10 +112,12 @@ exit code：`0` 成功 · `2` 用法错 · `3` 未登录或身份与 persona 不
 | `makea-cli admin get currency-conversion` | read | `GET /admin/fx/rates` | the platform's own exchange rates and rounding (rate table for several --from; one --from with --amount converts it). | `convert-currency` |
 | `makea-cli admin get feature-usage` | read | `POST /admin/analytics/query` | How many distinct users used a feature recently, plus event volume. Matches $pageview path and feature_time_spent eve… | `analytics-feature-usage` |
 | `makea-cli admin get library-schema` | read | `GET /admin/library_components/schema` | the tech-pack library taxonomy: sections and their library-role field keys (run this before create/update). | `library-schema` |
+| `makea-cli admin get playbook-preview` | read | `GET /admin/playbook/preview` | the playbook block one AI surface would get for a person or factory, and every rule left out with its reason; --product previews a conversation about one product, --rule answers for one rule. | — |
 | `makea-cli admin get production-pricing` | read | `GET /admin/production_orders/{id}/details` | show a production order's price tiers, MOQ, sizes/colours, pricing groups and cart coverage. | `production-pricing-show` |
 | `makea-cli admin get quote-request` | read | `GET /admin/quote_requests/{quote_request_id}` | one quote request in full. | — |
 | `makea-cli admin get revenue-metrics` | read | `GET /admin/business-metrics/cumulative-payment-and-platform-revenue` | platform-wide payment received and platform revenue (service fee + transaction fee) bucketed over a date range. | `get-cumulative-payment-and-platform-revenue` |
 | `makea-cli admin get rule` | read | `GET /admin/playbook/users/{user}/rules/{rule_id}` | one rule in full, with its evidence: where it came from, who changed it and why. | — |
+| `makea-cli admin get rule-history` | read | `GET /admin/playbook/rules/{rule_id}/history` | every revision of one rule: its words, who changed it and why, and the rule that replaced it. | — |
 | `makea-cli admin get shipping-order` | read | `GET /admin/shipping_orders/{shipping_order_id}/details` | one shipment with its production and sampling orders, freight quotes, fees, tracking and address. | — |
 | `makea-cli admin get supplier-profile-schema` | read | `GET /admin/supplier/profile/schema` | supplier profile v2 schema (section/field taxonomy: sections, fields, options, required rules). | `get-supplier-profile-schema` |
 | `makea-cli admin get tech-spec-extraction` | read | `GET /admin/products/{id}/extract-tech-specifications` | AI-generate specs (not saved). | `extract-ai-tech-spec` |
@@ -141,7 +143,7 @@ exit code：`0` 成功 · `2` 用法错 · `3` 未登录或身份与 persona 不
 | `makea-cli admin update library-element` | write（auto） | `PATCH /admin/designer/{user_id}/library_components/{component_id}` | update a component's name and/or values (empty value clears a field). | `library-update` |
 | `makea-cli admin update quote` | write（ask） | `POST /admin/product/edit_supplier_link_override_info` | admin updates an existing quote (supplier link) in place. Only the options you pass are sent, and the backend leaves … | `update-supplier-quote` |
 | `makea-cli admin update quote-request` | write（ask） | `PATCH /admin/quote_requests/{quote_request_id}/update` | set a quote request's stage, status and/or due date. Only what you pass is changed. This is the door that unblocks a … | `update-quote-request` |
-| `makea-cli admin update rule` | write（ask） | `PATCH /admin/playbook/users/{user}/rules/{rule_id}` | change a rule's text, status, applies_to, when or mode. --reason required; the rule keeps what it was before. | — |
+| `makea-cli admin update rule` | write（ask） | `PATCH /admin/playbook/users/{user}/rules/{rule_id}` | change a rule's text, status, applies_to, when, mode or end date (--valid-until). --reason required; the rule keeps what it was before. | — |
 | `makea-cli admin update shipping-order` | write（ask） | `PUT /admin/shipping_orders/{shipping_order_id}/status` | Change a shipment: --status (PUT .../status), tracking flags (POST .../tracking), --address (PUT .../shipping-address… | — |
 | `makea-cli admin update supplier` | write（ask） | `PUT /admin/supplier/update_supplier` | update an existing supplier from a JSON file (admin). Run `makea-cli get-supplier-profile-schema` FIRST to get the fi… | `update-supplier` |
 | `makea-cli admin update tech-spec` | write（ask） | `POST /admin/products/{id}/technical-specifications` | persist specs from a JSON file. | `save-product-tech-spec` |

{makea_cli-0.2.17 → makea_cli-0.2.19}/README.md

@@ -100,10 +100,12 @@ exit code：`0` 成功 · `2` 用法错 · `3` 未登录或身份与 persona 不
 | `makea-cli admin get currency-conversion` | read | `GET /admin/fx/rates` | the platform's own exchange rates and rounding (rate table for several --from; one --from with --amount converts it). | `convert-currency` |
 | `makea-cli admin get feature-usage` | read | `POST /admin/analytics/query` | How many distinct users used a feature recently, plus event volume. Matches $pageview path and feature_time_spent eve… | `analytics-feature-usage` |
 | `makea-cli admin get library-schema` | read | `GET /admin/library_components/schema` | the tech-pack library taxonomy: sections and their library-role field keys (run this before create/update). | `library-schema` |
+| `makea-cli admin get playbook-preview` | read | `GET /admin/playbook/preview` | the playbook block one AI surface would get for a person or factory, and every rule left out with its reason; --product previews a conversation about one product, --rule answers for one rule. | — |
 | `makea-cli admin get production-pricing` | read | `GET /admin/production_orders/{id}/details` | show a production order's price tiers, MOQ, sizes/colours, pricing groups and cart coverage. | `production-pricing-show` |
 | `makea-cli admin get quote-request` | read | `GET /admin/quote_requests/{quote_request_id}` | one quote request in full. | — |
 | `makea-cli admin get revenue-metrics` | read | `GET /admin/business-metrics/cumulative-payment-and-platform-revenue` | platform-wide payment received and platform revenue (service fee + transaction fee) bucketed over a date range. | `get-cumulative-payment-and-platform-revenue` |
 | `makea-cli admin get rule` | read | `GET /admin/playbook/users/{user}/rules/{rule_id}` | one rule in full, with its evidence: where it came from, who changed it and why. | — |
+| `makea-cli admin get rule-history` | read | `GET /admin/playbook/rules/{rule_id}/history` | every revision of one rule: its words, who changed it and why, and the rule that replaced it. | — |
 | `makea-cli admin get shipping-order` | read | `GET /admin/shipping_orders/{shipping_order_id}/details` | one shipment with its production and sampling orders, freight quotes, fees, tracking and address. | — |
 | `makea-cli admin get supplier-profile-schema` | read | `GET /admin/supplier/profile/schema` | supplier profile v2 schema (section/field taxonomy: sections, fields, options, required rules). | `get-supplier-profile-schema` |
 | `makea-cli admin get tech-spec-extraction` | read | `GET /admin/products/{id}/extract-tech-specifications` | AI-generate specs (not saved). | `extract-ai-tech-spec` |
@@ -129,7 +131,7 @@ exit code：`0` 成功 · `2` 用法错 · `3` 未登录或身份与 persona 不
 | `makea-cli admin update library-element` | write（auto） | `PATCH /admin/designer/{user_id}/library_components/{component_id}` | update a component's name and/or values (empty value clears a field). | `library-update` |
 | `makea-cli admin update quote` | write（ask） | `POST /admin/product/edit_supplier_link_override_info` | admin updates an existing quote (supplier link) in place. Only the options you pass are sent, and the backend leaves … | `update-supplier-quote` |
 | `makea-cli admin update quote-request` | write（ask） | `PATCH /admin/quote_requests/{quote_request_id}/update` | set a quote request's stage, status and/or due date. Only what you pass is changed. This is the door that unblocks a … | `update-quote-request` |
-| `makea-cli admin update rule` | write（ask） | `PATCH /admin/playbook/users/{user}/rules/{rule_id}` | change a rule's text, status, applies_to, when or mode. --reason required; the rule keeps what it was before. | — |
+| `makea-cli admin update rule` | write（ask） | `PATCH /admin/playbook/users/{user}/rules/{rule_id}` | change a rule's text, status, applies_to, when, mode or end date (--valid-until). --reason required; the rule keeps what it was before. | — |
 | `makea-cli admin update shipping-order` | write（ask） | `PUT /admin/shipping_orders/{shipping_order_id}/status` | Change a shipment: --status (PUT .../status), tracking flags (POST .../tracking), --address (PUT .../shipping-address… | — |
 | `makea-cli admin update supplier` | write（ask） | `PUT /admin/supplier/update_supplier` | update an existing supplier from a JSON file (admin). Run `makea-cli get-supplier-profile-schema` FIRST to get the fi… | `update-supplier` |
 | `makea-cli admin update tech-spec` | write（ask） | `POST /admin/products/{id}/technical-specifications` | persist specs from a JSON file. | `save-product-tech-spec` |

makea_cli-0.2.19/makea_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.19"

{makea_cli-0.2.17 → makea_cli-0.2.19}/makea_cli/api_client.py

@@ -1181,6 +1181,31 @@ def admin_delete_user_rule(user: str, rule_id: str, reason: str) -> Any:
     return delete_json(_user_rules_path(user, rule_id), body={"reason": reason})
 
 
+def admin_get_rule_history(rule_id: str) -> Any:
+    """GET /admin/playbook/rules/{rule_id}/history — every revision of one rule
+    (words, who, why), what replaced it and what it replaced."""
+    return get_json(f"/admin/playbook/rules/{quote(rule_id, safe='')}/history")
+
+
+def admin_playbook_preview(
+    surface: str,
+    *,
+    user_id: str | None = None,
+    supplier_id: str | None = None,
+    product_id: str | None = None,
+) -> Any:
+    """GET /admin/playbook/preview — the block a surface would inject, plus every
+    rule left out and why (``excluded``)."""
+    params: dict[str, Any] = {"surface": surface}
+    if user_id:
+        params["user_id"] = user_id
+    if supplier_id:
+        params["supplier_id"] = supplier_id
+    if product_id:
+        params["product_id"] = product_id
+    return get_json("/admin/playbook/preview", params=params)
+
+
 # --- supplier persona: a factory acting on its own RFQs, quotes and orders --------
 
 

{makea_cli-0.2.17 → makea_cli-0.2.19}/makea_cli/commands/playbook/cmd.py

@@ -17,6 +17,7 @@ the row stays as the record, and ``update --status active`` brings it back.
 from __future__ import annotations
 
 import json
+from datetime import date
 from typing import Any
 
 import typer
@@ -107,6 +108,13 @@ def _when(raw: str) -> dict[str, Any]:
     return data
 
 
+def _date(raw: str) -> str:
+    try:
+        return date.fromisoformat(raw.strip()).isoformat()
+    except ValueError as e:
+        raise typer.BadParameter("--valid-until: expected YYYY-MM-DD") from e
+
+
 def _choice(value: str | None, allowed: tuple[str, ...], flag: str) -> str | None:
     if value is None:
         return None
@@ -172,6 +180,71 @@ def register(app: typer.Typer) -> None:
         """Show one playbook rule with its evidence."""
         print_json_or_exit(console, lambda: api_client.admin_get_user_rule(user, rule_id))
 
+    @command(
+        app,
+        "admin",
+        "get",
+        "rule-history",
+        api="GET /admin/playbook/rules/{rule_id}/history",
+        help=(
+            "GET /admin/playbook/rules/{rule_id}/history — every revision of one rule: "
+            "its words, who changed it and why; superseded_chain leads to the rule "
+            "that holds now when this one was replaced."
+        ),
+    )
+    def get_rule_history(
+        rule_id: str = typer.Argument(..., help="Rule id (rul_…)."),
+    ) -> None:
+        """Show what a playbook rule said at each point, and what replaced it."""
+        print_json_or_exit(console, lambda: api_client.admin_get_rule_history(rule_id))
+
+    @command(
+        app,
+        "admin",
+        "get",
+        "playbook-preview",
+        api="GET /admin/playbook/preview",
+        help=(
+            "GET /admin/playbook/preview — the playbook block one AI surface would get "
+            "for a person (or a factory), and in excluded[] every rule read that stays "
+            "out with its reason (waiting for confirmation, paused, only for knitwear, "
+            "over budget…). --product previews a conversation about one product."
+        ),
+    )
+    def playbook_preview(
+        user: str | None = typer.Option(None, "--user", "-u", help="Brand user_id."),
+        supplier: str | None = typer.Option(None, "--supplier", help="Supplier id."),
+        surface: str = typer.Option(
+            "chat_default", "--surface", help="AI surface, e.g. chat_default."
+        ),
+        product: str | None = typer.Option(None, "--product", "-p", help="Product id."),
+        rule: str | None = typer.Option(
+            None, "--rule", help="Only say whether this rule is in, and if not why."
+        ),
+    ) -> None:
+        """Preview a playbook block and why the other rules stay out."""
+        if not user and not supplier:
+            raise typer.BadParameter("pass --user or --supplier")
+
+        def fetch() -> Any:
+            out = api_client.admin_playbook_preview(
+                surface, user_id=user, supplier_id=supplier, product_id=product
+            )
+            if not rule:
+                return out
+            if rule in (out.get("rule_ids") or []):
+                return {"rule_id": rule, "in_prompt": True}
+            for ex in out.get("excluded") or []:
+                if ex.get("rule_id") == rule:
+                    return {"rule_id": rule, "in_prompt": False, **ex}
+            return {
+                "rule_id": rule,
+                "in_prompt": False,
+                "reason": "not read: archived, or not on a scope this surface reads",
+            }
+
+        print_json_or_exit(console, fetch)
+
     @command(
         app,
         "admin",
@@ -225,6 +298,11 @@ def register(app: typer.Typer) -> None:
         force: bool = typer.Option(
             False, "--force", help="Add even if it repeats or disagrees with an existing rule."
         ),
+        valid_until: str | None = typer.Option(
+            None,
+            "--valid-until",
+            help="YYYY-MM-DD the rule ends on (a closure, a temporary arrangement).",
+        ),
     ) -> None:
         """Add a playbook rule for a person."""
         body: dict[str, Any] = {"text": text, "reason": _reason(reason)}
@@ -246,6 +324,8 @@ def register(app: typer.Typer) -> None:
             body["status"] = _choice(status, ("pending", "active", "muted"), "--status")
         if force:
             body["force"] = True
+        if valid_until is not None:
+            body["valid_until"] = _date(valid_until)
         print_json_or_exit(console, lambda: api_client.admin_create_user_rule(user, body))
 
     @command(
@@ -280,6 +360,11 @@ def register(app: typer.Typer) -> None:
             None, "--when", help="Which products, JSON ({} for every product)."
         ),
         mode: str | None = typer.Option(None, "--mode", help="remind or act."),
+        valid_until: str | None = typer.Option(
+            None,
+            "--valid-until",
+            help='YYYY-MM-DD the rule ends on; "none" removes the end date.',
+        ),
     ) -> None:
         """Edit a person's playbook rule."""
         body: dict[str, Any] = {}
@@ -293,9 +378,14 @@ def register(app: typer.Typer) -> None:
             body["when"] = _when(when)
         if mode is not None:
             body["mode"] = _choice(mode, _MODES, "--mode")
+        if valid_until is not None:
+            body["valid_until"] = (
+                "" if valid_until.strip().lower() == "none" else _date(valid_until)
+            )
         if not body:
             raise typer.BadParameter(
-                "nothing to change: pass --text, --status, --applies-to, --when or --mode"
+                "nothing to change: pass --text, --status, --applies-to, --when, --mode "
+                "or --valid-until"
             )
         body["reason"] = _reason(reason)
         print_json_or_exit(console, lambda: api_client.admin_update_user_rule(user, rule_id, body))

{makea_cli-0.2.17 → makea_cli-0.2.19}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "makea-cli"
-version = "0.2.17"
+version = "0.2.19"
 description = "Makea admin CLI (browser login + Makea admin HTTP API)"
 readme = "README.md"
 requires-python = ">=3.10"

{makea_cli-0.2.17 → makea_cli-0.2.19}/tests/golden_manifest.json

@@ -486,6 +486,18 @@
           "multiple": false,
           "default": false,
           "help": "Add even if it repeats or disagrees with an existing rule."
+        },
+        {
+          "name": "valid_until",
+          "kind": "option",
+          "opts": [
+            "--valid-until"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "YYYY-MM-DD the rule ends on (a closure, a temporary arrangement)."
         }
       ]
     },
@@ -1858,6 +1870,87 @@
         }
       ]
     },
+    {
+      "name": "admin get playbook-preview",
+      "persona": "admin",
+      "verb": "get",
+      "noun": "playbook-preview",
+      "access": "read",
+      "api": "GET /admin/playbook/preview",
+      "external": null,
+      "side_effects": [],
+      "approval": "auto",
+      "reversible": null,
+      "idempotent": null,
+      "limit": null,
+      "legacy": [],
+      "help": "GET /admin/playbook/preview — the playbook block one AI surface would get for a person (or a factory), and in excluded[] every rule read that stays out with its reason (waiting for confirmation, paused, only for knitwear, over budget…). --product previews a conversation about one product.",
+      "function": "makea_cli.commands.playbook.cmd.register.<locals>.playbook_preview",
+      "flags": [
+        {
+          "name": "user",
+          "kind": "option",
+          "opts": [
+            "--user",
+            "-u"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "Brand user_id."
+        },
+        {
+          "name": "supplier",
+          "kind": "option",
+          "opts": [
+            "--supplier"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "Supplier id."
+        },
+        {
+          "name": "surface",
+          "kind": "option",
+          "opts": [
+            "--surface"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": "chat_default",
+          "help": "AI surface, e.g. chat_default."
+        },
+        {
+          "name": "product",
+          "kind": "option",
+          "opts": [
+            "--product",
+            "-p"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "Product id."
+        },
+        {
+          "name": "rule",
+          "kind": "option",
+          "opts": [
+            "--rule"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "Only say whether this rule is in, and if not why."
+        }
+      ]
+    },
     {
       "name": "admin get production-pricing",
       "persona": "admin",
@@ -2062,6 +2155,37 @@
         }
       ]
     },
+    {
+      "name": "admin get rule-history",
+      "persona": "admin",
+      "verb": "get",
+      "noun": "rule-history",
+      "access": "read",
+      "api": "GET /admin/playbook/rules/{rule_id}/history",
+      "external": null,
+      "side_effects": [],
+      "approval": "auto",
+      "reversible": null,
+      "idempotent": null,
+      "limit": null,
+      "legacy": [],
+      "help": "GET /admin/playbook/rules/{rule_id}/history — every revision of one rule: its words, who changed it and why; superseded_chain leads to the rule that holds now when this one was replaced.",
+      "function": "makea_cli.commands.playbook.cmd.register.<locals>.get_rule_history",
+      "flags": [
+        {
+          "name": "rule_id",
+          "kind": "argument",
+          "opts": [
+            "rule_id"
+          ],
+          "type": "text",
+          "required": true,
+          "multiple": false,
+          "default": null,
+          "help": "Rule id (rul_…)."
+        }
+      ]
+    },
     {
       "name": "admin get shipping-order",
       "persona": "admin",
@@ -4448,6 +4572,18 @@
           "multiple": false,
           "default": null,
           "help": "remind or act."
+        },
+        {
+          "name": "valid_until",
+          "kind": "option",
+          "opts": [
+            "--valid-until"
+          ],
+          "type": "text",
+          "required": false,
+          "multiple": false,
+          "default": null,
+          "help": "YYYY-MM-DD the rule ends on; \"none\" removes the end date."
         }
       ]
     },

{makea_cli-0.2.17 → makea_cli-0.2.19}/tests/test_persona_commands.py

@@ -429,6 +429,35 @@ class PlaybookRuleCommandTests(_PersonaCase):
             ("GET", "/admin/playbook/users/u1/rules/rul_1"),
         )
 
+    def test_history_reads_one_rule_by_id(self):
+        self.run_cli("admin", "get", "rule-history", "rul_1")
+        self.assertEqual(
+            (self.rec.last["method"], self.rec.last["path"]),
+            ("GET", "/admin/playbook/rules/rul_1/history"),
+        )
+
+    def test_preview_passes_the_conversation(self):
+        self.run_cli(
+            "admin", "get", "playbook-preview", "-u", "u1", "--product", "p1",
+            "--surface", "chat_tech_pack_builder",
+        )  # fmt: skip
+        self.assertEqual(self.rec.last["path"], "/admin/playbook/preview")
+        self.assertEqual(
+            self.rec.last["params"],
+            {"surface": "chat_tech_pack_builder", "user_id": "u1", "product_id": "p1"},
+        )
+        self.run_cli("admin", "get", "playbook-preview", expect=2)
+
+    def test_preview_answers_for_one_rule(self):
+        self.rec.payload = {
+            "success": True,
+            "rule_ids": ["rul_in"],
+            "excluded": [{"rule_id": "rul_out", "reason": "pending", "label": "Waiting"}],
+        }
+        out = self.run_cli("admin", "get", "playbook-preview", "-u", "u1", "--rule", "rul_out")
+        self.assertIn('"in_prompt": false', out.output)
+        self.assertIn('"reason": "pending"', out.output)
+
     def test_create_builds_the_body(self):
         self.run_cli(
             "admin", "create", "rule", "--user", "u1",

{makea_cli-0.2.17 → makea_cli-0.2.19}/uv.lock

@@ -115,7 +115,7 @@ wheels = [
 
 [[package]]
 name = "makea-cli"
-version = "0.2.15"
+version = "0.2.19"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

makea_cli-0.2.17/makea_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.17"