makea-cli 0.1.15__tar.gz → 0.1.17__tar.gz

{makea_cli-0.1.15 → makea_cli-0.1.17}/.gitignore

@@ -22,3 +22,4 @@ creds_*.json
 
 # Random-name temp drop from sandbox uploads (e.g. zi1zLQLi).
 zi1zLQLi
+.release-venv/

{makea_cli-0.1.15 → makea_cli-0.1.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: makea-cli
-Version: 0.1.15
+Version: 0.1.17
 Summary: Makea admin CLI (browser login + Makea admin HTTP API)
 Requires-Python: >=3.10
 Requires-Dist: httpx>=0.27

makea_cli-0.1.17/makea_cli/__init__.py

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

{makea_cli-0.1.15 → makea_cli-0.1.17}/makea_cli/api_client.py

@@ -79,6 +79,35 @@ def put_json(path: str, body: Any, *, timeout: float = 60.0) -> Any:
     return r.json()
 
 
+def patch_json(path: str, body: Any, *, timeout: float = 60.0) -> Any:
+    """PATCH JSON body (same error handling as ``post_json``)."""
+    url = f"{api_base_url()}{path}"
+    headers = {**_headers(), "Content-Type": "application/json"}
+    with httpx.Client(timeout=timeout) as client:
+        r = client.patch(url, headers=headers, json=body)
+    if r.status_code >= 400:
+        try:
+            detail = r.json()
+        except json.JSONDecodeError:
+            detail = r.text
+        raise RuntimeError(f"HTTP {r.status_code}: {detail}")
+    return r.json()
+
+
+def delete_json(path: str, *, params: dict[str, Any] | None = None, timeout: float = 60.0) -> Any:
+    """DELETE request (same error handling as ``get_json``)."""
+    url = f"{api_base_url()}{path}"
+    with httpx.Client(timeout=timeout) as client:
+        r = client.delete(url, headers=_headers(), params=params)
+    if r.status_code >= 400:
+        try:
+            detail = r.json()
+        except json.JSONDecodeError:
+            detail = r.text
+        raise RuntimeError(f"HTTP {r.status_code}: {detail}")
+    return r.json()
+
+
 def send_admin_raw_email(body: dict[str, Any]) -> Any:
     """
     POST /admin/email/send — queue HTML email (from must be @makea.co).
@@ -816,3 +845,48 @@ def update_product_technical_specifications(
         {"technical_specifications": json.dumps(technical_specifications)},
         timeout=timeout,
     )
+
+
+# ── Tech-pack library (reusable library components), admin-side ──────────
+def admin_library_component_schema(*, timeout: float = 60.0) -> Any:
+    """GET /admin/library_components/schema — the library taxonomy (sections +
+    library-role field descriptors). Static; no target user."""
+    return get_json("/admin/library_components/schema", timeout=timeout)
+
+
+def admin_list_library_components(
+    user_id: str, *, section: str | None = None, timeout: float = 60.0
+) -> Any:
+    """GET /admin/designer/{user_id}/library_components — list a designer's
+    tech-pack library (org-fanned). Optional ``section`` scopes to one type."""
+    params = {"section": section} if section else None
+    return get_json(f"/admin/designer/{user_id}/library_components", params=params, timeout=timeout)
+
+
+def admin_create_library_component(
+    user_id: str, body: dict[str, Any], *, timeout: float = 60.0
+) -> Any:
+    """POST /admin/designer/{user_id}/library_components — {section, name?,
+    values, documents?}."""
+    return post_json(f"/admin/designer/{user_id}/library_components", body, timeout=timeout)
+
+
+def admin_update_library_component(
+    user_id: str, component_id: str, body: dict[str, Any], *, timeout: float = 60.0
+) -> Any:
+    """PATCH /admin/designer/{user_id}/library_components/{component_id} —
+    {name?, values?, documents?}."""
+    return patch_json(
+        f"/admin/designer/{user_id}/library_components/{component_id}",
+        body,
+        timeout=timeout,
+    )
+
+
+def admin_delete_library_component(
+    user_id: str, component_id: str, *, timeout: float = 60.0
+) -> Any:
+    """DELETE /admin/designer/{user_id}/library_components/{component_id}."""
+    return delete_json(
+        f"/admin/designer/{user_id}/library_components/{component_id}", timeout=timeout
+    )

{makea_cli-0.1.15 → makea_cli-0.1.17}/makea_cli/commands/__init__.py

@@ -8,6 +8,7 @@ from makea_cli.commands.designer.cmd import register as register_designer
 from makea_cli.commands.directory.cmd import register as register_directory
 from makea_cli.commands.document.cmd import register as register_document
 from makea_cli.commands.email.cmd import register as register_email
+from makea_cli.commands.library.cmd import register as register_library
 from makea_cli.commands.metrics.cmd import register as register_metrics
 from makea_cli.commands.orders.cmd import register as register_orders
 from makea_cli.commands.product.cmd import register as register_product
@@ -25,3 +26,4 @@ def register_all(app: typer.Typer) -> None:
     register_metrics(app)
     register_analytics(app)
     register_email(app)
+    register_library(app)

makea_cli-0.1.17/makea_cli/commands/library/cmd.py

@@ -0,0 +1,281 @@
+"""Admin commands for a designer's tech-pack library (reusable library components).
+
+A *library component* is a designer's saved, reusable spec for one tech-pack
+section — the ``role='library'`` field values of a fabric / colour / trim …
+(name, composition, construction, certifications, pricing). Designers fill them
+into tech packs ("use from library") and capture them back ("save to library");
+the library is shared across their org the same way products are.
+
+These commands are the admin side: they take the target designer's ``user_id``
+explicitly (Cognito sub) and curate that designer/org's library on their behalf.
+Require an admin Makea login (makea-cli auth).
+
+Workflow: run ``library-schema`` first to learn the valid ``section`` ids and the
+``values`` keys (and which are required) before ``library-create`` / ``library-update``.
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+import typer
+from rich.console import Console
+
+from makea_cli import api_client
+from makea_cli.commands._util import print_json_or_exit
+
+console = Console()
+
+
+_LIBRARY_EPILOG = """
+The tech-pack library holds reusable per-section specs (fabrics, colours, trims …)
+keyed to a designer and shared across their org.
+
+Taxonomy first
+  Run ``makea-cli library-schema`` to list the sections that support a library
+  (e.g. MAIN_FABRIC) and, per section, the ``values`` keys, their labels/types,
+  and which are required ("essential") before a component can be saved. The
+  server ignores any ``values`` key that is not a library-role field for the
+  section, so use exactly the keys the schema reports.
+
+Creating / updating
+  ``values`` is an object of ``{"<field key>": <value>}`` — e.g.
+  ``{"main_fabric.library.name": "Pique Knit", "main_fabric.library.composition": "100% Cotton"}``.
+  On update, a provided value replaces; an empty string / null clears that field.
+  A component's display name defaults to its ``*.library.name`` value when ``name``
+  is omitted.
+
+Org scope
+  Reads (``library-list``) fan across the target designer's whole org and tag each
+  component with ``owner_user_id``. Creates land under the USER_ID you pass;
+  update/delete work on any component in that user's org.
+""".strip()
+
+
+def _load_values(values: str | None, values_file: Path | None) -> dict[str, Any]:
+    """Resolve the ``values`` map from an inline JSON string or a JSON file."""
+    if values is not None and values_file is not None:
+        raise ValueError("Pass only one of --values / --values-file.")
+    raw: str | None = None
+    if values_file is not None:
+        raw = values_file.read_text(encoding="utf-8")
+    elif values is not None:
+        raw = values
+    if raw is None:
+        return {}
+    parsed = json.loads(raw)
+    if not isinstance(parsed, dict):
+        raise ValueError("values must be a JSON object of {field key: value}.")
+    return parsed
+
+
+def register(app: typer.Typer) -> None:
+    @app.command(
+        "library-schema",
+        help=(
+            "GET /admin/library_components/schema — the tech-pack library taxonomy: "
+            "sections and their library-role field keys (run this before create/update)."
+        ),
+        epilog=_LIBRARY_EPILOG,
+    )
+    def library_schema(
+        timeout: float = typer.Option(
+            60.0,
+            "--timeout",
+            "-t",
+            help="HTTP timeout in seconds.",
+            min=10.0,
+            max=300.0,
+        ),
+    ) -> None:
+        """Print the library taxonomy (sections + fields). Admin token required."""
+        print_json_or_exit(
+            console,
+            lambda: api_client.admin_library_component_schema(timeout=timeout),
+        )
+
+    @app.command(
+        "library-list",
+        help=(
+            "GET /admin/designer/{user_id}/library_components — list a designer's "
+            "tech-pack library (org-fanned). Optional --section scopes to one type."
+        ),
+        epilog=_LIBRARY_EPILOG,
+    )
+    def library_list(
+        user_id: str = typer.Argument(..., help="Target designer Cognito user_id (sub)."),
+        section: str | None = typer.Option(
+            None,
+            "--section",
+            "-s",
+            help="Scope to one section id (e.g. MAIN_FABRIC); see library-schema.",
+        ),
+        timeout: float = typer.Option(
+            60.0,
+            "--timeout",
+            "-t",
+            help="HTTP timeout in seconds.",
+            min=10.0,
+            max=300.0,
+        ),
+    ) -> None:
+        """List the target designer's library components across their org."""
+        print_json_or_exit(
+            console,
+            lambda: api_client.admin_list_library_components(
+                user_id, section=section, timeout=timeout
+            ),
+        )
+
+    @app.command(
+        "library-create",
+        help=(
+            "POST /admin/designer/{user_id}/library_components — save a reusable "
+            "component under a designer. Provide --section and --values (see library-schema)."
+        ),
+        epilog=_LIBRARY_EPILOG,
+    )
+    def library_create(
+        user_id: str = typer.Argument(..., help="Target designer Cognito user_id (sub)."),
+        section: str = typer.Option(
+            ...,
+            "--section",
+            "-s",
+            help="Section id the component belongs to (e.g. MAIN_FABRIC).",
+        ),
+        name: str | None = typer.Option(
+            None,
+            "--name",
+            "-n",
+            help="Optional display name (defaults to the *.library.name value).",
+        ),
+        values: str | None = typer.Option(
+            None,
+            "--values",
+            help='Inline JSON object of {field key: value}, e.g. \'{"main_fabric.library.name":"Pique Knit"}\'.',
+        ),
+        values_file: Path | None = typer.Option(
+            None,
+            "--values-file",
+            "-f",
+            exists=True,
+            dir_okay=False,
+            readable=True,
+            help="Path to a UTF-8 JSON file holding the values object (instead of --values).",
+        ),
+        timeout: float = typer.Option(
+            60.0,
+            "--timeout",
+            "-t",
+            help="HTTP timeout in seconds.",
+            min=10.0,
+            max=300.0,
+        ),
+    ) -> None:
+        """Create a library component under the target designer."""
+        try:
+            body: dict[str, Any] = {
+                "section": section,
+                "values": _load_values(values, values_file),
+            }
+            if name is not None:
+                body["name"] = name
+        except (OSError, json.JSONDecodeError, ValueError) as e:
+            console.print(f"[red]Invalid input: {e}[/red]")
+            raise typer.Exit(1) from e
+
+        print_json_or_exit(
+            console,
+            lambda: api_client.admin_create_library_component(user_id, body, timeout=timeout),
+        )
+
+    @app.command(
+        "library-update",
+        help=(
+            "PATCH /admin/designer/{user_id}/library_components/{component_id} — update "
+            "a component's name and/or values (empty value clears a field)."
+        ),
+        epilog=_LIBRARY_EPILOG,
+    )
+    def library_update(
+        user_id: str = typer.Argument(..., help="Target designer Cognito user_id (sub)."),
+        component_id: str = typer.Argument(..., help="Library component UUID."),
+        name: str | None = typer.Option(None, "--name", "-n", help="New display name."),
+        values: str | None = typer.Option(
+            None,
+            "--values",
+            help='Inline JSON object of {field key: value} to merge; "" or null clears a field.',
+        ),
+        values_file: Path | None = typer.Option(
+            None,
+            "--values-file",
+            "-f",
+            exists=True,
+            dir_okay=False,
+            readable=True,
+            help="Path to a UTF-8 JSON file holding the values object (instead of --values).",
+        ),
+        timeout: float = typer.Option(
+            60.0,
+            "--timeout",
+            "-t",
+            help="HTTP timeout in seconds.",
+            min=10.0,
+            max=300.0,
+        ),
+    ) -> None:
+        """Update a library component's name and/or values."""
+        try:
+            body: dict[str, Any] = {}
+            if name is not None:
+                body["name"] = name
+            if values is not None or values_file is not None:
+                body["values"] = _load_values(values, values_file)
+            if not body:
+                raise ValueError("Nothing to update: pass --name and/or --values.")
+        except (OSError, json.JSONDecodeError, ValueError) as e:
+            console.print(f"[red]Invalid input: {e}[/red]")
+            raise typer.Exit(1) from e
+
+        print_json_or_exit(
+            console,
+            lambda: api_client.admin_update_library_component(
+                user_id, component_id, body, timeout=timeout
+            ),
+        )
+
+    @app.command(
+        "library-delete",
+        help=(
+            "DELETE /admin/designer/{user_id}/library_components/{component_id} — remove "
+            "a component from the designer's org library."
+        ),
+        epilog=_LIBRARY_EPILOG,
+    )
+    def library_delete(
+        user_id: str = typer.Argument(..., help="Target designer Cognito user_id (sub)."),
+        component_id: str = typer.Argument(..., help="Library component UUID."),
+        yes: bool = typer.Option(False, "--yes", "-y", help="Skip the confirmation prompt."),
+        timeout: float = typer.Option(
+            60.0,
+            "--timeout",
+            "-t",
+            help="HTTP timeout in seconds.",
+            min=10.0,
+            max=300.0,
+        ),
+    ) -> None:
+        """Delete a library component from the target designer's org library."""
+        if not yes:
+            typer.confirm(
+                f"Delete library component {component_id} from {user_id}'s org library?",
+                abort=True,
+            )
+        print_json_or_exit(
+            console,
+            lambda: api_client.admin_delete_library_component(
+                user_id, component_id, timeout=timeout
+            ),
+        )

makea_cli-0.1.17/makea_cli/commands/metrics/cmd.py

@@ -0,0 +1,192 @@
+from __future__ import annotations
+
+import math
+
+import httpx
+import typer
+from rich.console import Console
+
+from makea_cli import api_client
+from makea_cli.commands._util import print_json_or_exit
+
+console = Console()
+
+_GRANULARITIES = ("day", "week", "month")
+_ORDER_TYPES = ("all", "sampling", "production")
+
+# Same free FX source the backend uses (FreeCurrencyService), so converted
+# amounts match the platform's revenue metrics.
+_FX_PRIMARY = (
+    "https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/{base}.json"
+)
+_FX_FALLBACK = "https://latest.currency-api.pages.dev/v1/currencies/{base}.json"
+
+
+def _fx_rate(base: str, target: str) -> float:
+    """Exchange rate base -> target, rounded UP to 2dp exactly like the backend
+    (math.ceil(raw * 100) / 100) so totals reconcile with revenue metrics."""
+    base, target = base.lower(), target.lower()
+    if base == target:
+        return 1.0
+    last_err: Exception | None = None
+    for url in (_FX_PRIMARY.format(base=base), _FX_FALLBACK.format(base=base)):
+        try:
+            with httpx.Client(timeout=10) as client:
+                resp = client.get(url)
+                resp.raise_for_status()
+                data = resp.json()
+            raw = data.get(base, {}).get(target)
+            if raw is not None:
+                return math.ceil(float(raw) * 100) / 100
+        except Exception as e:  # noqa: BLE001 - try fallback URL
+            last_err = e
+            continue
+    raise RuntimeError(
+        f"FX rate {base.upper()}->{target.upper()} unavailable"
+        + (f": {last_err}" if last_err else "")
+    )
+
+
+def register(app: typer.Typer) -> None:
+    @app.command(
+        "get-cumulative-payment-and-platform-revenue",
+        help=(
+            "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."
+        ),
+    )
+    def get_cumulative_payment_and_platform_revenue(
+        start_date: str = typer.Option(
+            ...,
+            "--start-date",
+            help="Start date (inclusive), ISO format YYYY-MM-DD.",
+        ),
+        end_date: str = typer.Option(
+            ...,
+            "--end-date",
+            help="End date (inclusive), ISO format YYYY-MM-DD.",
+        ),
+        granularity: str = typer.Option(
+            "day",
+            "--granularity",
+            "-g",
+            help="Time bucket: day, week, or month. Default: day.",
+        ),
+        currency: str = typer.Option(
+            "GBP",
+            "--currency",
+            "-c",
+            help="Target currency for conversion. Default: GBP.",
+        ),
+        order_type: str = typer.Option(
+            "all",
+            "--order-type",
+            "-t",
+            help="Filter: all, sampling, or production. Default: all.",
+        ),
+    ) -> None:
+        """
+        Platform-wide cumulative payment received and platform revenue over a date range.
+
+        Calls GET /admin/business-metrics/cumulative-payment-and-platform-revenue.
+
+        Platform revenue = service fee + transaction fee (the 2.8% transaction fee is
+        applied by the server). The response contains two siblings under ``result``:
+
+        - ``payment_received``: cumulative/period amounts per bucket, plus a
+          ``payment_breakdown`` (sampling / production_deposit / production_final).
+        - ``platform_revenue``: cumulative/period amounts per bucket.
+
+        Input: required --start-date and --end-date (YYYY-MM-DD); optional
+        --granularity (day|week|month), --currency, --order-type (all|sampling|production).
+
+        Output: raw JSON body from the admin business-metrics endpoint.
+
+        This endpoint is **platform-wide only** and does not support filtering by
+        user_id, product, or category. For per-user / per-product drill-downs, use
+        list-product-orders / list-sampling-orders-by-product /
+        list-production-orders-by-product and aggregate client-side.
+        """
+        g = granularity.strip().lower()
+        if g not in _GRANULARITIES:
+            console.print(f"[red]--granularity must be one of: {', '.join(_GRANULARITIES)}.[/red]")
+            raise typer.Exit(1)
+        ot = order_type.strip().lower()
+        if ot not in _ORDER_TYPES:
+            console.print(f"[red]--order-type must be one of: {', '.join(_ORDER_TYPES)}.[/red]")
+            raise typer.Exit(1)
+
+        print_json_or_exit(
+            console,
+            lambda: api_client.get_cumulative_payment_and_platform_revenue(
+                start_date=start_date,
+                end_date=end_date,
+                granularity=g,
+                currency=currency,
+                order_type=ot,
+            ),
+        )
+
+    @app.command(
+        "convert-currency",
+        help=(
+            "Convert money between currencies using the same free FX source and "
+            "rounding as the platform's revenue metrics. Pass several source "
+            "currencies via --from (comma-separated) to get a full rate table in "
+            "one call, then convert locally — avoids repeated lookups."
+        ),
+    )
+    def convert_currency(
+        to: str = typer.Option(..., "--to", "-t", help="Target currency, e.g. GBP."),
+        from_: str = typer.Option(
+            ...,
+            "--from",
+            "-f",
+            help="Source currency code, or comma-separated list (e.g. usd,eur,cny,gbp).",
+        ),
+        amount: float = typer.Option(
+            None,
+            "--amount",
+            "-a",
+            help="Optional amount to convert (only meaningful with a single --from).",
+        ),
+    ) -> None:
+        """Return source->target rates (rounded like the backend), and optionally a
+        converted amount.
+
+        Use it to collapse a mixed-currency set into one currency: collect the
+        distinct currencies, call once with --from a,b,c to get every rate, then
+        multiply locally. Rates use math.ceil(raw * 100) / 100, matching the
+        platform's FreeCurrencyService, so totals reconcile with revenue metrics.
+
+        Output JSON: {"to", "rates": {CUR: rate, ...}, "rounding", "source"} plus
+        {"from", "rate", "amount", "converted"} when a single --from and --amount
+        are given.
+        """
+        sources = [s.strip() for s in from_.split(",") if s.strip()]
+        if not sources:
+            console.print("[red]--from must contain at least one currency code.[/red]")
+            raise typer.Exit(1)
+
+        def _do() -> dict:
+            rates = {s.upper(): _fx_rate(s, to) for s in sources}
+            out: dict = {
+                "to": to.upper(),
+                "rates": rates,
+                "rounding": "ceil_2dp",
+                "source": "fawazahmed0/currency-api",
+            }
+            if amount is not None and len(sources) == 1:
+                rate = rates[sources[0].upper()]
+                out.update(
+                    {
+                        "from": sources[0].upper(),
+                        "rate": rate,
+                        "amount": amount,
+                        "converted": round(amount * rate, 2),
+                    }
+                )
+            return out
+
+        print_json_or_exit(console, _do)

{makea_cli-0.1.15 → makea_cli-0.1.17}/pyproject.toml

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

makea_cli-0.1.15/.release-venv/.gitignore

@@ -1,2 +0,0 @@
-# Created by venv; see https://docs.python.org/3/library/venv.html
-*